package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type version =
  1. | Version_0
  2. | Version_1
  3. | Version_2
type chain = [
  1. | `Main
  2. | `Test
  3. | `Hash of Tezos_base.TzPervasives.Chain_id.t
]
type chain_prefix = unit * chain
val chain_path : (unit, chain_prefix) Tezos_rpc.Path.t
val parse_chain : string -> (chain, string) Stdlib.result
val chain_to_string : chain -> string
val chain_arg : chain Tezos_rpc.Arg.t
type 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 Stdlib.Int32.t
    (*

    The block at a given level

    *)
]

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

val parse_block : string -> (block, string) Stdlib.result
type range = [ `Level of Stdlib.Int32.t ] * [ `Level of Stdlib.Int32.t ]
val parse_block_range : string -> (range, string) Stdlib.result

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

type block_or_range =
  1. | Block of block
  2. | Range of range
val parse_block_or_range : string -> (block_or_range, string) Stdlib.result
val to_string : block -> string
type prefix = (unit * chain) * block
val mempool_path : ('a, 'b) Tezos_rpc.Path.t -> ('a, 'b) Tezos_rpc.Path.t
val live_blocks_path : ('a, 'b) Tezos_rpc.Path.t -> ('a, 'b) Tezos_rpc.Path.t
type operation_list_quota = {
  1. max_size : int;
  2. max_op : int option;
}
val 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.

module type PROTO = sig ... end
type protocols = {
  1. current_protocol : Tezos_base.TzPervasives.Protocol_hash.t;
  2. next_protocol : Tezos_base.TzPervasives.Protocol_hash.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