package tezos-shell-services

  1. Overview
  2. Docs
package tezos-shell-services
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Tezos_shell_services.Block_servicesSource

Sourcetype chain = [
  1. | `Main
  2. | `Test
  3. | `Hash of Tezos_base__TzPervasives.Chain_id.t
]
Sourcetype chain_prefix = unit * chain
Sourceval chain_path : (unit, chain_prefix) Tezos_base__TzPervasives.RPC_path.t
Sourceval parse_chain : string -> (chain, string) result
Sourceval chain_to_string : chain -> string
Sourceval chain_arg : chain Tezos_base__TzPervasives.RPC_arg.t
Sourcetype block = [
  1. | `Genesis
    (*

    The genesis block

    *)
  2. | `Head of int
    (*

    The nth predecessor of the current_head block if n > 0. If n = 0, represents the current_head. n should not be negative since the current_head does not have successors.

    *)
  3. | `Alias of [ `Caboose | `Checkpoint | `Savepoint ] * int
    (*

    The nth predecessor of the caboose, the checkpoint or the savepoint if n > 0. If n = 0, represents the block itself. If n < 0, represents the nth successor.

    *)
  4. | `Hash of Tezos_base__TzPervasives.Block_hash.t * int
    (*

    The nth predecessor of the block of given hash if n > 0. If n = 0, represents the block itself. Otherwise, if n < 0, represents the nth successor.

    *)
  5. | `Level of Int32.t
    (*

    The block at a given level

    *)
]

A representation of a block's position relatively to a known block of a chain.

Sourceval parse_block : string -> (block, string) result
Sourceval to_string : block -> string
Sourcetype prefix = (unit * chain) * block
Sourceval dir_path : (chain_prefix, chain_prefix) Tezos_base__TzPervasives.RPC_path.t
Sourceval path : (chain_prefix, chain_prefix * block) Tezos_base__TzPervasives.RPC_path.t
Sourceval mempool_path : ('a, 'b) Tezos_base__TzPervasives.RPC_path.t -> ('a, 'b) Tezos_base__TzPervasives.RPC_path.t
Sourceval live_blocks_path : ('a, 'b) Tezos_base__TzPervasives.RPC_path.t -> ('a, 'b) Tezos_base__TzPervasives.RPC_path.t
Sourcetype operation_list_quota = {
  1. max_size : int;
  2. max_op : int option;
}
Sourcetype raw_context =
  1. | Key of Bytes.t
    (*

    A leaf, containing a value

    *)
  2. | Dir of raw_context Tezos_base__TzPervasives.TzString.Map.t
    (*

    A directory, mapping keys to nested raw_contexts

    *)
  3. | 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

Sourceval raw_context_eq : raw_context -> raw_context -> bool

raw_context_eq rc1 rc2 tests whether rc1 and rc2 are equal, * that is, have the same constructors; and the constructor's content * are recursively equal

Sourceval raw_context_encoding : raw_context Tezos_base__TzPervasives.Data_encoding.t
Sourceval pp_raw_context : Format.formatter -> raw_context -> unit
Sourceval raw_context_insert : (string list * raw_context) -> raw_context -> raw_context

raw_context_insert (k,v) c inserts a key-value pair (k,v) in a raw_context c. If k collides to a existing sub-tree in c, the sub-tree is replaced by a new key-value pair.

Sourcetype merkle_hash_kind =
  1. | Contents
    (*

    The kind associated to leaves

    *)
  2. | Node
    (*

    The kind associated to directories

    *)

The kind of a merkle_node

Sourcetype 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

Sourceand merkle_tree = merkle_node Tezos_base__TzPervasives.TzString.Map.t

The type of Merkle tree used by the light mode

Sourceval merkle_tree_eq : merkle_tree -> merkle_tree -> bool

merkle_tree_eq mtree1 mtree2 tests whether mtree1 and mtree2 are equal, * that is, have the same constructors; and the constructor's content * are recursively equal

Sourcetype 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)

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