TezosToolkit | Taquito

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
format

Accessors

Methods

Constructors

constructor

new TezosToolkit(_rpc: string | RpcClientInterface): TezosToolkit

- Defined in taquito/src/taquito.ts:91
Parameters
- _rpc: string | RpcClientInterface
Returns TezosToolkit

Properties

batch

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

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

Type declaration

- (params?: ParamsWithKind[]): OperationBatch
- description
  
  Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
  
  Parameters
  - Optional params: ParamsWithKind[]
    
    List of operation to batch together
  Returns OperationBatch

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

get contract(): ContractProvider

- Defined in taquito/src/taquito.ts:281
description

Provide access to smart contract utilities

Returns ContractProvider

estimate

get estimate(): EstimationProvider

- Defined in taquito/src/taquito.ts:296
description

Provide access to operation estimation utilities

Returns EstimationProvider

globalConstants

get globalConstants(): GlobalConstantsProvider

- Defined in taquito/src/taquito.ts:324
description

Provide access to the currently used globalConstantsProvider

Returns GlobalConstantsProvider

operation

get operation(): OperationFactory

- Defined in taquito/src/taquito.ts:289
Returns OperationFactory

rpc

get rpc(): RpcClientInterface

- Defined in taquito/src/taquito.ts:310
description

Provide access to the currently used rpc client

Returns RpcClientInterface

signer

get signer(): Signer

- Defined in taquito/src/taquito.ts:317
description

Provide access to the currently used signer

Returns Signer

stream

get stream(): SubscribeProvider

- Defined in taquito/src/taquito.ts:303
description

Provide access to streaming utilities backed by an streamer implementation

Returns SubscribeProvider

tz

get tz(): TzProvider

- Defined in taquito/src/taquito.ts:274
description

Provide access to tezos account management

Returns TzProvider

wallet

get wallet(): Wallet

- Defined in taquito/src/taquito.ts:285
Returns Wallet

Methods

addExtension

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

- Defined in taquito/src/taquito.ts:335
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
- module: Extension | Extension[]
  
  extension to add to the TezosToolkit instance
Returns void

getFactory

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

- Defined in taquito/src/taquito.ts:343
Type parameters
- T
- K: any[]
Parameters
- ctor: TaquitoProvider<T, K>
Returns (...args: K) => T
- - (...args: K): T
  - Parameters
    - Rest ...args: K
    Returns T

getVersionInfo

getVersionInfo(): VersionInfo

- Defined in taquito/src/taquito.ts:352
description

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

Returns VersionInfo

setForgerProvider

setForgerProvider(forger?: Forger): void

- Defined in taquito/src/taquito.ts:186
description

Sets forger provider on the Tezos Taquito instance

example

Tezos.setForgerProvider(localForger)

Parameters
- Optional forger: Forger
Returns void

setGlobalConstantsProvider

setGlobalConstantsProvider(globalConstantsProvider?: GlobalConstantsProvider): void

description

Sets global constants provider on the Tezos Taquito instance

example

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

Parameters

Optional globalConstantsProvider: GlobalConstantsProvider

Returns void

setPackerProvider

setPackerProvider(packer?: Packer): void

- Defined in taquito/src/taquito.ts:238
description

Sets Packer provider on the Tezos Taquito instance

example

Tezos.setPackerProvider(new MichelCodecPacker())

Parameters
- Optional packer: Packer
Returns void

setProvider

setProvider(__namedParameters: SetProviderOptions): void

- Defined in taquito/src/taquito.ts:115
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
- __namedParameters: SetProviderOptions
Returns void

setRpcProvider

setRpcProvider(rpc?: string | RpcClientInterface): void

- Defined in taquito/src/taquito.ts:166
description

Sets rpc provider on the Tezos Taquito instance

example

Tezos.setRpcProvider('https://mainnet.api.tez.ie/')

Parameters
- Optional rpc: string | RpcClientInterface
Returns void

setSignerProvider

setSignerProvider(signer?: Signer): void

- Defined in taquito/src/taquito.ts:148
description

Sets signer provider on the Tezos Taquito instance.

example

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

Parameters
- Optional signer: Signer
Returns void

setStreamProvider

setStreamProvider(stream?: string | SubscribeProvider): void

- Defined in taquito/src/taquito.ts:200
description

Sets stream provider on the Tezos Taquito instance

example

Tezos.setStreamProvider(...)

Parameters
- Optional stream: string | SubscribeProvider
Returns void

setWalletProvider

setWalletProvider(wallet?: WalletProvider): void

- Defined in taquito/src/taquito.ts:219
description

Sets wallet provider on the Tezos Taquito instance

example

Tezos.setWalletProvider(...)

Parameters
- Optional wallet: WalletProvider
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_rpc: string | RpcClientInterface

Returns TezosToolkit

Properties

batch

Type declaration

Parameters

Optional params: ParamsWithKind[]

Returns OperationBatch

Readonly format

Type declaration

Parameters

from: Format = 'mutez'

to: Format = 'mutez'

amount: number | string | BigNumber

Returns string | number | BigNumber

Accessors

contract

Returns ContractProvider

estimate

Returns EstimationProvider

globalConstants

Returns GlobalConstantsProvider

operation

Returns OperationFactory

rpc

Returns RpcClientInterface

signer

Returns Signer

stream

Returns SubscribeProvider

tz

Returns TzProvider

wallet

Returns Wallet

Methods

addExtension

Parameters

module: Extension | Extension[]

Returns void

getFactory

Type parameters

T

K: any[]

Parameters

ctor: TaquitoProvider<T, K>

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

Parameters

Rest ...args: K

Returns T

getVersionInfo

Returns VersionInfo

setForgerProvider

Parameters

Optional forger: Forger

Returns void

setGlobalConstantsProvider

Parameters

Optional globalConstantsProvider: GlobalConstantsProvider

Returns void

setPackerProvider

Parameters

Optional packer: Packer

Returns void

setProvider

Parameters

__namedParameters: SetProviderOptions

Returns void

setRpcProvider

Parameters

Optional rpc: string | RpcClientInterface

Returns void