fix: use MultiHash instead of string for type safety

Author: richardschneider

src/Block.cs

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

src/CoreApi/BlockApi.cs

@@ -66,11 +66,11 @@ internal BlockApi(IpfsClient ipfs)
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of a base58 encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> of the block.
         /// </param>
-        public async Task<Block> GetAsync(string hash, CancellationToken cancel = default(CancellationToken)) // TODO CID support
+        public async Task<Block> GetAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken)) // TODO CID support
         {
-            var data = await ipfs.DownloadBytesAsync("block/get", cancel, hash);
+            var data = await ipfs.DownloadBytesAsync("block/get", cancel, hash.ToString());
             return new Block
             {
                 DataBytes = data,
@@ -116,14 +116,14 @@ internal BlockApi(IpfsClient ipfs)
         ///   Information on a raw <see cref="Block">IPFS block</see>.
         /// </summary>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of a base58 encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> id 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(string hash, CancellationToken cancel = default(CancellationToken))
+        public Task<BlockInfo> StatAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
         {
-            return ipfs.DoCommandAsync<BlockInfo>("block/stat", cancel, hash);
+            return ipfs.DoCommandAsync<BlockInfo>("block/stat", cancel, hash.ToBase58());
         }
 
         /// <summary>
@@ -133,7 +133,7 @@ internal BlockApi(IpfsClient ipfs)
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of a base58 encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> id of the block.
         /// </param>
         /// <param name="ignoreNonexistent">
         ///   If <b>true</b> do not raise exception when <paramref name="hash"/> does not
@@ -144,9 +144,9 @@ internal BlockApi(IpfsClient ipfs)
         ///   <see cref="string.Empty"/> if the hash does not exist and <paramref name="ignoreNonexistent"/>
         ///   is <b>true</b>.
         /// </returns>
-        public async Task<string> RemoveAsync(string hash, bool ignoreNonexistent = false, CancellationToken cancel = default(CancellationToken)) // TODO CID support
+        public async Task<string> RemoveAsync(MultiHash hash, bool ignoreNonexistent = false, CancellationToken cancel = default(CancellationToken)) // TODO CID support
         {
-            var json = await ipfs.DoCommandAsync("block/rm", cancel, hash, "force=" + ignoreNonexistent.ToString().ToLowerInvariant());
+            var json = await ipfs.DoCommandAsync("block/rm", cancel, hash.ToBase58(), "force=" + ignoreNonexistent.ToString().ToLowerInvariant());
             if (json.Length == 0)
                 return "";
             var result = JObject.Parse(json);

src/CoreApi/FileSystemApi.cs

@@ -144,7 +144,9 @@ internal FileSystemApi(IpfsClient ipfs)
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        /// <returns></returns>
+        /// <returns>
+        ///   The contents of the <paramref name="path"/> as a <see cref="string"/>.
+        /// </returns>
         public async Task<String> ReadAllTextAsync(string path, CancellationToken cancel = default(CancellationToken))
         {
             using (var data = await ReadFileAsync(path, cancel))
@@ -154,6 +156,23 @@ 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.
         /// </summary>
@@ -172,6 +191,23 @@ 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.
         /// </summary>

src/CoreApi/GenericApi.cs

@@ -25,9 +25,9 @@ public partial class IpfsClient
         /// <returns>
         ///   Information on the peer node.
         /// </returns>
-        public Task<Peer> IdAsync(string peer = null, CancellationToken cancel = default(CancellationToken))
+        public Task<Peer> IdAsync(MultiHash peer = null, CancellationToken cancel = default(CancellationToken))
         {
-            return DoCommandAsync<Peer>("id", cancel, peer);
+            return DoCommandAsync<Peer>("id", cancel, peer?.ToString());
         }
 
         /// <summary>

src/CoreApi/ObjectApi.cs

@@ -97,15 +97,15 @@ internal ObjectApi(IpfsClient ipfs)
         ///   Fetch a MerkleDAG node.
         /// </summary>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of an encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> 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(string hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<DagNode> GetAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
         {
-            var json = await ipfs.DoCommandAsync("object/get", cancel, hash);
+            var json = await ipfs.DoCommandAsync("object/get", cancel, hash.ToBase58());
             return GetDagFromJson(json);
         }
 
@@ -143,7 +143,7 @@ internal ObjectApi(IpfsClient ipfs)
         ///   Get the data of a MerkleDAG node.
         /// </summary>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of an encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> id 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(string hash, CancellationToken cancel = default(CancellationToken))
+        public Task<Stream> DataAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
         {
-            return ipfs.DownloadAsync("object/data", cancel, hash);
+            return ipfs.DownloadAsync("object/data", cancel, hash.ToBase58());
         }
 
         /// <summary>
         ///   Get the links of a MerkleDAG node.
         /// </summary>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of an encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> 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(string hash, CancellationToken cancel = default(CancellationToken))
+        public async Task<IEnumerable<IMerkleLink>> LinksAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
         {
-            var json = await ipfs.DoCommandAsync("object/links", cancel, hash);
+            var json = await ipfs.DoCommandAsync("object/links", cancel, hash.ToBase58());
             return GetDagFromJson(json).Links;
         }
 
         /// <summary>
         ///   Get the statistics of a MerkleDAG node.
         /// </summary>
         /// <param name="hash">
-        ///   The <see cref="string"/> representation of an encoded <see cref="Ipfs.MultiHash"/>.
+        ///   The <see cref="MultiHash"/> 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(string hash, CancellationToken cancel = default(CancellationToken))
+        public Task<DagInfo> StatAsync(MultiHash hash, CancellationToken cancel = default(CancellationToken))
         {
-            return ipfs.DoCommandAsync<DagInfo>("object/stat", cancel, hash);
+            return ipfs.DoCommandAsync<DagInfo>("object/stat", cancel, hash.ToBase58());
         }
 
         // TOOD: patch sub API

src/CoreApi/PinApi.cs

@@ -32,8 +32,9 @@ internal PinApi(IpfsClient ipfs)
         /// <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">
-        ///   The <see cref="string"/> representation of a base58 encoded <see cref="Ipfs.MultiHash"/>.
+        /// <param name="path">
+        ///   A path to an existing object, such as "QmXarR6rgkQ2fDSHjSY5nM2kuCXKYGViky5nohtwgF65Ec/about"
+        ///   or "QmZTR5bcpQD7cFgTorqxZDYaew1Wqgfbd2ud9QqGPAkK2V"
         /// </param>
         /// <param name="recursive">
         ///   <b>true</b> to recursively pin links of object; otherwise, <b>false</b> to only pin
@@ -42,15 +43,33 @@ internal PinApi(IpfsClient ipfs)
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        public async Task<PinnedObject[]> AddAsync(string hash, bool recursive = true, CancellationToken cancel = default(CancellationToken))
+        public async Task<PinnedObject[]> AddAsync(string path, bool recursive = true, CancellationToken cancel = default(CancellationToken))
         {
             var opts = "recursive=" + recursive.ToString().ToLowerInvariant();
-            var json = await ipfs.DoCommandAsync("pin/add", cancel, hash, opts);
+            var json = await ipfs.DoCommandAsync("pin/add", cancel, path, opts);
             return ((JArray)JObject.Parse(json)["Pins"])
                 .Select(p => new PinnedObject { Id = (string)p })
                 .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>
@@ -79,8 +98,9 @@ internal PinApi(IpfsClient ipfs)
         /// <summary>
         ///   Unpin an object.
         /// </summary>
-        /// <param name="hash">
-        ///   The <see cref="string"/> representation of a base58 encoded <see cref="Ipfs.MultiHash"/>.
+        /// <param name="path">
+        ///   A path to an existing object, such as "QmXarR6rgkQ2fDSHjSY5nM2kuCXKYGViky5nohtwgF65Ec/about"
+        ///   or "QmZTR5bcpQD7cFgTorqxZDYaew1Wqgfbd2ud9QqGPAkK2V"
         /// </param>
         /// <param name="recursive">
         ///   <b>true</b> to recursively unpin links of object; otherwise, <b>false</b> to only unpin
@@ -89,14 +109,32 @@ internal PinApi(IpfsClient ipfs)
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
-        public async Task<PinnedObject[]> RemoveAsync(string hash, bool recursive = true, CancellationToken cancel = default(CancellationToken))
+        public async Task<PinnedObject[]> RemoveAsync(string path, bool recursive = true, CancellationToken cancel = default(CancellationToken))
         {
             var opts = "recursive=" + recursive.ToString().ToLowerInvariant();
-            var json = await ipfs.DoCommandAsync("pin/rm", cancel, hash, opts);
+            var json = await ipfs.DoCommandAsync("pin/rm", cancel, path, opts);
             return ((JArray)JObject.Parse(json)["Pins"])
                 .Select(p => new PinnedObject { Id = (string)p })
                 .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 string Hash { get; set; }
+        public MultiHash Hash { get; set; }
 
         /// <inheritdoc />
         public long Size { get; set; }

src/FileSystemNode.cs

@@ -34,11 +34,11 @@ public Stream DataStream
         {
             get
             {
-                return IpfsClient.FileSystem.ReadFileAsync(Hash).Result;
+                return IpfsClient.FileSystem.ReadFileAsync(Hash.ToBase58()).Result;
             }
         }
         /// <inheritdoc />
-        public string Hash { get; set; }
+        public MultiHash Hash { get; set; }
 
         /// <inheritdoc />
         public IEnumerable<FileSystemLink> Links {
@@ -103,7 +103,7 @@ public FileSystemLink ToLink(string name = null)
         {
             return new FileSystemLink
             {
-                Name = name != null ? name : Name,
+                Name = name ?? Name,
                 Hash = Hash,
                 Size = Size,
                 IsDirectory = IsDirectory
@@ -131,7 +131,7 @@ internal IpfsClient IpfsClient
 
         void GetInfo()
         {
-            var node = IpfsClient.FileSystem.ListFileAsync(Hash).Result;
+            var node = IpfsClient.FileSystem.ListFileAsync(Hash.ToBase58()).Result;
             this.IsDirectory = node.IsDirectory;
             this.Links = node.Links;
             this.Size = node.Size;

src/IpfsApi.csproj

@@ -28,7 +28,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Ipfs.Core" Version="0.13.0" />
+    <PackageReference Include="Ipfs.Core" Version="0.14.0" />
     <PackageReference Include="Newtonsoft.Json" Version="10.0.3" />
 	<PackageReference Include="System.Net.Http" Version="4.3.3" Condition="'$(TargetFramework)' == 'netstandard14'" />
     <PackageReference Include="System.Net.Http" Version="4.3.3" Condition="'$(TargetFramework)' == 'net45'" />