P2PNetworkBuilder

P2PNetworkBuilder is a tool that provides a framework for creating networks of devices in Peer-to-peer manner. Is such networks, all devices are connected to each other. You can use it as a backbone of decentralized systems.

Key features:

  • Uses UDP Hole Punching technique to connect devices hidden behind NATs
  • Provides end-to-end encryption of sent message’s content
  • Uses public-key cryptography to exchange keys
  • Operates on custom UDP based Internet protocol which ensures packet delivery in correct order
  • Detects network memebers automatically. To enter the network you need to manually connect to one node, library will handle connection to the rest.

Installation

Package is available on Nuget package manager

$ dotnet add package P2PNetworkBuilder

Usage

For working example with explanation comments, look at source code of NetworkBuilderDemo project in this repository.

All you need to do to set up network node is to create INetworkController instance and specify port listener:

INetworkController network = new NetworkManagerFactory().Create();

network.StartListening(1234);

Now, device listens for incoming packets on specified port. External device can connect to it via ConnectManually command:

IExternalNode node = network.ConnectManually(new IPEndPoint(IPAddress.Parse("127.0.0.1"), 1234));

All nodes exchange information about other network memebers with each other. That means you need to connect to only one node, others will appear automatically.

You can easily iterate over all network nodes, check their Id and status:

foreach (var node in network.Nodes)
{
    Console.WriteLine($"{n.Id} \t" +
        $" {Enum.GetName(typeof(ExternalNode.ConnectionState), n.CurrentState)} \t" +
        $" {n.CurrentEndpoint}");
}

To communicate with other nodes in network, you can use SendBytes method. The first parameter it takes is called messageType. It informs external node about purpose of your message. Keep in mind that some of numbers are reserved and used by framework internally. To avoid message conflicts, follow instructions from NetworkBuilderDemo example.

node.SendBytes(1234, new byte[] { 1, 2, 3, 4 }, (result) =>
    {
        // this code executes after receving acknowledge that message was delivered 
        if(result == AckStatus.Success){
            // message processed successfully
        }
        else {
            // external node reported error while processing this message
        }
    });
Links

Library for building P2P networks

2020-12-14