package octez-proto-libs

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

Module V3.MakeSource

Parameters

module Param : sig ... end

Signature

include Tezos_protocol_environment_sigs.V3.T with type Format.formatter = Format.formatter and type 'a Data_encoding.t = 'a Tezos_base.TzPervasives.Data_encoding.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) result and type Chain_id.t = Tezos_crypto.Hashed.Chain_id.t and type Block_hash.t = Tezos_crypto.Hashed.Block_hash.t and type Operation_hash.t = Tezos_crypto.Hashed.Operation_hash.t and type Operation_list_hash.t = Tezos_crypto.Hashed.Operation_list_hash.t and type Operation_list_list_hash.t = Tezos_crypto.Hashed.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_crypto.Hashed.Context_hash.t and type Context_hash.Version.t = Tezos_crypto.Hashed.Context_hash.Version.t and type Protocol_hash.t = Tezos_crypto.Hashed.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_base.TzPervasives.Signature.Ed25519.Public_key_hash.t and type Ed25519.Public_key.t = Tezos_base.TzPervasives.Signature.Ed25519.Public_key.t and type Ed25519.t = Tezos_base.TzPervasives.Signature.Ed25519.t and type Secp256k1.Public_key_hash.t = Tezos_base.TzPervasives.Signature.Secp256k1.Public_key_hash.t and type Secp256k1.Public_key.t = Tezos_base.TzPervasives.Signature.Secp256k1.Public_key.t and type Secp256k1.t = Tezos_base.TzPervasives.Signature.Secp256k1.t and type P256.Public_key_hash.t = Tezos_base.TzPervasives.Signature.P256.Public_key_hash.t and type P256.Public_key.t = Tezos_base.TzPervasives.Signature.P256.Public_key.t and type P256.t = Tezos_base.TzPervasives.Signature.P256.t and type Signature.public_key_hash = Tezos_base.TzPervasives.Signature.V0.public_key_hash and type Signature.public_key = Tezos_base.TzPervasives.Signature.V0.public_key and type Signature.t = Tezos_base.TzPervasives.Signature.V0.t and type Signature.watermark = Tezos_base.TzPervasives.Signature.V0.watermark and type 'a Micheline.canonical = 'a Tezos_micheline.Micheline.canonical and type Z.t = Z.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) result and type Timelock.chest = Tezos_crypto.Timelock_legacy.chest and type Timelock.chest_key = Tezos_crypto.Timelock_legacy.chest_key and type Timelock.opening_result = Tezos_crypto.Timelock_legacy.opening_result and module Sapling = Tezos_sapling.Core.Validator_legacy with type Updater.quota = Tezos_protocol_environment__.Environment_context.quota with type Updater.rpc_context = Tezos_protocol_environment__.Environment_context.rpc_context
Sourcemodule Pervasives : sig ... end

The OCaml Standard library.

Sourcemodule String : sig ... end

String operations.

Sourcemodule Char : sig ... end

Character operations.

Sourcemodule Bytes : sig ... end

Byte sequence operations.

Sourcemodule Int32 : sig ... end

32-bit integers.

Sourcemodule Int64 : sig ... end

64-bit integers.

Sourcemodule Format : sig ... end

Pretty-printing.

Sourcemodule Logging : sig ... end
Sourcemodule Hex : sig ... end

Hexadecimal encoding.

module Z : sig ... end

Integers.

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

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

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

Sourcemodule Error_monad : sig ... end
Sourcemodule Seq : sig ... end
Sourcemodule List : sig ... end
Sourcemodule Set : sig ... end
Sourcemodule Map : sig ... end
Sourcemodule Option : sig ... end

Signature from Lwtreslib's option module

Sourcemodule Result : sig ... end
Sourcemodule RPC_arg : sig ... end
Sourcemodule RPC_path : sig ... end
Sourcemodule RPC_query : sig ... end
Sourcemodule RPC_service : sig ... end
Sourcemodule RPC_answer : sig ... end
Sourcemodule RPC_directory : sig ... end
Sourcemodule Base58 : sig ... end
Sourcemodule S : sig ... end
Sourcemodule Blake2B : sig ... end

Builds a new Hash type using Blake2B.

Sourcemodule Bls12_381 : sig ... end
Sourcemodule Ed25519 : sig ... end

Tezos - Ed25519 cryptography

Sourcemodule Secp256k1 : sig ... end

Tezos - Secp256k1 cryptography

Sourcemodule P256 : sig ... end

Tezos - P256 cryptography

Sourcemodule Chain_id : sig ... end
Sourcemodule Signature : sig ... end
Sourcemodule Block_hash : sig ... end
Sourcemodule Operation_hash : sig ... end
Sourcemodule Operation_list_hash : sig ... end
Sourcemodule Operation_list_list_hash : sig ... end
Sourcemodule Protocol_hash : sig ... end
Sourcemodule Context_hash : sig ... end
Sourcemodule Timelock : sig ... end
Sourcemodule Micheline : sig ... end
Sourcemodule Block_header : sig ... end
Sourcemodule Fitness : sig ... end
Sourcemodule Operation : sig ... end

Tezos operations.

Sourcemodule Context : sig ... end

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

Sourcemodule Updater : sig ... end

Tezos Protocol Environment - Protocol updater.

Sourcemodule RPC_context : 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.)

Sourcemodule Lift (P : Updater.PROTOCOL) : sig ... end
Sourceclass ['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