octez-smart-rollup-node-lib 20.1 (latest)

Storage for persisting messages downloaded from the L1 node.

type +'a t

The type of indexed file store.

val mem : 
  [> `Read ] t ->
  Octez_smart_rollup.Merkelized_payload_hashes_hash.t ->
  bool Tezos_base.TzPervasives.tzresult Lwt.t

Returns true if the key has a value associated in the store.

val header : 
  [> `Read ] t ->
  Octez_smart_rollup.Merkelized_payload_hashes_hash.t ->
  (bool
   * Tezos_base.TzPervasives.Block_hash.t
   * Tezos_base.Time.Protocol.t
   * int)
    option
    Tezos_base.TzPervasives.tzresult
    Lwt.t

Returns the header for a key if it exists in the store.

val read : 
  [> `Read ] t ->
  Octez_smart_rollup.Merkelized_payload_hashes_hash.t ->
  (string list
   * (bool
      * Tezos_base.TzPervasives.Block_hash.t
      * Tezos_base.Time.Protocol.t
      * int))
    option
    Tezos_base.TzPervasives.tzresult
    Lwt.t

Read a full value and header from the indexed file store.

val append : 
  ?flush:bool ->
  [> `Write ] t ->
  key:Octez_smart_rollup.Merkelized_payload_hashes_hash.t ->
  header:
    (bool
     * Tezos_base.TzPervasives.Block_hash.t
     * Tezos_base.Time.Protocol.t
     * int) ->
  value:string list ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

Append a new binding to the indexed file store.

val load : 
  path:string ->
  index_buffer_size:int ->
  cache_size:int ->
  'a Tezos_layer2_store.Store_sigs.mode ->
  'a t Tezos_base.TzPervasives.tzresult Lwt.t

Loads a new or existing indexed file store in the directory path.

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

Close the index and the file. One must call load again to read or write data in the store.

val readonly : [> `Read ] t -> [ `Read ] t

readonly t returns a read only version of the store t.

val gc : 
  ?async:bool ->
  Tezos_layer2_store.Store_sigs.rw t ->
  (Octez_smart_rollup.Merkelized_payload_hashes_hash.t ->
    (bool
     * Tezos_base.TzPervasives.Block_hash.t
     * Tezos_base.Time.Protocol.t
     * int) ->
    string list ->
    bool Tezos_base.TzPervasives.tzresult Lwt.t) ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

gc ?async t filter garbage collects data stored in the store t by keeping only elements that satisfy the predicate filter. This call runs the GC asynchronously unless async is false. If a GC is already ongoing this new request is ignored and this call is a no-op.

val wait_gc_completion : 'a t -> unit Lwt.t

wait_gc_completion t returns a blocking thread if a GC run is currently ongoing.

val is_gc_finished : 'a t -> bool

is_gc_finished t returns true if there is no GC running.

package octez-smart-rollup-node-lib