Class Context

constructor

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

  Parameters

  • _rpc: string | RpcClientInterface
  • _signer: Signer = ...
  • Optional_proto: Protocols
  • _config: BehaviorSubject<
        {
            confirmationPollingTimeoutSecond: number;
            defaultConfirmationCount: number;
        },
    > = ...
  • Optionalforger: Forger
  • Optionalinjector: Injector
  • Optionalpacker: Packer
  • Optionalwallet: WalletProvider
  • Optionalparser: ParserProvider
  • OptionalglobalConstantsProvider: GlobalConstantsProvider
  • OptionalreadProvider: TzReadProvider
  • Optionalstream: SubscribeProvider

  Returns Context

Readonly_config

Readonlybatch

Readonlycontract

Readonlyestimate

ReadonlyoperationFactory

Readonlyprepare

Readonlytz

Readonlywallet

config

• get config(): ConfigConfirmation

  Returns ConfigConfirmation

• set config(value: ConfigConfirmation): void

  Parameters

  • value: ConfigConfirmation

  Returns void

forger

• get forger(): Forger

  Returns Forger

• set forger(value: Forger): void

  Parameters

  • value: Forger

  Returns void

globalConstantsProvider

• get globalConstantsProvider(): GlobalConstantsProvider

  Returns GlobalConstantsProvider

• set globalConstantsProvider(value: GlobalConstantsProvider): void

  Parameters

  • value: GlobalConstantsProvider

  Returns void

injector

• get injector(): Injector

  Returns Injector

• set injector(value: Injector): void

  Parameters

  • value: Injector

  Returns void

packer

• get packer(): Packer

  Returns Packer

• set packer(value: Packer): void

  Parameters

  • value: Packer

  Returns void

parser

• get parser(): ParserProvider

  Returns ParserProvider

• set parser(value: ParserProvider): void

  Parameters

  • value: ParserProvider

  Returns void

proto

• get proto(): Protocols | undefined

  Returns Protocols | undefined

• set proto(value: Protocols | undefined): void

  Parameters

  • value: Protocols | undefined

  Returns void

readProvider

• get readProvider(): TzReadProvider

  Returns TzReadProvider

• set readProvider(value: TzReadProvider): void

  Parameters

  • value: TzReadProvider

  Returns void

rpc

• get rpc(): RpcClientInterface

  Returns RpcClientInterface

• set rpc(value: RpcClientInterface): void

  Parameters

  • value: RpcClientInterface

  Returns void

signer

• get signer(): Signer

  Returns Signer

• set signer(value: Signer): void

  Parameters

  • value: Signer

  Returns void

stream

• get stream(): SubscribeProvider

  Returns SubscribeProvider

• set stream(value: SubscribeProvider): void

  Parameters

  • value: SubscribeProvider

  Returns void

walletProvider

• get walletProvider(): WalletProvider

  Returns WalletProvider

• set walletProvider(value: WalletProvider): void

  Parameters

  • value: WalletProvider

  Returns void

clone

• clone(): Context

  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

  Returns Context

isAnyProtocolActive

• isAnyProtocolActive(protocol?: string[]): Promise<boolean>

  Parameters

  • protocol: string[] = []

  Returns Promise<boolean>

isAnySignerConfigured

• isAnySignerConfigured(): boolean

  Returns boolean

registerProviderDecorator

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

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

  Parameters

  • fx: (context: Context) => Context

  Returns void

setPartialConfig

• setPartialConfig(value: Partial<ConfigConfirmation>): void

  Parameters

  • value: Partial<ConfigConfirmation>

  Returns void

withExtensions

• withExtensions(): Context

  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.

  Returns Context