@taquito/taquito

Index

References

Enumerations

Classes

Interfaces

Variables

Object literals

References

BigMapAbstraction

Re-exports BigMapAbstraction

CompositeForger

Re-exports CompositeForger

Config

Re-exports Config

Context

Re-exports Context

Contract

Re-exports Contract

Contract

Re-exports Contract

ContractAbstraction

Re-exports ContractAbstraction

ContractAbstraction

Re-exports ContractAbstraction

ContractMethod

Re-exports ContractMethod

ContractMethod

Re-exports ContractMethod

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

DelegationWalletOperation

Re-exports DelegationWalletOperation

DelegationWalletOperation

Re-exports DelegationWalletOperation

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

LegacyWalletProvider

Re-exports LegacyWalletProvider

LegacyWalletProvider

Re-exports LegacyWalletProvider

MANAGER_LAMBDA

Re-exports MANAGER_LAMBDA

MANAGER_LAMBDA

Re-exports MANAGER_LAMBDA

MichelsonMap

Re-exports MichelsonMap

MissedBlockDuringConfirmationError

Re-exports MissedBlockDuringConfirmationError

MissedBlockDuringConfirmationError

Re-exports MissedBlockDuringConfirmationError

OpFilter

Re-exports OpFilter

OpHashFilter

Re-exports OpHashFilter

OpKind

Re-exports OpKind

OpKind

Re-exports OpKind

OperationContent

Re-exports OperationContent

OperationStatus

Re-exports OperationStatus

OperationStatus

Re-exports OperationStatus

OriginationWalletOperation

Re-exports OriginationWalletOperation

OriginationWalletOperation

Re-exports OriginationWalletOperation

PKHOption

Re-exports PKHOption

PKHOption

Re-exports PKHOption

PollingSubscribeProvider

Re-exports PollingSubscribeProvider

Protocols

Re-exports Protocols

RpcForger

Re-exports RpcForger

Signer

Re-exports Signer

SourceFilter

Re-exports SourceFilter

StorageProvider

Re-exports StorageProvider

StorageProvider

Re-exports StorageProvider

SubscribeProvider

Re-exports SubscribeProvider

SubscribeProvider

Re-exports SubscribeProvider

Subscription

Re-exports Subscription

TaquitoProvider

Re-exports TaquitoProvider

TaquitoProvider

Re-exports TaquitoProvider

TezosOperationError

Re-exports TezosOperationError

TzProvider

Re-exports TzProvider

UnitValue

Re-exports UnitValue

Wallet

Re-exports Wallet

Wallet

Re-exports Wallet

WalletContract

Re-exports WalletContract

WalletContract

Re-exports WalletContract

WalletDefinedFields

Re-exports WalletDefinedFields

WalletDefinedFields

Re-exports WalletDefinedFields

WalletDelegateParams

Re-exports WalletDelegateParams

WalletDelegateParams

Re-exports WalletDelegateParams

WalletOperation

Re-exports WalletOperation

WalletOperation

Re-exports WalletOperation

WalletOperationBatch

Re-exports WalletOperationBatch

WalletOperationBatch

Re-exports WalletOperationBatch

WalletOriginateParams

Re-exports WalletOriginateParams

WalletOriginateParams

Re-exports WalletOriginateParams

WalletParamsWithKind

Re-exports WalletParamsWithKind

WalletParamsWithKind

Re-exports WalletParamsWithKind

WalletProvider

Re-exports WalletProvider

WalletProvider

Re-exports WalletProvider

WalletTransferParams

Re-exports WalletTransferParams

WalletTransferParams

Re-exports WalletTransferParams

createOriginationOperation

Re-exports createOriginationOperation

createOriginationOperation

Re-exports createOriginationOperation

createRegisterDelegateOperation

Re-exports createRegisterDelegateOperation

createRegisterDelegateOperation

Re-exports createRegisterDelegateOperation

createSetDelegateOperation

Re-exports createSetDelegateOperation

createSetDelegateOperation

Re-exports createSetDelegateOperation

createTransferOperation

Re-exports createTransferOperation

createTransferOperation

Re-exports createTransferOperation

defaultConfig

Re-exports defaultConfig

protocols

Re-exports protocols

Type aliases

BatchKinds

BatchKinds: ACTIVATION | ORIGINATION | TRANSACTION | DELEGATION

Contract

Contract: ContractAbstraction<ContractProvider>

ContractSchema

ContractSchema: Schema | unknown

ExpressionOrOpFilter

ExpressionOrOpFilter: OpFilter | FilterExpression

Filter

Filter: ExpressionOrOpFilter | ExpressionOrOpFilter[]

FilterExpression

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

Type declaration

Optional and?: ExpressionOrOpFilter[]
Optional or?: ExpressionOrOpFilter[]

ForgeResponse

ForgeResponse: string

InjectorParams

InjectorParams: string

MergedOperationResult

MergedOperationResult: OperationResultDelegation & OperationResultOrigination & OperationResultTransaction & OperationResultReveal & { fee?: undefined | string }

OpFilter

OpFilter: OpHashFilter | SourceFilter | KindFilter | DestinationFilter

OperationContent

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

OperationStatus

OperationStatus: "pending" | "unknown" | OperationResultStatusEnum

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

ParamsWithKind: withKind<OriginateParams, ORIGINATION> | withKind<DelegateParams, DELEGATION> | withKind<TransferParams, TRANSACTION> | withKind<ActivationParams, ACTIVATION>

PrepareOperationParams

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

Type declaration

operation: RPCOperation | RPCOperation[]
Optional source?: undefined | string

RPCOpWithFee

RPCOpWithFee: RPCTransferOperation | RPCOriginationOperation | RPCDelegateOperation | RPCRevealOperation

RPCOpWithSource

RPCOpWithSource: RPCTransferOperation | RPCOriginationOperation | RPCDelegateOperation | RPCRevealOperation

RPCOperation

RPCOperation: RPCOriginationOperation | RPCTransferOperation | RPCDelegateOperation | RPCRevealOperation | RPCActivateOperation

SourceKinds

SourceKinds: InternalOperationResultKindEnum

TxHash

TxHash: string

WalletContract

WalletContract: ContractAbstraction<Wallet>

WalletDefinedFields

WalletDefinedFields: "fee" | "gasLimit" | "storageLimit" | "source"

WalletDelegateParams

WalletDelegateParams: Omit<DelegateParams, WalletDefinedFields>

WalletOriginateParams

WalletOriginateParams: Omit<OriginateParams, WalletDefinedFields>

WalletParamsWithKind

WalletParamsWithKind: withKind<WalletTransferParams, TRANSACTION> | withKind<WalletOriginateParams, ORIGINATION> | withKind<WalletDelegateParams, DELEGATION>

WalletTransferParams

WalletTransferParams: Omit<TransferParams, WalletDefinedFields>

withKind

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

Type parameters

T
K: OpKind

Variables

Const BATCH_KINDS

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

Const Tezos

Tezos: TezosToolkit = new TezosToolkit()

description: Default Tezos toolkit instance

Functions

Const attachKind

attachKind<T, K>(op: T, kind: K): T & { kind: K }

- Defined in packages/taquito/src/operations/types.ts:18
Type parameters
- T
- K: OpKind
Parameters
- op: T
- kind: K
Returns T & { kind: K }

Const cacheUntil

cacheUntil<T>(cacheUntilObs: Observable<any>): MonoTypeOperatorFunction<T>

- Defined in packages/taquito/src/wallet/opreation-factory.ts:30
Type parameters
- T
Parameters
- cacheUntilObs: Observable<any>
Returns MonoTypeOperatorFunction<T>

Const createNewPollingBasedHeadObservable

createNewPollingBasedHeadObservable(pollingTimer: Observable<number>, sharedHeadOb: Observable<BlockResponse>, context: Context, scheduler?: SchedulerLike): Observable<BlockResponse>

- Defined in packages/taquito/src/wallet/opreation-factory.ts:48
Parameters
- pollingTimer: Observable<number>
- sharedHeadOb: Observable<BlockResponse>
- context: Context
- Optional scheduler: SchedulerLike
Returns Observable<BlockResponse>

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>

- Defined in packages/taquito/src/contract/prepare.ts:16
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>

- Defined in packages/taquito/src/contract/prepare.ts:131
Parameters
- __namedParameters: { fee: number; gasLimit: number; storageLimit: number }
  - fee: number
  - gasLimit: number
  - storageLimit: number
- source: string
Returns Promise<RPCDelegateOperation>

Const createSetDelegateOperation

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

- Defined in packages/taquito/src/contract/prepare.ts:113
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

createTransferOperation(__namedParameters: { amount: number; fee: number; gasLimit: number; mutez: boolean; parameter: undefined | TransactionOperationParameter; storageLimit: number; to: string }): Promise<RPCTransferOperation>

- Defined in packages/taquito/src/contract/prepare.ts:90
Parameters
- __namedParameters: { amount: number; fee: number; gasLimit: number; mutez: boolean; parameter: undefined | TransactionOperationParameter; storageLimit: number; to: string }
  - amount: number
  - fee: number
  - gasLimit: number
  - mutez: boolean
  - parameter: undefined | TransactionOperationParameter
  - storageLimit: number
  - to: string
Returns Promise<RPCTransferOperation>

Const evaluateExpression

evaluateExpression(op: OperationContent, exp: FilterExpression): boolean

- Defined in packages/taquito/src/subscribe/filters.ts:55
Parameters
- op: OperationContent
- exp: FilterExpression
Returns boolean

Const evaluateFilter

evaluateFilter(op: OperationContent, filter: Filter): boolean

- Defined in packages/taquito/src/subscribe/filters.ts:65
Parameters
- op: OperationContent
- filter: Filter
Returns boolean

Const evaluateOpFilter

evaluateOpFilter(op: OperationContent, filter: OpFilter): undefined | false | true

- Defined in packages/taquito/src/subscribe/filters.ts:41
Parameters
- op: OperationContent
- filter: OpFilter
Returns undefined | false | true

Const findWithKind

findWithKind<T, K>(arr: T[], kind: K): (T & { kind: K }) | undefined

- Defined in packages/taquito/src/operations/types.ts:22
Type parameters
- T: { kind: OpKind }
- K: OpKind
Parameters
- arr: T[]
- kind: K
Returns (T & { kind: K }) | undefined

Const flattenErrors

flattenErrors(response: PreapplyResponse | PreapplyResponse[], status?: string): TezosGenericOperationError[]

- Defined in packages/taquito/src/operations/operation-errors.ts:90
description

Flatten all error from preapply response (including internal error)

Parameters
- response: PreapplyResponse | PreapplyResponse[]
- Default value status: string = "failed"
Returns TezosGenericOperationError[]

Const flattenOperationResult

flattenOperationResult(response: PreapplyResponse | PreapplyResponse[]): (OperationResultDelegation & OperationResultOrigination & OperationResultTransaction & OperationResultReveal & { fee?: undefined | string })[]

- Defined in packages/taquito/src/operations/operation-errors.ts:64
Parameters
- response: PreapplyResponse | PreapplyResponse[]
Returns (OperationResultDelegation & OperationResultOrigination & OperationResultTransaction & OperationResultReveal & { fee?: undefined | string })[]

format

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

- Defined in packages/taquito/src/format.ts:20
Parameters
- Default value from: Format = "mutez"
- Default value to: Format = "mutez"
- amount: number | string | BigNumber
Returns string | number | BigNumber

Const hasMetadata

hasMetadata<T, K>(op: T): op is T & { metadata: K }

- Defined in packages/taquito/src/operations/types.ts:71
Type parameters
- T: { kind: OpKind }
- K
Parameters
- op: T
Returns op is T & { metadata: K }

Const hasMetadataWithInternalOperationResult

hasMetadataWithInternalOperationResult<T, K>(op: T): op is T & { metadata: { internal_operation_results?: K } }

- Defined in packages/taquito/src/operations/types.ts:89
Type parameters
- T: { kind: OpKind }
- K
Parameters
- op: T
Returns op is T & { metadata: { internal_operation_results?: K } }

Const hasMetadataWithResult

hasMetadataWithResult<T, K>(op: T): op is T & { metadata: { operation_result: K } }

- Defined in packages/taquito/src/operations/types.ts:79
Type parameters
- T: { kind: OpKind }
- K
Parameters
- op: T
Returns op is T & { metadata: { operation_result: K } }

Const isKind

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

- Defined in packages/taquito/src/operations/types.ts:35
Type parameters
- T: { kind: OpKind }
- K: OpKind
Parameters
- op: T
- kind: K
Returns op is withKind<T, K>

Const isOpRequireReveal

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

- Defined in packages/taquito/src/operations/types.ts:59
Type parameters
- T: { kind: OpKind }
Parameters
- op: T
Returns op is withKind<T, Exclude<InternalOperationResultKindEnum, REVEAL>>

Const isOpWithFee

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

- Defined in packages/taquito/src/operations/types.ts:53
Type parameters
- T: { kind: OpKind }
Parameters
- op: T
Returns op is withKind<T, InternalOperationResultKindEnum>

Const isSourceOp

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

- Defined in packages/taquito/src/operations/types.ts:67
Type parameters
- T: { kind: OpKind }
Parameters
- op: T
Returns op is withKind<T, SourceKinds>

Const receiptFromOperation

receiptFromOperation(op: OperationContentsAndResult[], __namedParameters?: { ALLOCATION_BURN: number; ORIGINATION_BURN: number }): Receipt

- Defined in packages/taquito/src/wallet/receipt.ts:15
Parameters
- op: OperationContentsAndResult[]
- Default value __namedParameters: { ALLOCATION_BURN: number; ORIGINATION_BURN: number } = {ALLOCATION_BURN: 257,ORIGINATION_BURN: 257,}
  - ALLOCATION_BURN: number
  - ORIGINATION_BURN: number
Returns Receipt

Const smartContractAbstractionSemantic

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

- Defined in packages/taquito/src/contract/semantic.ts:8
Parameters
- provider: ContractProvider
Returns { big_map: any }
- big_map: function
  - big_map(val: MichelsonV1Expression, code: MichelsonV1Expression): {}
  - - Defined in packages/taquito/src/contract/semantic.ts:12
    Parameters
    - val: MichelsonV1Expression
    - code: MichelsonV1Expression
    Returns {}

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]

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

References

BigMapAbstraction

CompositeForger

Config

Context

Contract

Contract

ContractAbstraction

ContractAbstraction

ContractMethod

ContractMethod

ContractProvider

ContractProvider

ContractSchema

ContractSchema

DEFAULT_FEE

DEFAULT_GAS_LIMIT

DEFAULT_STORAGE_LIMIT

DelegationWalletOperation

DelegationWalletOperation

DestinationFilter

EstimationProvider

EstimationProvider

ExpressionOrOpFilter

Filter

FilterExpression

ForgeParams

ForgeResponse

Forger

InvalidDelegationSource

InvalidDelegationSource

InvalidParameterError

InvalidParameterError

KindFilter

LegacyWalletProvider

LegacyWalletProvider

MANAGER_LAMBDA

MANAGER_LAMBDA

MichelsonMap

MissedBlockDuringConfirmationError

MissedBlockDuringConfirmationError

OpFilter

OpHashFilter

OpKind

OpKind

OperationContent

OperationStatus

OperationStatus

OriginationWalletOperation

OriginationWalletOperation

PKHOption

PKHOption

PollingSubscribeProvider

Protocols

RpcForger

Signer

SourceFilter

StorageProvider

StorageProvider

SubscribeProvider

SubscribeProvider

Subscription

TaquitoProvider

TaquitoProvider

TezosOperationError

TezosOperationErrorWithMessage

TezosPreapplyFailureError

TransactionWalletOperation

TransactionWalletOperation

TzProvider

UnitValue