package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module defines the messages of the P2p layers.

P2p messages are parameterized by a generic upper-layer message type 'msg. The P2p layer serializes these 'msg using a 'msg encoding' provided by the client of this lib.

The P2p protocol is simple and can be deduced mostly from the message type. To make the network topology more dynamic, it implements a simple peer swapping mechanism which works as follows.

Peer A sends a message : Swap_request (point, peer) to B. If B is already connected to the peer, the message is ignored. Otherwise B picks a peer peer' at point point' and connect to peer. If successful, it sends a response Swap_ack (point', peer') to A. Upon reception of Swap_ack. B tries to connected to peer'. If successful, it disconnect from peer.

type 'msg t =
  1. | Bootstrap
    (*

    Welcome message sent by a peer upon connection

    *)
  2. | Advertise of Tezos_base.TzPervasives.P2p_point.Id.t list
    (*

    Response to a Bootstrap message, contains list of known points

    *)
  3. | Swap_request of Tezos_base.TzPervasives.P2p_point.Id.t * Tezos_base.TzPervasives.P2p_peer.Id.t
    (*

    Propose new peer/point and ask a peer/point to swap with

    *)
  4. | Swap_ack of Tezos_base.TzPervasives.P2p_point.Id.t * Tezos_base.TzPervasives.P2p_peer.Id.t
    (*

    Response to a swap request and propose peer/point to swap with.

    *)
  5. | Message of 'msg
    (*

    Generic upper-layer message

    *)
  6. | Disconnect
    (*

    Ending of connection, unused for now

    *)
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