Class SessionKit

constructor

• new SessionKit(args: SessionKitArgs, options?: SessionKitOptions): SessionKit

  Parameters

  • args: SessionKitArgs
  • options: SessionKitOptions = {}

  Returns SessionKit

Readonlyabis

ReadonlyaccountCreationPlugins

ReadonlyallowModify

ReadonlyappName

ReadonlyawaitIrreversible

Optional ReadonlybroadcastOptions

chains

ReadonlyequalityFn

ReadonlyexpireSeconds

Readonlyfetch

ReadonlyloginPlugins

Optional ReadonlysessionKeyManager

Readonlystorage

ReadonlytransactPlugins

ReadonlytransactPluginsOptions

Readonlyui

ReadonlywalletPlugins

createAccount

• createAccount(options?: CreateAccountOptions): Promise<CreateAccountResponse>

  Request account creation.

  Parameters

  • Optionaloptions: CreateAccountOptions

  Returns Promise<CreateAccountResponse>

getChainDefinition

• getChainDefinition(
      id: Checksum256Type,
      override?: ChainDefinition<AccountObject>[],
  ): ChainDefinition

  Parameters

  • id: Checksum256Type
  • Optionaloverride: ChainDefinition<AccountObject>[]

  Returns ChainDefinition

getSessionOptions

• getSessionOptions(
      options?: LoginOptions,
  ): {
      abis: TransactABIDef[];
      allowModify: boolean;
      appName: string;
      awaitIrreversible: boolean;
      broadcastOptions: BroadcastOptions | undefined;
      expireSeconds: number;
      fetch: Fetch;
      onPersist: (session: Session) => Promise<void>;
      sessionKeyManager: SessionKeyManager | undefined;
      storage: SessionStorage;
      transactPlugins: TransactPlugin[];
      transactPluginsOptions: TransactPluginsOptions;
      ui: UserInterface;
  }

  Parameters

  • Optionaloptions: LoginOptions

  Returns {
      abis: TransactABIDef[];
      allowModify: boolean;
      appName: string;
      awaitIrreversible: boolean;
      broadcastOptions: BroadcastOptions | undefined;
      expireSeconds: number;
      fetch: Fetch;
      onPersist: (session: Session) => Promise<void>;
      sessionKeyManager: SessionKeyManager | undefined;
      storage: SessionStorage;
      transactPlugins: TransactPlugin[];
      transactPluginsOptions: TransactPluginsOptions;
      ui: UserInterface;
  }

getSessions

• getSessions(): Promise<SerializedSession[]>

  Returns Promise<SerializedSession[]>

getWalletPlugin

• getWalletPlugin(id: string): WalletPlugin | undefined

  Find a wallet plugin by its ID.

  Parameters

  • id: string

    The wallet plugin ID to search for

  Returns WalletPlugin | undefined

  The wallet plugin if found, undefined otherwise

login

• login(options?: LoginOptions): Promise<LoginResult>

  Request a session from an account.

  Parameters

  • Optionaloptions: LoginOptions

  Returns Promise<LoginResult>

  Mermaid

  • Login sequence diagram flowchart LR A((Login)) --> B{{"Hook(s): beforeLogin"}} B --> C[Wallet Plugin] C --> D{{"Hook(s): afterLogin"}} D --> E[Session]

logout

• logout(session?: SessionType, options?: LogoutOptions): Promise<void>

  Log a session out, or every session when none is named.

  Logging out a session affects only that session: other sessions keep their default flags, and the default session key is cleared only when it held the session being logged out. Nothing is promoted in its place.

  Parameters

  • Optionalsession: SessionType
  • options: LogoutOptions = {}

  Returns Promise<void>

logoutParams

• logoutParams(session: SessionType, walletPlugin: WalletPlugin): LogoutContext

  Parameters

  • session: SessionType
  • walletPlugin: WalletPlugin

  Returns LogoutContext

persistSession

• persistSession(session: Session, options?: PersistOptions): Promise<void>

  Parameters

  • session: Session
  • options: PersistOptions = {}

  Returns Promise<void>

restore

• restore(
      args?: PartialSerializedSession,
      options?: LoginOptions,
  ): Promise<Session | undefined>

  Parameters

  • Optionalargs: PartialSerializedSession
  • Optionaloptions: LoginOptions

  Returns Promise<Session | undefined>

restoreAll

• restoreAll(): Promise<Session[]>

  Build a live session for every stored session with a registered wallet plugin. Reads storage without writing to it.

  Returns Promise<Session[]>

setEndpoint

• setEndpoint(id: Checksum256Type, url: string): void

  Alters the session kit config for a specific chain to change the API endpoint in use

  Parameters

  • id: Checksum256Type
  • url: string

  Returns void