SessionKey

Defined in: packages/synapse-core/src/session-key/types.ts:25

Extends

• TypedEventTarget<SessionKeyEvents>

Type Parameters

Type Parameter
KeyType extends SessionKeyType

Properties

account

readonly account: Account

Defined in: packages/synapse-core/src/session-key/types.ts:29

---

address

readonly address: `0x${string}`

Defined in: packages/synapse-core/src/session-key/types.ts:27

---

client

readonly client: Client<Transport, FilecoinChain, { address: `0x${string}`; keyType: KeyType; nonceManager?: NonceManager; publicKey: `0x${string}`; rootAddress: `0x${string}`; sign: (parameters) => Promise<`0x${string}`>; signAuthorization: (parameters) => Promise<SignAuthorizationReturnType>; signMessage: (__namedParameters) => Promise<`0x${string}`>; signTransaction: <serializer, transaction>(transaction, options?) => Promise<`0x${string}`>; signTypedData: <typedData, primaryType>(parameters) => Promise<`0x${string}`>; source: "sessionKey"; type: "local"; }>

Defined in: packages/synapse-core/src/session-key/types.ts:26

---

expirations

readonly expirations: Expirations

Defined in: packages/synapse-core/src/session-key/types.ts:31

---

hasPermission

hasPermission: (permission) => boolean

Defined in: packages/synapse-core/src/session-key/types.ts:32

Parameters

Parameter	Type
permission	Permission

Returns

boolean

---

hasPermissions

hasPermissions: (permissions) => boolean

Defined in: packages/synapse-core/src/session-key/types.ts:33

Parameters

Parameter	Type
permissions	Permission[]

Returns

boolean

---

rootAddress

readonly rootAddress: `0x${string}`

Defined in: packages/synapse-core/src/session-key/types.ts:28

---

syncExpirations

syncExpirations: () => Promise<void>

Defined in: packages/synapse-core/src/session-key/types.ts:34

Returns

Promise<void>

---

type

readonly type: KeyType

Defined in: packages/synapse-core/src/session-key/types.ts:30

---

unwatch

unwatch: () => void

Defined in: packages/synapse-core/src/session-key/types.ts:44

Stop watching the session key for expirations updates.

Returns

void

---

watch

watch: () => Promise<() => void>

Defined in: packages/synapse-core/src/session-key/types.ts:40

Watch the session key for expirations updates.

Returns

Promise<() => void>

A function to stop watching the session key.

Methods

addEventListener()

addEventListener<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/iso-web@4.0.0/node_modules/iso-web/dist/src/event-target/index.d.ts:29

Type Parameters

Type Parameter
T extends "error" | "expirationsUpdated" | "connected" | "disconnected"

Parameters

Parameter	Type
type	T
callback	TypedEventListenerOrEventListenerObject<SessionKeyEvents, T> | null
options?	boolean | AddEventListenerOptions

Returns

void

Inherit Doc

Inherited from

TypedEventTarget.addEventListener

---

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14386

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

TypedEventTarget.dispatchEvent

---

dispatchTypedEvent()

dispatchTypedEvent<T>(type, event): boolean

Defined in: node_modules/.pnpm/iso-web@4.0.0/node_modules/iso-web/dist/src/event-target/index.d.ts:20

Dispatches a synthetic event to target and returns true if either event’s cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Type Parameters

Type Parameter
T extends "error" | "expirationsUpdated" | "connected" | "disconnected"

Parameters

Parameter	Type
type	T
event	SessionKeyEvents[T]

Returns

boolean

Inherited from

TypedEventTarget.dispatchTypedEvent

---

emit()

emit<T>(…args): boolean

Defined in: node_modules/.pnpm/iso-web@4.0.0/node_modules/iso-web/dist/src/event-target/index.d.ts:21

Type Parameters

Type Parameter
T extends keyof SessionKeyEvents

Parameters

Parameter	Type
…args	EmitArgs<SessionKeyEvents, T>

Returns

boolean

Inherited from

TypedEventTarget.emit

---

off()

off<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/iso-web@4.0.0/node_modules/iso-web/dist/src/event-target/index.d.ts:55

Alias for TypedEventTarget.removeEventListener

Type Parameters

Type Parameter
T extends "error" | "expirationsUpdated" | "connected" | "disconnected"

Parameters

Parameter	Type
type	T
callback	TypedEventListenerOrEventListenerObject<SessionKeyEvents, T> | null
options?	boolean | EventListenerOptions

Returns

void

Inherited from

TypedEventTarget.off

---

on()

on<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/iso-web@4.0.0/node_modules/iso-web/dist/src/event-target/index.d.ts:38

Alias for TypedEventTarget.addEventListener

Type Parameters

Type Parameter
T extends "error" | "expirationsUpdated" | "connected" | "disconnected"

Parameters

Parameter	Type
type	T
callback	TypedEventListenerOrEventListenerObject<SessionKeyEvents, T> | null
options?	boolean | AddEventListenerOptions

Returns

void

Inherited from

TypedEventTarget.on

---

removeEventListener()

removeEventListener<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/iso-web@4.0.0/node_modules/iso-web/dist/src/event-target/index.d.ts:46

Type Parameters

Type Parameter
T extends "error" | "expirationsUpdated" | "connected" | "disconnected"

Parameters

Parameter	Type
type	T
callback	TypedEventListenerOrEventListenerObject<SessionKeyEvents, T> | null
options?	boolean | EventListenerOptions

Returns

void

Inherit Doc

Inherited from

TypedEventTarget.removeEventListener