package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Tezos_protocol_environment_sigs.V11.T with type Format.formatter = Stdlib.Format.formatter and type 'a Seq.node = 'a Tezos_base.TzPervasives.Seq.node and type 'a Seq.t = unit -> 'a Tezos_base.TzPervasives.Seq.node and type 'a Data_encoding.t = 'a Tezos_base.TzPervasives.Data_encoding.t and type 'a Data_encoding.Compact.t = 'a Tezos_base.TzPervasives.Data_encoding.Compact.t and type 'a Data_encoding.lazy_t = 'a Tezos_base.TzPervasives.Data_encoding.lazy_t and type 'a Lwt.t = 'a Lwt.t and type ('a, 'b) Pervasives.result = ('a, 'b) Stdlib.result and type Chain_id.t = Tezos_base.TzPervasives.Chain_id.t and type Block_hash.t = Tezos_base.TzPervasives.Block_hash.t and type Operation_hash.t = Tezos_base.TzPervasives.Operation_hash.t and type Operation_list_hash.t = Tezos_base.TzPervasives.Operation_list_hash.t and type Operation_list_list_hash.t = Tezos_base.TzPervasives.Operation_list_list_hash.t and type Context.t = Tezos_protocol_environment__.Environment_context.Context.t and type Context.cache_key = Tezos_protocol_environment__.Environment_context.Context.cache_key and type Context.cache_value = Tezos_protocol_environment__.Environment_context.Context.cache_value and type Context_hash.t = Tezos_base.TzPervasives.Context_hash.t and type Context_hash.Version.t = Tezos_base.TzPervasives.Context_hash.Version.t and type Context.config = Tezos_context_sigs.Config.t and module Context.Proof = Tezos_protocol_environment__.Environment_context.Context.Proof and type Context_binary.t = Tezos_context_memory.Context_binary.t and type Context_binary.tree = Tezos_context_memory.Context_binary.tree and type Protocol_hash.t = Tezos_base.TzPervasives.Protocol_hash.t and type Time.t = Tezos_base.TzPervasives.Time.Protocol.t and type Operation.shell_header = Tezos_base.TzPervasives.Operation.shell_header and type Operation.t = Tezos_base.TzPervasives.Operation.t and type Block_header.shell_header = Tezos_base.TzPervasives.Block_header.shell_header and type Block_header.t = Tezos_base.TzPervasives.Block_header.t and type 'a RPC_directory.t = 'a Tezos_rpc.Directory.t and type Ed25519.Public_key_hash.t = Tezos_crypto.Signature.Ed25519.Public_key_hash.t and type Ed25519.Public_key.t = Tezos_crypto.Signature.Ed25519.Public_key.t and type Ed25519.t = Tezos_crypto.Signature.Ed25519.t and type Secp256k1.Public_key_hash.t = Tezos_crypto.Signature.Secp256k1.Public_key_hash.t and type Secp256k1.Public_key.t = Tezos_crypto.Signature.Secp256k1.Public_key.t and type Secp256k1.t = Tezos_crypto.Signature.Secp256k1.t and type P256.Public_key_hash.t = Tezos_crypto.Signature.P256.Public_key_hash.t and type P256.Public_key.t = Tezos_crypto.Signature.P256.Public_key.t and type P256.t = Tezos_crypto.Signature.P256.t and type Bls.Public_key_hash.t = Tezos_crypto.Signature.Bls.Public_key_hash.t and type Bls.Public_key.t = Tezos_crypto.Signature.Bls.Public_key.t and type Bls.t = Tezos_crypto.Signature.Bls.t and type Signature.public_key_hash = Tezos_crypto.Signature.V1.public_key_hash and type Signature.public_key = Tezos_crypto.Signature.V1.public_key and type Signature.signature = Tezos_crypto.Signature.V1.signature and type Signature.t = Tezos_crypto.Signature.V1.t and type Signature.watermark = Tezos_crypto.Signature.V1.watermark and type Micheline.canonical_location = Tezos_micheline.Micheline.canonical_location and type 'a Micheline.canonical = 'a Tezos_micheline.Micheline.canonical and type Z.t = Z.t and type Q.t = Q.t and type ('a, 'b) Micheline.node = ('a, 'b) Tezos_micheline.Micheline.node and type Data_encoding.json_schema = Tezos_base.TzPervasives.Data_encoding.json_schema and type ('a, 'b) RPC_path.t = ('a, 'b) Tezos_rpc.Path.t and type RPC_service.meth = Tezos_rpc.Service.meth and type (+'m, 'pr, 'p, 'q, 'i, 'o) RPC_service.t = ('m, 'pr, 'p, 'q, 'i, 'o) Tezos_rpc.Service.t and type Error_monad.shell_tztrace = Tezos_base.TzPervasives.Error_monad.tztrace and type 'a Error_monad.shell_tzresult = ('a, Tezos_base.TzPervasives.Error_monad.tztrace) Stdlib.result and type Timelock.chest = Tezos_crypto.Timelock.chest and type Timelock.chest_key = Tezos_crypto.Timelock.chest_key and type Timelock.opening_result = Tezos_crypto.Timelock.opening_result and module Sapling = Tezos_sapling.Core.Validator and type ('a, 'b) Either.t = ('a, 'b) Stdlib.Either.t and type Bls.Primitive.Fr.t = Bls12_381.Fr.t and type Plonk.proof = Tezos_protocol_environment_structs.V11.Plonk.proof and type Plonk.public_parameters = Tezos_protocol_environment_structs.V11.Plonk.verifier_public_parameters and type Dal.parameters = Tezos_crypto_dal.Cryptobox.Verifier.parameters and type Dal.commitment = Tezos_crypto_dal.Cryptobox.Verifier.commitment and type Dal.commitment_proof = Tezos_crypto_dal.Cryptobox.Verifier.commitment_proof and type Dal.page_proof = Tezos_crypto_dal.Cryptobox.Verifier.page_proof and type Bounded.Non_negative_int32.t = Tezos_base.Bounded.Non_negative_int32.t and type Wasm_2_0_0.version = Tezos_scoru_wasm.Wasm_pvm_state.version and type Wasm_2_0_0.input = Tezos_scoru_wasm.Wasm_pvm_state.input_info and type Wasm_2_0_0.output = Tezos_scoru_wasm.Wasm_pvm_state.output_info and type Wasm_2_0_0.reveal = Tezos_scoru_wasm.Wasm_pvm_state.reveal and type Wasm_2_0_0.input_request = Tezos_scoru_wasm.Wasm_pvm_state.input_request and type Wasm_2_0_0.info = Tezos_scoru_wasm.Wasm_pvm_state.info and module Skip_list = Tezos_base.Skip_list and type Smart_rollup.Address.t = Tezos_crypto.Hashed.Smart_rollup_address.t and type Smart_rollup.Commitment_hash.t = Tezos_crypto.Hashed.Smart_rollup_commitment_hash.t and type Smart_rollup.State_hash.t = Tezos_crypto.Hashed.Smart_rollup_state_hash.t and type Smart_rollup.Inbox_hash.t = Tezos_crypto.Hashed.Smart_rollup_inbox_hash.t and type Smart_rollup.Merkelized_payload_hashes_hash.t = Tezos_crypto.Hashed.Smart_rollup_merkelized_payload_hashes_hash.t
module Pervasives : sig ... end

The OCaml Standard library.

module Either : sig ... end

Either type.

module String : sig ... end

String operations.

module Char : sig ... end

Character operations.

module Bytes : sig ... end

Byte sequence operations.

module Int32 : sig ... end

32-bit integers.

module Int64 : sig ... end

64-bit integers.

module Format : sig ... end

Pretty-printing.

module Logging : sig ... end
module Hex : sig ... end

Hexadecimal encoding.

module Z : sig ... end

Integers.

module Q : sig ... end

Rationals.

module Lwt : sig ... end
module Data_encoding : sig ... end
module Raw_hashes : sig ... end
module Compare : sig ... end
module Time : sig ... end
module TzEndian : sig ... end
module Bits : sig ... end
module Equality_witness : sig ... end

This module provides support for type equalities and runtime type identifiers.

module FallbackArray : sig ... end

This module implements arrays equipped with accessors that cannot raise exceptions. Reading out of the bounds of the arrays return a fallback value fixed at array construction time, writing out of the bounds of the arrays is ignored.

module Error_monad : sig ... end
module Seq : sig ... end
module List : sig ... end
module Array : sig ... end

This module is a very restricted subset of OCaml's Stdlib Array module. There is just enough exposed that you can pass arrays around to some functions and such, but not enough that you can easily shoot yourself in the foot. (See details below.)

module Set : sig ... end
module Map : sig ... end
module Option : sig ... end

Signature from Lwtreslib's option module

module Result : sig ... end
module RPC_arg : sig ... end

See src/lib_rpc/RPC_arg.mli for documentation

module RPC_path : sig ... end
module RPC_query : sig ... end
module RPC_service : sig ... end
module RPC_answer : sig ... end
module RPC_directory : sig ... end
module Base58 : sig ... end
module S : sig ... end
module Blake2B : sig ... end

Builds a new Hash type using Blake2B.

module Bls : sig ... end

Tezos - BLS12-381 cryptography

module Ed25519 : sig ... end

Tezos - Ed25519 cryptography

module Secp256k1 : sig ... end

Tezos - Secp256k1 cryptography

module P256 : sig ... end

Tezos - P256 cryptography

module Chain_id : sig ... end
module Signature : sig ... end
module Block_hash : sig ... end
module Operation_hash : sig ... end
module Operation_list_hash : sig ... end
module Operation_list_list_hash : sig ... end
module Protocol_hash : sig ... end
module Context_hash : sig ... end
module Timelock : sig ... end
module Vdf : sig ... end
module Micheline : sig ... end
module Block_header : sig ... end
module Bounded : sig ... end

This module implements bounded (or refined) versions of data types.

module Fitness : sig ... end
module Operation : sig ... end

Tezos operations.

module Context : sig ... end

View over the context store, restricted to types, access and functional manipulation of an existing context.

module Updater : sig ... end

Tezos Protocol Environment - Protocol updater.

module RPC_context : sig ... end
module Context_binary : sig ... end
module Wasm_2_0_0 : sig ... end
module Plonk : sig ... end

aPlonK is a PlonK-based proving system. As such, it provides a way to create succinct cryptographic proofs about a given predicate, which can be then verified with a low computational cost.

module Dal : sig ... end
module Skip_list = Tezos_base.Skip_list
module Smart_rollup : sig ... end

An Ecoproto_error e is a shell error that carry a protocol error.

Each protocol has its own error-monad (instantiated when this module here is applied) with a fresh extensible error type. This protocol-specific error type is incompatible with the shell's. The Ecoproto_error constructor belongs to the shell's error type and it carries the errors of the protocol's specific error type back into the shell's.

The function wrap_tz* below provide wrappers for three different levels: errors, traces, and tzresults. They are used within the implementation of the environment to translate some return values from the protocol's error monad into the shell's. They are exported because they can be useful for writing tests for the protocol (i.e., for the tests located in src/proto_*/lib_protocol/test/) and for writing protocol-specific support libraries and binaries (i.e., for the code in src/proto_*/lib_{client,delegate,etc.}).

wrap_tzerror e is a shell error wrapping the protocol error e. (It is Ecoproto_error e.)

wrap_tztrace t is a shell trace composed of the wrapped errors of the protocol trace t.

wrap_tzresult r is a shell tzresult that carries the same result as or a wrapped trace of the protocol tzresult r. (It is Ok x if r is Ok x, it is Error (wrap_tztrace t) if r is Error t.)

module Lift (P : Updater.PROTOCOL) : sig ... end
class ['chain, 'block] proto_rpc_context : Tezos_rpc.Context.t -> (unit, (unit * 'chain) * 'block) RPC_path.t -> ('chain * 'block) RPC_context.simple
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