#p2p #tcp-connection #node #low-level #customizable #handshake

pea2pea

A simple, low-level, and customizable implementation of a TCP P2P node

67 releases (breaking)

0.50.0 Jul 5, 2024
0.49.0 Dec 29, 2023
0.48.0 Jul 3, 2023
0.45.0 Jan 13, 2023
0.8.0 Dec 31, 2020

#904 in Network programming

Download history 169/week @ 2024-07-08 126/week @ 2024-07-15 115/week @ 2024-07-22 212/week @ 2024-07-29 155/week @ 2024-08-05 164/week @ 2024-08-12 71/week @ 2024-08-19 166/week @ 2024-08-26 198/week @ 2024-09-02 173/week @ 2024-09-09 94/week @ 2024-09-16 462/week @ 2024-09-23 142/week @ 2024-09-30 46/week @ 2024-10-07 69/week @ 2024-10-14 111/week @ 2024-10-21

487 downloads per month
Used in 3 crates

CC0 license

230KB
1K SLoC

pea2pea

crates.io docs.rs dependencies actively developed issues

pea2pea is a simple, low-level, and customizable implementation of a TCP P2P node.

The core library only provides the most basic functionalities like starting, ending and maintaining connections; the rest is up to a few low-level, opt-in protocols:

  • Handshake requires connections to adhere to the given handshake logic before anything else can be done with them
  • Reading enables the node to receive messages based on the user-supplied Decoder
  • Writing enables the node to send messages based on the user-supplied Encoder
  • OnDisconnect makes the node perform specified actions whenever a connection with a peer is severed
  • OnConnect makes the node perform specified actions whenever a connection with a peer is fully established (post-handshake)

goals

  • small, simple, non-framework codebase: the entire library is ~1k LOC and there are few dependencies
  • ease of use: few objects and traits, no "turboeels" or generics/references that would force all parent objects to adapt
  • correctness: builds with stable Rust, there is no unsafe code, there's more code in tests than in the actual library
  • low-level: the user has full control over all connections and every byte sent or received
  • good performance: over 10GB/s in favorable scenarios, small memory footprint

how to use it

  1. define a clonable struct containing a Node and any extra state you'd like to carry alongside it
  2. implement the trivial Pea2Pea trait for it
  3. make it implement any/all of the protocols
  4. create that struct (or as many of them as you like)
  5. enable the protocols you'd like them to utilize

That's it!

examples

  • including noise encryption, simple interop with libp2p, or TLS connections

status

  • all the desired functionalities are complete
  • the crate follows semver, and some API breakage is still possible before 1.0
  • the project is actively developed, with all changes being recorded in the CHANGELOG
  • some of the desired features that are not yet available in Rust include associated type defaults
  • the project aims to always build with the current stable Rust compiler; legacy version support is not a goal, but they might also work

Dependencies

~4–12MB
~125K SLoC