Class TezosToolkit

constructor

• new TezosToolkit(_rpc: string | RpcClientInterface): TezosToolkit

  Parameters

  • _rpc: string | RpcClientInterface

  Returns TezosToolkit

Readonlyformat

contract

• get contract(): ContractProvider

  Provide access to smart contract utilities

  Returns ContractProvider

estimate

• get estimate(): EstimationProvider

  Provide access to operation estimation utilities

  Returns EstimationProvider

globalConstants

• get globalConstants(): GlobalConstantsProvider

  Provide access to the currently used globalConstantsProvider

  Returns GlobalConstantsProvider

operation

• get operation(): OperationFactory

  Returns OperationFactory

prepare

• get prepare(): PreparationProvider

  Provide access to tezos operation preparation utilities

  Returns PreparationProvider

rpc

• get rpc(): RpcClientInterface

  Provide access to the currently used rpc client

  Returns RpcClientInterface

signer

• get signer(): Signer

  Provide access to the currently used signer

  Returns Signer

stream

• get stream(): SubscribeProvider

  Provide access to streaming utilities backed by an streamer implementation

  Returns SubscribeProvider

tz

• get tz(): TzProvider

  Provide access to tezos account management

  Returns TzProvider

wallet

• get wallet(): Wallet

  Returns Wallet

addExtension

• addExtension(module: Extension | Extension[]): void

  Allow to add a module to the TezosToolkit instance. This method adds the appropriate Providers(s) required by the module to the internal context.

  Parameters

  • module: Extension | Extension[]

    extension to add to the TezosToolkit instance

  Returns void

  Example

  Tezos.addExtension(new Tzip16Module());
  Copy

getFactory

• getFactory<T, K extends any[]>(ctor: TaquitoProvider<T, K>): (...args: K) => T

  Type Parameters

  • T
  • K extends any[]

  Parameters

  • ctor: TaquitoProvider<T, K>

  Returns (...args: K) => T

getVersionInfo

• getVersionInfo(): VersionInfo

  Gets an object containing the version of Taquito library and git sha of the commit this library is compiled from

  Returns VersionInfo

prepareFor

• prepareFor(identity: DetachedIdentity): DetachedSigningWorkflow

  Create an identity-bound workflow for external operation signing.

  Parameters

  • identity: DetachedIdentity

  Returns DetachedSigningWorkflow

setFieldNumberingStrategy

• setFieldNumberingStrategy(strategy: FieldNumberingStrategy): void

  Sets the strategy used for field numbering in Token execute/encode/decode to convert Michelson values to/from javascript objects

  Parameters

  • strategy: FieldNumberingStrategy

    a value of type FieldNumberingStrategy that controls how field numbers are calculated

  Returns void

setForgerProvider

• setForgerProvider(forger?: Forger): void

  Sets forger provider on the Tezos Taquito instance The LocalForger from @taquito/local-forging is set by default.

  Parameters

  • Optionalforger: Forger

    forger to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setForgerProvider(this.getFactory(RpcForger)())
  Copy

setGlobalConstantsProvider

• setGlobalConstantsProvider(
      globalConstantsProvider?: GlobalConstantsProvider,
  ): void

  Sets global constants provider on the Tezos Taquito instance

  Parameters

  • OptionalglobalConstantsProvider: GlobalConstantsProvider

    globalConstantsProvider to use to interact with the Tezos network

  Returns void

  Example

  const globalConst = new DefaultGlobalConstantsProvider();
  globalConst.loadGlobalConstant({
   "expruu5BTdW7ajqJ9XPTF3kgcV78pRiaBW3Gq31mgp3WSYjjUBYxre": { prim: "int" },
   // ...
  })
  Tezos.setGlobalConstantsProvider(globalConst);
  Copy

setInjectorProvider

• setInjectorProvider(injectorProvider?: Injector): void

  Sets injector provider on the Tezos Taquito instance

  Parameters

  • OptionalinjectorProvider: Injector

    Injector to use to interact with the Tezos network by default RpcInjector

  Returns void

setPackerProvider

• setPackerProvider(packer?: Packer): void

  Sets Packer provider on the Tezos Taquito instance

  Parameters

  • Optionalpacker: Packer

    packer to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setPackerProvider(new MichelCodecPacker())
  Copy

setParserProvider

• setParserProvider(parserProvider?: ParserProvider): void

  Sets parser provider on the Tezos Taquito instance

  Parameters

  • OptionalparserProvider: ParserProvider

    parserProvider to use to interact with the Tezos network

  Returns void

setProvider

• setProvider(options: SetProviderOptions): void

  Sets configuration on the Tezos Taquito instance. Allows user to choose which signer, rpc client, rpc url, forger and so forth

  Parameters

  • options: SetProviderOptions

    rpc url or rpcClient to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setProvider({rpc: 'https://mainnet.tezos.ecadinfra.com/', signer: new InMemorySigner.fromSecretKey(“edsk...”)})
  Copy

  Example

  Tezos.setProvider({ config: { confirmationPollingTimeoutSecond: 300 }})
  Copy

setReadProvider

• setReadProvider(readProvider?: TzReadProvider): void

  Sets read provider on the Tezos Taquito instance By default reads use the current RPC through RpcReadAdapter. An explicit provider can read from an indexer. Calling this method without a provider restores default reads that follow subsequent RPC changes.

  Parameters

  • OptionalreadProvider: TzReadProvider

    TzReadProvider to use to interact with the Tezos network

  Returns void

setRpcProvider

• setRpcProvider(rpc?: string | RpcClientInterface): void

  Sets rpc provider on the Tezos Taquito instance. Updates the toolkit-created default read provider. Explicit read providers remain unchanged.

  Parameters

  • Optionalrpc: string | RpcClientInterface

    rpc url or rpcClient to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setRpcProvider('https://mainnet.tezos.ecadinfra.com/')
  Copy

setSignerProvider

• setSignerProvider(signer?: Signer): void

  Sets signer provider on the Tezos Taquito instance.

  Parameters

  • Optionalsigner: Signer

    signer to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setSignerProvider(new InMemorySigner.fromSecretKey('edsk...'))
  Copy

setStreamProvider

• setStreamProvider(stream?: string | SubscribeProvider): void

  Sets stream provider on the Tezos Taquito instance

  Parameters

  • Optionalstream: string | SubscribeProvider

    stream to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setStreamProvider(...)
  Copy

setWalletProvider

• setWalletProvider(wallet?: WalletProvider): void

  Sets wallet provider on the Tezos Taquito instance

  Parameters

  • Optionalwallet: WalletProvider

    wallet to use to interact with the Tezos network

  Returns void

  Example

  Tezos.setWalletProvider(...)
  Copy