package octez-l2-libs

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

Module Tezos_layer2_store.Irmin_contextSource

Sourcetype repo
Sourcetype tree

The type of trees stored in the context, i.e. the actual data.

Sourcetype 'a raw_index = ('a, repo) Context_sigs.raw_index
Sourcetype 'a index = ('a, repo) Context_sigs.index

The type of indexed repository for contexts. The parameter indicates if the index can be written or only read.

Sourcetype rw_index = [ `Read | `Write ] index

Read/write index.

Sourcetype ro_index = [ `Read ] index

Read only index.

Sourcetype 'a t = ('a, repo, tree) Context_sigs.t

The type of context with its content.

Sourcetype rw = [ `Read | `Write ] t

Read/write context t.

Sourcetype ro = [ `Read ] t

Read-only context t.

Sourcemodule Tree : Tezos_context_sigs.Context.TREE with type t := rw and type key := string list and type value := bytes and type tree := tree
Sourcetype hash = Tezos_base.TzPervasives.Context_hash.t

A context hash is the hash produced when the data of the context is committed to disk, i.e. the commit hash.

Sourcetype commit

The type of commits for the context.

Sourceval impl_name : string
Sourceval load : cache_size:int -> 'a Store_sigs.mode -> string -> 'a index Tezos_base.TzPervasives.tzresult Lwt.t

load cache_size path initializes from disk a context from path. cache_size allows to change the LRU cache size of Irmin (100_000 by default at irmin-pack/config.ml

Sourceval index : 'a t -> 'a index

index context is the repository of the context context.

Sourceval close : _ index -> unit Lwt.t

close ctxt closes the context index ctxt.

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

readonly index returns a read-only version of the index.

Sourceval raw_commit : ?message:string -> [> `Write ] index -> tree -> commit Lwt.t

raw_commit ?message ctxt tree commits the tree in the context repository ctxt on disk, and return the commit.

Sourceval commit : ?message:string -> [> `Write ] t -> hash Lwt.t

commit ?message context commits content of the context context on disk, and return the commit hash.

Sourceval checkout : 'a index -> hash -> 'a t option Lwt.t

checkout ctxt hash checkouts the content that corresponds to the commit hash hash in the repository ctxt and returns the corresponding context. If there is no commit that corresponds to hash, it returns None.

Sourceval checkout_exn : 'a index -> hash -> 'a t Lwt.t
Sourceval empty : 'a index -> 'a t

empty ctxt is the context with an empty content for the repository ctxt.

Sourceval is_empty : _ t -> bool

is_empty context returns true iff the context content of context is empty.

Sourceval split : _ index -> unit

split ctxt creates a new suffix file, also called "chunk", into the Irmin's file hierarchy. This split function is expected to be called after committing a commit that will be a future candidate for a GC target.

Sourceval gc : [> `Write ] index -> ?callback:(unit -> unit Lwt.t) -> hash -> unit Lwt.t

gc index ?callback hash removes all data older than hash from disk. If passed, callback will be executed when garbage collection finishes.

Sourceval is_gc_finished : [> `Write ] index -> bool

is_gc_finished index returns true if a GC is finished (or idle) and false if a GC is running for index.

Sourceval wait_gc_completion : [> `Write ] index -> unit Lwt.t

wait_gc_completion index will return a blocking thread if a GC run is currently ongoing.

Sourceval export_snapshot : _ index -> hash -> path:string -> unit Tezos_base.TzPervasives.tzresult Lwt.t

export_snapshot index context_hash ~path exports the context corresponding to context_hash, if found in index, into the given folder path. As the export uses the GC's behaviour to extract a single commit into a standalone fresh store, it is not possible to export a snapshot while a GC is running. This call will hang until the GC has finished.

Note: there is no associated import_snapshot function as the import consist in copying the exported Irmin store.

Sourcemodule Proof (Hash : sig ... end) (Proof_encoding : sig ... end) : sig ... end

Module for generating and verifying proofs for a context

Sourcemodule PVMState : sig ... end

State of the PVM that this rollup node deals with

Sourcemodule Internal_for_tests : sig ... end
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