Class RpcClient

Description

RpcClient allows interaction with Tezos network through an rpc node

Implements

RpcClientInterface

Index

Constructors

constructor

new RpcClient(url, chain?, 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:112

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
Parameters
- path: string
Returns string
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:118

forgeOperations

forgeOperations(data, options?): Promise<string>
Parameters
- data: ForgeOperationsParams
  operation contents to forge
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<string>
Description
Forge an operation returning the unsigned bytes

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

getAdaptiveIssuanceLaunchCycle

getAdaptiveIssuanceLaunchCycle(options?): Promise<AILaunchCycleResponse>
Parameters
- options: {
  block: string;
  } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
  - block: string
Returns Promise<AILaunchCycleResponse>
Description
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.

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

getAllDelegates

getAllDelegates(args?, options?): 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)
  - block: string
Returns Promise<string[]>
Description
Lists all registered delegates by default with query arguments to filter unneeded values.

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

getAllTicketBalances

getAllTicketBalances(contract, options?): 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)
  - block: string
Returns Promise<AllTicketBalances>
Description
Access the complete list of tickets owned by the given contract by scanning the contract's storage.

See
https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
Implementation of RpcClientInterface.getAllTicketBalances
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1247

getAttestationRights

getAttestationRights(args?, options?): 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)
Returns Promise<AttestationRightsResponse>
Description
Retrieves the delegates allowed to attest a block

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

getBakingRights

getBakingRights(args?, options?): 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)
Returns Promise<BakingRightsResponse>
Description
Retrieves the list of delegates allowed to bake a block.

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

getBalance

getBalance(address, options?): 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)
Returns Promise<BigNumber>
Description
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.

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

getBalanceAndFrozenBonds

getBalanceAndFrozenBonds(address, options?): 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)
Returns Promise<BigNumber>
Description
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.

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

getBallotList

getBallotList(options?): Promise<BallotListResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<BallotListResponse>
Description
Ballots casted so far during a voting period

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

getBallots

getBallots(options?): Promise<BallotsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<BallotsResponse>
Description
Sum of ballots casted so far during a voting period

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

getBigMapExpr

getBigMapExpr(id, expr, options?): 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)
  - block: string
Returns Promise<BigMapResponse>
Description
Access the value associated with a key in a big map.

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

getBigMapKey

getBigMapKey(address, key, __namedParameters?): Promise<MichelsonV1Expression>
Parameters
- address: string
  contract address from which we want to retrieve the big map key
- key: BigMapKey
- __namedParameters: {
  block: string;
  } = defaultRPCOptions
  - block: string
Returns Promise<MichelsonV1Expression>
Deprecated
Deprecated in favor of getBigMapKeyByID

Description
Access the value associated with a key in the big map storage of the contract.

See
https://tezos.gitlab.io/active/rpc.html#post-block-id-context-contracts-contract-id-big-map-get
Implementation of RpcClientInterface.getBigMapKey
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:505

getBlock

getBlock(options?): Promise<BlockResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) and version.
Returns Promise<BlockResponse>
Description
All the information about a block

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

getBlockHash

getBlockHash(options?): Promise<string>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<string>
Description
Get the block's hash, its unique identifier.

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

getBlockHeader

getBlockHeader(options?): Promise<BlockHeaderResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<BlockHeaderResponse>
Description
The whole block header

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

getBlockMetadata

getBlockMetadata(options?): Promise<BlockMetadata>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head) and version
Returns Promise<BlockMetadata>
Description
All the metadata associated to the block

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

getChainId

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

getConstants

getConstants(options?): Promise<ConstantsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<ConstantsResponse>
Description
All constants

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

getContract

getContract(address, options?): 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)
  - block: string
Returns Promise<ContractResponse>
Description
Access the complete status of a contract.

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

getCurrentPeriod

getCurrentPeriod(options?): Promise<VotingPeriodBlockResult>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<VotingPeriodBlockResult>
Description
Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block

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

getCurrentProposal

getCurrentProposal(options?): Promise<CurrentProposalResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<CurrentProposalResponse>
Description
Current proposal under evaluation.

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

getCurrentQuorum

getCurrentQuorum(options?): Promise<number>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<number>
Description
Current expected quorum.

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

getDelegate

getDelegate(address, options?): 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)
  - block: string
Returns Promise<DelegateResponse>
Description
Access the delegate of a contract, if any

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

getDelegates

getDelegates(address, options?): 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)
  - block: string
Returns Promise<DelegatesResponse>
Description
Everything about a delegate

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

getEntrypoints

getEntrypoints(contract, options?): 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)
Returns Promise<EntrypointsResponse>
Description
Return the list of entrypoints of the contract

See
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-entrypoints

Version
005_PsBABY5H
Implementation of RpcClientInterface.getEntrypoints
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:930

getFullBalance

getFullBalance(address, options?): 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)
Returns Promise<BigNumber>
Description
Access the full balance of a contract, including frozen bonds and stake.

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

getLiveBlocks

getLiveBlocks(options?): Promise<string[]>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<string[]>
Description
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.

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

getManagerKey

getManagerKey(address, options?): 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)
  - block: string
Returns Promise<ManagerKeyResponse>
Description
Access the manager of an implicit contract

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

getNormalizedScript

getNormalizedScript(address, unparsingMode?, options?): 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)
  - block: string
Returns Promise<ScriptedContracts>
Description
Access the script of the contract and normalize it using the requested unparsing mode.
Implementation of RpcClientInterface.getNormalizedScript
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:412

getPendingOperations

getPendingOperations(args?): Promise<PendingOperationsV1 | PendingOperationsV2>
Parameters
- args: PendingOperationsQueryArguments = {}
  has 5 optional properties
Returns Promise<PendingOperationsV1 | PendingOperationsV2>
Description
List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)

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/paris-mempool-openapi-rc.json
Implementation of RpcClientInterface.getPendingOperations
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1281

getProposals

getProposals(options?): Promise<ProposalsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<ProposalsResponse>
Description
List of proposals with number of supporters

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

getProtocols

getProtocols(options?): Promise<ProtocolsResponse>
Parameters
- options: {
  block: string;
  } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
  - block: string
Returns Promise<ProtocolsResponse>
Description
get current and next protocol

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

getRpcUrl

getRpcUrl(): string
Returns string
Description
Return rpc root url
Implementation of RpcClientInterface.getRpcUrl
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:1098

getSaplingDiffByContract

getSaplingDiffByContract(contract, options?): 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)
  - block: string
Returns Promise<SaplingDiffResponse>
Description
Returns the root and a diff of a state starting from an optional offset which is zero by default

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

getSaplingDiffById

getSaplingDiffById(id, options?): Promise<SaplingDiffResponse>
Parameters
- id: string
  Sapling state ID
- options: {
  block: string;
  } = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
  - block: string
Returns Promise<SaplingDiffResponse>
Description
Returns the root and a diff of a state starting from an optional offset which is zero by default

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

getScript

getScript(address, options?): 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)
  - block: string
Returns Promise<ScriptedContracts>
Description
Access the code and data of the contract.

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

getSpendable

getSpendable(address, options?): 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)
Returns Promise<BigNumber>
Description
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.
Implementation of RpcClientInterface.getSpendable
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:194

getSpendableAndFrozenBonds

getSpendableAndFrozenBonds(address, options?): 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)
Returns Promise<BigNumber>
Description
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.

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

getStakedBalance

getStakedBalance(address, options?): 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)
Returns Promise<BigNumber>
Description
Access the staked balance of a contract. Returns None if the contract is originated, or neither delegated nor a delegate.

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

getStorage

getStorage(address, options?): 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)
  - block: string
Returns Promise<MichelsonV1Expression>
Description
Access the data of the contract.

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

getStoragePaidSpace

getStoragePaidSpace(contract, options?): 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)
  - block: string
Returns Promise<string>
Description
Access the paid storage space of the contract

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

getStorageUsedSpace

getStorageUsedSpace(contract, options?): 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)
  - block: string
Returns Promise<string>
Description
Access the used storage space of the contract

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

getSuccessorPeriod

getSuccessorPeriod(options?): Promise<VotingPeriodBlockResult>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<VotingPeriodBlockResult>
Description
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

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

getTicketBalance

getTicketBalance(contract, ticket, options?): 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)
  - block: string
Returns Promise<string>
Description
Access the contract's balance of ticket with specified ticketer, content type, and content.

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

getUnstakeRequests

getUnstakeRequests(address, options?): 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)
Returns Promise<UnstakeRequestsResponse>
Description
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.

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

getUnstakedFinalizableBalance

getUnstakedFinalizableBalance(address, options?): 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)
Returns Promise<BigNumber>
Description
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.

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

getUnstakedFrozenBalance

getUnstakedFrozenBalance(address, options?): 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)
Returns Promise<BigNumber>
Description
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.

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

getVotesListings

getVotesListings(options?): Promise<VotesListingsResponse>
Parameters
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<VotesListingsResponse>
Description
List of delegates with their voting power

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

getVotingInfo

getVotingInfo(address, options?): 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)
  - block: string
Returns Promise<VotingInfoResponse>
Description
Returns the delegate info (e.g. voting power) found in the listings of the current voting period

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

injectOperation

injectOperation(signedOpBytes): Promise<string>
Parameters
- signedOpBytes: string
  signed bytes to inject
Returns Promise<string>
Description
Inject an operation in node and broadcast it and return the ID of the operation

See
https://tezos.gitlab.io/shell/rpc.html#post-injection-operation
Implementation of RpcClientInterface.injectOperation
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:893

packData

packData(data, options?): Promise<{
gas: undefined | BigNumber | "unaccounted";
packed: string;
}>
Parameters
- data: PackDataParams
  Data to pack
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<{
gas: undefined | BigNumber | "unaccounted";
packed: string;
}>
Description
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.

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

preapplyOperations

preapplyOperations(ops, options?): Promise<PreapplyResponse[]>
Parameters
- ops: PreapplyParams
  Operations to apply
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block and version
Returns Promise<PreapplyResponse[]>
Description
Simulate the application of the operations with the context of the given block and return the result of each operation application

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

runCode

runCode(code, options?): Promise<RunCodeResult>
Parameters
- code: RPCRunCodeParam
  Code to run
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block (default to head)
Returns Promise<RunCodeResult>
Description
Run a Michelson script in the current context

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

runOperation

runOperation(op, options?): Promise<PreapplyResponse>
Parameters
- op: RPCRunOperationParam
  Operation to run
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block and version
Returns Promise<PreapplyResponse>
Deprecated
Deprecated in favor of simulateOperation

Description
Run an operation with the context of the given block and without signature checks and return the operation application result, including the consumed gas.

See
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
Implementation of RpcClientInterface.runOperation
- Defined in packages/taquito-rpc/src/taquito-rpc.ts:954

runScriptView

runScriptView(viewScriptParams, options?): 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)
Returns Promise<RunScriptViewResult>
Description
Simulate a call to a michelson view

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

runView

runView(viewParams, options?): 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)
Returns Promise<RunViewResult>
Description
Simulate a call to a view following the TZIP-4 standard.

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

simulateOperation

simulateOperation(op, options?): Promise<PreapplyResponse>
Parameters
- op: RPCSimulateOperationParam
  Operation to simulate
- options: RPCOptions = defaultRPCOptions
  contains generic configuration for rpc calls to specified block and version
Returns Promise<PreapplyResponse>
Description
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.

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

Class RpcClient

Description

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>

Description

See

getAdaptiveIssuanceLaunchCycle

Parameters

block: string

Returns Promise<AILaunchCycleResponse>

Description

See

getAllDelegates

Parameters

block: string

Returns Promise<string[]>

Description

See

getAllTicketBalances

Parameters

block: string

Returns Promise<AllTicketBalances>

Description

See

getAttestationRights

Parameters

Returns Promise<AttestationRightsResponse>

Description

See

getBakingRights

Parameters

Returns Promise<BakingRightsResponse>

Description

See

getBalance

Parameters

Returns Promise<BigNumber>

Description

See

getBalanceAndFrozenBonds

Parameters

Returns Promise<BigNumber>

Description

See

getBallotList

Parameters

Returns Promise<BallotListResponse>

Description

See

getBallots

Parameters

Returns Promise<BallotsResponse>

Description

See

getBigMapExpr

Parameters

block: string

Returns Promise<BigMapResponse>

Description

See

getBigMapKey

`Protected`chain

`Protected`httpBackend

`Protected`url

`Protected`createURL