package octez-shell-libs

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

The module for handling protocol-related operations.

val mem : store -> Tezos_base.TzPervasives.Protocol_hash.t -> bool

mem global_store ph checks the existence of the protocol ph in global_store.

val all : store -> Tezos_base.TzPervasives.Protocol_hash.Set.t

all global_store ph returns the set of all stored protocol in global_store.

val read : store -> Tezos_base.TzPervasives.Protocol_hash.t -> Tezos_base.TzPervasives.Protocol.t option Lwt.t

read global_store ph reads the protocol ph from the global_store. Returns None if it does not exist.

val store : store -> Tezos_base.TzPervasives.Protocol_hash.t -> Tezos_base.TzPervasives.Protocol.t -> Tezos_base.TzPervasives.Protocol_hash.t option Lwt.t

store global_store ph protocol stores the protocol under the hash ph in the global_store. Returns None if it already exists or Some ph if it was correctly stored.

Warning No hash check is made, the caller must be careful when storing protocols.

val store_raw : store -> Tezos_base.TzPervasives.Protocol_hash.t -> bytes -> Tezos_base.TzPervasives.Protocol_hash.t option Lwt.t

store_raw global_store ph bytes raw version of store.

val protocol_watcher : store -> Tezos_base.TzPervasives.Protocol_hash.t Lwt_stream.t * Lwt_watcher.stopper

protocol_watcher global_store instantiates a new protocol watcher in global_store.

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