Class RpcClient

RpcClient allows interaction with Tezos network through an rpc node

Implements

RpcClientInterface

Index

Constructors

constructor

new RpcClient(url: string, chain?: string, httpBackend?: HttpBackend): RpcClient
Parameters
- url: string
  rpc root url
- chain: string = defaultChain
  chain (default main)
- httpBackend: HttpBackend = ...
  Http backend that issue http request. You can override it by providing your own if you which to hook in the request/response
Returns RpcClient
Example
```
new RpcClient('https://mainnet.tezos.ecadinfra.com/', 'main') this will use https://mainnet.tezos.ecadinfra.com//chains/main
```
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:115

Properties

`Protected`chain

chain: string = defaultChain

chain (default main)

`Protected`httpBackend

httpBackend: HttpBackend = ...

Http backend that issue http request. You can override it by providing your own if you which to hook in the request/response

`Protected`url

url: string

rpc root url

Methods

`Protected`createURL

createURL(path: string): string
Parameters
- path: string
Returns string
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:121

forgeOperations

forgeOperations(
data: ForgeOperationsParams,
options?: RPCOptions,
): Promise<string>
Parameters
- data: ForgeOperationsParams
  operation contents to forge
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Forge an operation returning the unsigned bytes
Returns Promise<string>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.forgeOperations
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:861

getActiveStakingParameters

getActiveStakingParameters(
delegate: string,
options?: RPCOptions,
): Promise<ActiveStakingParametersResponse>
Parameters
- delegate: string
  delegate address which we want to retrieve active staking parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the currently active staking parameters for the given delegate
Returns Promise<ActiveStakingParametersResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-active-staking-parameters
Implementation of RpcClientInterface.getActiveStakingParameters
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1300

getAdaptiveIssuanceLaunchCycle

getAdaptiveIssuanceLaunchCycle(
options?: { block: string },
): Promise<AILaunchCycleResponse>
Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of null means that the feature is not yet set to launch.
Parameters
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<AILaunchCycleResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-adaptive-issuance-launch-cycle
Implementation of RpcClientInterface.getAdaptiveIssuanceLaunchCycle
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1250

getAllDelegates

getAllDelegates(
args?: AllDelegatesQueryArguments,
options?: { block: string },
): Promise<string[]>
Parameters
- args: AllDelegatesQueryArguments = {}
  contains optional query arguments (active, inactive, with_minimal_stake, without_minimal_stake)
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Lists all registered delegates by default with query arguments to filter unneeded values.
Returns Promise<string[]>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh
Implementation of RpcClientInterface.getAllDelegates
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:525

getAllTicketBalances

getAllTicketBalances(
contract: string,
options?: { block: string },
): Promise<AllTicketBalances>
Parameters
- contract: string
  originated address we want to retrieve ticket balances of
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the complete list of tickets owned by the given contract by scanning the contract's storage.
Returns Promise<AllTicketBalances>
See
https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
Implementation of RpcClientInterface.getAllTicketBalances
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1233

getAttestationRights

getAttestationRights(
args?: AttestationRightsQueryArguments,
options?: RPCOptions,
): Promise<AttestationRightsResponse>
Parameters
- args: AttestationRightsQueryArguments = {}
  contains optional query arguments (level, cycle, delegate, and consensus_key)
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Retrieves the delegates allowed to attest a block
Returns Promise<AttestationRightsResponse>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.getAttestationRights
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:740

getBakingRights

getBakingRights(
args?: BakingRightsQueryArgumentsBase,
options?: RPCOptions,
): Promise<BakingRightsResponse>
Parameters
- args: BakingRightsQueryArgumentsBase = {}
  contains optional query arguments (level, cycle, delegate, consensus_key, and max_round)
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Retrieves the list of delegates allowed to bake a block.
Returns Promise<BakingRightsResponse>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.getBakingRights
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:721

getBalance

getBalance(address: string, options?: RPCOptions): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve the spendable balance
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-balance
Implementation of RpcClientInterface.getBalance
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:178

getBalanceAndFrozenBonds

getBalanceAndFrozenBonds(
address: string,
options?: RPCOptions,
): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve balance and frozen bonds
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'spendable_and_frozen_bonds' RPC.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
Implementation of RpcClientInterface.getBalanceAndFrozenBonds
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:217

getBallotList

getBallotList(options?: RPCOptions): Promise<BallotListResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Ballots casted so far during a voting period
Returns Promise<BallotListResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-ballot-list
Implementation of RpcClientInterface.getBallotList
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:758

getBallots

getBallots(options?: RPCOptions): Promise<BallotsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Sum of ballots casted so far during a voting period
Returns Promise<BallotsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-ballots
Implementation of RpcClientInterface.getBallots
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:772

getBigMapExpr

getBigMapExpr(
    id: string,
    expr: string,
    options?: { block: string },
): Promise<BigMapResponse>
Parameters
- id: string
  Big Map ID
- expr: string
  Expression hash to query (A b58check encoded Blake2b hash of the expression (The expression can be packed using the pack_data method))
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the value associated with a key in a big map.
Returns Promise<BigMapResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
Implementation of RpcClientInterface.getBigMapExpr
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:508

getBlock

getBlock(options?: RPCOptions): Promise<BlockResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) and version. All the information about a block
Returns Promise<BlockResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id
Example
```
getBlock() will default to `/main/chains/block/head?version=1`
```
Example
```
getBlock({ block: 'head~2' }) will return an offset of 2 from head blocks
```
Example
```
getBlock({ block: 'BL8fTiWcSxWCjiMVnDkbh6EuhqVPZzgWheJ2dqwrxYRm9AephXh~2' }) will return an offset of 2 blocks from given block hash..
```
Implementation of RpcClientInterface.getBlock
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:671

getBlockHash

getBlockHash(options?: RPCOptions): Promise<string>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Get the block's hash, its unique identifier.
Returns Promise<string>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-hash
Implementation of RpcClientInterface.getBlockHash
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:151

getBlockHeader

getBlockHeader(options?: RPCOptions): Promise<BlockHeaderResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) The whole block header
Returns Promise<BlockHeaderResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-header
Implementation of RpcClientInterface.getBlockHeader
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:687

getBlockMetadata

getBlockMetadata(options?: RPCOptions): Promise<BlockMetadata>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) and version All the metadata associated to the block
Returns Promise<BlockMetadata>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-metadata
Implementation of RpcClientInterface.getBlockMetadata
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:701

getChainId

getChainId(): Promise<string>
Returns Promise<string>
Implementation of RpcClientInterface.getChainId
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1022

getConstants

getConstants(options?: RPCOptions): Promise<ConstantsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) All constants
Returns Promise<ConstantsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-constants
Implementation of RpcClientInterface.getConstants
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:621

getContract

getContract(
address: string,
options?: { block: string },
): Promise<ContractResponse>
Parameters
- address: string
  contract address from which we want to retrieve
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the complete status of a contract.
Returns Promise<ContractResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id
Implementation of RpcClientInterface.getContract
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:438

getCurrentPeriod

getCurrentPeriod(options?: RPCOptions): Promise<VotingPeriodBlockResult>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block
Returns Promise<VotingPeriodBlockResult>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-period
Implementation of RpcClientInterface.getCurrentPeriod
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1075

getCurrentProposal

getCurrentProposal(options?: RPCOptions): Promise<CurrentProposalResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Current proposal under evaluation.
Returns Promise<CurrentProposalResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-proposal
Implementation of RpcClientInterface.getCurrentProposal
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:787

getCurrentQuorum

getCurrentQuorum(options?: RPCOptions): Promise<number>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Current expected quorum.
Returns Promise<number>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-quorum
Implementation of RpcClientInterface.getCurrentQuorum
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:803

getDelegate

getDelegate(
address: string,
options?: { block: string },
): Promise<DelegateResponse>
Parameters
- address: string
  contract address from which we want to retrieve the delegate (baker)
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the delegate of a contract, if any
Returns Promise<DelegateResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-delegate
Implementation of RpcClientInterface.getDelegate
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:478

getDelegates

getDelegates(
address: string,
options?: { block: string },
): Promise<DelegatesResponse>
Parameters
- address: string
  delegate address which we want to retrieve
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Everything about a delegate
Returns Promise<DelegatesResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh
Implementation of RpcClientInterface.getDelegates
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:542

getDestinationIndex

getDestinationIndex(
destination: string,
options?: RPCOptions,
): Promise<DestinationIndexResponse>
Parameters
- destination: string
  address to retrieve the index for
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the index assigned to the address if it was indexed by the opcode INDEX_ADDRESS, otherwise returns null
Returns Promise<DestinationIndexResponse>
See
https://octez.tezos.com/docs/alpha/rpc.html#get-block-id-context-destination-destination-id-index
Implementation of RpcClientInterface.getDestinationIndex
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1336

getEntrypoints

getEntrypoints(
contract: string,
options?: RPCOptions,
): Promise<EntrypointsResponse>
Parameters
- contract: string
  address of the contract we want to get the entrypoints of
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Return the list of entrypoints of the contract
Returns Promise<EntrypointsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-entrypoints

Remarks
version 005_PsBABY5H
Implementation of RpcClientInterface.getEntrypoints
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:916

getFullBalance

getFullBalance(address: string, options?: RPCOptions): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve the full balance
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the full balance of a contract, including frozen bonds and stake.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
Implementation of RpcClientInterface.getFullBalance
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:257

getLiveBlocks

getLiveBlocks(options?: RPCOptions): Promise<string[]>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) List the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.
Returns Promise<string[]>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-live-blocks
Implementation of RpcClientInterface.getLiveBlocks
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:164

getManagerKey

getManagerKey(
address: string,
options?: { block: string },
): Promise<ManagerKeyResponse>
Parameters
- address: string
  contract address from which we want to retrieve the manager
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the manager of an implicit contract
Returns Promise<ManagerKeyResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-manager-key
Implementation of RpcClientInterface.getManagerKey
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:459

getMempoolFilter

getMempoolFilter(
args?: MempoolFilterQueryArguments,
): Promise<MempoolFilterResponse>
Returns the current mempool fee filter configuration.

On Tezos L1 these values commonly resemble the historical fee defaults used by clients. On Tezos X / Tezlink, the same fields are used for estimation but may differ materially, especially the byte fee and the gas-price component.
Parameters
- args: MempoolFilterQueryArguments = {}
  optional query arguments for the mempool/filter endpoint
Returns Promise<MempoolFilterResponse>
Implementation of RpcClientInterface.getMempoolFilter
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1286

getNormalizedScript

getNormalizedScript(
    address: string,
    unparsingMode?: UnparsingMode,
    options?: { block: string },
): Promise<ScriptedContracts>
Parameters
- address: string
  contract address from which we want to retrieve the script
- unparsingMode: UnparsingMode = ...
  default is { unparsing_mode: "Readable" }
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the script of the contract and normalize it using the requested unparsing mode.
Returns Promise<ScriptedContracts>
Implementation of RpcClientInterface.getNormalizedScript
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:415

getPendingOperations

getPendingOperations(
args?: PendingOperationsQueryArguments,
): Promise<PendingOperationsV2>
List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
Parameters
- args: PendingOperationsQueryArguments = {}
  has 5 optional properties
Returns Promise<PendingOperationsV2>
Default
```
args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined, source: undefined, operationHash: undefined }
```
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/tallinn-mempool-openapi-rc.json
Implementation of RpcClientInterface.getPendingOperations
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1267

getPendingStakingParameters

getPendingStakingParameters(
delegate: string,
options?: RPCOptions,
): Promise<PendingStakingParametersResponse>
Parameters
- delegate: string
  delegate address which we want to retrieve pending staking parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the pending values for the given delegate's staking parameters
Returns Promise<PendingStakingParametersResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-pending-staking-parameters
Implementation of RpcClientInterface.getPendingStakingParameters
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1318

getProposals

getProposals(options?: RPCOptions): Promise<ProposalsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) List of proposals with number of supporters
Returns Promise<ProposalsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-proposals
Implementation of RpcClientInterface.getProposals
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:842

getProtocolActivations

getProtocolActivations(protocol?: string): Promise<ProtocolActivationsResponse>
Parameters
- protocol: string = ''
  the protocol hash to look up (default to empty string) get current and next protocol
Returns Promise<ProtocolActivationsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
Implementation of RpcClientInterface.getProtocolActivations
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1154

getProtocols

getProtocols(options?: { block: string }): Promise<ProtocolsResponse>
Parameters
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) get current and next protocol
Returns Promise<ProtocolsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
Implementation of RpcClientInterface.getProtocols
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1142

getRpcUrl

getRpcUrl(): string
Return rpc root url

Returns string
Implementation of RpcClientInterface.getRpcUrl
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1066

getSaplingDiffByContract

getSaplingDiffByContract(
contract: string,
options?: { block: string },
): Promise<SaplingDiffResponse>
Parameters
- contract: string
  address of the contract we want to get the sapling diff
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the root and a diff of a state starting from an optional offset which is zero by default
Returns Promise<SaplingDiffResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-single-sapling-get-diff
Implementation of RpcClientInterface.getSaplingDiffByContract
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1125

getSaplingDiffById

getSaplingDiffById(
id: string,
options?: { block: string },
): Promise<SaplingDiffResponse>
Parameters
- id: string
  Sapling state ID
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the root and a diff of a state starting from an optional offset which is zero by default
Returns Promise<SaplingDiffResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-sapling-sapling-state-id-get-diff
Implementation of RpcClientInterface.getSaplingDiffById
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1109

getScript

getScript(
address: string,
options?: { block: string },
): Promise<ScriptedContracts>
Parameters
- address: string
  contract address from which we want to retrieve the script
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the code and data of the contract.
Returns Promise<ScriptedContracts>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-script
Implementation of RpcClientInterface.getScript
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:396

getSpendable

getSpendable(address: string, options?: RPCOptions): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve the spendable balance
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
Returns Promise<BigNumber>
Implementation of RpcClientInterface.getSpendable
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:197

getSpendableAndFrozenBonds

getSpendableAndFrozenBonds(
address: string,
options?: RPCOptions,
): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve spendable and frozen bonds
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'balance_and_frozen_bonds' RPC.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
Implementation of RpcClientInterface.getSpendableAndFrozenBonds
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:237

getStakedBalance

getStakedBalance(address: string, options?: RPCOptions): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve the staked balance
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the staked balance of a contract. Returns None if the contract is originated, or neither delegated nor a delegate.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-staked-balance
Implementation of RpcClientInterface.getStakedBalance
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:277

getStorage

getStorage(
address: string,
options?: { block: string },
): Promise<MichelsonV1Expression>
Parameters
- address: string
  contract address from which we want to retrieve the storage
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the data of the contract.
Returns Promise<MichelsonV1Expression>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-storage
Implementation of RpcClientInterface.getStorage
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:377

getStoragePaidSpace

getStoragePaidSpace(
contract: string,
options?: { block: string },
): Promise<string>
Parameters
- contract: string
  address of the contract we want to retrieve storage information of
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the paid storage space of the contract
Returns Promise<string>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.getStoragePaidSpace
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1191

getStorageUsedSpace

getStorageUsedSpace(
contract: string,
options?: { block: string },
): Promise<string>
Parameters
- contract: string
  address of the contract we want to retrieve storage information of
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the used storage space of the contract
Returns Promise<string>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.getStorageUsedSpace
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1173

getSuccessorPeriod

getSuccessorPeriod(options?: RPCOptions): Promise<VotingPeriodBlockResult>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the voting period (index, kind, starting position) and related information (position, remaining) of the next block.Useful to craft operations that will be valid in the next block
Returns Promise<VotingPeriodBlockResult>
Example
```
getSuccessorPeriod() will default to successor voting period for /main/chains/block/head.
```
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-successor-period
Implementation of RpcClientInterface.getSuccessorPeriod
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1092

getTicketBalance

getTicketBalance(
    contract: string,
    ticket: TicketTokenParams,
    options?: { block: string },
): Promise<string>
Parameters
- contract: string
  implicit or originated address we want to retrieve ticket balance of
- ticket: TicketTokenParams
  object to specify a ticket by ticketer, content type and content
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the contract's balance of ticket with specified ticketer, content type, and content.
Returns Promise<string>
Example
```
ticket { ticketer: 'address', content_type: { prim: "string" }, content: { string: 'ticket1' } }
```
See
https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
Implementation of RpcClientInterface.getTicketBalance
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1211

getUnstakedFinalizableBalance

getUnstakedFinalizableBalance(
address: string,
options?: RPCOptions,
): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve the unstaked finalizable balance
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the balance of a contract that was requested for an unstake operation, and is no longer frozen, which means it will appear in the spendable balance of the contract after any stake/unstake/finalize_unstake operation. Returns None if the contract is originated.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstaked-finalizable-balance
Implementation of RpcClientInterface.getUnstakedFinalizableBalance
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:297

getUnstakedFrozenBalance

getUnstakedFrozenBalance(
address: string,
options?: RPCOptions,
): Promise<BigNumber>
Parameters
- address: string
  address from which we want to retrieve the unstaked frozen balance
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the balance of a contract that was requested for an unstake operation, but is still frozen for the duration of the slashing period. Returns None if the contract is originated.
Returns Promise<BigNumber>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstaked-frozen-balance
Implementation of RpcClientInterface.getUnstakedFrozenBalance
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:317

getUnstakeRequests

getUnstakeRequests(
address: string,
options?: RPCOptions,
): Promise<UnstakeRequestsResponse>
Parameters
- address: string
  address from which we want to retrieve the unstaked requests
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Access the unstake requests of the contract. The requests that appear in the finalizable field can be finalized, which means that the contract can transfer these (no longer frozen) funds to their spendable balance with a [finalize_unstake] operation call. Returns null if there is no unstake request pending.
Returns Promise<UnstakeRequestsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstake-requests
Implementation of RpcClientInterface.getUnstakeRequests
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:337

getVotesListings

getVotesListings(options?: RPCOptions): Promise<VotesListingsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) List of delegates with their voting power
Returns Promise<VotesListingsResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-listings
Implementation of RpcClientInterface.getVotesListings
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:819

getVotingInfo

getVotingInfo(
address: string,
options?: { block: string },
): Promise<VotingInfoResponse>
Parameters
- address: string
  delegate address which we want to retrieve
- options: { block: string } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Returns the delegate info (e.g. voting power) found in the listings of the current voting period
Returns Promise<VotingInfoResponse>
See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-voting-info
Implementation of RpcClientInterface.getVotingInfo
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:603

injectOperation

injectOperation(signedOpBytes: string): Promise<string>
Parameters
- signedOpBytes: string
  signed bytes to inject Inject an operation in node and broadcast it and return the ID of the operation
Returns Promise<string>
See
https://tezos.gitlab.io/shell/rpc.html#post-injection-operation
Implementation of RpcClientInterface.injectOperation
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:879

packData

packData(
data: PackDataParams,
options?: RPCOptions,
): Promise<{ gas: BigNumber | "unaccounted" | undefined; packed: string }>
Parameters
- data: PackDataParams
  Data to pack
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Computes the serialized version of a data expression using the same algorithm as script instruction PACK Note: You should always verify the packed bytes before signing or requesting that they be signed when using the RPC to pack. This precaution helps protect you and your applications users from RPC nodes that have been compromised. A node that is operated by a bad actor, or compromised by a bad actor could return a fully formed operation that does not correspond to the input provided to the RPC endpoint. A safer solution to pack and sign data would be to use the packDataBytes function available in the @taquito/michel-codec package.
Returns Promise<{ gas: BigNumber | "unaccounted" | undefined; packed: string }>
Example
```
packData({ data: { string: "test" }, type: { prim: "string" } })
```
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.packData
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1040

preapplyOperations

preapplyOperations(
ops: PreapplyParams,
options?: RPCOptions,
): Promise<PreapplyResponse[]>
Parameters
- ops: PreapplyParams
  Operations to apply
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block and version Simulate the application of the operations with the context of the given block and return the result of each operation application
Returns Promise<PreapplyResponse[]>
See
https://tezos.gitlab.io/active/rpc.html#post-block-id-helpers-preapply-operations
Implementation of RpcClientInterface.preapplyOperations
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:895

runCode

runCode(code: RPCRunCodeParam, options?: RPCOptions): Promise<RunCodeResult>
Parameters
- code: RPCRunCodeParam
  Code to run
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Run a Michelson script in the current context
Returns Promise<RunCodeResult>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.runCode
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:961

runScriptView

runScriptView(
viewScriptParams: RPCRunScriptViewParam,
options?: RPCOptions,
): Promise<RunScriptViewResult>
Parameters
- viewScriptParams: RPCRunScriptViewParam
  Parameters of the script view to run
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Simulate a call to a michelson view
Returns Promise<RunScriptViewResult>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.runScriptView
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:982

runView

runView(
viewParams: RPCRunViewParam,
options?: RPCOptions,
): Promise<RunViewResult>
Parameters
- viewParams: RPCRunViewParam
  Parameters of the view to run
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) Simulate a call to a view following the TZIP-4 standard.
Returns Promise<RunViewResult>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.runView
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1006

simulateOperation

simulateOperation(
op: RPCSimulateOperationParam,
options?: RPCOptions,
): Promise<PreapplyResponse>
Parameters
- op: RPCSimulateOperationParam
  Operation to simulate
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block and version Simulate running an operation at some future moment (based on the number of blocks given in the latency argument), and return the operation application result.
Returns Promise<PreapplyResponse>
See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.simulateOperation
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:939

Class RpcClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RpcClient

Example

Properties

Protectedchain

ProtectedhttpBackend

Protectedurl

Methods

ProtectedcreateURL

Parameters

Returns string

forgeOperations

Parameters

Returns Promise<string>

See

getActiveStakingParameters

Parameters

Returns Promise<ActiveStakingParametersResponse>

See

getAdaptiveIssuanceLaunchCycle

Parameters

Returns Promise<AILaunchCycleResponse>

See

getAllDelegates

Parameters

Returns Promise<string[]>

See

getAllTicketBalances

Parameters

Returns Promise<AllTicketBalances>

See

getAttestationRights

Parameters

Returns Promise<AttestationRightsResponse>

See

getBakingRights

Parameters

Returns Promise<BakingRightsResponse>

See

getBalance

Parameters

Returns Promise<BigNumber>

See

getBalanceAndFrozenBonds

Parameters

Returns Promise<BigNumber>

See

getBallotList

Parameters

Returns Promise<BallotListResponse>

See

getBallots

Parameters

Returns Promise<BallotsResponse>

See

getBigMapExpr

Parameters

Returns Promise<BigMapResponse>

See

getBlock

Parameters

Returns Promise<BlockResponse>

See

Example

Example

Example

getBlockHash

Parameters

Returns Promise<string>

See

getBlockHeader

Parameters

`Protected`chain

`Protected`httpBackend

`Protected`url

`Protected`createURL