Legend:
Library
Module
Module type
Parameter
Class
Class type
RPCs for octez-node
Naming Conventions
Functions in this module are named after the RPC they implement.
The name starts with the HTTP verb, in lowercase, followed by an underscore. E.g. get_ for GET, patch_ for PATCH, delete_ for DELETE, etc.
Then the name contains all constant parts of the endpoint path, separated by underscores. E.g. chain_levels_caboose for GET /chains/<chain>/levels/caboose. The dynamic part <chain> is dropped (it becomes an argument of the function).
When a word is plural, it becomes singular if the RPC selects one element. For instance, GET /network/connections becomes get_network_connections because it returns all elements of the list, but GET /network/connections/<peer_id> becomes get_network_connection because it returns only one connection. This allows to differentiate the two RPCs. Another example is GET /chains/<chain>/blocks/<block>/metadata which becomes get_chain_block_metadata since it selects one block. Another example is GET /chains/<chain>/levels/checkpoint which becomes get_chain_level_checkpoint, which illustrates that the selector (here checkpoint) does not need to be dynamic for this rule to apply.
Submodules are not used. Do not group all /network RPCs in a Network submodule for instance.
val post_private_injection_operations :
?use_tmp_file:bool ->?force:bool ->?async:bool ->ops:Hex.t list->unit ->[ `OpHash of string ] listt
RPC: POST /private/injection/operations
Returns the hashes of the operations that were injected.
use_tmp_file defaults to false. Set use_tmp_file to inject large operations or many operations. Otherwise, the injection may fail as a command line argument can only handle a limited number of characters. force default to falseasync default to false
val post_injection_operation : ?async:bool ->data->Tezt_wrapper.JSON.t t
RPC: POST /injection/operation
val post_private_injection_operation :
?async:bool ->data->Tezt_wrapper.JSON.t t
RPC: POST /private/injection/operation
val post_chain_block_helpers_scripts_run_operation :
?chain:string ->?block:string ->?version:string ->?async:bool ->data->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/scripts/run_operation
Tries to validate and apply the operation represented by the given json, directly on top of the block. Only skips signature checks. If successful, returns the operation together with the metadata produced by its application.
chain defaults to "main". block defaults to "head".
val get_chain_chain_id : ?chain:string ->unit ->string t
RPC: GET /chains/<chain>/chain_id
Returns the chain ID.
val get_chain_block :
?chain:string ->?block:string ->?version:string ->?force_metadata:bool ->?metadata:[ `Always | `Never ]->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>
chain defaults to "main". block defaults to "head".
type balance_update = {
kind : string;
category : string option;
}
type block_metadata = {
protocol : string;
next_protocol : string;
proposer : string;
max_operations_ttl : int;
dal_attestation : bool Stdlib.Array.t option;
(*
This field is None if and only if the DAL feature flag is disabled.
val post_injection_block : data:data->Tezt_wrapper.JSON.t t
RPC: POST /injection/block
val get_chain_block_header_protocol_data_raw :
?chain:string ->?block:string ->unit ->string t
RPC: GET /chains/<chain>/blocks/<block>/header/protocol_data/raw
chain defaults to "main". block defaults to "head".
RPC: GET /chains/<chain>/blocks/<block>/header/protocol_data
chain defaults to "main". block defaults to "head". offset defaults to 0.
val get_chain_block_header_protocol_data :
?chain:string ->?block:string ->?offset:int ->unit ->Tezt_wrapper.JSON.t t
val get_chain_block_operations :
?chain:string ->?block:string ->?version:string ->?force_metadata:bool ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/operations
chain defaults to "main". block defaults to "head".
val get_chain_block_operations_validation_pass :
?chain:string ->?block:string ->?version:string ->?force_metadata:bool ->?operation_offset:int ->validation_pass:int ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/operations/<validation_pass> if operation_offset is unset
Otherwise, RPC: GET /chains/<chain>/blocks/<block>/operations/<validation_pass>/<operation_offset>
chain defaults to "main". block defaults to "head". force_metadata defaults to false.
val get_chain_mempool_pending_operations :
?chain:string ->?version:string ->?validated:bool ->?branch_delayed:bool ->?branch_refused:bool ->?refused:bool ->?outdated:bool ->?validation_passes:int list->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/mempool/pending_operations
chain defaults to "main".
val get_chain_mempool_monitor_operations :
?chain:string ->?version:string ->?validated:bool ->?branch_delayed:bool ->?branch_refused:bool ->?refused:bool ->?outdated:bool ->?validation_passes:int list->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/mempool/monitor_operations
chain defaults to "main".
val post_chain_mempool_request_operations :
?chain:string ->?peer:string ->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/mempool/request_operations
chain defaults to "main".
val post_chain_mempool_ban_operation :
?chain:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/mempool/ban_operation
chain defaults to "main".
val post_chain_mempool_unban_operation :
?chain:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/mempool/unban_operation
chain defaults to "main".
val post_chain_mempool_unban_all_operations :
?chain:string ->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/mempool/unban_all_operations
chain defaults to "main".
val get_chain_mempool_filter :
?chain:string ->?include_default:bool ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/mempool/filter
chain defaults to "main".
val post_chain_mempool_filter :
?chain:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/mempool/filter
chain defaults to "main".
val post_chain_block_helpers_preapply_block :
?chain:string ->?block:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/preapply/block
chain defaults to "main". block defaults to "head".
val post_chain_block_helpers_preapply_operations :
?chain:string ->?block:string ->?version:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/preapply/operations
chain defaults to "main". block defaults to "head".
val post_chain_block_helpers_forge_operations :
?chain:string ->?block:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/forge/operations
chain defaults to "main". block defaults to "head".
val post_chain_block_helpers_forge_block_header :
?chain:string ->?block:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/forge_block_header
chain defaults to "main". block defaults to "head".
val post_chain_block_helpers_parse_operations :
?chain:string ->?block:string ->?check_signature:bool ->?version:string ->Tezt_wrapper.JSON.u ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/parse/operations
chain defaults to "main". block defaults to "head". check_signature defaults to true.
val post_chain_block_helpers_scripts_simulate_operation :
?chain:string ->?block:string ->?version:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/scripts/simulate_operation
chain defaults to "main". block defaults to "head".
val post_chain_block_helpers_scripts_event_address :
?chain:string ->?block:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC: POST /chains/<chain>/blocks/<block>/helpers/scripts/event_address
chain defaults to "main". block defaults to "head".
type ctxt_type =
| Bytes
| Json
val get_chain_block_context_raw :
?chain:string ->?block:string ->?ctxt_type:ctxt_type->?depth:int ->value_path:string list->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/raw/<ctxt_type>/<value_path>
chain defaults to "main". block defaults to "head". ctxt_type defaults to Json.
val get_chain_block_context_raw_bytes :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/raw/bytes
chain defaults to "main". block defaults to "head".
val get_chain_block_context_cache_contracts_all :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/cache/contracts/all
chain defaults to "main". block defaults to "head".
val get_chain_block_context_constants :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/constants
chain defaults to "main". block defaults to "head".
val get_chain_block_context_constants_errors :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/constants/errors
chain defaults to "main". block defaults to "head".
val get_chain_block_context_constants_parametric :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/constants/parametric
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_storage_used_space :
?chain:string ->?block:string ->string ->int t
RPC: GET /chains/<chain>/blocks/<block>/context/contracts/<contract>/storage/used_space
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_storage_paid_space :
?chain:string ->?block:string ->string ->int t
RPC: GET /chains/<chain>/blocks/<block>/context/contracts/<contract>/storage/paid_space
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_staking_numerator :
?chain:string ->?block:string ->string ->int t
RPC: GET /chains/<chain>/blocks/<block>/context/contracts/<contract>/storage/staking_numerator
chain defaults to "main". block defaults to "head".
val get_chain_block_helper_baking_rights :
?chain:string ->?block:string ->?delegate:string ->?level:int ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/helpers/baking_rights
chain defaults to "main". block defaults to "head".
type level = {
level : int;
level_position : int;
cycle : int;
cycle_position : int;
expected_commitment : bool;
}
val get_chain_block_helper_current_level :
?chain:string ->?block:string ->?offset:int ->unit ->levelt
RPC: GET /chains/<chain>/blocks/<block>/helpers/current_level
chain defaults to "main". block defaults to "head". offset defaults to 0.
val get_chain_block_helper_attestation_rights :
?chain:string ->?block:string ->?delegate:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/helpers/attestation_rights
chain defaults to "main". block defaults to "head".
val get_chain_block_helper_endorsing_rights :
?chain:string ->?block:string ->?delegate:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/helpers/endorsing_rights
chain defaults to "main". block defaults to "head".
val get_chain_block_helper_validators :
?chain:string ->?block:string ->?delegate:string ->?level:int ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/helpers/validators
chain defaults to "main". block defaults to "head".
val get_chain_block_helper_levels_in_current_cycle :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/helpers/levels_in_current_cycle
chain defaults to "main". block defaults to "head".
Big maps RPC module
val get_chain_block_context_big_map :
?chain:string ->?block:string ->id:string ->key_hash:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/big_maps/<id>/<key_hash>
chain defaults to "main". block defaults to "head".
val get_chain_block_context_big_maps :
?chain:string ->?block:string ->id:string ->?offset:int ->?length:int ->unit ->Tezt_wrapper.JSON.t t
RPC: GET /chains/<chain>/blocks/<block>/context/big_maps/<id>?offset=<offset>&length=<length>
chain defaults to "main". block defaults to "head".
Contracts RPC module
val get_chain_block_context_contracts :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_balance :
?chain:string ->?block:string ->id:string ->unit ->Tez.tt
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/balance
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_frozen_bonds :
?chain:string ->?block:string ->id:string ->unit ->Tez.tt
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/frozen_bonds
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_balance_and_frozen_bonds :
?chain:string ->?block:string ->id:string ->unit ->Tez.tt
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/balance_and_frozen_bonds
chain defaults to "main". block defaults to "head".
val post_chain_block_context_contract_big_map_get :
?chain:string ->?block:string ->id:string ->data:data->unit ->Tezt_wrapper.JSON.t t
RPC POST /chains/<chain>/blocks/<block>/context/contracts/<id>/big_map_get
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_counter :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/counter
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_delegate :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/delegate
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_entrypoints :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/entrypoints
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_manager_key :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/manager_key
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_script :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/script
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_storage :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC GET /chains/<chain>/blocks/<block>/context/contracts/<id>/storage
chain defaults to "main". block defaults to "head".
val post_chain_block_context_contract_ticket_balance :
?chain:string ->?block:string ->id:string ->data:data->unit ->int t
RPC POST /chains/<chain>/blocks/<block>/context/contracts/<id>/ticket_balance
chain defaults to "main". block defaults to "head".
val get_chain_block_context_contract_all_ticket_balances :
?chain:string ->?block:string ->id:string ->unit ->Tezt_wrapper.JSON.t t
RPC POST /chains/<chain>/blocks/<block>/context/contracts/<id>/all_ticket_balances
chain defaults to "main". block defaults to "head".
Smart rollup RPC module
val get_chain_block_context_smart_rollups_all :
?chain:string ->?block:string ->unit ->string listt
RPC: GET chains/<chain>/blocks/<block>/context/smart_rollups/all
val get_chain_block_context_smart_rollups_smart_rollup_staker_games :
?chain:string ->?block:string ->staker:string ->string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET chains/<chain>/blocks/<block>/context/smart_rollups/smart_rollup/<smart_rollup_address>/staker/<staker>/games
val get_chain_block_context_smart_rollups_all_inbox :
?chain:string ->?block:string ->unit ->Tezt_wrapper.JSON.t t
RPC: GET chains/<chain>/blocks/<block>/context/smart_rollups/all/inbox
val get_chain_block_context_smart_rollups_smart_rollup_genesis_info :
?chain:string ->?block:string ->string ->Tezt_wrapper.JSON.t t
RPC: GET chains/<chain>/blocks/<block>/context/smart_rollups/smart_rollup/<smart_rollup_address>/genesis_info
val get_chain_block_context_smart_rollups_smart_rollup_last_cemented_commitment_hash_with_level :
?chain:string ->?block:string ->string ->Tezt_wrapper.JSON.t t
RPC: GET chains/<chain>/blocks/<block>/context/smart_rollups/smart_rollup/<smart_rollup_address>/get_last_cemented_commitment_hash_with_level
val get_chain_block_context_smart_rollups_smart_rollup_commitment :
?chain:string ->?block:string ->sc_rollup:string ->hash:string ->unit ->Sc_rollup_rpc.commitment optiont
RPC: GET chains/<chain>/blocks/<block>/context/smart_rollups/smart_rollup/<smart_rollup_address>/commitment/<hash>
val get_chain_block_context_smart_rollups_smart_rollup_staker_staked_on_commitment :
?chain:string ->?block:string ->sc_rollup:string ->string ->Tezt_wrapper.JSON.t t