@taquito/rpc | Taquito

Index

References

OpKind

Classes

Interfaces

Type aliases

Variables

Functions

castToBigNumber

References

OpKind

Re-exports OpKind

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: { args?: object[]; prim: string } }

Type declaration

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

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

entrypoints: {}
- [key: string]: MichelsonV1ExpressionExtended
Optional unreachable?: { path: ("Left" | "Right")[] }
- path: ("Left" | "Right")[]

ForgeOperationsParams

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

HexString

HexString: string

InlinedEndorsementKindEnum

InlinedEndorsementKindEnum: ENDORSEMENT

InternalOperationResultEnum

InternalOperationResultEnum: OperationResultReveal | OperationResultTransaction | OperationResultDelegation | OperationResultOrigination | OperationResultRegisterGlobalConstant

InternalOperationResultKindEnum

InternalOperationResultKindEnum: REVEAL | TRANSACTION | ORIGINATION | DELEGATION | REGISTER_GLOBAL_CONSTANT

LazyStorageDiff

LazyStorageDiff: LazyStorageDiffBigMap | LazyStorageDiffSaplingState

ManagerKeyResponse

ManagerKeyResponse: string | { key: string }

ManagerResponse

ManagerResponse: { manager: string }

Type declaration

manager: string

MetadataBalanceUpdatesCategoryEnum

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

MetadataBalanceUpdatesKindEnum

MetadataBalanceUpdatesKindEnum: "contract" | "freezer"

MetadataBalanceUpdatesOriginEnum

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

MichelsonV1Expression

MichelsonV1Expression: MichelsonV1ExpressionBase | MichelsonV1ExpressionExtended | MichelsonV1Expression[]

OperationBalanceUpdates

OperationBalanceUpdates: OperationBalanceUpdatesItem[]

OperationContents

OperationContentsAndResult

OperationContentsBallotEnum

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

OperationHash

OperationHash: string

OperationResultStatusEnum

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

PeriodKindResponse

PreapplyParams

PreapplyParams: OperationObject[]

PreapplyResponse

PreapplyResponse: { contents: OperationContentsAndResult[] }

Type declaration

contents: OperationContentsAndResult[]

ProposalsResponse

ProposalsResponse: ProposalsResponseItem[]

ProposalsResponseItem

ProposalsResponseItem: [string, number]

RPCRunCodeParam

RPCRunCodeParam: { amount: string; balance?: string; chain_id: string; entrypoint?: string; gas?: BigNumber; input: MichelsonV1Expression; payer?: string; script: MichelsonV1ExpressionExtended[]; source?: string; storage: MichelsonV1Expression }

Type declaration

amount: string
Optional balance?: string
chain_id: string
Optional entrypoint?: string
Optional gas?: BigNumber
input: MichelsonV1Expression
Optional payer?: string
script: MichelsonV1ExpressionExtended[]
Optional source?: string
storage: MichelsonV1Expression

RPCRunOperationParam

RPCRunOperationParam: { chain_id: string; operation: OperationObject }

Type declaration

chain_id: string
operation: OperationObject

Ratio

Ratio: { denominator: number; numerator: number }

Type declaration

denominator: number
numerator: number

RunCodeResult

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

Type declaration

Optional big_map_diff?: ContractBigMapDiff
operations: InternalOperationResult[]
storage: MichelsonV1Expression

SaplingDiffResponse

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

Type declaration

commitments_and_ciphertexts: CommitmentsAndCiphertexts[]
nullifiers: string[]
root: SaplingTransactionCommitmentHash

SaplingTransactionCommitment

SaplingTransactionCommitment: string

SaplingTransactionCommitmentHash

SaplingTransactionCommitmentHash: string

ScriptResponse

ScriptResponse: ScriptedContracts

StorageResponse

StorageResponse: ScriptedContracts["storage"]

SuccessfulManagerOperationResultKindEnum

SuccessfulManagerOperationResultKindEnum: REVEAL | TRANSACTION | ORIGINATION | DELEGATION

TimeStampMixed

TimeStampMixed: Date | string

UnparsingMode

UnparsingMode: { unparsing_mode: UnparsingModeEnum }

Type declaration

unparsing_mode: UnparsingModeEnum

UnparsingModeEnum

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

VotesListingsResponse

VotesListingsResponse: VotesListingsResponseItem[]

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

- Defined in taquito-rpc/src/utils/utils.ts:14
Casts object/array items to BigNumber keys support lodash path notation

see

https://lodash.com/docs/#get

Parameters
- data: any
  
  input object or array
- Optional keys: any
  
  keys for processing or all items if not defined
Returns object

Index

References

Classes

Interfaces

Type aliases

Variables

Functions

References

OpKind

Type aliases

BakingRightsArgumentsCycle

BakingRightsArgumentsDelegate

BakingRightsArgumentsLevel

BakingRightsResponse

BalanceResponse

BalanceUpdateCategoryEnum

BalanceUpdateKindEnum

BallotListResponse

BallotListResponseEnum

BigMapGetResponse

BigMapKey

Type declaration

key: {}

[key: string]: string | object[]

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

Optional args?: object[]

prim: string

BigMapResponse

CommitmentsAndCiphertexts

ConstantsResponse

ContractBigMapDiff

CurrentProposalResponse

CurrentQuorumResponse

DelegateResponse

DiffActionEnum

EndorsingRightsArgumentsCycle

EndorsingRightsArgumentsDelegate

EndorsingRightsArgumentsLevel

EndorsingRightsResponse

EntrypointsResponse

Type declaration

entrypoints: {}

[key: string]: MichelsonV1ExpressionExtended

Optional unreachable?: { path: ("Left" | "Right")[] }

path: ("Left" | "Right")[]

ForgeOperationsParams

HexString

InlinedEndorsementKindEnum

InternalOperationResultEnum

InternalOperationResultKindEnum

LazyStorageDiff

ManagerKeyResponse

ManagerResponse

Type declaration

manager: string

MetadataBalanceUpdatesCategoryEnum

MetadataBalanceUpdatesKindEnum

MetadataBalanceUpdatesOriginEnum

MichelsonV1Expression

OperationBalanceUpdates

OperationContents

OperationContentsAndResult

OperationContentsBallotEnum

OperationHash

OperationResultStatusEnum

PeriodKindResponse

PreapplyParams

PreapplyResponse

Type declaration

contents: OperationContentsAndResult[]

ProposalsResponse

ProposalsResponseItem

RPCRunCodeParam

Type declaration

amount: string

Optional balance?: string

chain_id: string

Optional entrypoint?: string

Optional gas?: BigNumber

input: MichelsonV1Expression