Class Session

A representation of a session to interact with a specific blockchain account.

Hierarchy

  • Session

Constructors

constructor

Properties

abiCache abis allowModify appName? broadcast chain expireSeconds fetch permissionLevel storage? transactPlugins transactPluginsOptions ui? walletPlugin

Accessors

actor client permission

Methods

cloneRequest createRequest getPluginTranslations serialize signTransaction transact updateRequest upgradeTransaction

Constructors

constructor

Properties

Readonly abiCache

abiCache: ABICacheInterface

Readonly abis

abis: TransactABIDef[] = []

Readonly allowModify

allowModify: boolean = true

Optional Readonly appName

appName?: string

Readonly broadcast

broadcast: boolean = true

Readonly chain

chain: ChainDefinition

Readonly expireSeconds

expireSeconds: number = 120

Readonly fetch

fetch: Fetch

Readonly permissionLevel

permissionLevel: PermissionLevel

Optional Readonly storage

storage?: SessionStorage

Readonly transactPlugins

transactPlugins: TransactPlugin[]

Readonly transactPluginsOptions

transactPluginsOptions: TransactPluginsOptions = {}

Optional Readonly ui

ui?: UserInterface

Readonly walletPlugin

walletPlugin: WalletPlugin

Accessors

actor

client

permission

  • get permission(): Name

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

    Returns Name

Methods

cloneRequest

createRequest

getPluginTranslations

serialize

signTransaction

  • Request a signature for a given transaction.

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

    Returns

    The signature(s) for the transaction

    Parameters

    Returns Promise<Signature[]>

transact

  • Perform a transaction using this session.

    Returns

    The status and data gathered during the operation.

    Mermaid

    - Transaction sequence diagram
    %%{init:{"theme":"dark"}}%% 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]
    %%{init:{"theme":"default"}}%% 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]
    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]

    Parameters

    Returns Promise<TransactResult>

updateRequest

upgradeTransaction

Settings

Member Visibility

Theme