Class TransactContext

Temporary context created for the duration of a Session.transact call.

This context is used to store the state of the transact request and provide a way for plugins to add hooks into the process.

Hierarchy

TransactContext

Index

Constructors

Properties

abiCache appName? chain client createRequest fetch hooks info permissionLevel storage? transactPluginsOptions ui?

Accessors

accountName esrOptions permissionName

Methods

addHook getInfo resolve

Constructors

constructor

new TransactContext(options: TransactContextOptions): TransactContext
Parameters
- options: TransactContextOptions
Returns TransactContext
- Defined in src/transact.ts:99

Properties

`Readonly` abiCache

abiCache: ABICacheInterface

`Optional` `Readonly` appName

appName?: string

`Readonly` chain

chain: ChainDefinition

`Readonly` client

client: APIClient

`Readonly` createRequest

createRequest: ((args: TransactArgs) => Promise<SigningRequest>)

Type declaration

- (args: TransactArgs): Promise<SigningRequest>
- Parameters
  - args: TransactArgs
  Returns Promise<SigningRequest>

`Readonly` fetch

fetch: Fetch

`Readonly` hooks

hooks: TransactHooks = ...

info

info: undefined | GetInfoResponse

`Readonly` permissionLevel

permissionLevel: PermissionLevel

`Optional` `Readonly` storage

storage?: SessionStorage

`Readonly` transactPluginsOptions

transactPluginsOptions: TransactPluginsOptions

`Optional` `Readonly` ui

ui?: UserInterface

Accessors

accountName

get accountName(): Name
Returns Name
- Defined in src/transact.ts:117

esrOptions

get esrOptions(): SigningRequestEncodingOptions
Returns SigningRequestEncodingOptions
- Defined in src/transact.ts:125

permissionName

get permissionName(): Name
Returns Name
- Defined in src/transact.ts:121

Methods

addHook

addHook(t: TransactHookTypes, hook: TransactHookImmutable | TransactHookMutable): void
Parameters
- t: TransactHookTypes
- hook: TransactHookImmutable | TransactHookMutable
Returns void
- Defined in src/transact.ts:132

getInfo

getInfo(): Promise<GetInfoResponse>
Returns Promise<GetInfoResponse>
- Defined in src/transact.ts:146

resolve

resolve(request: SigningRequest, expireSeconds?: number): Promise<ResolvedSigningRequest>
Parameters
- request: SigningRequest
- expireSeconds: number = 120
Returns Promise<ResolvedSigningRequest>
- Defined in src/transact.ts:156