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.

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

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ContractSchema

ContractSchema: Schema | unknown

ExpressionOrOpFilter

ExpressionOrOpFilter: OpFilter | FilterExpression

Filter

Filter: ExpressionOrOpFilter | ExpressionOrOpFilter[]

FilterExpression

FilterExpression: object

Type declaration

ForgeResponse

ForgeResponse: string

Format

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

InjectorParams

InjectorParams: string

OpFilter

OpFilter: OpHashFilter | SourceFilter | KindFilter | DestinationFilter

OperationContent

OperationContent: OperationContentsEndorsement | OperationContentsRevelation | OperationContentsDoubleEndorsement | OperationContentsDoubleBaking | OperationContentsActivateAccount | OperationContentsProposals | OperationContentsBallot | OperationContentsReveal | OperationContentsTransaction | OperationContentsOrigination | OperationContentsDelegation | OperationContentsAndResultEndorsement | OperationContentsAndResultRevelation | OperationContentsAndResultDoubleEndorsement | OperationContentsAndResultDoubleBaking | OperationContentsAndResultActivateAccount | OperationContentsAndResultProposals | OperationContentsAndResultBallot | OperationContentsAndResultReveal | OperationContentsAndResultTransaction | OperationContentsAndResultOrigination | OperationContentsAndResultDelegation & object

OriginateParams

OriginateParams: OriginateParamsBase & object | object
description

Parameters for originate method

OriginateParamsBase

OriginateParamsBase: object

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

PrepareOperationParams

PrepareOperationParams: object

Type declaration

RPCOperation

RPCOperation: RPCOriginationOperation | RPCTransferOperation | RPCDelegateOperation | RPCRevealOperation | RPCActivateOperation

TxHash

TxHash: string

Variables

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

  • Parameters

    • __namedParameters: object
      • 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: object, source: string): Promise<RPCDelegateOperation>

Const createSetDelegateOperation

Const createTransferOperation

  • Parameters

    • __namedParameters: object
      • amount: number
      • fee: number
      • gasLimit: number
      • mutez: boolean
      • parameter: undefined | string | object | object
      • rawParam: boolean
      • storageLimit: number
      • to: string

    Returns Promise<RPCTransferOperation>

Const destinationFilter

Const evaluateExpression

Const evaluateFilter

Const evaluateOpFilter

Const flattenErrors

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): boolean

Const kindFilter

Const opHashFilter

Const removeDelegate

  • removeDelegate(): (object | object)[]

Const setDelegate

  • setDelegate(key: string): (object | object)[]

Const smartContractAbstractionSemantic

Const sourceFilter

Const transferImplicit

  • transferImplicit(key: string, mutez: number): (object | object | object)[]

Const transferToContract

  • transferToContract(key: string, amount: number): (object | object | object[] | object)[]

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