package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

octez-19.1.tar.gz
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/octez-shell-libs.shell-services/Tezos_shell_services/Block_services/index.html

Module Tezos_shell_services.Block_servicesSource

Sourcemodule Proof = Tezos_context_sigs.Context.Proof_types
Sourcetype version =
  1. | Version_0
  2. | Version_1
  3. | Version_2
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_rpc.Path.t
Sourceval parse_chain : string -> (chain, string) result
Sourceval chain_to_string : chain -> string
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
Sourcetype range = [ `Level of Int32.t ] * [ `Level of Int32.t ]
Sourceval parse_block_range : string -> (range, string) result

A block range in the form level..level. Currently, this function supports only level..level.

Sourcetype block_or_range =
  1. | Block of block
  2. | Range of range
Sourceval parse_block_or_range : string -> (block_or_range, string) result
Sourceval to_string : block -> string
Sourcetype prefix = (unit * chain) * block
Sourceval mempool_path : ('a, 'b) Tezos_rpc.Path.t -> ('a, 'b) Tezos_rpc.Path.t
Sourceval live_blocks_path : ('a, 'b) Tezos_rpc.Path.t -> ('a, 'b) Tezos_rpc.Path.t
Sourcetype operation_list_quota = {
  1. max_size : int;
  2. max_op : int option;
}
Sourceval raw_context_encoding : Proof.raw_context Tezos_base.TzPervasives.Data_encoding.t
Sourceval raw_context_insert : (string list * Proof.raw_context) -> Proof.raw_context -> Proof.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.

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_rpc.Context.simple -> ?chain:chain -> ?block:block -> unit -> protocols Tezos_base.TzPervasives.tzresult Lwt.t
Sourcemodule Make (Proto : PROTO) (Next_proto : PROTO) : sig ... end
Sourcemodule Empty : sig ... end