Class Context

constructor

• new Context(_rpc, _signer?, _proto?, _config?, forger?, injector?, packer?, wallet?, parser?, globalConstantsProvider?, readProvider?, stream?): Context

• Parameters

  • _rpc: string | RpcClientInterface
  • _signer: Signer = ...
  • Optional _proto: Protocols
  • _config: BehaviorSubject<{
        confirmationPollingTimeoutSecond: number;
        defaultConfirmationCount: number;
    }> = ...
  • Optional forger: Forger
  • Optional injector: Injector
  • Optional packer: Packer
  • Optional wallet: WalletProvider
  • Optional parser: ParserProvider
  • Optional globalConstantsProvider: GlobalConstantsProvider
  • Optional readProvider: TzReadProvider
  • Optional stream: SubscribeProvider

  Returns Context

Readonly _config

Readonly batch

Readonly contract

Readonly estimate

Readonly operationFactory

Readonly prepare

Readonly tz

Readonly wallet

config

• get config(): ConfigConfirmation

• Returns ConfigConfirmation

• set config(value): void

• Parameters

  • value: ConfigConfirmation

  Returns void

forger

• get forger(): Forger

• Returns Forger

• set forger(value): void

• Parameters

  • value: Forger

  Returns void

globalConstantsProvider

• get globalConstantsProvider(): GlobalConstantsProvider

• Returns GlobalConstantsProvider

• set globalConstantsProvider(value): void

• Parameters

  • value: GlobalConstantsProvider

  Returns void

injector

• get injector(): Injector

• Returns Injector

• set injector(value): void

• Parameters

  • value: Injector

  Returns void

packer

• get packer(): Packer

• Returns Packer

• set packer(value): void

• Parameters

  • value: Packer

  Returns void

parser

• get parser(): ParserProvider

• Returns ParserProvider

• set parser(value): void

• Parameters

  • value: ParserProvider

  Returns void

proto

• get proto(): undefined | Protocols

• Returns undefined | Protocols

• set proto(value): void

• Parameters

  • value: undefined | Protocols

  Returns void

readProvider

• get readProvider(): TzReadProvider

• Returns TzReadProvider

• set readProvider(value): void

• Parameters

  • value: TzReadProvider

  Returns void

rpc

• get rpc(): RpcClientInterface

• Returns RpcClientInterface

• set rpc(value): void

• Parameters

  • value: RpcClientInterface

  Returns void

signer

• get signer(): Signer

• Returns Signer

• set signer(value): void

• Parameters

  • value: Signer

  Returns void

stream

• get stream(): SubscribeProvider

• Returns SubscribeProvider

• set stream(value): void

• Parameters

  • value: SubscribeProvider

  Returns void

walletProvider

• get walletProvider(): WalletProvider

• Returns WalletProvider

• set walletProvider(value): void

• Parameters

  • value: WalletProvider

  Returns void

clone

• clone(): Context

• Returns Context

  Description

  Create a copy of the current context. Useful when you have long running operation and you do not want a context change to affect the operation

isAnyProtocolActive

• isAnyProtocolActive(protocol?): Promise<boolean>

• Parameters

  • protocol: string[] = []

  Returns Promise<boolean>

isAnySignerConfigured

• isAnySignerConfigured(): boolean

• Returns boolean

registerProviderDecorator

• registerProviderDecorator(fx): void

• Parameters

  • fx: ((context) => Context)
    • • (context): Context

      • Parameters

        • context: Context

        Returns Context

  Returns void

  Description

  Allows extensions set on the TezosToolkit to inject logic into the context

setPartialConfig

• setPartialConfig(value): void

• Parameters

  • value: Partial<ConfigConfirmation>

  Returns void

withExtensions

• withExtensions(): Context

• Returns Context

  Description

  Applies the decorators on a cloned instance of the context and returned this cloned instance. The decorators are functions that inject logic into the context. They are provided by the extensions set on the TezosToolkit by calling the registerProviderDecorator method.