package tezos-protocol-alpha
include Sc_rollup_PVM_sig.S
with type context = unit
with type state = minimal_state
with type proof = void
type state = minimal_state
The state of the PVM denotes a state of the rollup.
The life cycle of the PVM is as follows. It starts its execution from an initial_state
. The initial state is specialized at origination with a boot_sector
, using the install_boot_sector
function. The resulting state is call the “genesis” of the rollup.
Afterwards, we classify states into two categories: "internal states" do not require any external information to be executed while "input states" are waiting for some information from the inbox to be executable.
val pp :
state ->
(Tezos_protocol_environment_alpha.Format.formatter ->
unit ->
unit)
Tezos_protocol_environment_alpha.Lwt.t
A context
represents the executable environment needed by the state to exist. Typically, the rollup node storage can be part of this context to allow the PVM state to be persistent.
type hash = Sc_rollup_repr.State_hash.t
A hash
characterizes the contents of a state.
type proof = void
During interactive refutation games, a player may need to provide a proof that a given execution step is valid. The PVM implementation is responsible for ensuring that this proof type has the correct semantics.
A proof p
has four parameters:
start_hash := proof_start_state p
stop_hash := proof_stop_state p
input_requested := proof_input_requested p
input_given := proof_input_given p
The following predicate must hold of a valid proof:
exists start_state, stop_state.
(state_hash start_state == start_hash)
AND (Option.map state_hash stop_state == stop_hash)
AND (is_input_state start_state == input_requested)
AND (match (input_given, input_requested) with
| (None, No_input_required) -> eval start_state == stop_state
| (None, Initial) -> stop_state == None
| (None, First_after (l, n)) -> stop_state == None
| (Some input, No_input_required) -> true
| (Some input, Initial) ->
set_input input_given start_state == stop_state
| (Some input, First_after (l, n)) ->
set_input input_given start_state == stop_state)
In natural language---the two hash parameters start_hash
and stop_hash
must have actual state
values (or possibly None
in the case of stop_hash
) of which they are the hashes. The input_requested
parameter must be the correct request from the start_hash
, given according to is_input_state
. Finally there are four possibilities of input_requested
and input_given
.
- if no input is required, or given, the proof is a simple
eval
step ; - if input was required but not given, the
stop_hash
must beNone
(the machine is blocked) ; - if no input was required but some was given, this makes no sense and it doesn't matter if the proof is valid or invalid (this case will be ruled out by the inbox proof anyway) ;
- finally, if input was required and given, the proof is a
set_input
step.
val proof_encoding : proof Tezos_protocol_environment_alpha.Data_encoding.t
proof
s are embedded in L1 refutation game operations using proof_encoding
. Given that the size of L1 operations are limited, it is of *critical* importance to make sure that no execution step of the PVM can generate proofs that do not fit in L1 operations when encoded. If such a proof existed, the rollup could get stuck.
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_alpha.Lwt.t
state_hash state
returns a compressed representation of state
.
val initial_state : empty:state -> state Tezos_protocol_environment_alpha.Lwt.t
initial_state ~empty
is the initial state of the PVM, before its specialization with a given boot_sector
. The initial state is built on the empty
state which must be provided.
val install_boot_sector :
state ->
string ->
state Tezos_protocol_environment_alpha.Lwt.t
install_boot_sector state boot_sector
specializes the initial state
of a PVM using a dedicated boot_sector
, submitted at the origination of the rollup.
val is_input_state :
is_reveal_enabled:Sc_rollup_PVM_sig.is_reveal_enabled ->
state ->
Sc_rollup_PVM_sig.input_request Tezos_protocol_environment_alpha.Lwt.t
is_input_state ~is_reveal_enabled state
returns the input expectations of the state
---does it need input, and if so, how far through the inbox has it read so far?
val set_input :
Sc_rollup_PVM_sig.input ->
state ->
state Tezos_protocol_environment_alpha.Lwt.t
set_input input state
sets input
in state
as the next input to be processed. This must answer the input_request
from is_input_state state
.
val eval : state -> state Tezos_protocol_environment_alpha.Lwt.t
eval s0
returns a state s1
resulting from the execution of an atomic step of the rollup at state s0
.
val verify_proof :
is_reveal_enabled:Sc_rollup_PVM_sig.is_reveal_enabled ->
Sc_rollup_PVM_sig.input option ->
proof ->
Sc_rollup_PVM_sig.input_request
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
verify_proof ~is_reveal_enabled input p
checks the proof p
with input input
and returns the input_request
before the evaluation of the proof. See the doc-string for the proof
type.
verify_proof input p
fails when the proof is invalid in regards to the given input.
val produce_proof :
context ->
is_reveal_enabled:Sc_rollup_PVM_sig.is_reveal_enabled ->
Sc_rollup_PVM_sig.input option ->
state ->
proof Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
produce_proof ctxt ~is_reveal_enabled input_given state
should return a proof
for the PVM step starting from state
, if possible. This may fail for a few reasons:
- the
input_given
doesn't match the expectations ofstate
; - the
context
for this instance of the PVM doesn't have access to enough of thestate
to build the proof.
The following type is inhabited by the proofs that a given output
is part of the outbox of a given state
.
val output_proof_encoding :
output_proof Tezos_protocol_environment_alpha.Data_encoding.t
output_proof_encoding
encoding value for output_proof
s.
val output_of_output_proof : output_proof -> Sc_rollup_PVM_sig.output
output_of_output_proof proof
returns the output
that is referred to in proof
's statement.
val state_of_output_proof : output_proof -> hash
state_of_output_proof proof
returns the state
hash that is referred to in proof
's statement.
val verify_output_proof :
output_proof ->
Sc_rollup_PVM_sig.output
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t
verify_output_proof output_proof
returns the output_proof
's output iff the proof is a valid witness that its output
is part of its state
's outbox.
val produce_output_proof :
context ->
state ->
Sc_rollup_PVM_sig.output ->
(output_proof, Tezos_protocol_environment_alpha.Error_monad.error)
Tezos_protocol_environment_alpha.Pervasives.result
Tezos_protocol_environment_alpha.Lwt.t
produce_output_proof ctxt state output
returns a proof that witnesses the fact that output
is part of state
's outbox.
val check_dissection :
default_number_of_sections:int ->
start_chunk:Sc_rollup_dissection_chunk_repr.t ->
stop_chunk:Sc_rollup_dissection_chunk_repr.t ->
Sc_rollup_dissection_chunk_repr.t list ->
unit Tezos_protocol_environment_alpha.Error_monad.tzresult
check_dissection ~default_number_of_sections ~start_chunk
~stop_chunk chunks
fails if the dissection encoded by the list [start_chunk] @ chunks @ [stop_chunk]
does not satisfy the properties expected by the PVM.
val get_current_level :
state ->
Raw_level_repr.t option Tezos_protocol_environment_alpha.Lwt.t
get_current_level state
returns the current level of the state
, returns None
if it is not possible to compute the level.
module Internal_for_tests : sig ... end
val pp_boot_sector :
Tezos_protocol_environment_alpha.Format.formatter ->
string ->
unit