package octez-shell-libs

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

Parameters

Signature

Returns a mockup environment for the default protocol (which is the first in the list of registered protocol, cf Registration module).

Returns a mockup environment for the specified protocol hash.

Load a mockup environment and initializes a protocol RPC context from a mockup base directory. If the protocol is specified, check that the loaded environment agrees with it.

val create_mockup : cctxt:Tezos_client_base.Client_context.full -> protocol_hash:Tezos_base.TzPervasives.Protocol_hash.t -> constants_overrides_json:Tezos_base.TzPervasives.Data_encoding.json option -> bootstrap_accounts_json:Tezos_base.TzPervasives.Data_encoding.json option -> asynchronous:bool -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Initializes an on-disk mockup environment in base_dir for the specified protocol.

val overwrite_mockup : protocol_hash:Tezos_base.TzPervasives.Protocol_hash.t -> chain_id:Tezos_base.TzPervasives.Chain_id.t -> rpc_context:Tezos_protocol_environment.rpc_context -> protocol_data:bytes -> base_dir:string -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Overwrites an on-disk mockup environment.

Base directory states

type base_dir_class =
  1. | Base_dir_does_not_exist
  2. | Base_dir_is_file
  3. | Base_dir_is_mockup
  4. | Base_dir_is_nonempty
  5. | Base_dir_is_empty
val pp_base_dir_class : Stdlib.Format.formatter -> base_dir_class -> unit
val classify_base_dir : string -> base_dir_class Tezos_base.TzPervasives.tzresult Lwt.t

Test whether base directory is a valid target for loading or creating a mockup environment.

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