Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @taquito/taquito

pkgsign status

Taquito high level functions

The @taquito/taquito package contains higher level functionality that builds upon the other packages in the Tezos Typescript Library Suite.

CDN Bundle

<script src="https://unpkg.com/@taquito/taquito@6.2.0-beta.1/dist/taquito.min.js"
crossorigin="anonymous" integrity="sha384-adbmPgTfZLGnpSCr/1zGj28GdRBw65sbljzNxsJalcz49nvc9t7lp4QP/Sex4zRB"></script>

API Documentation

TypeDoc style documentation is available on-line here

See the top-level https://github.com/ecadlabs/taquito file for details on reporting issues, contributing and versioning.

Disclaimer

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

References

BigMapAbstraction

Re-exports BigMapAbstraction

CompositeForger

Re-exports CompositeForger

ContractProvider

Re-exports ContractProvider

ContractProvider

Re-exports ContractProvider

ContractSchema

Re-exports ContractSchema

ContractSchema

Re-exports ContractSchema

DEFAULT_FEE

Re-exports DEFAULT_FEE

DEFAULT_GAS_LIMIT

Re-exports DEFAULT_GAS_LIMIT

DEFAULT_STORAGE_LIMIT

Re-exports DEFAULT_STORAGE_LIMIT

DestinationFilter

Re-exports DestinationFilter

EstimationProvider

Re-exports EstimationProvider

EstimationProvider

Re-exports EstimationProvider

ExpressionOrOpFilter

Re-exports ExpressionOrOpFilter

Filter

Re-exports Filter

FilterExpression

Re-exports FilterExpression

ForgeParams

Re-exports ForgeParams

ForgeResponse

Re-exports ForgeResponse

Forger

Re-exports Forger

InvalidDelegationSource

Re-exports InvalidDelegationSource

InvalidDelegationSource

Re-exports InvalidDelegationSource

InvalidParameterError

Re-exports InvalidParameterError

InvalidParameterError

Re-exports InvalidParameterError

KindFilter

Re-exports KindFilter

MANAGER_LAMBDA

Re-exports MANAGER_LAMBDA

MANAGER_LAMBDA

Re-exports MANAGER_LAMBDA

MapTypecheckError

Re-exports MapTypecheckError

MichelsonMap

Re-exports MichelsonMap

MichelsonMapKey

Re-exports MichelsonMapKey

OpFilter

Re-exports OpFilter

OpHashFilter

Re-exports OpHashFilter

OpKind

Re-exports OpKind

OpKind

Re-exports OpKind

OperationContent

Re-exports OperationContent

PollingSubscribeProvider

Re-exports PollingSubscribeProvider

Protocols

Re-exports Protocols

RpcForger

Re-exports RpcForger

Signer

Re-exports Signer

SourceFilter

Re-exports SourceFilter

SubscribeProvider

Re-exports SubscribeProvider

SubscribeProvider

Re-exports SubscribeProvider

Subscription

Re-exports Subscription

TaquitoProvider

Re-exports TaquitoProvider

TezosOperationError

Re-exports TezosOperationError

TezosOperationErrorWithMessage

Re-exports TezosOperationErrorWithMessage

TezosPreapplyFailureError

Re-exports TezosPreapplyFailureError

TzProvider

Re-exports TzProvider

UnitValue

Re-exports UnitValue

protocols

Re-exports protocols

Type aliases

BatchKinds

ContractSchema

ContractSchema: Schema | unknown

ExplicitTransferParams

ExplicitTransferParams: Required<Omit<TransferParams, keyof SendParams>> & SendParams

ExpressionOrOpFilter

ExpressionOrOpFilter: OpFilter | FilterExpression

Filter

FilterExpression

FilterExpression: { and?: ExpressionOrOpFilter[]; or?: ExpressionOrOpFilter[] }

Type declaration

ForgeResponse

ForgeResponse: string

Format

Format: "tz" | "mtz" | "mutez"

InjectorParams

InjectorParams: string

OpFilter

OperationContent

OperationContent: OperationEntry["contents"][0] & { hash: string }

OriginateParams

OriginateParams: OriginateParamsBase & { init?: undefined; storage: any } | { init: string | object; storage?: undefined }
description

Parameters for originate method

OriginateParamsBase

OriginateParamsBase: { balance?: undefined | string; code: string | object[]; delegate?: undefined | string; fee?: undefined | number; gasLimit?: undefined | number; storageLimit?: undefined | number }

Type declaration

  • Optional balance?: undefined | string
  • code: string | object[]
  • Optional delegate?: undefined | string
  • Optional fee?: undefined | number
  • Optional gasLimit?: undefined | number
  • Optional storageLimit?: undefined | number

ParamsWithKind

PrepareOperationParams

PrepareOperationParams: { operation: RPCOperation | RPCOperation[]; source?: undefined | string }

Type declaration

RPCOpWithFee

RPCOpWithSource

RPCOperation

SourceKinds

TxHash

TxHash: string

withKind

withKind<T, K>: T & { kind: K }

Type parameters

Variables

Const BATCH_KINDS

BATCH_KINDS: OpKind[] = [OpKind.ACTIVATION,OpKind.ORIGINATION,OpKind.TRANSACTION,OpKind.DELEGATION,]

Const DEFAULT_SMART_CONTRACT_METHOD_NAME

DEFAULT_SMART_CONTRACT_METHOD_NAME: "main" = "main"

Const GAS_BUFFER

GAS_BUFFER: 100 = 100

Const MINIMAL_FEE_MUTEZ

MINIMAL_FEE_MUTEZ: 100 = 100

Const MINIMAL_FEE_PER_BYTE_MUTEZ

MINIMAL_FEE_PER_BYTE_MUTEZ: 1 = 1

Const MINIMAL_FEE_PER_GAS_MUTEZ

MINIMAL_FEE_PER_GAS_MUTEZ: 0.1 = 0.1

Const MINIMAL_FEE_PER_STORAGE_BYTE_MUTEZ

MINIMAL_FEE_PER_STORAGE_BYTE_MUTEZ: 1000 = 1000

Const MTZ_DECIMALS

MTZ_DECIMALS: 3 = 3

Const SIGNATURE_STUB

SIGNATURE_STUB: "edsigtkpiSSschcaCt9pUVrpNPf7TTcgvgDEDD6NCEHMy8NNQJCGnMfLZzYoQj74yLjo9wx6MPVV29CvVzgi7qEcEUok3k7AuMg" = "edsigtkpiSSschcaCt9pUVrpNPf7TTcgvgDEDD6NCEHMy8NNQJCGnMfLZzYoQj74yLjo9wx6MPVV29CvVzgi7qEcEUok3k7AuMg"

Const TZ_DECIMALS

TZ_DECIMALS: 6 = 6

Const Tezos

Tezos: TezosToolkit = new TezosToolkit()
description

Default Tezos toolkit instance

Functions

Const applyFilter

Const createOriginationOperation

  • createOriginationOperation(__namedParameters: { balance: string; code: string | object[]; delegate: undefined | string; fee: number; gasLimit: number; init: undefined | string | object; storage: any; storageLimit: number }): Promise<RPCOriginationOperation>
  • Parameters

    • __namedParameters: { balance: string; code: string | object[]; delegate: undefined | string; fee: number; gasLimit: number; init: undefined | string | object; storage: any; storageLimit: number }
      • balance: string
      • code: string | object[]
      • delegate: undefined | string
      • fee: number
      • gasLimit: number
      • init: undefined | string | object
      • storage: any
      • storageLimit: number

    Returns Promise<RPCOriginationOperation>

Const createRegisterDelegateOperation

  • createRegisterDelegateOperation(__namedParameters: { fee: number; gasLimit: number; storageLimit: number }, source: string): Promise<RPCDelegateOperation>

Const createSetDelegateOperation

  • createSetDelegateOperation(__namedParameters: { delegate: string; fee: number; gasLimit: number; source: string; storageLimit: number }): Promise<RPCDelegateOperation>
  • Parameters

    • __namedParameters: { delegate: string; fee: number; gasLimit: number; source: string; storageLimit: number }
      • delegate: string
      • fee: number
      • gasLimit: number
      • source: string
      • storageLimit: number

    Returns Promise<RPCDelegateOperation>

Const createTransferOperation

Const destinationFilter

Const evaluateExpression

Const evaluateFilter

Const evaluateOpFilter

Const flattenErrors

Const flattenOperationResult

format

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

    • Default value from: Format = "mutez"
    • Default value to: Format = "mutez"
    • amount: number | string | BigNumber

    Returns string | number | BigNumber

getDecimal

  • getDecimal(format: Format): 6 | 3 | 0

Const getLastBlock

Const isErrorWithMessage

  • isErrorWithMessage(error: any): error is TezosOperationErrorWithMessage

Const isKind

  • isKind<T, K>(op: T, kind: K): op is withKind<T, K>

Const isOpRequireReveal

  • isOpRequireReveal<T>(op: T): op is withKind<T, Exclude<InternalOperationResultKindEnum, REVEAL>>

Const isOpWithFee

  • isOpWithFee<T>(op: T): op is withKind<T, InternalOperationResultKindEnum>

Const isSourceOp

  • isSourceOp<T>(op: T): op is withKind<T, SourceKinds>

Const kindFilter

Const mergeLimits

  • mergeLimits(userDefinedLimit: Limits, defaultLimits: Required<Limits>): Required<Limits>

Const opHashFilter

Const removeDelegate

  • removeDelegate(): ({ prim: string } | { args: { prim: string }[]; prim: string })[]

Const setDelegate

  • setDelegate(key: string): ({ prim: string } | { args: ({ prim: string } | { string: string })[]; prim: string })[]

Const smartContractAbstractionSemantic

  • smartContractAbstractionSemantic(provider: ContractProvider): { big_map: any }

Const sourceFilter

Const transferImplicit

  • transferImplicit(key: string, mutez: number): ({ prim: string } | { args: ({ prim: string } | { string: string })[]; prim: string } | { args: ({ prim: string } | { int: string })[]; prim: string })[]
  • Parameters

    • key: string
    • mutez: number

    Returns ({ prim: string } | { args: ({ prim: string } | { string: string })[]; prim: string } | { args: ({ prim: string } | { int: string })[]; prim: string })[]

Const transferToContract

  • transferToContract(key: string, amount: number): ({ prim: string } | { args: ({ prim: string } | { string: string })[]; prim: string } | { args: { prim: string }[][][]; prim: string }[] | { args: ({ prim: string } | { int: string })[]; prim: string })[]
  • Parameters

    • key: string
    • amount: number

    Returns ({ prim: string } | { args: ({ prim: string } | { string: string })[]; prim: string } | { args: { prim: string }[][][]; prim: string }[] | { args: ({ prim: string } | { int: string })[]; prim: string })[]

Const validateArgs

Object literals

Const MANAGER_LAMBDA

MANAGER_LAMBDA: object

removeDelegate

removeDelegate: removeDelegate

setDelegate

setDelegate: setDelegate

transferImplicit

transferImplicit: transferImplicit

transferToContract

transferToContract: transferToContract

Const defaultConfig

defaultConfig: object

confirmationPollingIntervalSecond

confirmationPollingIntervalSecond: number = 10

confirmationPollingTimeoutSecond

confirmationPollingTimeoutSecond: number = 180

defaultConfirmationCount

defaultConfirmationCount: number = 1

Const protocols

protocols: object

004

004: Protocols[] = [Protocols.Pt24m4xi]

005

005: Protocols[] = [Protocols.PsBABY5H, Protocols.PsBabyM1]

006

006: Protocols[] = [Protocols.PsCARTHA]

Generated using TypeDoc