package octez-smart-rollup-node-lib

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Octez_smart_rollup_node.Store_v1Source

This version of the store is used for the rollup nodes for protocols for and after Nairobi, i.e. >= 17.

include module type of struct include Store_v0 end
Sourcemodule Irmin_store = Store_v0.Irmin_store
Sourcemodule L2_blocks = Store_v0.L2_blocks
Sourcemodule Inboxes = Store_v0.Inboxes

Aggregated collection of messages from the L1 inbox

Sourcemodule Commitments = Store_v0.Commitments

Storage containing commitments and corresponding commitment hashes that the rollup node has knowledge of.

Sourcemodule Commitments_published_at_level = Store_v0.Commitments_published_at_level

Storage mapping commitment hashes to the level when they were published by the rollup node. It only contains hashes of commitments published by this rollup node.

Sourcemodule L2_head = Store_v0.L2_head
Sourcemodule Last_finalized_level = Store_v0.Last_finalized_level
Sourcemodule Levels_to_hashes = Store_v0.Levels_to_hashes
Sourcemodule Dal_slots_headers = Store_v0.Dal_slots_headers

Published slot headers per block hash, stored as a list of bindings from Dal_slot_index.t to Dal.Slot.t. The encoding function converts this list into a Dal.Slot_index.t-indexed map.

Sourcemodule Dal_confirmed_slots_history = Store_v0.Dal_confirmed_slots_history
Sourcemodule Dal_confirmed_slots_histories = Store_v0.Dal_confirmed_slots_histories

Confirmed DAL slots histories cache. See documentation of Dal_slot_repr.Slots_history for more details.

Sourcemodule Dal_slot_pages = Store_v0.Dal_slot_pages

Dal_slot_pages is a Store_utils.Nested_map used to store the contents of dal slots fetched by the rollup node, as a list of pages. The values of this storage module have type `string list`. A value of the form page_contents refers to a page of a slot that has been confirmed, and whose contents are page_contents.

include Store_sig.S with type 'a store := 'a Store_v0.store

Storage for persisting messages downloaded from the L1 node.

Sourcemodule Dal_pages : sig ... end
Sourcemodule Dal_processed_slots : sig ... end

Dal_slots_statuses is a Store_utils.Nested_map used to store the attestation status of DAL slots. The values of this storage module have type ``Confirmed | `Unconfirmed`, depending on whether the content of the slot has been attested on L1 or not. If an entry is not present for a (block_hash, slot_index), this means that the corresponding block is not processed yet.

Sourcetype +'a store = {
  1. l2_blocks : 'a L2_blocks.t;
  2. messages : 'a Messages.t;
  3. inboxes : 'a Inboxes.t;
  4. commitments : 'a Commitments.t;
  5. commitments_published_at_level : 'a Commitments_published_at_level.t;
  6. l2_head : 'a L2_head.t;
  7. last_finalized_level : 'a Last_finalized_level.t;
  8. levels_to_hashes : 'a Levels_to_hashes.t;
  9. irmin_store : 'a Irmin_store.t;
}
include Store_sig.S with type 'a store := 'a store
Sourcetype 'a t = ([< `Read | `Write Read ] as 'a) store

Type of store. The parameter indicates if the store can be written or only read.

Read/write store t.

Read only store t.

Sourceval version : Store_version.t

Version supported by this code.

Sourceval close : _ t -> unit Tezos_base.TzPervasives.tzresult Lwt.t

close store closes the store.

Sourceval load : 'a Tezos_layer2_store.Store_sigs.mode -> l2_blocks_cache_size:int -> string -> 'a store Tezos_base.TzPervasives.tzresult Lwt.t

load mode ~l2_blocks_cache_size directory loads a store from the data persisted in directory. If mode is Store_sigs.Read_only, then the indexes and irmin store will be opened in readonly mode and only read operations will be permitted. This allows to open a store for read access that is already opened in Store_sigs.Read_write mode in another process. l2_blocks_cache_size is the number of L2 blocks the rollup node will keep in memory.

Sourceval readonly : _ t -> ro

readonly store returns a read-only version of store.

iter_l2_blocks store f iterates f on all L2 blocks reachable from the head, from newest to oldest.

OCaml

Innovation. Community. Security.