package tezt-tezos

  1. Overview
  2. Docs
val get_global_block_ticks : ?block:string -> unit -> int RPC_core.t

RPC: GET global/block/<block>/ticks gets the number of ticks for the PVM for the block (default "head").

val get_global_block_state_hash : ?block:string -> unit -> string RPC_core.t

RPC: GET global/block/<block>/state_hash gets the corresponding PVM state hash for the block (default "head").

val get_global_block_total_ticks : ?block:string -> unit -> int RPC_core.t

RPC: GET global/block/<block>/total_ticks gets the total number of ticks for the PVM.

val get_global_block_state_current_level : ?block:string -> unit -> int RPC_core.t

RPC: GET global/block/<block>/state_current_level gets the corresponding PVM state current level for the block (default "head").

val get_global_block_status : ?block:string -> unit -> string RPC_core.t

RPC: GET global/block/<block>/status gets the corresponding PVM status for the block (default "head").

val get_global_block_outbox : ?block:string -> outbox_level:int -> unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/block/<block>/outbox/<outbox_level>/messages gets the rollup outbox of outbox_level as known to the block (default "cemented" which is the block corresponding to the last cemented level).

val get_global_smart_rollup_address : unit -> string RPC_core.t

RPC: GET global/smart_rollup_address returns the smart contract rollup address of the node.

val get_global_block : ?block:string -> unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/block/<block>.

val get_global_block_inbox : ?block:string -> unit -> RPC.smart_rollup_inbox RPC_core.t

RPC: GET global/block/<block>/inbox.

val get_global_block_hash : ?block:string -> unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/block/<block>/hash.

val get_global_block_level : ?block:string -> unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/block/<block>/level.

val get_global_block_num_messages : ?block:string -> unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/block/<block>/num_messages.

val get_global_tezos_head : unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/tezos_head.

val get_global_tezos_level : unit -> Tezt_wrapper.JSON.t RPC_core.t

RPC: GET global/tezos_level.

type slot_header = {
  1. level : int;
  2. commitment : string;
  3. index : int;
}
val get_global_block_dal_slot_headers : ?block:string -> unit -> slot_header list RPC_core.t

RPC: GET global/block/<block>/dal/slot_headers returns the dal slot headers of the block (default "head").

val get_local_batcher_queue : unit -> (string * string) list RPC_core.t

RPC: GET local/batcher/queue returns the queue of messages, as pairs of message id and binary message, in the batcher.

val get_local_batcher_queue_msg_id : msg_id:string -> (string * string) RPC_core.t

RPC: GET local/batcher/queue/<msg_id> fetches the message whose id is msg_id from the queue. It returns the message together with the full JSON response including the status.

type simulation_result = {
  1. state_hash : string;
  2. status : string;
  3. output : Tezt_wrapper.JSON.t;
  4. inbox_level : int;
  5. num_ticks : int;
  6. insights : string option list;
}
val post_global_block_simulate : ?block:string -> ?reveal_pages:string list -> ?insight_requests: [< `Durable_storage_key of string list | `Pvm_state_key of string list ] list -> string list -> simulation_result RPC_core.t

RPC: POST global/block/<block>/simulate simulates the evaluation of input messages for the rollup PVM at block (default "head"). reveal_pages can be used to provide data to be used for the revelation ticks. insight_request can be used to look at a list of keys in the PVM state after the simulation.

val get_global_block_dal_processed_slots : ?block:string -> unit -> (int * string) list RPC_core.t

RPC: GET global/block/<block>/dal/processed_slots returns the slots indices that have been marked by the rollup node as confirmed or unconfirmed for block block (default "head"), with their statuses.

type commitment_and_hash = {
  1. commitment : RPC.smart_rollup_commitment;
  2. hash : string;
}
type commitment_info = {
  1. commitment_and_hash : commitment_and_hash;
  2. first_published_at_level : int option;
  3. published_at_level : int option;
}
val commitment_info_from_json : Tezt_wrapper.JSON.t -> commitment_info

commitment_info_from_json parses a commitment, its hash and the levels when the commitment was first published (if any) and included, from the JSON representation.

val get_global_last_stored_commitment : unit -> commitment_and_hash RPC_core.t

RPC: GET global/last_stored_commitment gets the last commitment with its hash stored by the rollup node.

val get_local_last_published_commitment : unit -> commitment_info RPC_core.t

RPC: GET local/last_published_commitment gets the last commitment published by the rollup node, with its hash and level when the commitment was first published and the level it was included.

val get_local_commitments : commitment_hash:string -> unit -> commitment_info RPC_core.t

RPC: GET local/commitments gets commitment by its hash from the rollup node, with its hash and level when the commitment was first published and the level it was included.

type gc_info = {
  1. last_gc_level : int;
  2. first_available_level : int;
}
val get_local_gc_info : unit -> gc_info RPC_core.t

RPC: GET local/gc_info returns garbage collection information.

val get_global_block_state : ?block:string -> key:string -> unit -> bytes RPC_core.t

RPC: GET global/block/<block>/state gets the corresponding PVM state value mapped to key for the block (default "head").

type 'output_type durable_state_operation =
  1. | Value : string option durable_state_operation
  2. | Length : int64 option durable_state_operation
  3. | Subkeys : string list durable_state_operation
val get_global_block_durable_state_value : ?block:string -> pvm_kind:string -> operation:'a durable_state_operation -> key:string -> unit -> 'a RPC_core.t

RPC: GET global/block/<block>/durable/<pvm_kind>/<operation> gets the corresponding durable PVM state information (depending on operation) mapped to key for the block (default "head").

val post_local_batcher_injection : messages:string list -> string list RPC_core.t

RPC: POST local/batcher/injection injects the messages in the queue the rollup node's batcher and returns the list of message hashes injected.

type outbox_proof = {
  1. commitment_hash : string;
  2. proof : string;
}
val outbox_proof_simple : ?block:string -> outbox_level:int -> message_index:int -> unit -> outbox_proof option RPC_core.t

RPC: GET global/block/<block>/helpers/proofs/outbox/<outbox_level>/messages

OCaml

Innovation. Community. Security.