refactor: Use Cid instead of MultiHash

Author: richardschneider

src/Block.cs

@@ -13,7 +13,7 @@ public class Block : IDataBlock
         byte[] dataBytes;
 
         /// <inheritdoc />
-        public MultiHash Hash { get; set; }
+        public Cid Id { get; set; }
 
         /// <inheritdoc />
         public byte[] DataBytes

src/CoreApi/BlockApi.cs

@@ -18,12 +18,12 @@ namespace Ipfs.Api
     public class BlockInfo
     {
         /// <summary>
-        ///   The <see cref="MultiHash"/> ID of the block.
+        ///   The <see cref="Cid"/> of the block.
         /// </summary>
         /// <value>
         ///   The unique ID of the block.
         /// </value>
-        public MultiHash Key { get; set; }
+        public Cid Id { get; set; }
 
         /// <summary>
         ///   The serialised size (in bytes) of the block.
@@ -65,16 +65,16 @@ internal BlockApi(IpfsClient ipfs)
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> of the block.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> of the block.
         /// </param>
-        public async Task<Block> GetAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken)) // TODO CID support
+        public async Task<Block> GetAsync(Cid id, CancellationToken cancel = default(CancellationToken)) // TODO CID support
         {
-            var data = await ipfs.DownloadBytesAsync("block/get", cancel, hash.ToString());
+            var data = await ipfs.DownloadBytesAsync("block/get", cancel, id);
             return new Block
             {
                 DataBytes = data,
-                Hash = hash
+                Id = id
             };
         }
 
@@ -89,12 +89,12 @@ internal BlockApi(IpfsClient ipfs)
         /// </param>
         public async Task<Block> PutAsync(byte[] data, CancellationToken cancel = default(CancellationToken))
         {
-            var json = await ipfs.UploadAsync("block/put", cancel, data);
-            var info = JsonConvert.DeserializeObject<BlockInfo>(json);
+            var json = await ipfs.UploadAsync("block/put", cancel, data);
+            var info = JObject.Parse(json);
             return new Block
             {
                 DataBytes = data,
-                Hash = info.Key
+                Id = (string)info["Key"]
             };
         }
 
@@ -115,15 +115,21 @@ internal BlockApi(IpfsClient ipfs)
         /// <summary>
         ///   Information on a raw <see cref="Block">IPFS block</see>.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> id of the block.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> of the block.
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        public Task<BlockInfo> StatAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<BlockInfo> StatAsync(Cid id, CancellationToken cancel = default(CancellationToken))
         {
-            return ipfs.DoCommandAsync<BlockInfo>("block/stat", cancel, hash.ToBase58());
+            var json = await ipfs.DoCommandAsync("block/stat", cancel, id);
+            var info = JObject.Parse(json);
+            return new BlockInfo
+            {
+                Size = (long)info["Size"],
+                Id = (string)info["Key"]
+            };
         }
 
         /// <summary>
@@ -132,21 +138,21 @@ internal BlockApi(IpfsClient ipfs)
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> id of the block.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> of the block.
         /// </param>
         /// <param name="ignoreNonexistent">
-        ///   If <b>true</b> do not raise exception when <paramref name="hash"/> does not
+        ///   If <b>true</b> do not raise exception when <paramref name="id"/> does not
         ///   exist.  Default value is <b>false</b>.
         /// </param>
         /// <returns>
-        ///   The awaited Task will return the deleted <paramref name="hash"/> or
+        ///   The awaited Task will return the deleted <paramref name="id"/> or
         ///   <see cref="string.Empty"/> if the hash does not exist and <paramref name="ignoreNonexistent"/>
         ///   is <b>true</b>.
         /// </returns>
-        public async Task<string> RemoveAsync(MultiHash hash, bool ignoreNonexistent = false, CancellationToken cancel = default(CancellationToken)) // TODO CID support
+        public async Task<string> RemoveAsync(Cid id, bool ignoreNonexistent = false, CancellationToken cancel = default(CancellationToken)) // TODO CID support
         {
-            var json = await ipfs.DoCommandAsync("block/rm", cancel, hash.ToBase58(), "force=" + ignoreNonexistent.ToString().ToLowerInvariant());
+            var json = await ipfs.DoCommandAsync("block/rm", cancel, id, "force=" + ignoreNonexistent.ToString().ToLowerInvariant());
             if (json.Length == 0)
                 return "";
             var result = JObject.Parse(json);

src/CoreApi/DhtApi.cs

@@ -51,18 +51,18 @@ internal DhtApi(IpfsClient ipfs)
         /// <summary>
         ///   Find the providers for content that is addressed by a hash.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="string"/> representation of a base58 encoded <see cref="Ipfs.MultiHash"/>.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> of the content.
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <returns>
         ///   A sequence of IPFS <see cref="Peer"/>.
         /// </returns>
-        public async Task<IEnumerable<Peer>> FindProvidersAsync(string hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<IEnumerable<Peer>> FindProvidersAsync(Cid id, CancellationToken cancel = default(CancellationToken))
         {
-            var stream = await ipfs.PostDownloadAsync("dht/findprovs", cancel, hash);
+            var stream = await ipfs.PostDownloadAsync("dht/findprovs", cancel, id);
             return ProviderFromStream(stream);
         }
 

src/CoreApi/FileSystemApi.cs

@@ -76,14 +76,14 @@ internal FileSystemApi(IpfsClient ipfs)
             var r = JObject.Parse(json);
             var fsn = new FileSystemNode
             {
-                Hash = (string)r["Hash"],
+                Id = (string)r["Hash"],
                 Size = long.Parse((string)r["Size"]),
                 IsDirectory = false,
                 Name = name,
                 IpfsClient = ipfs
             };
             if (log.IsDebugEnabled)
-                log.Debug("added " + fsn.Hash + " " + fsn.Name);
+                log.Debug("added " + fsn.Id + " " + fsn.Name);
              return fsn;
         }
 
@@ -121,10 +121,10 @@ internal FileSystemApi(IpfsClient ipfs)
             var directory = await ipfs.Object.PutAsync(folder, cancel);
 
             if (log.IsDebugEnabled)
-                log.Debug("added " + directory.Hash + " " + Path.GetFileName(path));
+                log.Debug("added " + directory.Id + " " + Path.GetFileName(path));
             return new FileSystemNode
             {
-                Hash = directory.Hash,
+                Id = directory.Id,
                 Name = Path.GetFileName(path),
                 Links = links,
                 IsDirectory = true,
@@ -156,22 +156,6 @@ internal FileSystemApi(IpfsClient ipfs)
             }
         }
 
-        /// <summary>
-        ///   Reads the content of an existing IPFS file as text.
-        /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> id of the file.
-        /// </param>
-        /// <param name="cancel">
-        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
-        /// </param>
-        /// <returns>
-        ///   The contents of the <paramref name="hash"/> as a <see cref="string"/>.
-        /// </returns>
-        public Task<String> ReadAllTextAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
-        {
-            return ReadAllTextAsync(hash.ToBase58(), cancel);
-        }
 
         /// <summary>
         ///   Opens an existing IPFS file for reading.
@@ -191,22 +175,6 @@ internal FileSystemApi(IpfsClient ipfs)
             return ipfs.DownloadAsync("cat", cancel, path);
         }
 
-        /// <summary>
-        ///   Opens an existing IPFS file for reading.
-        /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> id of the file.
-        /// </param>
-        /// <param name="cancel">
-        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
-        /// </param>
-        /// <returns>
-        ///   A <see cref="Stream"/> to the file contents.
-        /// </returns>
-        public Task<Stream> ReadFileAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
-        {
-            return ipfs.DownloadAsync("cat", cancel, hash.ToBase58());
-        }
 
         /// <summary>
         ///   Get information about the file or directory.
@@ -227,7 +195,7 @@ internal FileSystemApi(IpfsClient ipfs)
             var o = (JObject)r["Objects"][hash];
             var node = new FileSystemNode()
             {
-                Hash = (string)o["Hash"],
+                Id = (string)o["Hash"],
                 Size = (long)o["Size"],
                 IsDirectory = (string)o["Type"] == "Directory",
                 Links = new FileSystemLink[0]
@@ -239,7 +207,7 @@ internal FileSystemApi(IpfsClient ipfs)
                     .Select(l => new FileSystemLink()
                     {
                         Name = (string)l["Name"],
-                        Hash = (string)l["Hash"],
+                        Id = (string)l["Hash"],
                         Size = (long)l["Size"],
                         IsDirectory = (string)l["Type"] == "Directory",
                     })

src/CoreApi/ObjectApi.cs

@@ -96,16 +96,16 @@ internal ObjectApi(IpfsClient ipfs)
         /// <summary>
         ///   Fetch a MerkleDAG node.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> to the node.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> to the node.
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <returns></returns>
-        public async Task<DagNode> GetAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<DagNode> GetAsync(Cid id, CancellationToken cancel = default(CancellationToken))
         {
-            var json = await ipfs.DoCommandAsync("object/get", cancel, hash.ToBase58());
+            var json = await ipfs.DoCommandAsync("object/get", cancel, id);
             return GetDagFromJson(json);
         }
 
@@ -142,8 +142,8 @@ internal ObjectApi(IpfsClient ipfs)
         /// <summary>
         ///   Get the data of a MerkleDAG node.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> id of the node.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> of the node.
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
@@ -152,40 +152,40 @@ internal ObjectApi(IpfsClient ipfs)
         /// <remarks>
         ///   The caller must dispose the returned <see cref="Stream"/>.
         /// </remarks>
-        public Task<Stream> DataAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
+        public Task<Stream> DataAsync(Cid id, CancellationToken cancel = default(CancellationToken))
         {
-            return ipfs.DownloadAsync("object/data", cancel, hash.ToBase58());
+            return ipfs.DownloadAsync("object/data", cancel, id);
         }
 
         /// <summary>
         ///   Get the links of a MerkleDAG node.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> id of the node.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> id of the node.
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <returns>A sequence of links</returns>
-        public async Task<IEnumerable<IMerkleLink>> LinksAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<IEnumerable<IMerkleLink>> LinksAsync(Cid id, CancellationToken cancel = default(CancellationToken))
         {
-            var json = await ipfs.DoCommandAsync("object/links", cancel, hash.ToBase58());
+            var json = await ipfs.DoCommandAsync("object/links", cancel, id);
             return GetDagFromJson(json).Links;
         }
 
         /// <summary>
         ///   Get the statistics of a MerkleDAG node.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="MultiHash"/> of the node.
+        /// <param name="id">
+        ///   The <see cref="Cid"/> of the node.
         /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <returns></returns>
-        public Task<DagInfo> StatAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
+        public Task<DagInfo> StatAsync(Cid id, CancellationToken cancel = default(CancellationToken))
         {
-            return ipfs.DoCommandAsync<DagInfo>("object/stat", cancel, hash.ToBase58());
+            return ipfs.DoCommandAsync<DagInfo>("object/stat", cancel, id);
         }
 
         // TOOD: patch sub API

src/CoreApi/PinApi.cs

@@ -52,24 +52,6 @@ internal PinApi(IpfsClient ipfs)
                 .ToArray();
         }
 
-        /// <summary>
-        ///   Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
-        /// </summary>
-        /// <param name="hash">
-        ///   A <see cref="MultiHash"/> id to an existing object.
-        /// </param>
-        /// <param name="recursive">
-        ///   <b>true</b> to recursively pin links of object; otherwise, <b>false</b> to only pin
-        ///   the specified object.  Default is <b>true</b>.
-        /// </param>
-        /// <param name="cancel">
-        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
-        /// </param>
-        public Task<PinnedObject[]> AddAsync(MultiHash hash, bool recursive = true, CancellationToken cancel = default(CancellationToken))
-        {
-            return AddAsync(hash.ToBase58(), recursive, cancel);
-        }
-
         /// <summary>
         ///   List all the objects pinned to local storage.
         /// </summary>
@@ -118,23 +100,6 @@ internal PinApi(IpfsClient ipfs)
                 .ToArray();
         }
 
-        /// <summary>
-        ///   Unpin an object.
-        /// </summary>
-        /// <param name="hash">
-        ///   A <see cref="MultiHash"/> id to an existing object.
-        /// </param>
-        /// <param name="recursive">
-        ///   <b>true</b> to recursively unpin links of object; otherwise, <b>false</b> to only unpin
-        ///   the specified object.  Default is <b>true</b>.
-        /// </param>
-        /// <param name="cancel">
-        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
-        /// </param>
-        public Task<PinnedObject[]> RemoveAsync(MultiHash hash, bool recursive = true, CancellationToken cancel = default(CancellationToken))
-        {
-            return RemoveAsync(hash.ToBase58(), recursive, cancel);
-        }
     }
 
 }

src/FileSystemLink.cs

@@ -10,7 +10,7 @@ public class FileSystemLink : IMerkleLink
         public string Name { get; set; }
 
         /// <inheritdoc />
-        public MultiHash Hash { get; set; }
+        public Cid Id { get; set; }
 
         /// <inheritdoc />
         public long Size { get; set; }