rpcClient responsible of the interaction with Tezos network through an rpc node
number representing the time to live (default 1000 milliseconds)
new RpcClientCache(new RpcClient('https://mainnet.ecadinfra.com/'))
operation contents to forge
contains generic configuration for rpc calls to specified block (default to head)
Forge an operation returning the unsigned bytes
https://tezos.gitlab.io/api/rpc.html#post-block-id-helpers-forge-operations
originated address we want to retrieve ticket balances of
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.
https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
contains optional query arguments (level, cycle, delegate, and consensus_key)
contains generic configuration for rpc calls to specified block (default to head)
Retrieves the delegates allowed to attest a block
https://tezos.gitlab.io/api/rpc.html#get-block-id-helpers-endorsing-rights
contains optional query arguments (level, cycle, delegate, consensus_key, and max_round)
contains generic configuration for rpc calls to specified block (default to head)
Retrieves the list of delegates allowed to bake a block.
https://tezos.gitlab.io/api/rpc.html#get-block-id-helpers-baking-rights
address from which we want to retrieve the balance
contains generic configuration for rpc calls to specified block (default to head)
Access the spendable balance of a contract, excluding frozen bonds
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-balance
contains generic configuration for rpc calls to specified block (default to head)
Ballots casted so far during a voting period
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-ballot-list
contains generic configuration for rpc calls to specified block (default to head)
Sum of ballots casted so far during a voting period
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-ballots
Big Map ID
Expression hash to query (A b58check encoded Blake2b hash of the expression (The expression can be packed using the pack_data method))
contains generic configuration for rpc calls to specified block (default to head)
Access the value associated with a key in a big map.
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
contract address from which we want to retrieve the big map key
Deprecated in favor of getBigMapKeyByID
Access the value associated with a key in the big map storage of the contract.
https://tezos.gitlab.io/api/rpc.html#post-block-id-context-contracts-contract-id-big-map-get
contains generic configuration for rpc calls to specified block (default to head) and version.
All the information about a block
https://tezos.gitlab.io/api/rpc.html#get-block-id
getBlock() will default to `/main/chains/block/head?version=0` which shows { kind: endorsement }
getBlock({ block: 'head~2', version: 1 }) will return an offset of 2 from head blocks and shows { kind: attestation }
getBlock({ block: 'BL8fTiWcSxWCjiMVnDkbh6EuhqVPZzgWheJ2dqwrxYRm9AephXh~2' }) will return an offset of 2 blocks from given block hash..
contains generic configuration for rpc calls to specified block (default to head)
Get the block's hash, its unique identifier.
contains generic configuration for rpc calls to specified block (default to head)
contains generic configuration for rpc calls to specified block (default to head) and version
All the metadata associated to the block
contains generic configuration for rpc calls to specified block (default to head)
contract address from which we want to retrieve
contains generic configuration for rpc calls to specified block (default to head)
Access the complete status of a contract.
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id
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
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-current-period
contains generic configuration for rpc calls to specified block (default to head)
Current proposal under evaluation.
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-current-proposal
contains generic configuration for rpc calls to specified block (default to head)
Current expected quorum.
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-current-quorum
contract address from which we want to retrieve the delegate (baker)
contains generic configuration for rpc calls to specified block (default to head)
Access the delegate of a contract, if any
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-delegate
delegate address which we want to retrieve
contains generic configuration for rpc calls to specified block (default to head)
Everything about a delegate
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-delegates-pkh
contains optional query arguments (level, cycle, delegate, and consensus_key)
contains generic configuration for rpc calls
Deprecated in favor of getAttestationRights
Retrieves the delegates allowed to endorse a block
https://tezos.gitlab.io/api/rpc.html#get-block-id-helpers-endorsing-rights
address of the contract we want to get the entrypoints of
contains generic configuration for rpc calls to specified block (default to head)
Return the list of entrypoints of the contract
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-entrypoints
005_PsBABY5H
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.
https://tezos.gitlab.io/api/rpc.html#get-block-id-live-blocks
contract address from which we want to retrieve the manager
contains generic configuration for rpc calls to specified block (default to head)
Access the manager of an implicit contract
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-manager-key
contract address from which we want to retrieve the script
default is { unparsing_mode: "Readable" }
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.
has 5 optional properties. We support version 1 as default will output { applied: { kind: endorsement} } version 2 will output { validated: { kind: attestation} }. The rest of the properties is to filter pending operations response
List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
args { version: '1', applied: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
https://tezos.gitlab.io/CHANGES.html?highlight=pending_operations#id4
contains generic configuration for rpc calls to specified block (default to head)
List of proposals with number of supporters
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-proposals
contains generic configuration for rpc calls to specified block (default to head)
get current and next protocol
https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
address of the contract we want to get the sapling diff
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
Sapling state ID
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
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-sapling-sapling-state-id-get-diff
contract address from which we want to retrieve the script
contains generic configuration for rpc calls to specified block (default to head)
Access the code and data of the contract.
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-script
contract address from which we want to retrieve the storage
contains generic configuration for rpc calls to specified block (default to head)
Access the data of the contract.
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-storage
address of the contract we want to retrieve storage information of
contains generic configuration for rpc calls to specified block (default to head) = *
Access the paid storage space of the contract
https://tezos.gitlab.io/lima/rpc.html#get-block-id-context-contracts-contract-id-storage
address of the contract we want to retrieve storage information of
contains generic configuration for rpc calls to specified block (default to head)
Access the used storage space of the contract
https://tezos.gitlab.io/lima/rpc.html#get-block-id-context-contracts-contract-id-storage
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
getSuccessorPeriod() will default to successor voting period for /main/chains/block/head.
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-successor-period
implicit or originated address we want to retrieve ticket balance of
object to specify a ticket by ticketer, content type and content
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.
ticket { ticketer: 'address', content_type: { prim: "string" }, content: { string: 'ticket1' } }
https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
contains generic configuration for rpc calls to specified block (default to head)
List of delegates with their voting power
https://tezos.gitlab.io/api/rpc.html#get-block-id-votes-listings
delegate address which we want to retrieve
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
https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-voting-info
signed bytes to inject
Inject an operation in node and broadcast it and return the ID of the operation
https://tezos.gitlab.io/api/rpc.html#post-injection-operation
Data to pack
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.
packData({ data: { string: "test" }, type: { prim: "string" } })
https://tezos.gitlab.io/api/rpc.html#post-block-id-helpers-scripts-pack-data
Operations to apply
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
https://tezos.gitlab.io/api/rpc.html#post-block-id-helpers-preapply-operations
Code to run
contains generic configuration for rpc calls to specified block (default to head)
Run a Michelson script in the current context
https://tezos.gitlab.io/api/rpc.html#post-block-id-helpers-scripts-run-code
Operation to run
contains generic configuration for rpc calls to specified block and version
Deprecated in favor of simulateOperation
Run an operation with the context of the given block and without signature checks and return the operation application result, including the consumed gas.
https://tezos.gitlab.io/api/rpc.html#post-block-id-helpers-scripts-run-operation
Parameters of the script view to run
contains generic configuration for rpc calls to specified block (default to head)
Simulate a call to a michelson view
Parameters of the view to run
contains generic configuration for rpc calls to specified block (default to head)
Simulate a call to a view following the TZIP-4 standard. See https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-4/tzip-4.md#view-entrypoints.
Operation to simulate
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.
https://gitlab.com/tezos/tezos/-/blob/master/docs/api/oxford-openapi.json
Generated using TypeDoc
Description
RpcClientCache acts as a decorator over the RpcClient instance by caching responses for the period defined by the ttl.