Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @taquito/rpc

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AllTicketBalances

AllTicketBalances: TicketBalance[]

BakingRightsArgumentsCycle

BakingRightsArgumentsCycle: number | number[]

BakingRightsArgumentsDelegate

BakingRightsArgumentsDelegate: string | string[]

BakingRightsArgumentsLevel

BakingRightsArgumentsLevel: number | number[]

BakingRightsQueryArguments

BakingRightsQueryArguments: BakingRightsQueryArgumentsBase

BakingRightsResponse

BakingRightsResponse: BakingRightsResponseItem[]

BalanceResponse

BalanceResponse: BigNumber

BalanceUpdateCategoryEnum

BalanceUpdateCategoryEnum: MetadataBalanceUpdatesCategoryEnum

BalanceUpdateKindEnum

BalanceUpdateKindEnum: MetadataBalanceUpdatesKindEnum

BallotListResponse

BallotListResponse: BallotListResponseItem[]

BallotListResponseEnum

BallotListResponseEnum: "nay" | "yay" | "pass"

BallotVote

BallotVote: "nay" | "yay" | "pass"

BatchOperationResult

BatchOperationResult: OperationResultTransaction | OperationResultReveal | OperationResultDelegation | OperationResultOrigination | OperationResultIncreasePaidStorage | OperationResultRegisterGlobalConstant | OperationResultTransferTicket | OperationResultSmartRollupAddMessages | OperationResultSmartRollupOriginate | OperationResultUpdateConsensusKey

BigMapGetResponse

BigMapGetResponse: MichelsonV1Expression

BigMapKey

BigMapKey: { key: {}; type: { args?: object[]; prim: string } }

Type declaration

  • key: {}
    • [key: string]: string | object[]
  • type: { args?: object[]; prim: string }
    • Optional args?: object[]
    • prim: string

BigMapResponse

BigMapResponse: MichelsonV1Expression | MichelsonV1Expression[]

BondId

BondId: { smart_rollup?: never; tx_rollup: string } | { smart_rollup: string; tx_rollup?: never }

CommitmentsAndCiphertexts

CommitmentsAndCiphertexts: [SaplingTransactionCommitment, SaplingTransactionCiphertext]

ConstantsResponse

ConstantsResponse: ConstantsResponseCommon & ConstantsResponseProto017 & ConstantsResponseProto016 & ConstantsResponseProto015 & ConstantsResponseProto014 & ConstantsResponseProto013 & ConstantsResponseProto012 & ConstantsResponseProto011 & ConstantsResponseProto010 & ConstantsResponseProto009 & ConstantsResponseProto008 & ConstantsResponseProto007 & ConstantsResponseProto006 & ConstantsResponseProto005 & ConstantsResponseProto004 & ConstantsResponseProto003 & ConstantsResponseProto001And002

ConstantsResponseProto017

ConstantsResponseProto017: ConstantsResponseProto016

ContractBigMapDiff

ContractBigMapDiff: ContractBigMapDiffItem[]

CurrentProposalResponse

CurrentProposalResponse: string | null

CurrentQuorumResponse

CurrentQuorumResponse: number

DelegateResponse

DelegateResponse: string | null

DiffActionEnum

DiffActionEnum: "update" | "remove" | "copy" | "alloc"

EndorsingRightsArgumentsCycle

EndorsingRightsArgumentsCycle: number | number[]

EndorsingRightsArgumentsDelegate

EndorsingRightsArgumentsDelegate: string | string[]

EndorsingRightsArgumentsLevel

EndorsingRightsArgumentsLevel: number | number[]

EndorsingRightsResponse

EndorsingRightsResponse: EndorsingRightsResponseItem[]

EntrypointsResponse

EntrypointsResponse: { entrypoints: {}; unreachable?: { path: ("Left" | "Right")[] } }

Type declaration

ForgeOperationsParams

ForgeOperationsParams: Pick<OperationObject, "branch" | "contents">

HexString

HexString: string

InlinedEndorsementKindEnum

InlinedEndorsementKindEnum: ENDORSEMENT

InternalOperationResultEnum

InternalOperationResultEnum: OperationResultReveal | OperationResultTransaction | OperationResultDelegation | OperationResultOrigination | OperationResultEvent

InternalOperationResultKindEnum

InternalOperationResultKindEnum: REVEAL | TRANSACTION | ORIGINATION | DELEGATION | EVENT

LastRemovedCommitmentHashes

LastRemovedCommitmentHashes: { commitment_hash: string; last_message_hash: string }

Type declaration

  • commitment_hash: string
  • last_message_hash: string

LazyStorageDiff

LazyStorageDiff: LazyStorageDiffBigMap | LazyStorageDiffSaplingState

LiquidityBakingToggleVotes

LiquidityBakingToggleVotes: "on" | "off" | "pass"

ManagerKeyResponse

ManagerKeyResponse: string | { key: string }

ManagerResponse

ManagerResponse: { manager: string }

Type declaration

  • manager: string

MetadataBalanceUpdatesCategoryEnum

MetadataBalanceUpdatesCategoryEnum: METADATA_BALANCE_UPDATES_CATEGORY

MetadataBalanceUpdatesKindEnum

MetadataBalanceUpdatesKindEnum: "contract" | "freezer" | "accumulator" | "burned" | "commitment" | "minted"

MetadataBalanceUpdatesOriginEnum

MetadataBalanceUpdatesOriginEnum: "block" | "migration" | "subsidy" | "simulation"

MichelsonV1Expression

MichelsonV1Expression: MichelsonV1ExpressionBase | MichelsonV1ExpressionExtended | MichelsonV1Expression[]

Next

Next: { next: number } | { newest: number; oldest: number }

OperationBalanceUpdates

OperationBalanceUpdates: OperationBalanceUpdatesItem[]

OperationContents

OperationContents: OperationContentsEndorsement | OperationContentsPreEndorsement | OperationContentsDoublePreEndorsement | OperationContentsRevelation | OperationContentsVdfRevelation | OperationContentsDoubleEndorsement | OperationContentsDoubleBaking | OperationContentsActivateAccount | OperationContentsProposals | OperationContentsBallot | OperationContentsReveal | OperationContentsTransaction | OperationContentsOrigination | OperationContentsDelegation | OperationContentsEndorsementWithSlot | OperationContentsFailingNoop | OperationContentsRegisterGlobalConstant | OperationContentsSetDepositsLimit | OperationContentsTxRollupOrigination | OperationContentsTxRollupSubmitBatch | OperationContentsTxRollupCommit | OperationContentsTxRollupReturnBond | OperationContentsTxRollupFinalizeCommitment | OperationContentsTxRollupRemoveCommitment | OperationContentsTxRollupRejection | OperationContentsTransferTicket | OperationContentsUpdateConsensusKey | OperationContentsDrainDelegate | OperationContentsIncreasePaidStorage | OperationContentsSmartRollupOriginate | OperationContentsSmartRollupAddMessages | OperationContentsSmartRollupExecuteOutboxMessage | OperationContentsSmartRollupPublish | OperationContentsSmartRollupCement | OperationContentsSmartRollupRefute | OperationContentsSmartRollupRecoverBond | OperationContentsSmartRollupTimeout

OperationContentsAndResult

OperationContentsAndResult: OperationContentsAndResultEndorsement | OperationContentsAndResultPreEndorsement | OperationContentsAndResultDoublePreEndorsement | OperationContentsAndResultRevelation | OperationContentsAndResultDoubleEndorsement | OperationContentsAndResultDoubleBaking | OperationContentsAndResultActivateAccount | OperationContentsAndResultProposals | OperationContentsAndResultBallot | OperationContentsAndResultReveal | OperationContentsAndResultTransaction | OperationContentsAndResultOrigination | OperationContentsAndResultDelegation | OperationContentsAndResultEndorsementWithSlot | OperationContentsAndResultRegisterGlobalConstant | OperationContentsAndResultSetDepositsLimit | OperationContentsAndResultTxRollupOrigination | OperationContentsAndResultTxRollupSubmitBatch | OperationContentsAndResultTxRollupCommit | OperationContentsAndResultTxRollupDispatchTickets | OperationContentsAndResultTxRollupReturnBond | OperationContentsAndResultTxRollupFinalizeCommitment | OperationContentsAndResultTxRollupRemoveCommitment | OperationContentsAndResultTxRollupRejection | OperationContentsAndResultTransferTicket | OperationContentsAndResultIncreasePaidStorage | OperationContentsAndResultUpdateConsensusKey | OperationContentsAndResultDrainDelegate | OperationContentsAndResultVdfRevelation | OperationContentsAndResultSmartRollupOriginate | OperationContentsAndResultSmartRollupAddMessages | OperationContentsAndResultSmartRollupExecuteOutboxMessage | OperationContentsAndResultSmartRollupPublish | OperationContentsAndResultSmartRollupCement | OperationContentsAndResultSmartRollupRefute | OperationContentsAndResultSmartRollupRecoverBond | OperationContentsAndResultSmartRollupTimeout

OperationContentsAndResultWithFee

OperationContentsAndResultWithFee: OperationContentsAndResultTransaction | OperationContentsAndResultOrigination | OperationContentsAndResultDelegation | OperationContentsAndResultReveal | OperationContentsAndResultRegisterGlobalConstant | OperationContentsAndResultSetDepositsLimit | OperationContentsAndResultUpdateConsensusKey | OperationContentsAndResultIncreasePaidStorage | OperationContentsAndResultSmartRollupAddMessages | OperationContentsAndResultSmartRollupOriginate

OperationHash

OperationHash: string

OperationResult

OperationResult: OperationResultOrigination | OperationResultTransaction | OperationResultReveal | OperationResultDelegation | OperationResultIncreasePaidStorage | OperationResultRegisterGlobalConstant | OperationResultTransferTicket | OperationResultUpdateConsensusKey | OperationResultSmartRollupOriginate | OperationResultSmartRollupAddMessages | OperationResultSetDepositsLimit | OperationResultSmartRollupPublish | OperationResultSmartRollupCement | OperationResultSmartRollupRefute | OperationResultSmartRollupRecoverBond | OperationResultSmartRollupTimeout | OperationResultSmartRollupExecuteOutboxMessage | OperationResultTxRollupOrigination | OperationResultTxRollupSubmitBatch | OperationResultTxRollupDispatchTickets | OperationResultTxRollupCommit | OperationResultTxRollupReturnBond | OperationResultTxRollupFinalizeCommitment | OperationResultTxRollupRemoveCommitment | OperationResultTxRollupRejection

OperationResultStatusEnum

OperationResultStatusEnum: "applied" | "failed" | "skipped" | "backtracked"

OtherElts

OtherElts: { node: [string, { value: string } | { node: string }][] } | { other_elts: OtherEltsInner }

PendingConsensusKey

PendingConsensusKey: { cycle: number; pkh: string }

Type declaration

  • cycle: number
  • pkh: string

PeriodKindResponse

PeriodKindResponse: "proposal" | "exploration" | "cooldown" | "promotion" | "adoption"

PreapplyParams

PreapplyParams: OperationObject[]

PreapplyResponse

PreapplyResponse: { contents: OperationContentsAndResult[] }

Type declaration

ProposalsResponse

ProposalsResponse: ProposalsResponseItem[]

ProposalsResponseItem

ProposalsResponseItem: [string, BigNumber]

ProtocolsResponse

ProtocolsResponse: { next_protocol: string; protocol: string }

Type declaration

  • next_protocol: string
  • protocol: string

RPCRunCodeParam

RPCRunCodeParam: { amount: string; balance?: string; chain_id: string; entrypoint?: string; gas?: string; input: MichelsonV1Expression; level?: string; now?: string; payer?: string; script: MichelsonV1ExpressionExtended[]; self?: string; source?: string; storage: MichelsonV1Expression; unparsing_mode?: UnparsingMode }

Type declaration

RPCRunOperationParam

RPCRunOperationParam: { chain_id: string; operation: OperationObject }

Type declaration

RPCRunScriptViewParam

RPCRunScriptViewParam: { chain_id: string; contract: string; gas?: string; input: MichelsonV1Expression; level?: string; now?: string; payer?: string; source?: string; unlimited_gas?: boolean; unparsing_mode?: UnparsingModeEnum; view: string }

Type declaration

  • chain_id: string
  • contract: string
  • Optional gas?: string
  • input: MichelsonV1Expression
  • Optional level?: string
  • Optional now?: string
  • Optional payer?: string
  • Optional source?: string
  • Optional unlimited_gas?: boolean
  • Optional unparsing_mode?: UnparsingModeEnum
  • view: string

RPCRunViewParam

RPCRunViewParam: { chain_id: string; contract: string; entrypoint: string; gas?: BigNumber; input: MichelsonV1Expression; payer?: string; source?: string; unparsing_mode?: UnparsingModeEnum }

Type declaration

  • chain_id: string
  • contract: string
  • entrypoint: string
  • Optional gas?: BigNumber
  • input: MichelsonV1Expression
  • Optional payer?: string
  • Optional source?: string
  • Optional unparsing_mode?: UnparsingModeEnum

Ratio

Ratio: { denominator: number; numerator: number }

Type declaration

  • denominator: number
  • numerator: number

RunCodeResult

RunCodeResult: { big_map_diff?: ContractBigMapDiff; lazy_storage_diff?: LazyStorageDiff; operations: InternalOperationResult[]; storage: MichelsonV1Expression }

Type declaration

RunScriptViewResult

RunScriptViewResult: { data: MichelsonV1Expression }

Type declaration

RunViewResult

RunViewResult: { data: MichelsonV1Expression }

Type declaration

SaplingDiffResponse

SaplingDiffResponse: { commitments_and_ciphertexts: CommitmentsAndCiphertexts[]; nullifiers: string[]; root: SaplingTransactionCommitmentHash }

Type declaration

SaplingTransactionCommitment

SaplingTransactionCommitment: string

SaplingTransactionCommitmentHash

SaplingTransactionCommitmentHash: string

ScriptResponse

ScriptResponse: ScriptedContracts

SmartRollupGameStatus

SmartRollupGameStatus: ONGOING | SmartRollupRefuteGameStatusEnded

SmartRollupRefutation

SmartRollupRefutation: SmartRollupRefutationStart | SmartRollupRefutationMove

SmartRollupRefutationMoveInputProof

SmartRollupRefutationMoveInputProof: SmartRollupRefutationMoveInputProofInbox | SmartRollupRefutationMoveInputProofReveal | SmartRollupRefutationMoveInputProofFirstInput

SmartRollupRefutationMoveStep

SmartRollupRefutationMoveStep: SmartRollupRefutationMoveStepDissection[] | SmartRollupRefutationMoveStepProof

SmartRollupRefuteGameStatusResult

SmartRollupRefuteGameStatusResult: SmartRollupRefuteGameEndedResultLoser | SmartRollupRefuteGameEndedResultDraw

SmartRollupRefuteRevealProofOptions

SmartRollupRefuteRevealProofOptions: SmartRollupRefuteRevealProofRaw | SmartRollupRefuteRevealProofMetadata | SmartRollupRefuteRevealProofDalPage

StorageResponse

StorageResponse: ScriptedContracts["storage"]

SuccessfulManagerOperationResultKindEnum

SuccessfulManagerOperationResultKindEnum: REVEAL | TRANSACTION | ORIGINATION | DELEGATION

TicketReceipt

TicketReceipt: TicketUpdates

TimeStampMixed

TimeStampMixed: Date | string

UnparsingMode

UnparsingMode: { unparsing_mode: UnparsingModeEnum }

Type declaration

UnparsingModeEnum

UnparsingModeEnum: "Readable" | "Optimized" | "Optimized_legacy"

VotesListingsResponse

VotesListingsResponse: VotesListingsResponseItem[]

VotingInfoResponse

VotingInfoResponse: { current_ballot?: BallotListResponseEnum; current_proposals?: string[]; remaining_proposals?: number; voting_power?: string }

Type declaration

  • Optional current_ballot?: BallotListResponseEnum
  • Optional current_proposals?: string[]
  • Optional remaining_proposals?: number
  • Optional voting_power?: string

Variables

Const VERSION

VERSION: { commitHash: string; version: string } = ...

Type declaration

  • commitHash: string
  • version: string

Const defaultChain

defaultChain: "main" = 'main'

Const defaultRPCOptions

defaultRPCOptions: RPCOptions = ...

Functions

castToBigNumber

  • castToBigNumber(data: any, keys?: any): object

  • Casts object/array items to BigNumber

    Parameters

    • data: any

      input object or array

    • Optional keys: any

      keys for processing or all items if not defined

    Returns object

Generated using TypeDoc