package octez-smart-rollup-node-lib

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

Module Store_v0.CommitmentsSource

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

Sourcetype +'a t

The type of store built on indexes.

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

Load (or initializes) a store in the file path. If readonly is true, the store will only be accessed in read only mode.

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

Returns the value associated to a key in the store, or None otherwise.

Add an association from a key to a value in the store. If flush (default to true) is set, the index is written on disk right away.

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

Closes the store. After this call the store cannot be accessed anymore (unless one calls load again).

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

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

gc ?async t filter garbage collects data stored in the index 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.

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

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

Sourceval is_gc_finished : 'a t -> bool

is_gc_finished t returns true if there is no GC running.

OCaml

Innovation. Community. Security.