Options
All
  • Public
  • Public/Protected
  • All
Menu
description

Facade class that surfaces all of the libraries capability and allow it's configuration

param

The RPC server to use

Hierarchy

  • TezosToolkit

Index

Constructors

constructor

Properties

batch

batch: (params?: ParamsWithKind[]) => OperationBatch
deprecated

TezosToolkit.batch has been deprecated in favor of TezosToolkit.contract.batch

Type declaration

Readonly format

format: (from?: Format, to?: Format, amount: number | string | BigNumber) => string | number | BigNumber = ...

Type declaration

    • (from?: Format, to?: Format, amount: number | string | BigNumber): string | number | BigNumber
    • Parameters

      • from: Format = 'mutez'
      • to: Format = 'mutez'
      • amount: number | string | BigNumber

      Returns string | number | BigNumber

Accessors

contract

estimate

globalConstants

operation

  • get operation(): OperationFactory

rpc

signer

stream

tz

wallet

Methods

addExtension

  • 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());

    Parameters

    Returns void

getFactory

getVersionInfo

setForgerProvider

  • setForgerProvider(forger?: Forger): void
  • description

    Sets forger provider on the Tezos Taquito instance

    example

    Tezos.setForgerProvider(localForger)

    Parameters

    Returns void

setGlobalConstantsProvider

  • description

    Sets global constants provider on the Tezos Taquito instance

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

    Parameters

    Returns void

setPackerProvider

  • setPackerProvider(packer?: Packer): void
  • description

    Sets Packer provider on the Tezos Taquito instance

    example

    Tezos.setPackerProvider(new MichelCodecPacker())

    Parameters

    Returns void

setProvider

  • 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.api.tez.ie/', signer: new InMemorySigner.fromSecretKey(“edsk...”)})

    example

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

    Parameters

    Returns void

setRpcProvider

setSignerProvider

  • setSignerProvider(signer?: Signer): void
  • description

    Sets signer provider on the Tezos Taquito instance.

    example

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

    Parameters

    Returns void

setStreamProvider

setWalletProvider

Generated using TypeDoc