package tezos-dal-node-lib

  1. Overview
  2. Docs
Tezos: `tezos-dal-node` library

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/tezos-dal-node-lib.gossipsub/Tezos_dal_node_lib_gossipsub/Transport_layer_interface/index.html

Module Tezos_dal_node_lib_gossipsub.Transport_layer_interfaceSource

This module defines the data structures used to instantiate the Octez P2P library. More exactly, it exposes:

  • the values peer_metadata_cfg of type P2p_params.peer_meta_config, conn_metadata_cfg of type P2p_params.conn_meta_config and message_cfg of type P2p_params.message_config that are used when calling P2p.create.

Peers exchanged via PX. point represents the (address, port) pair of the exchanged peer, while peer represents the cryptographic identity of the peer.

Sourcetype p2p_message =
  1. | Graft of {
    1. topic : Gs_interface.topic;
    }
  2. | Prune of {
    1. topic : Gs_interface.topic;
    2. px : px_peer Tezos_base.TzPervasives.Seq.t;
    3. backoff : Gs_interface.Span.t;
    }
  3. | IHave of {
    1. topic : Gs_interface.topic;
    2. message_ids : Gs_interface.message_id list;
    }
  4. | IWant of {
    1. message_ids : Gs_interface.message_id list;
    }
  5. | Subscribe of {
    1. topic : Gs_interface.topic;
    }
  6. | Unsubscribe of {
    1. topic : Gs_interface.topic;
    }
  7. | Message_with_header of {
    1. message : Gs_interface.message;
    2. topic : Gs_interface.topic;
    3. message_id : Gs_interface.message_id;
    }

Without piggybacking, p2p_message is almost identical to Gs_interface.p2p_message, except that for the Prune case, P2p_peer.Id.t elements in px are augmented by their P2p_point.Id.t counterpart.

Sourcetype peer_metadata = unit

peer_metadata is not used. So, its value is unit.

Sourcetype connection_metadata = unit

connection_metadata is not used currently. So, its value is unit.

Sourceval message_config : network_name:string -> p2p_message Tezos_p2p.P2p_params.message_config

A P2P message config is parameterized by the network's name.