package tezos-protocol-013-PtJakart
include Sc_rollup_PVM_sem.S
with type context = Tezos_protocol_environment_013_PtJakart.Context.t
During interactive rejection games, a player may need to provide a proof that a given execution step is valid.
val proof_encoding :
proof Tezos_protocol_environment_013_PtJakart.Data_encoding.ttype context = Tezos_protocol_environment_013_PtJakart.Context.tA state is initialized in a given context.
type hash = Alpha_context.Sc_rollup.State_hash.tA commitment hash characterized the contents of the state.
proof_start_state proof returns the initial state hash of the proof execution step.
proof_stop_state proof returns the final state hash of the proof execution step.
val state_hash : state -> hash Tezos_protocol_environment_013_PtJakart.Lwt.tstate_hash state returns a compressed representation of state.
val initial_state :
context ->
string ->
state Tezos_protocol_environment_013_PtJakart.Lwt.tinitial_state context is the state of the PVM before booting. It must be such that state_hash state = Commitment_hash.zero. Any context should be enough to create an initial state.
val is_input_state :
state ->
(Alpha_context.Raw_level.t * Tezos_protocol_environment_013_PtJakart.Z.t)
option
Tezos_protocol_environment_013_PtJakart.Lwt.tis_input_state state returns Some (level, counter) if state is waiting for the input message that comes next to the message numbered counter in the inbox of a given level.
val set_input :
Sc_rollup_PVM_sem.input ->
state ->
state Tezos_protocol_environment_013_PtJakart.Lwt.tset_input level n msg state sets msg in state as the next message to be processed. This input message is assumed to be the number n in the inbox messages at the given level. The input message must be the message next to the previous message processed by the rollup.
val eval : state -> state Tezos_protocol_environment_013_PtJakart.Lwt.teval s0 returns a state s1 resulting from the execution of an atomic step of the rollup at state s0.
val verify_proof :
input:Sc_rollup_PVM_sem.input option ->
proof ->
bool Tezos_protocol_environment_013_PtJakart.Lwt.tverify_proof input proof returns true iff the proof is valid. If the state is an input state, input is the hash of the input message externally provided to the evaluation function.
parse_boot_sector s builds a boot sector from its human writable description.
val pp_boot_sector :
Tezos_protocol_environment_013_PtJakart.Format.formatter ->
string ->
unitpp_boot_sector fmt s prints a human readable representation of a boot sector.
val pp :
state ->
(Tezos_protocol_environment_013_PtJakart.Format.formatter ->
unit ->
unit)
Tezos_protocol_environment_013_PtJakart.Lwt.tpp state returns a pretty-printer valid for state.
val get_tick :
state ->
Alpha_context.Sc_rollup.Tick.t Tezos_protocol_environment_013_PtJakart.Lwt.tget_tick state returns the current tick of state.
The machine has three possible states:
val get_status : state -> status Tezos_protocol_environment_013_PtJakart.Lwt.tget_status state returns the machine status in state.
The machine has only two instructions.
val equal_instruction : instruction -> instruction -> boolequal_instruction i1 i2 is true iff i1 equals i2.
val pp_instruction :
Tezos_protocol_environment_013_PtJakart.Format.formatter ->
instruction ->
unitpp_instruction fmt i shows a human readable representation of i.
val get_parsing_result :
state ->
bool option Tezos_protocol_environment_013_PtJakart.Lwt.tget_parsing_result state is Some true if the current message is syntactically correct, Some false when it contains a syntax error, and None when the machine is not in parsing state.
val get_code :
state ->
instruction list Tezos_protocol_environment_013_PtJakart.Lwt.tget_code state returns the current code obtained by parsing the current input message.
val get_stack : state -> int list Tezos_protocol_environment_013_PtJakart.Lwt.tget_stack state returns the current stack.
val get_evaluation_result :
state ->
bool option Tezos_protocol_environment_013_PtJakart.Lwt.tget_evaluation_result state returns Some true if the current message evaluation succeeds, Some false if it failed, and None if the evaluation has not been done yet.
val get_is_stuck :
state ->
string option Tezos_protocol_environment_013_PtJakart.Lwt.tget_is_stuck state returns Some err if some internal error made the machine fail during the last evaluation step. None if no internal error occurred. When a machine is stuck, it reboots, waiting for the next message to process.