package tezos-dal-node-lib

You can search for identifiers within the package.

in-package search v0.2.0

tezos-dal-node-lib
- Tezos_dal_node_lib
  - Dal_node_client
    
    cctxt
    
    unix_cctxt
  - Dal_plugin
    
    T
    
    Proto
    
    Mempool
tezos-dal-node-lib.gossipsub
- Tezos_dal_node_lib_gossipsub
  - Gossipsub
    
    Transport_layer
    
    Default_parameters
    
    P2p_config
    
    P2p_limits
    
    P2p_reconnection_config
    
    Interface
    
    Transport_layer_hooks
    
    Worker
    
    Config
    
    GS
    
    Introspection
    
    Connections
    
    Message_cache
    
    Internal_for_tests
    
    Message
    
    Message_id
    
    Map
    
    Set
    
    Peer
    
    Map
    
    Set
    
    Score
    
    Internal_for_tests
    
    Time
    
    Topic
    
    Map
    
    Set
    
    Stream
    
    Default_parameters
    
    Limits
    
    Peer_filter
    
    Score
    
    Topic_score
    
    GS
    
    Introspection
    
    Connections
    
    Message_cache
    
    Internal_for_tests
    
    Message
    
    Message_id
    
    Map
    
    Set
    
    Peer
    
    Map
    
    Set
    
    Score
    
    Internal_for_tests
    
    Time
    
    Topic
    
    Map
    
    Set
    
    Logging
    
    Monad
    
    Stream
    
    Validate_message_hook
  - Gs_default_parameters
    
    Limits
    
    Peer_filter
    
    Score
    
    Topic_score
  - Gs_interface
    
    Monad
    
    Span
    
    Validate_message_hook
    
    Worker_config
    
    GS
    
    Introspection
    
    Connections
    
    Message_cache
    
    Internal_for_tests
    
    Message
    
    Message_id
    
    Map
    
    Set
    
    Peer
    
    Map
    
    Set
    
    Score
    
    Internal_for_tests
    
    Time
    
    Topic
    
    Map
    
    Set
    
    Stream
    
    Worker_instance
    
    GS
    
    Introspection
    
    Connections
    
    Message_cache
    
    Internal_for_tests
    
    Message
    
    Message_id
    
    Map
    
    Set
    
    Peer
    
    Map
    
    Set
    
    Score
    
    Internal_for_tests
    
    Time
    
    Topic
    
    Map
    
    Set
    
    Stream
  - Gs_logging
  - Gs_transport_connection
  - Transport_layer_default_parameters
    
    P2p_config
    
    P2p_limits
    
    P2p_reconnection_config
  - Transport_layer_interface

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

the types p2p_message, peer_metadata and connection_metadata, used to instantiate type variables of P2p.t;

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.

type px_peer = {

point : Tezos_base.TzPervasives.P2p_point.Id.t;
peer : Tezos_base.TzPervasives.P2p_peer.Id.t;

}

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

type p2p_message =

| Graft of {
1. topic : Gs_interface.topic;
}
| Prune of {
1. topic : Gs_interface.topic;
2. px : px_peer Tezos_base.TzPervasives.Seq.t;
3. backoff : Gs_interface.Span.t;
}
| IHave of {
1. topic : Gs_interface.topic;
2. message_ids : Gs_interface.message_id list;
}
| IWant of {
1. message_ids : Gs_interface.message_id list;
}
| Subscribe of {
1. topic : Gs_interface.topic;
}
| Unsubscribe of {
1. topic : Gs_interface.topic;
}
| 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.

type peer_metadata = unit

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

type connection_metadata = unit

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

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

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

val peer_meta_config : peer_metadata Tezos_p2p.P2p_params.peer_meta_config

val conn_meta_config : 
  connection_metadata Tezos_p2p.P2p_params.conn_meta_config