Class Session

constructor

• new Session(args: SessionArgs, options?: SessionOptions): Session

  The constructor of the Session class.

  Parameters

  • args: SessionArgs
  • options: SessionOptions = {}

    SessionOptions

  Returns Session

ReadonlyabiCache

Readonlyabis

ReadonlyallowModify

Optional ReadonlyappName

ReadonlyawaitIrreversible

Readonlybroadcast

Optional ReadonlybroadcastOptions

Readonlychain

ReadonlyexpireSeconds

Readonlyfetch

Optional ReadonlyonPersist

ReadonlypermissionLevel

Optional ReadonlysessionKeyManager

Optional Readonlystorage

ReadonlytransactPlugins

ReadonlytransactPluginsOptions

Optional Readonlyui

actor

• get actor(): Name

  Returns the name of the actor that is being used for this session.

  Returns Name

client

• get client(): APIClient

  Returns an APIClient configured for this session.

  Returns APIClient

data

• get data(): Record<string, any>

  Get the data stored in this session instance.

  Returns Record<string, any>

• set data(data: Record<string, any>): void

  Set the data stored in this session instance.

  Parameters

  • data: Record<string, any>

  Returns void

permission

• get permission(): Name

  Returns the name of the permission that is being used for this session.

  Returns Name

walletPlugin

• get walletPlugin(): WalletPlugin

  Get the wallet plugin for this session.

  Returns WalletPlugin

cloneRequest

• cloneRequest(
      request: SigningRequest,
      abiCache: ABICacheInterface,
  ): SigningRequest

  Create a clone of the given SigningRequest

  Overrides: https://github.com/greymass/@wharfkit/signing-request/blob/6fc84b2355577d6461676bff417c76e4f6f2f5c3/src/signing-request.ts#L1112

  Parameters

  • request: SigningRequest

    The SigningRequest to clone

  • abiCache: ABICacheInterface

    The ABICacheInterface to use for the clone

  Returns SigningRequest

  Returns a cloned SigningRequest with updated abiCache and zlib

createRequest

• createRequest(
      args: TransactArgs,
      abiCache: ABICacheInterface,
  ): Promise<SigningRequest>

  Convert any provided form of TransactArgs to a SigningRequest

  Parameters

  • args: TransactArgs
  • abiCache: ABICacheInterface

  Returns Promise<SigningRequest>

  Returns a SigningRequest

getMergedAbiCache

• getMergedAbiCache(
      args: TransactArgs,
      options?: TransactOptions,
  ): ABICacheInterface

  Parameters

  • args: TransactArgs
  • Optionaloptions: TransactOptions

  Returns ABICacheInterface

getSessionKeyStatus

• getSessionKeyStatus(): Promise<SessionKeyStatus>

  Get the current status of the session key for this session.

  Returns Promise<SessionKeyStatus>

  SessionKeyStatus indicating whether a session key is active, inactive, has a mismatch, or is not set up

hasSessionKey

• hasSessionKey(): this is Session & { walletPlugin: SessionKeyWalletInterface }

  Check if this session has a session key wallet. Type guard that narrows walletPlugin to SessionKeyWalletInterface.

  Returns this is Session & { walletPlugin: SessionKeyWalletInterface }

  True if the wallet plugin is a session key wallet

removeSessionKey

• removeSessionKey(): Promise<void>

  Remove the session key from this session, reverting to the primary wallet. Removes the key from the blockchain permission and persists the session.

  Returns Promise<void>

  Throws

  Error if session keys are not configured or if the session does not have a session key

rewriteAuthorizationsForSessionKey

• rewriteAuthorizationsForSessionKey(args: TransactArgs): TransactArgs

  Rewrite action authorizations to use the session key permission instead of the primary permission. Only rewrites actions that match the session permission and are whitelisted.

  Parameters

  • args: TransactArgs

    The transaction arguments to rewrite

  Returns TransactArgs

  Modified TransactArgs with session key permissions, or original args if not applicable

serialize

• serialize(): SerializedSession

  Serialize the session to a plain object for storage.

  Returns SerializedSession

  SerializedSession object containing chain, actor, permission, and wallet plugin data

setEndpoint

• setEndpoint(url: string): void

  Alters the session config to change the API endpoint in use

  Parameters

  • url: string

  Returns void

setupSessionKey

• setupSessionKey(): Promise<SessionKeySetupResult>

  Set up a session key for this session, creating a new permission with a generated key. Shows consent UI if configured, handles conflicts with existing keys, and persists the session.

  Returns Promise<SessionKeySetupResult>

  SessionKeySetupResult containing the public key and permission name

  Throws

  Error if session keys are not configured or if setup is cancelled by user

signTransaction

• signTransaction(transaction: TransactionType): Promise<Signature[]>

  Request a signature for a given transaction.

  This function will NOT use plugins and will NOT broadcast the transaction.

  Parameters

  • transaction: TransactionType

    A full transaction-like object

  Returns Promise<Signature[]>

  The signature(s) for the transaction

transact

• transact(args: TransactArgs, options?: TransactOptions): Promise<TransactResult>

  Perform a transaction using this session.

  Parameters

  • args: TransactArgs
  • Optionaloptions: TransactOptions

  Returns Promise<TransactResult>

  The status and data gathered during the operation.

  Mermaid

  • Transaction sequence diagram flowchart LR A((Transact)) --> B{{"Hook(s): beforeSign"}} B --> C[Wallet Plugin] C --> D{{"Hook(s): afterSign"}} D --> E[Broadcast Plugin] E --> F{{"Hook(s): afterBroadcast"}} F --> G[TransactResult]

updateRequest

• updateRequest(
      previous: SigningRequest,
      modified: SigningRequest,
      abiCache: ABICacheInterface,
  ): Promise<SigningRequest>

  Update a SigningRequest, ensuring its old metadata is retained.

  Parameters

  • previous: SigningRequest
  • modified: SigningRequest
  • abiCache: ABICacheInterface

  Returns Promise<SigningRequest>

updateSessionKeyLinks

• updateSessionKeyLinks(): Promise<void>

  Update the on-chain permission links to match the configured whitelist. Adds missing links and removes extra links, then persists the session.

  Returns Promise<void>

  Throws

  Error if session keys are not configured or if the session does not have a session key

upgradeTransaction

• upgradeTransaction(args: TransactArgs): TransactArgs

  Templates in any missing fields from partial transactions.

  Parameters

  • args: TransactArgs

    TransactArgs

  Returns TransactArgs

  TransactArgs

validateSessionKeyWhitelist

• validateSessionKeyWhitelist(): Promise<SessionKeyMismatch | undefined>

  Validate the session key whitelist against the on-chain permission links. Returns any mismatches between configured whitelist and actual blockchain state.

  Returns Promise<SessionKeyMismatch | undefined>

  SessionKeyMismatch if there are differences, undefined if in sync or no session key

willUseSessionKey

• willUseSessionKey(args: TransactArgs): boolean

  Determine if the given transaction will be signed using the session key. Checks if session has a session key and all relevant actions are whitelisted.

  Parameters

  • args: TransactArgs

    The transaction arguments to check

  Returns boolean

  True if the session key will be used for signing

Staticmatches

• matches(s1: SessionType, s2: SessionType): boolean

  Check if two sessions match by comparing chain, actor, and permission.

  Parameters

  • s1: SessionType

    Session or SerializedSession

  • s2: SessionType

    Session or SerializedSession

  Returns boolean

  boolean indicating if the sessions match