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

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

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: object

Type declaration

  • key: object
    • [key: string]: string
  • type: object
    • 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: object

Type declaration

  • entrypoints: object
    • [key: string]: Object
  • Optional unreachable?: undefined | object

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 | object

ManagerResponse

ManagerResponse: object

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: object

Type declaration

ProposalsResponse

ProposalsResponse: ProposalsResponseItem[]

ProposalsResponseItem

ProposalsResponseItem: [string, number]

RPCRunOperationParam

RPCRunOperationParam: object

Type declaration

ScriptResponse

ScriptResponse: ScriptedContracts

StorageResponse

StorageResponse: MichelsonV1ExpressionBase | MichelsonV1ExpressionExtended

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