package octez-protocol-019-PtParisB-libs

  1. Overview
  2. Docs
package octez-protocol-019-PtParisB-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Tezos_019_PtParisB_test_helpers.Sc_rollup_helpersSource

Sourceval originated_rollup : Tezos_raw_protocol_019_PtParisB__Alpha_context.packed_operation -> Tezos_raw_protocol_019_PtParisB__Alpha_context.Contract.t
Sourcemodule Make_in_memory_context (Context : sig ... end) : sig ... end
Sourcemodule Wrong_in_memory_context : sig ... end
Sourcemodule Wrong_arith_pvm : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.PVM.S with type context = Wrong_in_memory_context.Tree.t and type state = Wrong_in_memory_context.tree and type proof = Tezos_context_memory.Context.Proof.tree Tezos_context_memory.Context.Proof.t
Sourceval genesis_commitment : boot_sector:string -> origination_level:Tezos_raw_protocol_019_PtParisB__Alpha_context.Raw_level.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Kind.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Commitment.t Lwt.t
Sourceval genesis_commitment_raw : boot_sector:string -> origination_level: Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollups.Kind.t -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_commitment_repr.t Lwt.t

Inbox message helpers.

Above Alpha_context.

Sourceval message_serialize : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.serialized
Sourceval make_external_inbox_message : string -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.serialized
Sourceval make_internal_inbox_message : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.internal_inbox_message -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.serialized
Sourceval make_input : ?inbox_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> ?message_counter:Tezos_protocol_environment_019_PtParisB.Z.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.serialized -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input
Sourceval make_external_input : ?inbox_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> ?message_counter:Tezos_protocol_environment_019_PtParisB.Z.t -> string -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input
Sourceval make_sol : inbox_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input
Sourceval make_eol : inbox_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> message_counter:Tezos_protocol_environment_019_PtParisB.Z.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input
Sourceval make_info_per_level : inbox_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> predecessor_timestamp:Tezos_protocol_environment_019_PtParisB.Time.t -> predecessor:Tezos_protocol_environment_019_PtParisB.Block_hash.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input
Sourceval make_protocol_migration : inbox_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input
Sourcetype message = {
  1. input : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input;
  2. message : [ `SOL | `Info_per_level of Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Timestamp.t * Tezos_base.TzPervasives.Block_hash.t | `Message of string | `EOL ];
}

Message is the combination of a message and its associated input.

message is used to:

  • Construct the protocol inbox, when message is `Message. The protocol adds `SOL and `EOL itself.
  • Construct the players' inboxes.

input is used to evaluate the players' inboxes.

Sourcetype payloads_per_level = {
  1. messages : string list;
    (*

    List of external messages.

    *)
  2. payloads : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.serialized list;
    (*

    List of external serialized messages.

    *)
  3. predecessor_timestamp : Tezos_base.TzPervasives.Time.Protocol.t;
    (*

    predecessor timestamp of the Info_per_level.

    *)
  4. predecessor : Tezos_base.TzPervasives.Block_hash.t;
    (*

    Predecessor of the Info_per_level.

    *)
  5. level : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.t;
  6. inputs : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input list;
    (*

    List of all inputs for the level, to be read by a PVM.

    *)
}

Put as much information as possible in this record so it can be used in different setups: 1. Creating an inbox on the protocol-side, requires messages only. 2. Re-construct an inbox, requires payloads, timestamp, predecessor. 3. Evaluate inputs in a PVM, requires inputs

level is useful for (1) (2) (3).

Sourceval pp_input : Format.formatter -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input -> unit
Sourceval pp_message : Format.formatter -> message -> unit
Sourceval strs_to_inputs : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> string list -> message list * Tezos_protocol_environment_019_PtParisB.Z.t

Creates inputs based on string messages.

Sourceval make_inputs : first_block:bool -> Tezos_protocol_environment_019_PtParisB.Time.t -> Tezos_protocol_environment_019_PtParisB.Block_hash.t -> string list -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input list

Transform the list of all inputs the PVM should read.

Sourceval predecessor_timestamp_and_hash_from_level : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> Tezos_base.TzPervasives.Time.Protocol.t * Tezos_base.TzPervasives.Block_hash.t
Sourceval wrap_messages : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> ?pred_info: (Tezos_base.TzPervasives.Time.Protocol.t * Tezos_base.TzPervasives.Block_hash.t) -> string list -> payloads_per_level

Wrap messages, predecessor_timestamp and predecessor of a level into a payloads_per_level .

Sourceval make_empty_level : ?pred_info: (Tezos_base.TzPervasives.Time.Protocol.t * Tezos_base.TzPervasives.Block_hash.t) -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> payloads_per_level

An empty inbox level is a SOL,IPL and EOL.

Sourceval gen_messages : ?pred_info: (Tezos_base.TzPervasives.Time.Protocol.t * Tezos_base.TzPervasives.Block_hash.t) -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> string QCheck2.Gen.t -> payloads_per_level QCheck2.Gen.t
Sourceval gen_payloads_for_levels : start_level:int -> max_level:int -> string QCheck2.Gen.t -> payloads_per_level list QCheck2.Gen.t

Below Alpha_context.

Sourceval message_serialize_repr : Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_inbox_message_repr.t -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_inbox_message_repr.serialized
Sourceval make_external_inbox_message_repr : string -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_inbox_message_repr.serialized
Sourceval make_internal_inbox_message_repr : Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_inbox_message_repr.internal_inbox_message -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_inbox_message_repr.serialized
Sourceval make_input_repr : ?inbox_level:Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> ?message_counter:Tezos_protocol_environment_019_PtParisB.Z.t -> Tezos_raw_protocol_019_PtParisB.Sc_rollup_inbox_message_repr.serialized -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_PVM_sig.input
Sourceval make_external_input_repr : ?inbox_level:Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> ?message_counter:Tezos_protocol_environment_019_PtParisB.Z.t -> string -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_PVM_sig.input
Sourceval make_sol_repr : inbox_level:Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_PVM_sig.input
Sourceval make_eol_repr : inbox_level:Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> message_counter:Tezos_protocol_environment_019_PtParisB.Z.t -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_PVM_sig.input
Sourcetype message_repr = {
  1. input_repr : Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_PVM_sig.input;
  2. message_repr : [ `SOL | `Message of string | `EOL ];
}

Message is the combination of a message and its associated input.

message is used to:

  • Construct the protocol inbox, when message is `Message. The protocol adds `SOL and `EOL itself.
  • Construct the players' inboxes.

input is used to evaluate the players' inboxes.

Sourceval pp_input_repr : Format.formatter -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_PVM_sig.input -> unit
Sourceval pp_message_repr : Format.formatter -> message_repr -> unit
Sourceval make_empty_level_repr : Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level * message_repr list

An empty inbox level is a SOL,IPL and EOL.

Sourceval strs_to_input_reprs_repr : Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> string list -> message_repr list * Tezos_protocol_environment_019_PtParisB.Z.t

Creates input_reprs based on string message_reprs.

Sourceval wrap_message_reprs_repr : Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level -> string list -> message_repr list

Transform message_reprs into input_reprs and wrap them between SOL and EOL.

Sourceval gen_message_reprs_for_levels_repr : start_level:int -> max_level:int -> string QCheck2.Gen.t -> (Tezos_protocol_019_PtParisB.Protocol.Raw_level_repr.raw_level * message_repr list) list QCheck2.Gen.t
Sourcemodule Payloads_histories : sig ... end
Sourcetype payloads_histories = Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_merkelized_payload_hashes.History.t Payloads_histories.t
Sourceval get_payloads_history : 'a Payloads_histories.t -> Payloads_histories.key -> 'a Lwt.t
Sourceval get_history : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.History.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.History.key -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.History.value option Lwt.t
Sourceval inbox_message_of_input : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.inbox_message option
Sourceval payloads_from_messages : message list -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox_message.serialized list
Sourceval first_after : payloads_per_level list -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.t -> Z.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.inbox_message option
Sourceval list_of_inputs_from_list_of_messages : message list list -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.input list list
Sourceval dumb_init : Tezos_raw_protocol_019_PtParisB__Alpha_context.Raw_level.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.t
Sourceval dumb_init_repr : Tezos_raw_protocol_019_PtParisB.Raw_level_repr.t -> Tezos_protocol_019_PtParisB.Protocol.Sc_rollup_inbox_repr.t
Sourceval origination_op : ?force_reveal:bool -> ?counter:Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Manager_counter.t -> ?fee:Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Tez.t -> ?gas_limit:Op.gas_limit -> ?storage_limit:Z.t -> ?boot_sector:string -> ?parameters_ty:string -> ?whitelist: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Whitelist.t -> Context.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Contract.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Kind.t -> (Tezos_protocol_019_PtParisB.Protocol.Alpha_context.packed_operation * Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.t) Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval latest_level_proof : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.t -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.Internal_for_tests.level_proof
Sourceval latest_level_proof_hash : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.t -> Tezos_raw_protocol_019_PtParisB__Alpha_context.Sc_rollup.Inbox_merkelized_payload_hashes.Hash.t
Sourcemodule Node_inbox : sig ... end
Sourcemodule Protocol_inbox : sig ... end
Sourceval construct_node_and_protocol_inbox : ?inbox_creation_level: Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Raw_level.raw_level -> ?genesis_predecessor_timestamp:Tezos_base.TzPervasives.Time.Protocol.t -> ?genesis_predecessor:Tezos_base.TzPervasives.Block_hash.t -> payloads_per_level list -> (Node_inbox.t * Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Inbox.t, Tezos_base.TzPervasives.tztrace) result
Sourcemodule Protocol_inbox_with_ctxt : sig ... end
Sourceval is_reveal_enabled_default : Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.is_reveal_enabled
Sourceval tick_of_int_exn : ?__LOC__:string -> int -> Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Tick.t
Sourcemodule type PVM_eval = sig ... end
Sourcemodule Make_PVM_eval (PVM : sig ... end) : PVM_eval with type context = PVM.context and type state = PVM.state
Sourcemodule Arith_pvm_eval : sig ... end
Sourcemodule Wasm_pvm_eval : sig ... end
Sourceval make_pvm_with_context_and_state : (module Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.PVM.S with type context = 'context and type state = 'state) -> state:'state -> context:'context -> reveal: (Tezos_raw_protocol_019_PtParisB.Sc_rollup_reveal_hash.t -> string option Tezos_protocol_environment_019_PtParisB.Lwt.t) -> inbox:Node_inbox.t -> unit -> (module Tezos_protocol_019_PtParisB.Protocol.Alpha_context.Sc_rollup.Proof.PVM_with_context_and_state)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct