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.ContextSource

Sourcetype 'a index constraint 'a = [< `Read | `Write Read ]

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 tree

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

Sourcetype 'a t constraint 'a = [< `Read | `Write Read ]

The type of context with its content.

Sourcetype rw = [ `Read | `Write ] t

Read/write context t.

Sourcetype ro = [ `Read ] t

Read-only context 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.

load path initializes from disk a context from path.

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 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.

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

Static information about the rollup.

OCaml

Innovation. Community. Security.