Class TezosToolkit

constructor

• new TezosToolkit(_rpc): TezosToolkit

• Parameters

  • _rpc: string | RpcClientInterface

  Returns TezosToolkit

batch

Readonly format

contract

• get contract(): ContractProvider

• Returns ContractProvider

  Description

  Provide access to smart contract utilities

estimate

• get estimate(): EstimationProvider

• Returns EstimationProvider

  Description

  Provide access to operation estimation utilities

globalConstants

• get globalConstants(): GlobalConstantsProvider

• Returns GlobalConstantsProvider

  Description

  Provide access to the currently used globalConstantsProvider

operation

• get operation(): OperationFactory

• Returns OperationFactory

prepare

• get prepare(): PreparationProvider

• Returns PreparationProvider

  Description

  Provide access to tezos operation preparation utilities

rpc

• get rpc(): RpcClientInterface

• Returns RpcClientInterface

  Description

  Provide access to the currently used rpc client

signer

• get signer(): Signer

• Returns Signer

  Description

  Provide access to the currently used signer

stream

• get stream(): SubscribeProvider

• Returns SubscribeProvider

  Description

  Provide access to streaming utilities backed by an streamer implementation

tz

• get tz(): TzProvider

• Returns TzProvider

  Description

  Provide access to tezos account management

wallet

• get wallet(): Wallet

• Returns Wallet

addExtension

• addExtension(module): void

• Parameters

  • module: Extension | Extension[]

    extension to add to the TezosToolkit instance

  Returns void

  Description

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

  Example

  Tezos.addExtension(new Tzip16Module());
  Copy

getFactory

• getFactory<T, K>(ctor): ((...args) => T)

• Type Parameters

  • T
  • K extends any[]

  Parameters

  • ctor: TaquitoProvider<T, K>

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

  • • (...args): T

    • Parameters

      • Rest ...args: K

      Returns T

getVersionInfo

• getVersionInfo(): VersionInfo

• Returns VersionInfo

  Description

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

setFieldNumberingStrategy

• setFieldNumberingStrategy(strategy): void

• Parameters

  • strategy: FieldNumberingStrategy

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

  Returns void

  Description

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

setForgerProvider

• setForgerProvider(forger?): void

• Parameters

  • Optional forger: Forger

  Returns void

  Description

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

  Example

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

setGlobalConstantsProvider

• setGlobalConstantsProvider(globalConstantsProvider?): void

• Parameters

  • Optional globalConstantsProvider: GlobalConstantsProvider

  Returns void

  Description

  Sets global constants provider on the Tezos Taquito instance

  Example

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

setInjectorProvider

• setInjectorProvider(injectorProvider?): void

• Parameters

  • Optional injectorProvider: Injector

  Returns void

  Description

  Sets injector provider on the Tezos Taquito instance

setPackerProvider

• setPackerProvider(packer?): void

• Parameters

  • Optional packer: Packer

  Returns void

  Description

  Sets Packer provider on the Tezos Taquito instance

  Example

  Tezos.setPackerProvider(new MichelCodecPacker())
  Copy

setParserProvider

• setParserProvider(parserProvider?): void

• Parameters

  • Optional parserProvider: ParserProvider

  Returns void

  Description

  Sets parser provider on the Tezos Taquito instance

setProvider

• setProvider(options): void

• Parameters

  • options: SetProviderOptions

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

  Returns void

  Description

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

  Example

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

  Example

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

setReadProvider

• setReadProvider(readProvider?): void

• Parameters

  • Optional readProvider: TzReadProvider

  Returns void

  Description

  Sets read provider on the Tezos Taquito instance By default reads are done from the RPC usign the RpcReadAdapter class, this can be overridden to read from an indexer that implements the TzReadProvider interface

setRpcProvider

• setRpcProvider(rpc?): void

• Parameters

  • Optional rpc: string | RpcClientInterface

  Returns void

  Description

  Sets rpc provider on the Tezos Taquito instance

  Example

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

setSignerProvider

• setSignerProvider(signer?): void

• Parameters

  • Optional signer: Signer

  Returns void

  Description

  Sets signer provider on the Tezos Taquito instance.

  Example

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

setStreamProvider

• setStreamProvider(stream?): void

• Parameters

  • Optional stream: string | SubscribeProvider

  Returns void

  Description

  Sets stream provider on the Tezos Taquito instance

  Example

  Tezos.setStreamProvider(...)
  Copy

setWalletProvider

• setWalletProvider(wallet?): void

• Parameters

  • Optional wallet: WalletProvider

  Returns void

  Description

  Sets wallet provider on the Tezos Taquito instance

  Example

  Tezos.setWalletProvider(...)
  Copy