Skip to content

docs: clarify session hash usage in useRevokeSessions #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maho0638 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify session hash usage in useRevokeSessions #212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions abstract-global-wallet/agw-react/hooks/useRevokeSessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,32 @@ import { useRevokeSessions } from "@abstract-foundation/agw-react";

```tsx
import { useRevokeSessions } from "@abstract-foundation/agw-react";
import type { SessionConfig } from "@abstract-foundation/agw-client/sessions";
import { getSessionHash, type SessionConfig } from "@abstract-foundation/agw-client/sessions";

export default function RevokeSessionExample() {
const { revokeSessionsAsync } = useRevokeSessions();

const existingSessionConfig = {} as SessionConfig;
const anotherSessionConfig = {} as SessionConfig;

async function handleRevokeSession() {
// Revoke a single session using its configuration
await revokeSessionsAsync({
sessions: existingSessionConfig,
});

// Revoke a single session using its creation transaction hash
// Revoke a single session using its hash
const sessionHash = getSessionHash(existingSessionConfig);

await revokeSessionsAsync({
sessions: "0x1234...",
sessions: sessionHash,
});

// Revoke multiple sessions
await revokeSessionsAsync({
sessions: [
existingSessionConfig,
"0x1234...",
sessionHash,
anotherSessionConfig
],
});
Expand All @@ -53,8 +58,8 @@ export default function RevokeSessionExample() {
The session(s) to revoke. Can be provided as an array of:

- Session configuration objects
- Transaction hashes of when the sessions were created
- A mix of both session configs and transaction hashes
- Session hashes returned by `getSessionHash(sessionConfig)`
- A mix of both session configs and session hashes

</ResponseField>

Expand Down