Context | Taquito

description: Encapsulate common service used throughout different part of the library

Hierarchy

Context

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Context(_rpc: string | RpcClientInterface, _signer?: Signer, _proto?: Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha, _config?: BehaviorSubject<{ confirmationPollingTimeoutSecond: number; defaultConfirmationCount: number }>, forger?: Forger, injector?: Injector, packer?: Packer, wallet?: WalletProvider, parser?: ParserProvider, globalConstantsProvider?: GlobalConstantsProvider, readProvider?: TzReadProvider, stream?: SubscribeProvider): Context

- Defined in packages/taquito/src/context.ts:63
Parameters
- _rpc: string | RpcClientInterface
- _signer: Signer = ...
- Optional _proto: Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha
- _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

Properties

Readonly _config

_config: BehaviorSubject<{ confirmationPollingTimeoutSecond: number; defaultConfirmationCount: number }> = ...

Readonly batch

batch: RPCBatchProvider = ...

Readonly contract

contract: RpcContractProvider = ...

Readonly estimate

estimate: RPCEstimateProvider = ...

Readonly operationFactory

operationFactory: OperationFactory

Readonly prepare

prepare: PrepareProvider = ...

Readonly tz

tz: RpcTzProvider = ...

Readonly wallet

wallet: Wallet = ...

Accessors

config

get config(): ConfigConfirmation
set config(value: ConfigConfirmation): void

- Defined in packages/taquito/src/context.ts:99
Returns ConfigConfirmation
- Defined in packages/taquito/src/context.ts:103
Parameters
- value: ConfigConfirmation
Returns void

forger

get forger(): Forger
set forger(value: Forger): void

- Defined in packages/taquito/src/context.ts:132
Returns Forger
- Defined in packages/taquito/src/context.ts:136
Parameters
- value: Forger
Returns void

globalConstantsProvider

get globalConstantsProvider(): GlobalConstantsProvider
set globalConstantsProvider(value: GlobalConstantsProvider): void

- Defined in packages/taquito/src/context.ts:180
Returns GlobalConstantsProvider
- Defined in packages/taquito/src/context.ts:184
Parameters
- value: GlobalConstantsProvider
Returns void

injector

get injector(): Injector
set injector(value: Injector): void

- Defined in packages/taquito/src/context.ts:124
Returns Injector
- Defined in packages/taquito/src/context.ts:128
Parameters
- value: Injector
Returns void

packer

get packer(): Packer
set packer(value: Packer): void

- Defined in packages/taquito/src/context.ts:172
Returns Packer
- Defined in packages/taquito/src/context.ts:176
Parameters
- value: Packer
Returns void

parser

get parser(): ParserProvider
set parser(value: ParserProvider): void

- Defined in packages/taquito/src/context.ts:164
Returns ParserProvider
- Defined in packages/taquito/src/context.ts:168
Parameters
- value: ParserProvider
Returns void

proto

get proto(): undefined | Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha
set proto(value: undefined | Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha): void

- Defined in packages/taquito/src/context.ts:160
Returns undefined | Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha
- Defined in packages/taquito/src/context.ts:156
Parameters
- value: undefined | Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha
Returns void

readProvider

get readProvider(): TzReadProvider
set readProvider(value: TzReadProvider): void

- Defined in packages/taquito/src/context.ts:188
Returns TzReadProvider
- Defined in packages/taquito/src/context.ts:192
Parameters
- value: TzReadProvider
Returns void

rpc

get rpc(): RpcClientInterface
set rpc(value: RpcClientInterface): void

- Defined in packages/taquito/src/context.ts:116
Returns RpcClientInterface
- Defined in packages/taquito/src/context.ts:120
Parameters
- value: RpcClientInterface
Returns void

signer

get signer(): Signer
set signer(value: Signer): void

- Defined in packages/taquito/src/context.ts:140
Returns Signer
- Defined in packages/taquito/src/context.ts:144
Parameters
- value: Signer
Returns void

stream

get stream(): SubscribeProvider
set stream(value: SubscribeProvider): void

- Defined in packages/taquito/src/context.ts:196
Returns SubscribeProvider
- Defined in packages/taquito/src/context.ts:200
Parameters
- value: SubscribeProvider
Returns void

walletProvider

get walletProvider(): WalletProvider
set walletProvider(value: WalletProvider): void

- Defined in packages/taquito/src/context.ts:148
Returns WalletProvider
- Defined in packages/taquito/src/context.ts:152
Parameters
- value: WalletProvider
Returns void

Methods

clone

clone(): Context

- Defined in packages/taquito/src/context.ts:220
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

Returns Context

isAnyProtocolActive

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

- Defined in packages/taquito/src/context.ts:204
Parameters
- protocol: string[] = []
Returns Promise<boolean>

isAnySignerConfigured

isAnySignerConfigured(): boolean

- Defined in packages/taquito/src/context.ts:213
Returns boolean

registerProviderDecorator

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

- Defined in packages/taquito/src/context.ts:240
description

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

Parameters
- fx: (context: Context) => Context
  - - (context: Context): Context
    - Parameters
      - context: Context
      Returns Context
Returns void

setPartialConfig

setPartialConfig(value: Partial<ConfigConfirmation>): void

- Defined in packages/taquito/src/context.ts:109
Parameters
- value: Partial<ConfigConfirmation>
Returns void

withExtensions

withExtensions(): Context

- Defined in packages/taquito/src/context.ts:249
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.

Returns Context

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_rpc: string | RpcClientInterface

_signer: Signer = ...

Optional _proto: Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha

_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

Properties

Readonly _config

Readonly batch

Readonly contract

Readonly estimate

Readonly operationFactory

Readonly prepare

Readonly tz

Readonly wallet

Accessors

config

Returns ConfigConfirmation

Parameters

value: ConfigConfirmation

Returns void

forger

Returns Forger

Parameters

value: Forger

Returns void

globalConstantsProvider

Returns GlobalConstantsProvider

Parameters

value: GlobalConstantsProvider

Returns void

injector

Returns Injector

Parameters

value: Injector

Returns void

packer

Returns Packer

Parameters

value: Packer

Returns void

parser

Returns ParserProvider

Parameters

value: ParserProvider

Returns void

proto

Returns undefined | Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha

Parameters

value: undefined | Pt24m4xi | PsBABY5H | PsBabyM1 | PsCARTHA | PsDELPH1 | PtEdo2Zk | PsFLorena | PtGRANADs | PtHangz2 | PsiThaCa | Psithaca2 | PtJakart2 | PtKathman | PtLimaPtL | PtMumbaii | PtMumbai2 | ProtoALpha

Returns void

readProvider

Returns TzReadProvider

Parameters

value: TzReadProvider

Returns void

rpc

Returns RpcClientInterface

Parameters

value: RpcClientInterface

Returns void

signer

Returns Signer

Parameters