README.md

net-ipfs-http-client

A .Net client library for managing IPFS using the HTTP API protocol. More information, including the Class Reference, is on the Project web site.

Features

• Targets .NET Framework 4.5, .NET Standard 1.4 and .NET Standard 2.0
• Asynchronous I/O to an IPFS server
• Supports cancellation of all requests to the IPFS Server
• Requests that all responses are compressed
• Comprehensive documentation
• C# style access to the ipfs core interface
  • Bitswap API
  • Block API
  • Config API
  • Dag API
  • Dht API
  • Misc API
  • FileSystem API
  • Key API
  • Name API
  • Object API
  • Pin API
  • PubSub API
  • Stats API
  • Swarm API

Getting started

Published releases of IPFS API are available on NuGet. To install, run the following command in the Package Manager Console.

PM> Install-Package Ipfs.Http.Client

Or using dotnet

> dotnet add package Ipfs.Http.Client

IpfsClient

Every feature of IPFS is a property of the IpfsClient. The following example uses FileSystem to read a text file

using Ipfs.Http;

var ipfs = new IpfsClient();

const string filename = "QmXarR6rgkQ2fDSHjSY5nM2kuCXKYGViky5nohtwgF65Ec/about";
string text = await ipfs.FileSystem.ReadAllTextAsync(filename);

License

Copyright © 2015-2018 Richard Schneider ([email protected])

The IPFS API library is licensed under the MIT license. Refer to the LICENSE file for more information.