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
    
    Default_parameters
    
    Limits
    
    Peer_filter
    
    Score
    
    Topic_score
    
    GS
    
    Introspection
    
    Connections
    
    Message_cache
    
    Internal_for_tests
    
    Introspection
    
    Map
    
    Message
    
    Message_id
    
    Map
    
    Set
    
    Peer
    
    Map
    
    Set
    
    Time
    
    Topic
    
    Map
    
    Set
    
    Message
    
    Message_id
    
    Map
    
    Set
    
    Peer
    
    Map
    
    Set
    
    Score
    
    Internal_for_tests
    
    Introspection
    
    Span
    
    Time
    
    Topic
    
    Map
    
    Set
    
    Introspection
    
    Logging
    
    Monad
    
    Stream
    
    Validate_message_hook
  - Gs_default_parameters
    
    Limits
    
    Peer_filter
    
    Score
    
    Topic_score
  - Gs_interface
    
    Validate_message_hook
  - 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

The worker module exposes instantiation of the Gossipsub worker functor, alongside the config used to instantiate the functor and the default values of the GS parameters.

module Config : 
  module type of Tezos_dal_node_lib_gossipsub.Gs_interface.Worker_config
    with type GS.Topic.t = Tezos_dal_node_services.Types.Topic.t
     and type GS.Message_id.t = Tezos_dal_node_services.Types.Message_id.t
     and type GS.Message.t = Tezos_dal_node_services.Types.Message.t
     and type GS.Peer.t = Tezos_dal_node_services.Types.Peer.t
     and type GS.Span.t = Tezos_dal_node_services.Types.Span.t
     and type GS.Time.t = Tezos_dal_node_services.Types.Time.t
     and type 'a Monad.t = 'a Lwt.t

module Default_parameters : module type of Gs_default_parameters

This module defines the default values for simple Gossip parameters and limits. These values are used or re-defined in the DAL node before instantiating the Gossipsub worker.

include Tezos_gossipsub.Gossipsub_intf.WORKER
  with type GS.Topic.t = Tezos_dal_node_services.Types.Topic.t
   and type GS.Message_id.t = Tezos_dal_node_services.Types.Message_id.t
   and type GS.Message.t = Tezos_dal_node_services.Types.Message.t
   and type GS.Peer.t = Tezos_dal_node_services.Types.Peer.t
   and type GS.Span.t = Tezos_dal_node_services.Types.Span.t
   and type GS.Time.t = Tezos_dal_node_services.Types.Time.t

type t

module GS : sig ... end

module Monad : sig ... end

module Stream : sig ... end

type message_with_header = {

message : GS.Message.t;
topic : GS.Topic.t;
message_id : GS.Message_id.t;

}

type p2p_message =

| Graft of {
1. topic : GS.Topic.t;
}
| Prune of {
1. topic : GS.Topic.t;
2. px : GS.Peer.t Tezos_base.TzPervasives.Seq.t;
3. backoff : GS.Span.t;
}
| IHave of {
1. topic : GS.Topic.t;
2. message_ids : GS.Message_id.t list;
}
| IWant of {
1. message_ids : GS.Message_id.t list;
}
| Subscribe of {
1. topic : GS.Topic.t;
}
| Unsubscribe of {
1. topic : GS.Topic.t;
}
| Message_with_header of message_with_header

type p2p_input =

| In_message of {
1. from_peer : GS.Peer.t;
2. p2p_message : p2p_message;
}
| New_connection of {
1. peer : GS.Peer.t;
2. direct : bool;
3. trusted : bool;
4. bootstrap : bool;
}
| Disconnection of {
1. peer : GS.Peer.t;
}

type app_input =

| Publish_message of message_with_header
| Join of GS.Topic.t
| Leave of GS.Topic.t

type peer_origin =

| PX of GS.Peer.t
| Trusted

type p2p_output =

| Out_message of {
1. to_peer : GS.Peer.t;
2. p2p_message : p2p_message;
}
| Disconnect of {
1. peer : GS.Peer.t;
}
| Kick of {
1. peer : GS.Peer.t;
}
| Connect of {
1. peer : GS.Peer.t;
2. origin : peer_origin;
}
| Forget of {
1. peer : GS.Peer.t;
2. origin : GS.Peer.t;
}

type app_output = message_with_header

type event = private

| Heartbeat
| P2P_input of p2p_input
| App_input of app_input

val make : 
  ?events_logging:(event -> unit Monad.t) ->
  Random.State.t ->
  (GS.Topic.t, GS.Peer.t, GS.Message_id.t, GS.span)
    Tezos_gossipsub__Gossipsub_intf.limits ->
  (GS.Peer.t, GS.Message_id.t) Tezos_gossipsub__Gossipsub_intf.parameters ->
  t

val start : GS.Topic.t list -> t -> unit

val shutdown : t -> unit Monad.t

val app_input : t -> app_input -> unit

val p2p_input : t -> p2p_input -> unit

val p2p_output_stream : t -> p2p_output Stream.t

val app_output_stream : t -> app_output Stream.t

val input_events_stream : t -> event Stream.t

val is_subscribed : t -> GS.Topic.t -> bool

val pp_p2p_output : Format.formatter -> p2p_output -> unit

val pp_app_output : Format.formatter -> app_output -> unit

module Introspection : sig ... end

val stats : t -> Introspection.stats

val state : t -> GS.Introspection.view

module Logging : sig ... end

module Validate_message_hook : sig ... end

A hook to set or update messages and messages IDs validation function. Should be called once at startup and every time the DAL parameters change.