chore: use MultiHash instead of string for type safety

Author: richardschneider

src/CoreApi/BlockApi.cs

@@ -18,12 +18,12 @@ namespace Ipfs.Api
     public class BlockInfo
     {
         /// <summary>
-        ///   The unique ID of the block.
+        ///   The <see cref="MultiHash"/> ID of the block.
         /// </summary>
         /// <value>
-        ///   Typically, the string representation of a <see cref="MultiHash"/>.
+        ///   The unique ID of the block.
         /// </value>
-        public string Key { get; set; }
+        public MultiHash Key { get; set; }
 
         /// <summary>
         ///   The serialised size (in bytes) of the block.

src/CoreApi/DhtApi.cs

@@ -38,12 +38,12 @@ internal DhtApi(IpfsClient ipfs)
         ///   Information about an IPFS peer.
         /// </summary>
         /// <param name="id">
-        ///   The <see cref="string"/> ID of the IPFS peer.  
+        ///   The <see cref="MultiHash"/> ID of the IPFS peer.  
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        public Task<Peer> FindPeerAsync(string id, CancellationToken cancel = default(CancellationToken))
+        public Task<Peer> FindPeerAsync(MultiHash id, CancellationToken cancel = default(CancellationToken))
         {
             return ipfs.IdAsync(id, cancel);
         }
@@ -58,16 +58,15 @@ internal DhtApi(IpfsClient ipfs)
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <returns>
-        ///   A sequence of IPFS peer IDs.
+        ///   A sequence of IPFS <see cref="Peer"/>.
         /// </returns>
-        public async Task<IEnumerable<string>> FindProvidersAsync(string hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<IEnumerable<Peer>> FindProvidersAsync(string hash, CancellationToken cancel = default(CancellationToken))
         {
-            var serializer = new JsonSerializer();
             var stream = await ipfs.PostDownloadAsync("dht/findprovs", cancel, hash);
             return ProviderFromStream(stream);
         }
 
-        IEnumerable<string> ProviderFromStream(Stream stream)
+        IEnumerable<Peer> ProviderFromStream(Stream stream)
         { 
             using (var sr = new StreamReader(stream))
             {
@@ -80,7 +79,7 @@ IEnumerable<string> ProviderFromStream(Stream stream)
                     var r = JObject.Parse(json);
                     var id = (string)r["ID"];
                     if (id != String.Empty)
-                        yield return id;
+                        yield return new Peer { Id = new MultiHash(id) };
                     else
                     {
                         var responses = (JArray)r["Responses"];
@@ -89,7 +88,8 @@ IEnumerable<string> ProviderFromStream(Stream stream)
                             foreach (var response in responses)
                             {
                                 var rid = (string)response["ID"];
-                                yield return rid;
+                                if (rid != String.Empty)
+                                    yield return new Peer { Id = new MultiHash(rid) };
                             }
                         }
                     }

src/CoreApi/KeyApi.cs

@@ -34,12 +34,12 @@ public class KeyApi
         public class KeyInfo
         {
             /// <summary>
-            ///   Unique identifier (multihash)
+            ///   Unique identifier.
             /// </summary>
             /// <value>
-            ///   This is the <see cref="MultiHash"/> of the key's public key.
+            ///   The <see cref="MultiHash"/> of the key's public key.
             /// </value>
-            public string Id { get; set; }
+            public MultiHash Id { get; set; }
 
             /// <summary>
             ///   The locally assigned name to the key.
@@ -50,6 +50,12 @@ public class KeyInfo
             /// </value>
             public string Name { get; set; }
 
+            /// <inheritdoc />
+            public override string ToString()
+            {
+                return Name;
+            }
+
         }
         IpfsClient ipfs;
 
@@ -78,8 +84,10 @@ internal KeyApi(IpfsClient ipfs)
         /// </returns>
         public async Task<KeyInfo> CreateAsync(string name, string keyType, int size, CancellationToken cancel = default(CancellationToken))
         {
-            return await ipfs.DoCommandAsync<KeyInfo>("key/gen", cancel, name, 
-                $"type={keyType}", $"size={size}");
+            return await ipfs.DoCommandAsync<KeyInfo>("key/gen", cancel, 
+                name, 
+                $"type={keyType}", 
+                $"size={size}");
         }
 
         /// <summary>

test/CoreApi/BlockApiTest.cs

@@ -34,6 +34,7 @@ public void Put_Block()
         [TestMethod]
         public void Get()
         {
+            var _ = ipfs.Block.PutAsync(blob).Result;
             var block = ipfs.Block.GetAsync(hash).Result;
             Assert.AreEqual(hash, block.Hash);
             CollectionAssert.AreEqual(blob, block.DataBytes);
@@ -42,6 +43,7 @@ public void Get()
         [TestMethod]
         public void Stat()
         {
+            var _ = ipfs.Block.PutAsync(blob).Result;
             var info = ipfs.Block.StatAsync(hash).Result;
             Assert.AreEqual(hash, info.Key);
             Assert.AreEqual(5, info.Size);
@@ -50,6 +52,7 @@ public void Stat()
         [TestMethod]
         public async Task Remove()
         {
+            var _ = ipfs.Block.PutAsync(blob).Result;
             var removed = await ipfs.Block.RemoveAsync(hash);
             Assert.AreEqual(hash, removed);
         }

test/CoreApi/DhtApiTest.cs

@@ -30,7 +30,7 @@ public async Task FindProviders()
         {
             var ipfs = TestFixture.Ipfs;
             var providers = await ipfs.Dht.FindProvidersAsync(helloWorldID);
-            Assert.IsFalse(providers.Take(3).Contains(""));
+            Assert.AreNotEqual(0, providers.Count());
         }
 
     }