package tezos-shell-services

  1. Overview
  2. Docs
package tezos-shell-services
Legend:
Library
Module
Module type
Parameter
Class
Class type
type chain = [
  1. | `Main
  2. | `Test
  3. | `Hash of Tezos_crypto.Chain_id.t
]
type chain_prefix = unit * chain
val chain_path : (unit, chain_prefix) Tezos_rpc.RPC_path.t
val parse_chain : string -> (chain, string) Stdlib.result
val chain_to_string : chain -> string
val chain_arg : chain Tezos_rpc.RPC_arg.t
type block = [
  1. | `Genesis
  2. | `Head of int
  3. | `Alias of [ `Caboose | `Checkpoint | `Savepoint ] * int
  4. | `Hash of Tezos_crypto.Block_hash.t * int
  5. | `Level of Stdlib.Int32.t
]
val parse_block : string -> (block, string) Stdlib.result
val to_string : block -> string
type prefix = (unit * chain) * block
val mempool_path : ('a, 'b) Tezos_rpc.RPC_path.t -> ('a, 'b) Tezos_rpc.RPC_path.t
val live_blocks_path : ('a, 'b) Tezos_rpc.RPC_path.t -> ('a, 'b) Tezos_rpc.RPC_path.t
type operation_list_quota = {
  1. max_size : int;
  2. max_op : int option;
}
type raw_context =
  1. | Key of Stdlib.Bytes.t
    (*

    A leaf, containing a value

    *)
  2. | Cut
    (*

    An omitted piece, because it is too deep compared to the maximum depth requested in the /chains/<chain_id>/blocks/<block_id/context/raw/bytes RPC

    *)

The low-level storage exposed as a tree

val pp_raw_context : Stdlib.Format.formatter -> raw_context -> unit
type Tezos_base__TzPervasives.error +=
  1. | Invalid_depth_arg of int
type merkle_hash_kind =
  1. | Contents
    (*

    The kind associated to leaves

    *)
  2. | Node
    (*

    The kind associated to directories

    *)

The kind of a merkle_node

type merkle_node =
  1. | Hash of merkle_hash_kind * string
    (*

    A shallow node: just a hash

    *)
  2. | Data of raw_context
    (*

    A full-fledged node containing actual data

    *)
  3. | Continue of merkle_tree
    (*

    An edge to a more nested tree

    *)

A node in a merkle_tree

and merkle_tree = merkle_node Tezos_base__TzPervasives.TzString.Map.t

The type of Merkle tree used by the light mode

type merkle_leaf_kind =
  1. | Hole
  2. | Raw_context

Whether an RPC caller requests an entirely shallow Merkle tree (Hole) or whether the returned tree should contain data at the given key (Raw_context)

val pp_merkle_node : Stdlib.Format.formatter -> merkle_node -> unit
val pp_merkle_tree : Stdlib.Format.formatter -> merkle_tree -> unit
module type PROTO = sig ... end
type protocols = {
  1. current_protocol : Tezos_crypto.Protocol_hash.t;
  2. next_protocol : Tezos_crypto.Protocol_hash.t;
}
val protocols : Tezos_rpc.RPC_context.simple -> ?chain:chain -> ?block:block -> unit -> (protocols, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
module Make (Proto : PROTO) (Next_proto : PROTO) : sig ... end
module Empty : sig ... end
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