package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Environment_context = Tezos_protocol_environment.Context
module Memory_context = Tezos_protocol_environment.Memory_context
val err_implementation_mismatch : expected:string -> got:string -> 'a
type index =
  1. | Disk_index of Tezos_context.Context.index
  2. | Memory_index of Tezos_context_memory.Context.index

Values of type index are used to checkout contexts specified by their hash.

val index : Environment_context.t -> index
val mem : Environment_context.t -> Tezos_context.Context.key -> bool Lwt.t
val mem_tree : Environment_context.t -> Tezos_context.Context.key -> bool Lwt.t
val find : Environment_context.t -> Tezos_context.Context.key -> Tezos_context.Context.value option Lwt.t
val add : Environment_context.t -> Tezos_context.Context.key -> Tezos_context.Context.value -> Tezos_protocol_environment.Context.t Lwt.t
val fold_value : ?depth:[ `Eq of int | `Le of int | `Lt of int | `Ge of int | `Gt of int ] -> Environment_context.t -> Tezos_context.Context.key -> order:[ `Sorted | `Undefined ] -> init:'a -> f: (Tezos_context.Context.key -> (unit -> Tezos_context_disk.Context.value option Lwt.t) -> 'b -> 'c Lwt.t) -> 'c Lwt.t
val add_protocol : Environment_context.t -> Tezos_base.TzPervasives.Protocol_hash.t -> Tezos_protocol_environment.Context.t Lwt.t
val get_protocol : Environment_context.t -> Tezos_base.TzPervasives.Protocol_hash.t Lwt.t
val add_predecessor_block_metadata_hash : Environment_context.t -> Tezos_base.TzPervasives.Block_metadata_hash.t -> Tezos_protocol_environment.Context.t Lwt.t
val add_predecessor_ops_metadata_hash : Environment_context.t -> Tezos_base.TzPervasives.Operation_metadata_list_list_hash.t -> Tezos_protocol_environment.Context.t Lwt.t
val hash : time:Tezos_base.TzPervasives.Time.Protocol.t -> ?message:string -> Environment_context.t -> Tezos_base.TzPervasives.Context_hash.t
val get_test_chain : Environment_context.t -> Tezos_base.TzPervasives.Test_chain_status.t Lwt.t
val add_test_chain : Environment_context.t -> Tezos_base.TzPervasives.Test_chain_status.t -> Tezos_protocol_environment.Context.t Lwt.t
val fork_test_chain : Environment_context.t -> protocol:Tezos_base.TzPervasives.Protocol_hash.t -> expiration:Tezos_base.TzPervasives.Time.Protocol.t -> Tezos_protocol_environment.Context.t Lwt.t
val commit : time:Tezos_base.TzPervasives.Time.Protocol.t -> ?message:string -> Environment_context.t -> Tezos_base.TzPervasives.Context_hash.t Lwt.t
val wait_gc_completion : index -> unit Lwt.t
val is_gc_allowed : index -> bool
val split : index -> unit Lwt.t
val sync : index -> unit Lwt.t
val commit_test_chain_genesis : Environment_context.t -> Tezos_base.TzPervasives.Block_header.t -> Tezos_base.TzPervasives.Block_header.t Lwt.t
val compute_testchain_genesis : Environment_context.t -> Tezos_base.TzPervasives.Block_hash.t -> Tezos_base.TzPervasives.Block_hash.t
val merkle_tree : Environment_context.t -> Tezos_context_sigs__Context.Proof_types.merkle_leaf_kind -> Tezos_context.Context.key -> Tezos_context_sigs__Context.Proof_types.merkle_node Tezos_base.TzPervasives.String.Map.t Lwt.t
val merkle_tree_v2 : Environment_context.t -> Tezos_context_sigs__Context.Proof_types.merkle_leaf_kind -> Tezos_context.Context.key -> Tezos_context.Context.Proof.tree Tezos_context.Context.Proof.t Lwt.t
val checkout : index -> Tezos_base.TzPervasives.Context_hash.t -> Tezos_protocol_environment.Context.t option Lwt.t
val checkout_exn : index -> Tezos_base.TzPervasives.Context_hash.t -> Tezos_protocol_environment.Context.t Lwt.t
val close : index -> unit Lwt.t
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