feat(PeerNode): determine if the information is valid

Author: richardschneider

src/PeerNode.cs

@@ -6,33 +6,79 @@
 namespace Ipfs.Api
 {
     /// <summary>
-    ///   Information about a peer node.
+    ///   An IPFS node.
     /// </summary>
     public class PeerNode
     {
         /// <summary>
         ///   Unique identifier (multihash)
         /// </summary>
+        /// <value>
+        ///   This is the <see cref="MultiHash"/> of the peer's <see cref="PublicKey"/>.
+        /// </value>
         public string Id { get; set; }
 
         /// <summary>
         ///   The public key of the node.
         /// </summary>
+        /// <value>
+        ///   The base 64 encoding of the node's public key.
+        /// </value>
         public string PublicKey { get; set; }
 
         /// <summary>
-        ///   The multi addresses of the node.
+        ///   The multiple addresses of the node.
         /// </summary>
+        /// <value>
+        ///   Where the peer can be found.
+        /// </value>
         public IEnumerable<MultiAddress> Addresses { get; set; }
 
         /// <summary>
-        ///  TODO
+        ///   The name and version of the IPFS software.
         /// </summary>
+        /// <value>
+        ///   For example "go-ipfs/0.4.7/".
+        /// </value>
+        /// <remarks>
+        ///   There is no specification that describes the agent version string.
+        /// </remarks>
         public string AgentVersion { get; set; }
 
         /// <summary>
-        ///  TODO
+        ///  The name and version of the supported IPFS protocol.
         /// </summary>
+        /// <value>
+        ///   For example "go-ipfs/0.4.7/".
+        /// </value>
+        /// <remarks>
+        ///   There is no specification that describes the protocol version string.
+        /// </remarks>
         public string ProtocolVersion { get; set; }
+
+        /// <summary>
+        ///   Determines if the information on the peer is valid.
+        /// </summary>
+        /// <returns>
+        ///   <b>true</b> if all validation rules pass; otherwise <b>false</b>.
+        /// </returns>
+        /// <remarks>
+        ///    Verifies that
+        ///    <list type="bullet">
+        ///      <item>The <see cref="Id"/> is a hash of the <see cref="PublicKey"/></item>
+        ///      <item>All <see cref="Addresses"/> point to the node</item>
+        ///    </list>
+        /// </remarks>
+        public bool IsValid()
+        {
+            var mh = new MultiHash(Id);
+            if (!mh.Matches(Convert.FromBase64String(PublicKey)))
+                return false;
+            if (!Addresses.All(a => 
+                a.Protocols.Last().Name == "ipfs" &&
+                a.Protocols.Last().Value == Id))
+                return false;
+            return true;
+        }
     }
 }

test/PeerNodeTest.cs

@@ -0,0 +1,42 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace Ipfs.Api
+{
+    [TestClass]
+    public class PeerNodeTest
+    {
+        const string mars = "QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3";
+
+        [TestMethod]
+        public async Task Valid_Node()
+        {
+            var ipfs = TestFixture.Ipfs;
+            var localNode = await ipfs.IdAsync();
+            Assert.IsTrue(localNode.IsValid());
+        }
+
+        [TestMethod]
+        public async Task Invalid_Node_Address()
+        {
+            var ipfs = TestFixture.Ipfs;
+            var localNode = await ipfs.IdAsync();
+            var addresses = localNode.Addresses.ToList();
+            addresses.Add(new MultiAddress($"/ip6/::1/tcp/4001/ipfs/{mars}"));
+            localNode.Addresses = addresses;
+            Assert.IsFalse(localNode.IsValid());
+        }
+
+        [TestMethod]
+        public async Task Invalid_Node_Id()
+        {
+            var ipfs = TestFixture.Ipfs;
+            var localNode = await ipfs.IdAsync();
+            localNode.Id = mars;
+            Assert.IsFalse(localNode.IsValid());
+        }
+
+    }
+}