package octez-smart-rollup-node-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Protocol registration logic
Using the correct protocol plugin
Safe protocol specific constants

package octez-smart-rollup-node-lib

octez-smart-rollup-node-lib
- Octez_smart_rollup_node
  - Batcher
  - Batcher_events
    
    Declare
    
    WORKER
    
    Worker
  - Batcher_worker_types
    
    Request
  - Block_directory_helpers
  - Cli
    
    Binary_dependent_args
    
    P
  - Commitment_event
    
    Publisher
  - Configuration
    
    Cli
  - Context
    
    Internal_for_tests
    
    PVMState
    
    Proof
    
    Hash
    
    Proof_encoding
    
    Tree
    
    Version
  - Daemon_event
  - Event
  - Fuel
    
    Accounted
    
    Free
    
    S
  - Injector
    
    Inj_operation
    
    Hash
    
    Error_table
    
    Map
    
    Set
    
    Table
    
    WeakRingTable
  - Interpreter
  - Interpreter_event
    
    Simple
  - Layer1
  - Loser_mode
  - Messages
  - Metadata
    
    V0
    
    V1
    
    Versioned
  - Metrics
    
    Inbox
    
    Stats
    
    Info
  - Node_context
  - Operation_kind
    
    Map
  - Outbox_execution
  - Progress_bar
    
    Config
    
    Default
    
    Display
    
    Duration
    
    Of_int
    
    Line
    
    Bar_style
    
    Integer_dependent
    
    Ext
    
    Bar_style
    
    Make
    
    Integer
    
    S
    
    Internals
    
    Line_buffer
    
    Span
    
    Using_float
    
    Bar_style
    
    Using_int32
    
    Bar_style
    
    Using_int63
    
    Bar_style
    
    Using_int64
    
    Bar_style
    
    Lwt
    
    Multi
    
    Printer
    
    Internals
    
    Reporter
    
    Units
    
    Bytes
    
    Duration
    
    Percentage
  - Protocol_plugin_sig
    
    BATCHER
    
    BATCHER_CONSTANTS
    
    DAL_SLOTS_TRACKER
    
    INBOX
    
    L1_PROCESSING
    
    LAYER1_HELPERS
    
    PARTIAL
    
    Layer1_helpers
    
    Pvm
    
    Fueled
    
    Accounted
    
    Free
    
    Wasm_2_0_0
    
    REFUTATION_GAME_HELPERS
    
    RPC_DIRECTORY
    
    S
    
    Batcher_constants
    
    Dal_slots_tracker
    
    Inbox
    
    L1_processing
    
    Layer1_helpers
    
    Pvm
    
    Fueled
    
    Accounted
    
    Free
    
    Wasm_2_0_0
    
    RPC_directory
    
    Refutation_game_helpers
  - Protocol_plugins
  - Publisher
  - Publisher_worker_types
    
    Request
  - Purpose
    
    Map
  - Pvm_plugin_sig
    
    FUELED_PVM
    
    S
    
    Fueled
    
    Accounted
    
    Free
    
    Wasm_2_0_0
  - Reference
  - Refutation_coordinator
  - Refutation_coordinator_types
    
    Request
  - Refutation_game
  - Refutation_game_event
    
    Coordinator
    
    Player
    
    Simple
    
    Coordinator
    
    Player
    
    Worker
    
    ARG
    
    Request
  - Refutation_player
    
    Worker
    
    BOX
    
    Dropbox
    
    HANDLERS
    
    Name
    
    QUEUE
    
    Queue
    
    Request
    
    Types
  - Refutation_player_types
    
    Request
  - Rollup_node_daemon
    
    Internal_for_tests
  - Rollup_node_errors
  - Rpc_directory
  - Rpc_directory_helpers
    
    Make_directory
    
    S
    
    Make_sub_directory
    
    S
    
    PARAM
    
    PARAM_PREFIX
  - Rpc_server
  - Simulation
  - Snapshot_utils
  - Snapshots
  - Store
  - Store_migration
    
    MIGRATION_ACTIONS
    
    Make
    
    Actions
    
    S_dest
    
    S_from
    
    S
  - Store_sig
    
    S
  - Store_v0
    
    Commitments_published_at_level
    
    Irmin_store
    
    Make_append_only_map
    
    Make_mutable_value
    
    Make_nested_map
    
    Make_updatable_map
    
    Raw_irmin
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Info
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Commit_portable
    
    Info
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Node_portable
    
    Metadata
    
    Remote
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    History
    
    E
    
    V
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Path
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
  - Store_v1
    
    Dal_pages
    
    Dal_processed_slots
  - Store_v2
    
    Gc_levels
    
    Lcc
    
    Protocols
  - Store_v3
  - Store_v4
  - Store_version
  - Utils
    
    Reveal_hash_map
  - Wasm_2_0_0_dump

Legend:
Library
Module
Module type
Parameter
Class
Class type

Protocol registration logic

type proto_plugin = (module Protocol_plugin_sig.S)

val register : proto_plugin -> unit

Register a protocol plugin for a specific protocol to be used by the rollup node.

val registered_protocols : unit -> Tezos_base.TzPervasives.Protocol_hash.t list

Returns the list of registered protocols.

Using the correct protocol plugin

val proto_plugin_for_protocol : 
  Tezos_base.TzPervasives.Protocol_hash.t ->
  proto_plugin Tezos_base.TzPervasives.tzresult

Return the protocol plugin for a given protocol (or an error if not supported).

val proto_plugin_for_level : 
  _ Node_context.t ->
  int32 ->
  proto_plugin Tezos_base.TzPervasives.tzresult Lwt.t

Return the protocol plugin for a given level (or an error if not supported).

val proto_plugin_for_level_with_store : 
  _ Store.t ->
  int32 ->
  proto_plugin Tezos_base.TzPervasives.tzresult Lwt.t

Return the protocol plugin for a given level (or an error if not supported).

val proto_plugin_for_block : 
  _ Node_context.t ->
  Tezos_base.TzPervasives.Block_hash.t ->
  proto_plugin Tezos_base.TzPervasives.tzresult Lwt.t

Return the protocol plugin for a given block (or an error if not supported).

val last_proto_plugin : 
  _ Node_context.t ->
  proto_plugin Tezos_base.TzPervasives.tzresult Lwt.t

Returns the plugin corresponding to the last protocol seen by the rollup node.

Safe protocol specific constants

These functions provide a way to retrieve constants in a safe manner, depending on the context.

val get_constants_of_protocol : 
  _ Node_context.t ->
  Tezos_base.TzPervasives.Protocol_hash.t ->
  Octez_smart_rollup.Rollup_constants.protocol_constants
    Tezos_base.TzPervasives.tzresult
    Lwt.t

Retrieve constants for a given protocol (values are cached).

val get_constants_of_level : 
  _ Node_context.t ->
  int32 ->
  Octez_smart_rollup.Rollup_constants.protocol_constants
    Tezos_base.TzPervasives.tzresult
    Lwt.t

Retrieve constants for a given level (values are cached).

val get_constants_of_block_hash : 
  _ Node_context.t ->
  Tezos_base.TzPervasives.Block_hash.t ->
  Octez_smart_rollup.Rollup_constants.protocol_constants
    Tezos_base.TzPervasives.tzresult
    Lwt.t

Retrieve constants for a given block hash (values are cached).