Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @taquito/rpc

pkgsign status

Taquito RPC package

@taquito/rpc is an npm package that provides low level methods, and types to invoke RPC calls from a Nomadic Tezos RPC node.

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

API Documentation

TypeDoc style documentation is available on-line here

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

BakingRightsArgumentsCycle

Re-exports BakingRightsArgumentsCycle

BakingRightsArgumentsDelegate

Re-exports BakingRightsArgumentsDelegate

BakingRightsArgumentsLevel

Re-exports BakingRightsArgumentsLevel

BakingRightsQueryArguments

Re-exports BakingRightsQueryArguments

BakingRightsResponse

Re-exports BakingRightsResponse

BakingRightsResponseItem

Re-exports BakingRightsResponseItem

BalanceResponse

Re-exports BalanceResponse

BalanceUpdateCategoryEnum

Re-exports BalanceUpdateCategoryEnum

BalanceUpdateKindEnum

Re-exports BalanceUpdateKindEnum

BallotListResponse

Re-exports BallotListResponse

BallotListResponseEnum

Re-exports BallotListResponseEnum

BallotListResponseItem

Re-exports BallotListResponseItem

BallotsResponse

Re-exports BallotsResponse

BigMapGetResponse

Re-exports BigMapGetResponse

BigMapKey

Re-exports BigMapKey

BigMapResponse

Re-exports BigMapResponse

BlockFullHeader

Re-exports BlockFullHeader

BlockHeaderResponse

Re-exports BlockHeaderResponse

BlockMetadata

Re-exports BlockMetadata

BlockResponse

Re-exports BlockResponse

ConstantsResponse

Re-exports ConstantsResponse

ContractBigMapDiff

Re-exports ContractBigMapDiff

ContractBigMapDiffItem

Re-exports ContractBigMapDiffItem

ContractResponse

Re-exports ContractResponse

CurrentProposalResponse

Re-exports CurrentProposalResponse

CurrentQuorumResponse

Re-exports CurrentQuorumResponse

DelegateResponse

Re-exports DelegateResponse

DelegatesResponse

Re-exports DelegatesResponse

EndorsingRightsArgumentsCycle

Re-exports EndorsingRightsArgumentsCycle

EndorsingRightsArgumentsDelegate

Re-exports EndorsingRightsArgumentsDelegate

EndorsingRightsArgumentsLevel

Re-exports EndorsingRightsArgumentsLevel

EndorsingRightsQueryArguments

Re-exports EndorsingRightsQueryArguments

EndorsingRightsResponse

Re-exports EndorsingRightsResponse

EndorsingRightsResponseItem

Re-exports EndorsingRightsResponseItem

EntrypointsResponse

Re-exports EntrypointsResponse

ForgeOperationsParams

Re-exports ForgeOperationsParams

HexString

Re-exports HexString

InlinedEndorsement

Re-exports InlinedEndorsement

InlinedEndorsementContents

Re-exports InlinedEndorsementContents

InlinedEndorsementKindEnum

Re-exports InlinedEndorsementKindEnum

InternalOperationResult

Re-exports InternalOperationResult

InternalOperationResultEnum

Re-exports InternalOperationResultEnum

InternalOperationResultKindEnum

Re-exports InternalOperationResultKindEnum

Level

Re-exports Level

ManagerKeyResponse

Re-exports ManagerKeyResponse

ManagerResponse

Re-exports ManagerResponse

MaxOperationListLength

Re-exports MaxOperationListLength

MetadataBalanceUpdatesCategoryEnum

Re-exports MetadataBalanceUpdatesCategoryEnum

MetadataBalanceUpdatesKindEnum

Re-exports MetadataBalanceUpdatesKindEnum

MichelsonV1Expression

Re-exports MichelsonV1Expression

MichelsonV1ExpressionBase

Re-exports MichelsonV1ExpressionBase

MichelsonV1ExpressionExtended

Re-exports MichelsonV1ExpressionExtended

OpKind

Re-exports OpKind

OperationBalanceUpdates

Re-exports OperationBalanceUpdates

OperationBalanceUpdatesItem

Re-exports OperationBalanceUpdatesItem

OperationContents

Re-exports OperationContents

OperationContentsActivateAccount

Re-exports OperationContentsActivateAccount

OperationContentsAndResult

Re-exports OperationContentsAndResult

OperationContentsAndResultActivateAccount

Re-exports OperationContentsAndResultActivateAccount

OperationContentsAndResultBallot

Re-exports OperationContentsAndResultBallot

OperationContentsAndResultDelegation

Re-exports OperationContentsAndResultDelegation

OperationContentsAndResultDoubleBaking

Re-exports OperationContentsAndResultDoubleBaking

OperationContentsAndResultDoubleEndorsement

Re-exports OperationContentsAndResultDoubleEndorsement

OperationContentsAndResultEndorsement

Re-exports OperationContentsAndResultEndorsement

OperationContentsAndResultMetadata

Re-exports OperationContentsAndResultMetadata

OperationContentsAndResultMetadataDelegation

Re-exports OperationContentsAndResultMetadataDelegation

OperationContentsAndResultMetadataExtended

Re-exports OperationContentsAndResultMetadataExtended

OperationContentsAndResultMetadataOrigination

Re-exports OperationContentsAndResultMetadataOrigination

OperationContentsAndResultMetadataReveal

Re-exports OperationContentsAndResultMetadataReveal

OperationContentsAndResultMetadataTransaction

Re-exports OperationContentsAndResultMetadataTransaction

OperationContentsAndResultOrigination

Re-exports OperationContentsAndResultOrigination

OperationContentsAndResultProposals

Re-exports OperationContentsAndResultProposals

OperationContentsAndResultReveal

Re-exports OperationContentsAndResultReveal

OperationContentsAndResultRevelation

Re-exports OperationContentsAndResultRevelation

OperationContentsAndResultTransaction

Re-exports OperationContentsAndResultTransaction

OperationContentsBallot

Re-exports OperationContentsBallot

OperationContentsBallotEnum

Re-exports OperationContentsBallotEnum

OperationContentsDelegation

Re-exports OperationContentsDelegation

OperationContentsDoubleBaking

Re-exports OperationContentsDoubleBaking

OperationContentsDoubleEndorsement

Re-exports OperationContentsDoubleEndorsement

OperationContentsEndorsement

Re-exports OperationContentsEndorsement

OperationContentsOrigination

Re-exports OperationContentsOrigination

OperationContentsProposals

Re-exports OperationContentsProposals

OperationContentsReveal

Re-exports OperationContentsReveal

OperationContentsRevelation

Re-exports OperationContentsRevelation

OperationContentsTransaction

Re-exports OperationContentsTransaction

OperationEntry

Re-exports OperationEntry

OperationHash

Re-exports OperationHash

OperationMetadataBalanceUpdates

Re-exports OperationMetadataBalanceUpdates

OperationObject

Re-exports OperationObject

OperationResultDelegation

Re-exports OperationResultDelegation

OperationResultOrigination

Re-exports OperationResultOrigination

OperationResultReveal

Re-exports OperationResultReveal

OperationResultStatusEnum

Re-exports OperationResultStatusEnum

OperationResultTransaction

Re-exports OperationResultTransaction

PackDataParams

Re-exports PackDataParams

PackDataResponse

Re-exports PackDataResponse

PeriodKindResponse

Re-exports PeriodKindResponse

PreapplyParams

Re-exports PreapplyParams

PreapplyResponse

Re-exports PreapplyResponse

ProposalsResponse

Re-exports ProposalsResponse

ProposalsResponseItem

Re-exports ProposalsResponseItem

RPCRunOperationParam

Re-exports RPCRunOperationParam

RawBlockHeaderResponse

Re-exports RawBlockHeaderResponse

ScriptResponse

Re-exports ScriptResponse

ScriptedContracts

Re-exports ScriptedContracts

StorageResponse

Re-exports StorageResponse

TestChainStatus

Re-exports TestChainStatus

TezosGenericOperationError

Re-exports TezosGenericOperationError

TimeStampMixed

Re-exports TimeStampMixed

TransactionOperationParameter

Re-exports TransactionOperationParameter

VotesListingsResponse

Re-exports VotesListingsResponse

VotesListingsResponseItem

Re-exports VotesListingsResponseItem

Type aliases

BakingRightsArgumentsCycle

BakingRightsArgumentsCycle: number | number[]

BakingRightsArgumentsDelegate

BakingRightsArgumentsDelegate: string | string[]

BakingRightsArgumentsLevel

BakingRightsArgumentsLevel: number | number[]

BakingRightsResponse

BakingRightsResponse: BakingRightsResponseItem[]

BalanceResponse

BalanceResponse: BigNumber

BalanceUpdateCategoryEnum

BalanceUpdateCategoryEnum: "rewards" | "fees" | "deposits"

BalanceUpdateKindEnum

BalanceUpdateKindEnum: "contract" | "freezer"

BallotListResponse

BallotListResponse: BallotListResponseItem[]

BallotListResponseEnum

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

BigMapGetResponse

BigMapGetResponse: MichelsonV1Expression

BigMapKey

BigMapKey: { key: {}; type: { prim: string } }

Type declaration

  • key: {}
    • [key: string]: string
  • type: { prim: string }
    • prim: string

BigMapResponse

BigMapResponse: MichelsonV1Expression | MichelsonV1Expression[]

ContractBigMapDiff

ContractBigMapDiff: ContractBigMapDiffItem[]

CurrentProposalResponse

CurrentProposalResponse: string | null

CurrentQuorumResponse

CurrentQuorumResponse: number

DelegateResponse

DelegateResponse: string | null

EndorsingRightsArgumentsCycle

EndorsingRightsArgumentsCycle: number | number[]

EndorsingRightsArgumentsDelegate

EndorsingRightsArgumentsDelegate: string | string[]

EndorsingRightsArgumentsLevel

EndorsingRightsArgumentsLevel: number | number[]

EndorsingRightsResponse

EndorsingRightsResponse: EndorsingRightsResponseItem[]

EntrypointsResponse

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

Type declaration

  • entrypoints: {}
    • [key: string]: Object
  • Optional unreachable?: undefined | { path: ("Left" | "Right")[] }

ForgeOperationsParams

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

HexString

HexString: string

InlinedEndorsementKindEnum

InlinedEndorsementKindEnum: ENDORSEMENT

InternalOperationResultEnum

InternalOperationResultEnum: OperationResultReveal | OperationResultTransaction | OperationResultDelegation | OperationResultOrigination

InternalOperationResultKindEnum

InternalOperationResultKindEnum: REVEAL | TRANSACTION | ORIGINATION | DELEGATION

ManagerKeyResponse

ManagerKeyResponse: string | { key: string }

ManagerResponse

ManagerResponse: { manager: string }

Type declaration

  • manager: string

MetadataBalanceUpdatesCategoryEnum

MetadataBalanceUpdatesCategoryEnum: "rewards" | "fees" | "deposits"

MetadataBalanceUpdatesKindEnum

MetadataBalanceUpdatesKindEnum: "contract" | "freezer"

MichelsonV1Expression

MichelsonV1Expression: MichelsonV1ExpressionBase | MichelsonV1ExpressionExtended

OperationBalanceUpdates

OperationBalanceUpdates: OperationBalanceUpdatesItem[]

OperationContents

OperationContents: OperationContentsEndorsement | OperationContentsRevelation | OperationContentsDoubleEndorsement | OperationContentsDoubleBaking | OperationContentsActivateAccount | OperationContentsProposals | OperationContentsBallot | OperationContentsReveal | OperationContentsTransaction | OperationContentsOrigination | OperationContentsDelegation

OperationContentsAndResult

OperationContentsAndResult: OperationContentsAndResultEndorsement | OperationContentsAndResultRevelation | OperationContentsAndResultDoubleEndorsement | OperationContentsAndResultDoubleBaking | OperationContentsAndResultActivateAccount | OperationContentsAndResultProposals | OperationContentsAndResultBallot | OperationContentsAndResultReveal | OperationContentsAndResultTransaction | OperationContentsAndResultOrigination | OperationContentsAndResultDelegation

OperationContentsBallotEnum

OperationContentsBallotEnum: "nay" | "yay" | "pass"

OperationHash

OperationHash: string

OperationResultStatusEnum

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

PeriodKindResponse

PeriodKindResponse: "proposal" | "testing_vote" | "testing" | "promotion_vote"

PreapplyParams

PreapplyParams: OperationObject[]

PreapplyResponse

PreapplyResponse: { contents: OperationContentsAndResult[] }

Type declaration

ProposalsResponse

ProposalsResponse: ProposalsResponseItem[]

ProposalsResponseItem

ProposalsResponseItem: [string, number]

RPCRunOperationParam

RPCRunOperationParam: { chain_id: string; operation: OperationObject }

Type declaration

ScriptResponse

ScriptResponse: ScriptedContracts

StorageResponse

StorageResponse: ScriptedContracts["storage"]

TimeStampMixed

TimeStampMixed: Date | string

VotesListingsResponse

VotesListingsResponse: VotesListingsResponseItem[]

Variables

Const defaultChain

defaultChain: "main" = "main"

Const defaultRPC

defaultRPC: "https://mainnet.tezrpc.me" = "https://mainnet.tezrpc.me"

Const getByPath

getByPath: any = require('lodash/get')

Const setByPath

setByPath: any = require('lodash/set')

Functions

castToBigNumber

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

castToString

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

  • Casts object/array BigNumber items to strings for readability

    Parameters

    • data: any

      input object or array

    • Optional keys: any

      keys for processing or all items if not defined

    Returns object

Object literals

Const defaultRPCOptions

defaultRPCOptions: object

block

block: string = "head"

Generated using TypeDoc