package tezos-shell

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Network database
Sending messages

tezos-shell
- Tezos_shell

Legend:
Library
Module
Module type
Parameter
Class
Class type

Tezos Shell - High-level API for the Gossip network and local storage.

It provides functions to query *static* resources such as blocks headers, operations, and functions to access dynamic resources such as heads and chains.

Several chains (mainchain, testchain, ...) can be managed independently. First a chain is activated using activate, which provides a chain_db from which it is possible to access resources. Eventually the chain is deactivated using deactivate.

Static resources are accessible via "Requester" modules (Block_header, Operation, Operations, Protocol). These modules act as read-through caches in front of the local storage State and the p2p layer. They centralize concurrent requests, and cache results in memory. They don't update State directly.

For instance, from a block_header hash, one can fetch the actual block header using Block_header.fetch, then the block operations with Operations.fetch.

module Message = Distributed_db_message

type t

type db = t

type p2p =
  (Message.t,
    Tezos_p2p_services.Peer_metadata.t,
    Tezos_p2p_services.Connection_metadata.t)
    Tezos_p2p.P2p.net

val create : State.t -> p2p -> t

val state : db -> State.t

val shutdown : t -> unit Lwt.t

Network database

type chain_db

An instance of the distributed DB for a given chain

val activate : t -> State.Chain.t -> chain_db

The first call to activate t chain activates chain, creates a chain_db and sends a Get_current_branch chain_id message to all neighbors, where chain_id is the identifier of chain. This informs the neighbors that this node expects notifications for new heads/mempools. Subsequent calls simply return the existing chain_db.

val get_chain : t -> Tezos_crypto.Chain_id.t -> chain_db option

Look for the database of an active chain.

val deactivate : chain_db -> unit Lwt.t

deactivate chain_db sends a Deactivate chain_id message to all active neighbors for this chain. This notifies them that this node isn't interested in messages for this chain

val set_callback : chain_db -> P2p_reader.callback -> unit

val disconnect : chain_db -> Tezos_base.P2p_peer.Id.t -> unit Lwt.t

Kick a given peer.

val greylist : chain_db -> Tezos_base.P2p_peer.Id.t -> unit Lwt.t

Greylist a given peer.

val chain_state : chain_db -> State.Chain.t

val db : chain_db -> db

val information : 
  chain_db ->
  Tezos_shell_services.Chain_validator_worker_state.Distributed_db_state.view

val my_peer_id : chain_db -> Tezos_base.P2p_peer.Id.t

Return the peer id of the node

val get_peer_metadata : 
  chain_db ->
  Tezos_base.P2p_peer.Id.t ->
  Tezos_p2p_services.Peer_metadata.t

Sending messages

module Request : sig ... end

module Advertise : sig ... end

Block index

module Block_header : sig ... end

Index of block headers.

val read_block_header : 
  db ->
  Tezos_crypto.Block_hash.t ->
  (Tezos_crypto.Chain_id.t * Block_header.t) option Lwt.t

Lookup for block header in any active chains

module Operations : 
  Tezos_requester.Requester.REQUESTER
    with type t := chain_db
     and type key = Tezos_crypto.Block_hash.t * int
     and type value = Tezos_base.Operation.t list
     and type param := Tezos_crypto.Operation_list_list_hash.t

Index of all the operations of a given block (per validation pass).

val commit_block : 
  chain_db ->
  Tezos_crypto.Block_hash.t ->
  Block_header.t ->
  Stdlib.Bytes.t ->
  Tezos_base.Operation.t list list ->
  Stdlib.Bytes.t list list ->
  Tezos_crypto.Block_metadata_hash.t option ->
  Tezos_crypto.Operation_metadata_hash.t list list option ->
  Tezos_validation.Block_validation.validation_store ->
  forking_testchain:bool ->
  (State.Block.t option, Tezos_error_monad.TzCore.error list) Stdlib.result
    Lwt.t

Store on disk all the data associated to a valid block.

val commit_invalid_block : 
  chain_db ->
  Tezos_crypto.Block_hash.t ->
  Block_header.t ->
  Tezos_error_monad.TzCore.error list ->
  (bool, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Store on disk all the data associated to an invalid block.

val watch_block_header : 
  t ->
  (Tezos_crypto.Block_hash.t * Block_header.t) Lwt_stream.t
  * Lwt_watcher.stopper

Monitor all the fetched block headers (for all activate chains).

Operations index

module Operation : sig ... end

Index of operations (for the mempool).

val inject_operation : 
  chain_db ->
  Tezos_crypto.Operation_hash.t ->
  Operation.t ->
  bool Lwt.t

Inject a new operation in the local index (memory only).

val watch_operation : 
  t ->
  (Tezos_crypto.Operation_hash.t * Operation.t) Lwt_stream.t
  * Lwt_watcher.stopper

Monitor all the fetched operations (for all activate chains).

Protocol index

module Protocol : sig ... end

Index of protocol sources.

val commit_protocol : 
  db ->
  Tezos_crypto.Protocol_hash.t ->
  Protocol.t ->
  (bool, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Store on disk protocol sources.