Add gossipsub

README.md

@@ -13,37 +13,38 @@
 
 The project aims to implement [libp2p](https://libp2p.io) to unlock building .NET peer-to-peer applications using a battle-tested specification of network communication of the new age.
 
-As an application developer, you may consider reading [quick start](./docs/quick-start.md).
+As an application developer, you may consider reading [quick start](./docs/README.md).
 As a stack implementer, you may be interested in [more advanced tutorials](./docs/development/README.md).
-**Contributors are welcomed**, kindly check the issues tab, everything there if not assigned to a person can be taken into work. More details in [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+**Contributions are welcome**, kindly check the [issues](https://github.com/NethermindEth/dotnet-libp2p/issues) tab, everything there if not assigned to a person can be taken into work. More details in [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ## Roadmap
 
-From the beginning, the target is to provide a performant well-tested implementation that works on multiple platforms. With high throughput and low memory profile. The modules to be implemented firstly should cover basic P2P application needs.
+From the beginning, the target is to provide a performant well-tested implementation that works on multiple platforms, with high throughput and low memory profile.
+See the [milestones](https://github.com/NethermindEth/dotnet-libp2p/milestones?direction=asc&sort=due_date&state=open).
 
 | Protocol           | Version            | Status          |
 |--------------------|--------------------|-----------------|
 | **Transports**
 | TCP                | tcp                | ✅             |
-| QUIC               | quic               | ⬜ help wanted |
-|                    | quic-v1            | ⬜ help wanted |
+| QUIC               | quic               | 🚧             |
+|                    | quic-v1            | 🚧             |
 | **Protocols**
 | multistream-select | /multistream/1.0.0 | ✅             |
 | plaintext          | /plaintext/2.0.0   | ✅             |
 | noise              | /noise             | ✅             |
-| mplex?             | /mplex/6.7.0       | ⬜             |
 | yamux              | /yamux/1.0.0       | ✅             |
 | Identify           | /ipfs/id/1.0.0     | ✅             |
-| ping               | /ipfs/ping/1.0.0   | 🚧             |
+| ping               | /ipfs/ping/1.0.0   | ✅             |
 | pubsub             | /floodsub/1.0.0    | ✅             |
-|                    | /meshsub/1.0.0     | 🚧             |
+|                    | /meshsub/1.0.0     | ✅             |
 |                    | /meshsub/1.1.0     | 🚧             |
 |                    | /meshsub/1.2.0     | ⬜             |
-| Circuit Relay      |                    | ⬜ help wanted |
+| Circuit Relay      | /libp2p/circuit/relay/0.2.0/* | ⬜ help wanted |
 | **Discovery**
 | mDns               | basic              | ✅             |
-|                    | DNS-SD             | ⬜             |
-| discv5             | 5.1                | ⬜ help wanted |
+|                    | DNS-SD             | 🚧             |
+| [discv5](https://github.com/Pier-Two/Lantern.Discv5) | 5.1 | ⬜ help wanted |
 
 ⬜ - not yet implemented<br>
 🚧 - work in progress<br>

docs/development/README.md

@@ -4,5 +4,5 @@ Libp2p protocols can be divided into 2 layers:
 - Transport layer protocols, that actively use peer address to discover network and establish connection;
 - Application layer protocols, that is used to exchange actual payload once the connection is active.
 
-To contribute to libp2p stack or build your own, kindly check [Developing a transport layer protocol](./transport-layer.md) and also [the list of best practices](./best-practices.md).
+To contribute to libp2p stack or build your own, kindly check [developing a transport layer protocol](./transport-layer.md) and also [the list of best practices](./best-practices.md).
 

src/libp2p/Libp2p.Core.Tests/IdentityTests.cs

@@ -0,0 +1,39 @@
+// SPDX-FileCopyrightText: 2023 Demerzel Solutions Limited
+// SPDX-License-Identifier: MIT
+
+using Google.Protobuf;
+using Nethermind.Libp2p.Core.Dto;
+namespace Nethermind.Libp2p.Core.Tests;
+public class IdentityTests
+{
+    [TestCaseSource(nameof(ExpectedKeysEncoded))]
+    public void Test_KeyEncoding(byte[] privateKey, byte[] publicKey)
+    {
+        Identity identity = new(PrivateKey.Parser.ParseFrom(privateKey));
+        Assert.That(identity.PublicKey.ToByteArray(), Is.EquivalentTo(publicKey));
+    }
+
+    public static IEnumerable<TestCaseData> ExpectedKeysEncoded()
+    {
+        yield return new TestCaseData(
+            Convert.FromHexString("08031279307702010104203E5B1FE9712E6C314942A750BD67485DE3C1EFE85B1BFB520AE8F9AE3DFA4A4CA00A06082A8648CE3D030107A14403420004DE3D300FA36AE0E8F5D530899D83ABAB44ABF3161F162A4BC901D8E6ECDA020E8B6D5F8DA30525E71D6851510C098E5C47C646A597FB4DCEC034E9F77C409E62"),
+            Convert.FromHexString("0803125b3059301306072a8648ce3d020106082a8648ce3d03010703420004de3d300fa36ae0e8f5d530899d83abab44abf3161f162a4bc901d8e6ecda020e8b6d5f8da30525e71d6851510c098e5c47c646a597fb4dcec034e9f77c409e62")
+            )
+        { TestName = "Ecdsa" };
+        yield return new TestCaseData(
+            Convert.FromHexString("080112407e0830617c4a7de83925dfb2694556b12936c477a0e1feb2e148ec9da60fee7d1ed1e8fae2c4a144b8be8fd4b47bf3d3b34b871c3cacf6010f0e42d474fce27e"),
+            Convert.FromHexString("080112201ed1e8fae2c4a144b8be8fd4b47bf3d3b34b871c3cacf6010f0e42d474fce27e")
+            )
+        { TestName = "Ed25519" };
+        yield return new TestCaseData(
+            Convert.FromHexString("0802122053DADF1D5A164D6B4ACDB15E24AA4C5B1D3461BDBD42ABEDB0A4404D56CED8FB"),
+            Convert.FromHexString("08021221037777e994e452c21604f91de093ce415f5432f701dd8cd1a7a6fea0e630bfca99")
+            )
+        { TestName = "Secp256K1" };
+        yield return new TestCaseData(
+            Convert.FromHexString("080012ae123082092a0201000282020100e1beab071d08200bde24eef00d049449b07770ff9910257b2d7d5dda242ce8f0e2f12e1af4b32d9efd2c090f66b0f29986dbb645dae9880089704a94e5066d594162ae6ee8892e6ec70701db0a6c445c04778eb3de1293aa1a23c3825b85c6620a2bc3f82f9b0c309bc0ab3aeb1873282bebd3da03c33e76c21e9beb172fd44c9e43be32e2c99827033cf8d0f0c606f4579326c930eb4e854395ad941256542c793902185153c474bed109d6ff5141ebf9cd256cf58893a37f83729f97e7cb435ec679d2e33901d27bb35aa0d7e20561da08885ef0abbf8e2fb48d6a5487047a9ecb1ad41fa7ed84f6e3e8ecd5d98b3982d2a901b4454991766da295ab78822add5612a2df83bcee814cf50973e80d7ef38111b1bd87da2ae92438a2c8cbcc70b31ee319939a3b9c761dbc13b5c086d6b64bf7ae7dacc14622375d92a8ff9af7eb962162bbddebf90acb32adb5e4e4029f1c96019949ecfbfeffd7ac1e3fbcc6b6168c34be3d5a2e5999fcbb39bba7adbca78eab09b9bc39f7fa4b93411f4cc175e70c0a083e96bfaefb04a9580b4753c1738a6a760ae1afd851a1a4bdad231cf56e9284d832483df215a46c1c21bdf0c6cfe951c18f1ee4078c79c13d63edb6e14feaeffabc90ad317e4875fe648101b0864097e998f0ca3025ef9638cd2b0caecd3770ab54a1d9c6ca959b0f5dcbc90caeefc4135baca6fd475224269bbe1b02030100010282020100a472ffa858efd8588ce59ee264b957452f3673acdf5631d7bfd5ba0ef59779c231b0bc838a8b14cae367b6d9ef572c03c7883b0a3c652f5c24c316b1ccfd979f13d0cd7da20c7d34d9ec32dfdc81ee7292167e706d705efde5b8f3edfcba41409e642f8897357df5d320d21c43b33600a7ae4e505db957c1afbc189d73f0b5d972d9aaaeeb232ca20eebd5de6fe7f29d01470354413cc9a0af1154b7af7c1029adcd67c74b4798afeb69e09f2cb387305e73a1b5f450202d54f0ef096fe1bde340219a1194d1ac9026e90b366cce0c59b239d10e4888f52ca1780824d39ae01a6b9f4dd6059191a7f12b2a3d8db3c2868cd4e5a5862b8b625a4197d52c6ac77710116ebd3ced81c4d91ad5fdfbed68312ebce7eea45c1833ca3acf7da2052820eacf5c6b07d086dabeb893391c71417fd8a4b1829ae2cf60d1749d0e25da19530d889461c21da3492a8dc6ccac7de83ac1c2185262c7473c8cc42f547cc9864b02a8073b6aa54a037d8c0de3914784e6205e83d97918b944f11b877b12084c0dd1d36592f8a4f8b8da5bb404c3d2c079b22b6ceabfbcb637c0dbe0201f0909d533f8bf308ada47aee641a012a494d31b54c974e58b87f140258258bb82f31692659db7aa07e17a5b2a0832c24e122d3a8babcc9ee74cbb07d3058bb85b15f6f6b2674aba9fd34367be9782d444335fbed31e3c4086c652597c27104938b47fa10282010100e9fdf843c1550070ca711cb8ff28411466198f0e212511c3186623890c0071bf6561219682fe7dbdfd81176eba7c4faba21614a20721e0fcd63768e6d925688ecc90992059ac89256e0524de90bf3d8a052ce6a9f6adafa712f3107a016e20c80255c9e37d8206d1bc327e06e66eb24288da866b55904fd8b59e6b2ab31bc5eab47e597093c63fab7872102d57b4c589c66077f534a61f5f65127459a33c91f6db61fc431b1ae90be92b4149a3255291baf94304e3efb77b1107b5a3bda911359c40a53c347ff9100baf8f36dc5cd991066b5bdc28b39ed644f404afe9213f4d31c9d4e40f3a5f5e3c39bebeb244e84137544e1a1839c1c8aaebf0c78a7fad590282010100f6fa1f1e6b803742d5490b7441152f500970f46feb0b73a6e4baba2aaf3c0e245ed852fc31d86a8e46eb48e90fac409989dfee45238f97e8f1f8e83a136488c1b04b8a7fb695f37b8616307ff8a8d63e8cfa0b4fb9b9167ffaebabf111aa5a4344afbabd002ae8961c38c02da76a9149abdde93eb389eb32595c29ba30d8283a7885218a5a9d33f7f01dbdf85f3aad016c071395491338ec318d39220e1c7bd69d3d6b520a13a30d745c102b827ad9984b0dd6aed73916ffa82a06c1c111e7047dcd2668f988a0570a71474992eecf416e068f029ec323d5d635fd24694fc9bf96973c255d26c772a95bf8b7f876547a5beabf86f06cd21b67994f944e7a5493028201010095b02fd30069e547426a8bea58e8a2816f33688dac6c6f6974415af8402244a22133baedf34ce499d7036f3f19b38eb00897c18949b0c5a25953c71aeeccfc8f6594173157cc854bd98f16dffe8f28ca13b77eb43a2730585c49fc3f608cd811bb54b03b84bddaa8ef910988567f783012266199667a546a18fd88271fbf63a45ae4fd4884706da8befb9117c0a4d73de5172f8640b1091ed8a4aea3ed4641463f5ff6a5e3401ad7d0c92811f87956d1fd5f9a1d15c7f3839a08698d9f35f9d966e5000f7cb2655d7b6c4adcd8a9d950ea5f61bb7c9a33c17508f9baa313eecfee4ae493249ebe05a5d7770bbd3551b2eeb752e3649e0636de08e3d672e66cb90282010100ad93e4c31072b063fc5ab5fe22afacece775c795d0efdf7c704cfc027bde0d626a7646fc905bb5a80117e3ca49059af14e0160089f9190065be9bfecf12c3b2145b211c8e89e42dd91c38e9aa23ca73697063564f6f6aa6590088a738722df056004d18d7bccac62b3bafef6172fc2a4b071ea37f31eff7a076bcab7dd144e51a9da8754219352aef2c73478971539fa41de4759285ea626fa3c72e7085be47d554d915bbb5149cb6ef835351f231043049cd941506a034bf2f8767f3e1e42ead92f91cb3d75549b57ef7d56ac39c2d80d67f6a2b4ca192974bfc5060e2dd171217971002193dba12e7e4133ab201f07500a90495a38610279b13a48d54f0c99028201003e3a1ac0c2b67d54ed5c4bbe04a7db99103659d33a4f9d35809e1f60c282e5988dddc964527f3b05e6cc890eab3dcb571d66debf3a5527704c87264b3954d7265f4e8d2c637dd89b491b9cf23f264801f804b90454d65af0c4c830d1aef76f597ef61b26ca857ecce9cb78d4f6c2218c00d2975d46c2b013fbf59b750c3b92d8d3ed9e6d1fd0ef1ec091a5c286a3fe2dead292f40f380065731e2079ebb9f2a7ef2c415ecbb488da98f3a12609ca1b6ec8c734032c8bd513292ff842c375d4acd1b02dfb206b24cd815f8e2f9d4af8e7dea0370b19c1b23cc531d78b40e06e1119ee2e08f6f31c6e2e8444c568d13c5d451a291ae0c9f1d4f27d23b3a00d60ad"),
+            Convert.FromHexString("080012a60430820222300d06092a864886f70d01010105000382020f003082020a0282020100e1beab071d08200bde24eef00d049449b07770ff9910257b2d7d5dda242ce8f0e2f12e1af4b32d9efd2c090f66b0f29986dbb645dae9880089704a94e5066d594162ae6ee8892e6ec70701db0a6c445c04778eb3de1293aa1a23c3825b85c6620a2bc3f82f9b0c309bc0ab3aeb1873282bebd3da03c33e76c21e9beb172fd44c9e43be32e2c99827033cf8d0f0c606f4579326c930eb4e854395ad941256542c793902185153c474bed109d6ff5141ebf9cd256cf58893a37f83729f97e7cb435ec679d2e33901d27bb35aa0d7e20561da08885ef0abbf8e2fb48d6a5487047a9ecb1ad41fa7ed84f6e3e8ecd5d98b3982d2a901b4454991766da295ab78822add5612a2df83bcee814cf50973e80d7ef38111b1bd87da2ae92438a2c8cbcc70b31ee319939a3b9c761dbc13b5c086d6b64bf7ae7dacc14622375d92a8ff9af7eb962162bbddebf90acb32adb5e4e4029f1c96019949ecfbfeffd7ac1e3fbcc6b6168c34be3d5a2e5999fcbb39bba7adbca78eab09b9bc39f7fa4b93411f4cc175e70c0a083e96bfaefb04a9580b4753c1738a6a760ae1afd851a1a4bdad231cf56e9284d832483df215a46c1c21bdf0c6cfe951c18f1ee4078c79c13d63edb6e14feaeffabc90ad317e4875fe648101b0864097e998f0ca3025ef9638cd2b0caecd3770ab54a1d9c6ca959b0f5dcbc90caeefc4135baca6fd475224269bbe1b0203010001")
+            )
+        { TestName = "Rsa" };
+    }
+}

src/libp2p/Libp2p.Core.Tests/PeerIdTests.cs

@@ -0,0 +1,48 @@
+// SPDX-FileCopyrightText: 2023 Demerzel Solutions Limited
+// SPDX-License-Identifier: MIT
+
+using Multiformats.Hash;
+
+namespace Nethermind.Libp2p.Core.Tests;
+public class PeerIdTests
+{
+    [TestCaseSource(nameof(PeerIdsWithExpectedMultihashes))]
+    public void Test_KeyEncoding(string peerIdString, string cidV1PeerId, string cidV0PeerId, HashType hashType)
+    {
+        PeerId peerId = new(peerIdString);
+
+        Assert.Multiple(() =>
+        {
+            Assert.That(peerId.ToCidString(), Is.EqualTo(cidV1PeerId));
+            Assert.That(peerId.ToString(), Is.EqualTo(cidV0PeerId));
+            Assert.That(Multihash.Decode(peerId.Bytes).Code, Is.EqualTo(hashType));
+        });
+    }
+
+    public static IEnumerable<TestCaseData> PeerIdsWithExpectedMultihashes()
+    {
+        yield return new TestCaseData(
+            "bafzbeie5745rpv2m6tjyuugywy4d5ewrqgqqhfnf445he3omzpjbx5xqxe",
+            "bafzbeie5745rpv2m6tjyuugywy4d5ewrqgqqhfnf445he3omzpjbx5xqxe",
+            "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
+            HashType.SHA2_256
+            )
+        { TestName = "CIDv1, sha256" };
+
+        yield return new TestCaseData(
+            "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
+            "bafzbeie5745rpv2m6tjyuugywy4d5ewrqgqqhfnf445he3omzpjbx5xqxe",
+            "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
+            HashType.SHA2_256
+            )
+        { TestName = "CIDv0, sha256" };
+
+        yield return new TestCaseData(
+            "12D3KooWD3eckifWpRn9wQpMG9R9hX3sD158z7EqHWmweQAJU5SA",
+            "bafzaajaiaejcal72gwuz2or47oyxxn6b3rkwdmmkrxgkjxzy3rqt5kczyn7lcm3l",
+            "12D3KooWD3eckifWpRn9wQpMG9R9hX3sD158z7EqHWmweQAJU5SA",
+            HashType.ID
+            )
+        { TestName = "CIDv0, identity" };
+    }
+}

src/libp2p/Libp2p.Core.TestsBase/TestDiscoveryProtocol.cs

@@ -0,0 +1,19 @@
+// SPDX-FileCopyrightText: 2023 Demerzel Solutions Limited
+// SPDX-License-Identifier: MIT
+
+using Nethermind.Libp2p.Core.Discovery;
+
+namespace Nethermind.Libp2p.Core.TestsBase;
+
+public class TestDiscoveryProtocol : IDiscoveryProtocol
+{
+    public Func<Multiaddr[], bool>? OnAddPeer { get; set; }
+    public Func<Multiaddr[], bool>? OnRemovePeer { get; set; }
+
+    public Task DiscoverAsync(Multiaddr localPeerAddr, CancellationToken token = default)
+    {
+        TaskCompletionSource task = new();
+        token.Register(task.SetResult);
+        return task.Task;
+    }
+}

src/libp2p/Libp2p.Core.TestsBase/TestLocalPeer.cs

@@ -0,0 +1,48 @@
+// SPDX-FileCopyrightText: 2023 Demerzel Solutions Limited
+// SPDX-License-Identifier: MIT
+
+namespace Nethermind.Libp2p.Core.TestsBase;
+
+public class TestLocalPeer : ILocalPeer
+{
+    public TestLocalPeer()
+    {
+        Identity = new(Enumerable.Repeat((byte)42, 32).ToArray());
+        Address = $"/p2p/{Identity.PeerId}";
+    }
+
+    public Identity Identity { get; set; }
+    public Multiaddr Address { get; set; }
+
+    public Task<IRemotePeer> DialAsync(Multiaddr addr, CancellationToken token = default)
+    {
+        return Task.FromResult<IRemotePeer>(new TestRemotePeer(addr));
+    }
+
+    public Task<IListener> ListenAsync(Multiaddr addr, CancellationToken token = default)
+    {
+        return Task.FromResult<IListener>(null);
+    }
+}
+
+public class TestRemotePeer : IRemotePeer
+{
+    public TestRemotePeer(Multiaddr addr)
+    {
+        Identity = TestPeers.Identity(addr);
+        Address = addr;
+    }
+
+    public Identity Identity { get; set; }
+    public Multiaddr Address { get; set; }
+
+    public Task DialAsync<TProtocol>(CancellationToken token = default) where TProtocol : IProtocol
+    {
+        return Task.CompletedTask;
+    }
+
+    public Task DisconnectAsync()
+    {
+        return Task.CompletedTask;
+    }
+}

src/libp2p/Libp2p.Core.TestsBase/TestPeers.cs

@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2023 Demerzel Solutions Limited
+// SPDX-License-Identifier: MIT
+
+using System.Buffers.Binary;
+using System.Collections.Concurrent;
+
+namespace Nethermind.Libp2p.Core.TestsBase;
+
+public class TestPeers
+{
+    private static readonly ConcurrentDictionary<int, Multiaddr> testPeerAddrs = new();
+    private static readonly ConcurrentDictionary<int, PeerId> testPeerIds = new();
+
+    public static Multiaddr Multiaddr(int i) => testPeerAddrs.GetOrAdd(i, i =>
+    {
+        byte[] key = new byte[32];
+        BinaryPrimitives.WriteInt32BigEndian(key.AsSpan(32 - 4, 4), i);
+        return new Multiaddr($"/p2p/{new Identity(key).PeerId}");
+    });
+
+    public static PeerId PeerId(int i) => testPeerIds.GetOrAdd(i, i => new PeerId(testPeerAddrs[i].At(Enums.Multiaddr.P2p)!));
+
+    public static PeerId PeerId(Multiaddr addr) => new(addr.At(Enums.Multiaddr.P2p)!);
+
+    public static Identity Identity(Multiaddr addr) => new Identity(Core.PeerId.ExtractPublicKey(PeerId(addr).Bytes));
+
+}

src/libp2p/Libp2p.Core/Discovery/IDiscoveryProtocol.cs

@@ -6,8 +6,6 @@ namespace Nethermind.Libp2p.Core.Discovery;
 public interface IDiscoveryProtocol
 {
     Task DiscoverAsync(Multiaddr localPeerAddr, CancellationToken token = default);
-    Task BanPeer();
-
     Func<Multiaddr[], bool>? OnAddPeer { set; }
     Func<Multiaddr[], bool>? OnRemovePeer { set; }
 }