SessionKey
Defined in: packages/synapse-sdk/src/session/key.ts:31
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SessionKey(
client,account):SessionKey
Defined in: packages/synapse-sdk/src/session/key.ts:37
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
client | Client<Transport, Chain, Account> |
account | Account |
Returns
Section titled “Returns”SessionKey
Accessors
Section titled “Accessors”account
Section titled “account”Get Signature
Section titled “Get Signature”get account():
Account
Defined in: packages/synapse-sdk/src/session/key.ts:48
Returns
Section titled “Returns”Account
Get Signature
Section titled “Get Signature”get chain():
Chain
Defined in: packages/synapse-sdk/src/session/key.ts:52
Returns
Section titled “Returns”Chain
client
Section titled “client”Get Signature
Section titled “Get Signature”get client():
Client<Transport,Chain,Account>
Defined in: packages/synapse-sdk/src/session/key.ts:55
Returns
Section titled “Returns”Client<Transport, Chain, Account>
Methods
Section titled “Methods”fetchExpiries()
Section titled “fetchExpiries()”fetchExpiries(
permissions):Promise<Record<SessionKeyPermissions,bigint>>
Defined in: packages/synapse-sdk/src/session/key.ts:64
Queries current permission expiries from the registry
Parameters
Section titled “Parameters”| Parameter | Type | Default value | Description |
|---|---|---|---|
permissions | SessionKeyPermissions[] | SK.ALL_PERMISSIONS | Expiries to fetch, as a list of bytes32 hex strings |
Returns
Section titled “Returns”Promise<Record<SessionKeyPermissions, bigint>>
map of each permission to its expiry for this session key
login()
Section titled “login()”login(
expiry,permissions,origin):Promise<`0x${string}`>
Defined in: packages/synapse-sdk/src/session/key.ts:97
Authorize signer with permissions until expiry. This can also be used to renew existing authorization by updating the expiry.
Parameters
Section titled “Parameters”| Parameter | Type | Default value | Description |
|---|---|---|---|
expiry | bigint | undefined | unix time (block.timestamp) that the permissions expire |
permissions | SessionKeyPermissions[] | SK.ALL_PERMISSIONS | list of permissions granted to the signer, as a list of bytes32 hex strings |
origin | string | DEFAULT_ORIGIN | the name of the application prompting this login |
Returns
Section titled “Returns”Promise<`0x${string}`>
signed and broadcasted login transaction details
revoke()
Section titled “revoke()”revoke(
permissions):Promise<`0x${string}`>
Defined in: packages/synapse-sdk/src/session/key.ts:116
Invalidate signer permissions, setting their expiry to zero.
Parameters
Section titled “Parameters”| Parameter | Type | Default value | Description |
|---|---|---|---|
permissions | SessionKeyPermissions[] | SK.ALL_PERMISSIONS | list of permissions removed from the signer, as a list of bytes32 hex strings |
Returns
Section titled “Returns”Promise<`0x${string}`>
signed and broadcasted revoke transaction details