A client library for the IPFS HTTP API, implemented in JavaScript. This client library implements the interface-ipfs-core enabling applications to change between an embedded js-ipfs node and any remote IPFS node without having to change the code. In addition, this client library implements a set of utility functions.

Lead Maintainer

Alan Shaw.

Table of Contents

• Install
  • Running the daemon with the right port
  • Importing the module and usage
  • Importing a sub-module and usage
  • In a web browser through Browserify
  • In a web browser from CDN
  • CORS
• Usage
  • API Docs
  • Callbacks and promises
• Contribute
• License

Install

This module uses node.js, and can be installed through npm:

npm install --save ipfs-api

Note: ipfs-api requires Node.js v6 (LTS) or higher.

Running the daemon with the right port

To interact with the API, you need to have a local daemon running. It needs to be open on the right port. 5001 is the default, and is used in the examples below, but it can be set to whatever you need.

# Show the ipfs config API port to check it is correct
> ipfs config Addresses.API
/ip4/127.0.0.1/tcp/5001
# Set it if it does not match the above output
> ipfs config Addresses.API /ip4/127.0.0.1/tcp/5001
# Restart the daemon after changing the config

# Run the daemon
> ipfs daemon

Importing the module and usage

var ipfsAPI = require('ipfs-api')

// connect to ipfs daemon API server
var ipfs = ipfsAPI('localhost', '5001', {protocol: 'http'}) // leaving out the arguments will default to these values

// or connect with multiaddr
var ipfs = ipfsAPI('/ip4/127.0.0.1/tcp/5001')

// or using options
var ipfs = ipfsAPI({host: 'localhost', port: '5001', protocol: 'http'})

// or specifying a specific API path
var ipfs = ipfsAPI({host: '1.1.1.1', port: '80', 'api-path': '/ipfs/api/v0'})

Importing a sub-module and usage

const bitswap = require('ipfs-api/src/bitswap')('/ip4/127.0.0.1/tcp/5001')

bitswap.unwant(key, (err) => {
  // ...
})

In a web browser through Browserify

Same as in Node.js, you just have to browserify the code before serving it. See the browserify repo for how to do that.

See the example in the examples folder to get a boilerplate.

In a web browser through webpack

See the example in the examples folder to get an idea on how to use js-ipfs-api with webpack.

In a web browser from CDN

Instead of a local installation (and browserification) you may request a remote copy of IPFS API from unpkg CDN.

To always request the latest version, use the following:

<!-- loading the minified version -->
<script src="https://unpkg.com/ipfs-api/dist/index.min.js"></script>

<!-- loading the human-readable (not minified) version -->
<script src="https://unpkg.com/ipfs-api/dist/index.js"></script>

For maximum security you may also decide to:

• reference a specific version of IPFS API (to prevent unexpected breaking changes when a newer latest version is published)
• generate a SRI hash of that version and use it to ensure integrity
• set the CORS settings attribute to make anonymous requests to CDN

Example:

<script src="https://unpkg.com/[email protected]/dist/index.js"
integrity="sha384-5bXRcW9kyxxnSMbOoHzraqa7Z0PQWIao+cgeg327zit1hz5LZCEbIMx/LWKPReuB"
crossorigin="anonymous"></script>

CDN-based IPFS API provides the IpfsApi constructor as a method of the global window object. Example:

var ipfs = window.IpfsApi('localhost', '5001')

If you omit the host and port, the API will parse window.host, and use this information. This also works, and can be useful if you want to write apps that can be run from multiple different gateways:

var ipfs = window.IpfsApi()

CORS

In a web browser IPFS API (either browserified or CDN-based) might encounter an error saying that the origin is not allowed. This would be a CORS ("Cross Origin Resource Sharing") failure: IPFS servers are designed to reject requests from unknown domains by default. You can whitelist the domain that you are calling from by changing your ipfs config like this:

ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin "[\"http://example.com\"]"
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials "[\"true\"]"
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods "[\"PUT\", \"POST\", \"GET\"]"

Custom Headers

If you wish to send custom headers with each request made by this library, for example, the Authorization header. You can use the config to do so:

const ipfs = IpfsApi({
  host: 'localhost',
  port: 5001,
  protocol: 'http',
  headers: {
    authorization: 'Bearer ' + TOKEN
  }
})

Usage

API

js-ipfs-api follows the spec defined by interface-ipfs-core, which concerns the interface to expect from IPFS implementations. This interface is a currently active endeavor. You can use it today to consult the methods available.

Files

• files

  • ipfs.files.add(data, [options], [callback]). Alias to ipfs.add.
  • ipfs.files.addPullStream([options])
  • ipfs.files.addReadableStream([options])
  • ipfs.files.cat(ipfsPath, [options], [callback]). Alias to ipfs.cat.
  • ipfs.files.catPullStream(ipfsPath, [options])
  • ipfs.files.catReadableStream(ipfsPath, [options])
  • ipfs.files.get(ipfsPath, [options], [callback]). Alias to ipfs.get.
  • ipfs.files.getPullStream(ipfsPath, [options])
  • ipfs.files.getReadableStream(ipfsPath, [options])
  • ipfs.ls(ipfsPath, [callback])
  • ipfs.lsPullStream(ipfsPath)
  • ipfs.lsReadableStream(ipfsPath)
  • MFS (mutable file system) specific
    • ipfs.files.cp([from, to], [callback])
    • ipfs.files.flush([path], [callback])
    • ipfs.files.ls([path], [options], [callback])
    • ipfs.files.mkdir(path, [options], [callback])
    • ipfs.files.mv([from, to], [callback])
    • ipfs.files.read(path, [options], [callback])
    • ipfs.files.readPullStream(path, [options])
    • ipfs.files.readReadableStream(path, [options])
    • ipfs.files.rm(path, [options], [callback])
    • ipfs.files.stat(path, [options], [callback])
    • ipfs.files.write(path, content, [options], [callback])

• block

  • ipfs.block.get(cid, [options], [callback])
  • ipfs.block.put(block, [options], [callback])
  • ipfs.block.stat(cid, [callback])

Graph

• dag

  • ipfs.dag.get(cid, [path], [options], [callback])
  • ipfs.dag.put(dagNode, [options], [callback])
  • ipfs.dag.tree(cid, [path], [options], [callback])

• object

  • ipfs.object.data(multihash, [options], [callback])
  • ipfs.object.get(multihash, [options], [callback])
  • ipfs.object.links(multihash, [options], [callback])
  • ipfs.object.new([template], [callback])
  • ipfs.object.patch.addLink(multihash, DAGLink, [options], [callback])
  • ipfs.object.patch.appendData(multihash, data, [options], [callback])
  • ipfs.object.patch.rmLink(multihash, DAGLink, [options], [callback])
  • ipfs.object.patch.setData(multihash, data, [options], [callback])
  • ipfs.object.put(obj, [options], [callback])
  • ipfs.object.stat(multihash, [options], [callback])

• pin

  • ipfs.pin.add(hash, [options], [callback])
  • ipfs.pin.ls([hash], [options], [callback])
  • ipfs.pin.rm(hash, [options], [callback])

• refs

  • ipfs.refs.local()

Network

• bootstrap

  • ipfs.bootstrap.add(addr, [options], [callback])
  • ipfs.bootstrap.list([callback])
  • ipfs.bootstrap.rm(addr, [options], [callback])

• bitswap

  • ipfs.bitswap.stat([callback])
  • ipfs.bitswap.wantlist([peerId])
  • ipfs.bitswap.unwant(cid)

• dht

  • ipfs.dht.findpeer(peerId, [callback])
  • ipfs.dht.findprovs(hash, [callback])
  • ipfs.dht.get(key, [callback])
  • ipfs.dht.provide(cid, [callback])
  • ipfs.dht.put(key, value, [callback])

• pubsub

  • ipfs.pubsub.ls(topic, [callback])
  • ipfs.pubsub.peers(topic, [callback])
  • ipfs.pubsub.publish(topic, data, [callback])
  • ipfs.pubsub.subscribe(topic, handler, [options], [callback])
  • ipfs.pubsub.unsubscribe(topic, handler, [callback])

• swarm

  • ipfs.swarm.addrs([callback])
  • ipfs.swarm.connect(addr, [callback])
  • ipfs.swarm.disconnect(addr, [callback])
  • ipfs.swarm.peers([options], [callback])

• name

  • ipfs.name.publish(addr, [options], [callback])
  • ipfs.name.resolve(addr, [options], [callback])

Node Management

• miscellaneous operations

  • ipfs.dns(domain, [callback])
  • ipfs.id([callback])
  • ipfs.ping(id, [options], [callback])
  • ipfs.pingPullStream(id, [options])
  • ipfs.pingReadableStream(id, [options])
  • ipfs.stop([callback]). Alias to ipfs.shutdown.
  • ipfs.version([callback])

• config

  • ipfs.config.get([key], [callback])
  • ipfs.config.replace(config, [callback])
  • ipfs.config.set(key, value, [callback])

• stats

  • ipfs.stats.bitswap([callback])
  • ipfs.stats.bw([options], [callback])
  • ipfs.stats.bwPullStream([options])
  • ipfs.stats.bwReadableStream([options])
  • ipfs.stats.repo([options], [callback])

• log

  • ipfs.log.level(subsystem, level, [options], [callback])
  • ipfs.log.ls([callback])
  • ipfs.log.tail([callback])

• repo

  • ipfs.repo.gc([options], [callback])
  • ipfs.repo.stat([options], [callback])
  • ipfs.repo.version([callback])

• key

  • ipfs.key.export(name, password, [callback])
  • ipfs.key.gen(name, [options], [callback])
  • ipfs.key.import(name, pem, password, [callback])
  • ipfs.key.list([options, callback])
  • ipfs.key.rename(oldName, newName, [callback])
  • ipfs.key.rm(name, [callback])

Pubsub Caveat

Currently, the PubSub API only works in Node.js environment

We currently don't support pubsub when run in the browser, and we test it with separate set of tests to make sure if it's being used in the browser, pubsub errors.

More info: https://github.com/ipfs/js-ipfs-api/issues/518

This means:

• You can use pubsub from js-ipfs-api in Node.js
• You can use pubsub from js-ipfs-api in Electron (when js-ipfs-api is ran in the main process of Electron)
• You can't use pubsub from js-ipfs-api in the browser
• You can't use pubsub from js-ipfs-api in Electron's renderer process
• You can use pubsub from js-ipfs in the browsers
• You can use pubsub from js-ipfs in Node.js
• You can use pubsub from js-ipfs in Electron (in both the main process and the renderer process)
• See https://github.com/ipfs/js-ipfs for details on pubsub in js-ipfs

Domain data types

A set of data types are exposed directly from the IPFS instance under ipfs.types. That way you're not required to import/require the following.

• ipfs.types.Buffer
• ipfs.types.PeerId
• ipfs.types.PeerInfo
• ipfs.types.multiaddr
• ipfs.types.multibase
• ipfs.types.multihash
• ipfs.types.CID
• ipfs.types.dagPB
• ipfs.types.dagCBOR

Utility functions

Adding to the methods defined by interface-ipfs-core, js-ipfs-api exposes a set of extra utility methods. These utility functions are scoped behind the ipfs.util.

Complete documentation for these methods is coming with: https://github.com/ipfs/js-ipfs-api/pull/305

Add files or entire directories from the FileSystem to IPFS

ipfs.util.addFromFs(path, option, callback)

Reads a file or folder from path on the filesystem and adds it to IPFS. Options:

• recursive: If path is a directory, use option { recursive: true } to add the directory and all its sub-directories.
  • ignore: To exclude fileglobs from the directory, use option { ignore: ['ignore/this/folder/**', 'and/this/file'] }.
  • hidden: hidden/dot files (files or folders starting with a ., for example, .git/) are not included by default. To add them, use the option { hidden: true }.

ipfs.util.addFromFs('path/to/a/folder', { recursive: true , ignore: ['subfolder/to/ignore/**']}, (err, result) => {
  if (err) { throw err }
  console.log(result)
})

result is an array of objects describing the files that were added, such as:

[
  {
    path: 'test-folder',
    hash: 'QmRNjDeKStKGTQXnJ2NFqeQ9oW23WcpbmvCVrpDHgDg3T6',
    size: 2278
  },
  // ...
]

Add a file from a URL to IPFS

ipfs.util.addFromURL(url, callback)

ipfs.util.addFromURL('http://example.com/', (err, result) => {
  if (err) {
    throw err
  }
  console.log(result)
})

Add a file from a stream to IPFS

ipfs.util.addFromStream(stream, callback)

This is very similar to ipfs.files.add({path:'', content: stream}). It is like the reverse of cat

ipfs.util.addFromStream(<readable-stream>, (err, result) => {
  if (err) {
    throw err
  }
  console.log(result)
})

Get endpoint configuration (host and port)

ipfs.util.getEndpointConfig()

This returns an object containing the host and the port

Get libp2p crypto primitives

ipfs.util.crypto

This contains an object with the crypto primitives

Get is-ipfs utilities

ipfs.util.isIPFS

This contains an object with the is-ipfs utilities to help identifying IPFS resources

Callbacks and Promises

If you do not pass in a callback all API functions will return a Promise. For example:

ipfs.id()
  .then((id) => {
    console.log('my id is: ', id)
  })
  .catch((err) => {
    console.log('Fail: ', err)
  })

This relies on a global Promise object. If you are in an environment where that is not yet available you need to bring your own polyfill.

Development

Testing

We run tests by executing npm test in a terminal window. This will run both Node.js and Browser tests, both in Chrome and PhantomJS. To ensure that the module conforms with the interface-ipfs-core spec, we run the batch of tests provided by the interface module, which can be found here.

Contribute

The js-ipfs-api is a work in progress. As such, there's a few things you can do right now to help out:

• Check out the existing issues!
• Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
• Add tests. There can never be enough tests. Note that interface tests exist inside interface-ipfs-core.
• Contribute to the FAQ repository with any questions you have about IPFS or any of the relevant technology. A good example would be asking, 'What is a merkledag tree?'. If you don't know a term, odds are, someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make IPFS and IPN better.

Want to hack on IPFS?

Historical context

This module started as a direct mapping from the go-ipfs cli to a JavaScript implementation, although this was useful and familiar to a lot of developers that were coming to IPFS for the first time, it also created some confusion on how to operate the core of IPFS and have access to the full capacity of the protocol. After much consideration, we decided to create interface-ipfs-core with the goal of standardizing the interface of a core implementation of IPFS, and keep the utility functions the IPFS community learned to use and love, such as reading files from disk and storing them directly to IPFS.

License

MIT