The JavaScript implementation of the IPFS protocol.

Project status

We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..

Want to get started? Check our examples folder to learn how to spawn an IPFS node in Node.js and in the Browser.

You can check the development status at the Waffle Board.

Important to note: DHT and Relay are not finalized yet, you won't have resource discovery happening by default as you get in go-ipfs, we are working actively on these pieces, please follow:

• DHT: ipfs#856
• Relay: ipfs#830

Table of Contents

• Install
  • npm
  • Use in Node.js
  • Through command line tool
  • Use in the browser
• Usage
  • CLI
  • HTTP-API
  • IPFS Core (use IPFS as a module in Node.js or in the Browser)
    • Create a IPFS node instance
  • Tutorials and Examples
  • API
    • Files API
    • DAG API
    • PubSub API
    • libp2p API
    • Miscellaneous API
    • Bitswap API
    • Block API
    • Config API
    • Bootstrap API
    • Repo API
    • Swarm API
    • Object API
    • Domain data types
• Packages
• Development
  • Clone and install dependencies
  • Run Tests
  • Lint
  • Build a dist version
• Contribute
  • Want to hack on IPFS?
• License

Install

This project is available through npm. To install run

> npm install ipfs --save

Requires npm@3 and node@6 or above, tested on OSX & Linux, expected to work on Windows.

Use in Node.js

To include this project programmatically:

const IPFS = require('ipfs')
const node = new IPFS()

Through command line tool

In order to use js-ipfs as a CLI, you must install it with the global flag. Run the following (even if you have ipfs installed locally):

> npm install ipfs --global

The CLI is available by using the command jsipfs in your terminal. This is aliased, instead of using ipfs, to make sure it does not conflict with the Go implementation.

Use in the browser

Learn how to bundle with browserify and webpack in the examples folder.

You can also load it using a <script> from the unpkg CDN:

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

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

Inserting one of the above lines will make an Ipfs object available in the global namespace.

Usage

CLI

The jsipfs CLI, available when js-ipfs is installed globally, follows(should, it is a WIP) the same interface defined by go-ipfs, you can always use the help command for help menus.

# Install js-ipfs globally
> npm install ipfs --global
> jsipfs --help
Commands:
  bitswap               A set of commands to manipulate the bitswap agent.
  block                 Manipulate raw IPFS blocks.
  bootstrap             Show or edit the list of bootstrap peers.
  commands              List all available commands
  config <key> [value]  Get and set IPFS config values
  daemon                Start a long-running daemon process
# ...

js-ipfs uses some different default config values, so that they don't clash directly with a go-ipfs node running in the same machine. These are:

• default repo location: ~/.jsipfs (can be changed with env variable IPFS_PATH)
• default swarm port: 4002
• default API port: 5002
• default Bootstrap is off, to enable it set IPFS_BOOTSTRAP=1

HTTP-API

The HTTP-API exposed by the js-ipfs daemon follows the http-api-spec. You can use any of the IPFS HTTP-API client libraries with it, such as: js-ipfs-api.

IPFS Core (use IPFS as a module)

Create a IPFS node instance

Creating an IPFS instance couldn't be easier, all you have to do is:

// Create the IPFS node instance
const node = new IPFS()

node.on('ready', () => {
  // Your node is now ready to use \o/

  // stopping a node
  node.stop(() => {
    // node is now 'offline'
  })
})

Advanced options when creating an IPFS node.

When starting a node, you can:

// IPFS will need a repo, it can create one for you or you can pass
// it a repo instance of the type IPFS Repo
// https://github.com/ipfs/js-ipfs-repo
const repo = <IPFS Repo instance or repo path>

const node = new IPFS({
  repo: repo,
  init: true, // default
  // init: false,
  // init: {
  //   bits: 1024 // size of the RSA key generated
  // },
  start: true,
  // start: false,
  EXPERIMENTAL: { // enable experimental features
    pubsub: true,
    sharding: true, // enable dir sharding
    dht: true // enable KadDHT, currently not interopable with go-ipfs
  },
  config: { // overload the default IPFS node config
    Addresses: {
      Swarm: [
        '/ip4/127.0.0.1/tcp/1337'
      ]
    }
  },
  libp2p: { // add custom modules to the libp2p stack of your node
    modules: {}
  }
})

// Events

node.on('ready', () => {})    // Node is ready to use when you first create it
node.on('error', (err) => {}) // Node has hit some error while initing/starting

node.on('init', () => {})     // Node has successfully finished initing the repo
node.on('start', () => {})    // Node has started
node.on('stop', () => {})     // Node has stopped

Tutorials and Examples

You can find some examples and tutorials in the examples folder, these exist to help you get started using js-ipfs.

API

A complete API definition is in the works. Meanwhile, you can learn how to you use js-ipfs through the standard interface at .

files

• ipfs.files.add(data, [options], [callback])
• ipfs.files.createAddStream([options], [callback])
• ipfs.files.cat(multihash, [callback])
• ipfs.files.get(hash, [callback])

dag

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

pubsub

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

libp2p

Every IPFS instance also exposes the libp2p API at ipfs.libp2p. The formal interface for this API hasn't been defined by you can find documentation at its implementations:

• Node.js bundle
• Browser Bundle
• libp2p baseclass

miscellaneous operations

• ipfs.id([callback])
• ipfs.version([callback])
• ipfs.ping()
• ipfs.init([options], callback)
• ipfs.start([callback])
• ipfs.stop([callback])
• ipfs.isOnline()

bitswap

• ipfs.bitswap.wantlist()
• ipfs.bitswap.stat()
• ipfs.bitswap.unwant()

block

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

config

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

bootstrap

• ipfs.bootstrap.list
• ipfs.bootstrap.add
• ipfs.bootstrap.rm

repo

• ipfs.repo.init
• ipfs.repo.version
• ipfs.repo.gc (not implemented, yet!)

swarm

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

object

Consider using the dag API API instead.

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

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.multihash
• ipfs.types.CID

dht (not implemented, yet!)

pin (not implemented, yet!)

FAQ

Is there WebRTC support for js-ipfs with Node.js?

Yes, however, bare in mind that there isn't a 100% stable solution to use WebRTC in Node.js, use it at your own risk. The most tested options are:

• wrtc - Follow the install instructions.
• electron-webrtc

To add WebRTC support in a IPFS node instance, do:

const wrtc = require('wrtc') // or require('electron-webrtc')()
const WStar = require('libp2p-webrtc-star')
const wstar = new WStar({ wrtc: wrtc })

const node = new IPFS({
  repo: 'your-repo-path',
  // start: false,
  config: {
    Addresses: {
      Swarm: [
        "/ip4/0.0.0.0/tcp/4002",
        "/ip4/127.0.0.1/tcp/4003/ws",
        "/dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star"
      ]
    }
  },
  libp2p: {
    modules: {
      transport: [wstar],
      discovery: [wstar.discovery]
    }
  }
})

node.on('ready', () => {
  // your instance with WebRTC is ready
})

To add WebRTC support to the IPFS daemon, you only need to install one of the WebRTC modules globally:

npm install wrtc --global
# or
npm install electron-webrtc --global

Then, update your IPFS Daemon config to include the multiaddr for this new transport on the Addresses.Swarm array. Add: "/dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star"

Packages

Package	Version	Deps	DevDeps	Build
API Specs
interface-ipfs-core
http-api-spec
cli spec
Repo
ipfs-repo
DAG
ipld-resolver
ipld-dag-pb
ipld-dag-cbor
Files
ipfs-unixfs-engine
Exchange
ipfs-block-service
Swarm/libp2p
js-libp2p
Data Types
ipfs-block
ipfs-unixfs
peer-id
peer-info
multiaddr
multihashes
Generics/Utils
ipfs-api
ipfs-multipart
multihashing
mafmt

Development

Clone and install dependencies

> git clone https://github.com/ipfs/js-ipfs.git
> cd js-ipfs
> npm install

Run unit tests

# run all the unit tsts
> npm test

# run just IPFS tests in Node.js
> npm run test:unit:node:core

# run just IPFS core tests
> npm run test:unit:node:core

# run just IPFS HTTP-API tests
> npm run test:unit:node:http

# run just IPFS CLI tests
> npm run test:unit:node:cli

# run just IPFS core tests in the Browser (Chrome)
> npm run test:unit:browser

Run interop tests

# run all the interop tsts
> npm run test:interop

# run just IPFS interop tests in Node.js using one go-ipfs daemon and one js-ipfs daemon
> npm run test:interop:node

# run just IPFS interop testsin the Browser (Chrome) using one instance in the browser and one go-ipfs daemon
> npm run test:interop:browser

Run benchmark tests

# run all the benchmark tests
> npm run test:benchmark

# run just IPFS benchmarks in Node.js
> npm run test:benchmark:node

# run just IPFS benchmarks in Node.js for an IPFS instance
> npm run test:benchmark:node:core

# run just IPFS benchmarks in Node.js for an IPFS daemon
> npm run test:benchmark:node:http

# run just IPFS benchmarks in the browser (Chrome)
> npm run test:benchmark:browser

Lint

Conforming to linting rules is a prerequisite to commit to js-ipfs.

> npm run lint

Build a dist version

> npm run build

Runtime Support

Code Architecture and folder Structure

Source code

> tree src -L 2
src                 # Main source code folder
├── cli             # Implementation of the IPFS CLI
│   └── ...
├── http-api        # The HTTP-API implementation of IPFS as defined by http-api-spec
├── core            # IPFS implementation, the core (what gets loaded in browser)
│   ├── components  # Each of IPFS subcomponent
│   └── ...
└── ...

Monitoring

The HTTP API exposed with js-ipfs can also be used for exposing metrics about the running js-ipfs node and other Node.js metrics.

To enable it, you need to set the environment variable IPFS_MONITORING (any value)

Once the environment variable is set and the js-ipfs daemon is running, you can get the metrics (in prometheus format) by making a GET request to the following endpoint:

http://localhost:5002/debug/metrics/prometheus

IPFS Core Architecture

What does this image explain?

• IPFS uses ipfs-repo which picks fs or indexeddb as its storage drivers, depending if it is running in Node.js or in the Browser.
• The exchange protocol, bitswap, uses the Block Service which in turn uses the Repo, offering a get and put of blocks to the IPFS implementation.
• The DAG API (previously Object) comes from the IPLD Resolver, it can support several IPLD Formats (i.e: dag-pb, dag-cbor, etc).
• The Files API uses ipfs-unixfs-engine to import and export files to and from IPFS.
• Swarm, the component that offers a network API, uses libp2p to dial and listen for connections, to use the DHT, for discovery mechanisms, and more. libp2p-ipfs-nodejs is used when running in Node.js and libp2p-ipfs-browser is used when running in the browser.

Contribute

IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:

• Go through the modules below and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
• Perform code reviews. More eyes will help (a) speed the project along, (b) ensure quality, and (c) reduce possible future bugs.
• Take a look at go-ipfs and some of the planning repositories or issues: for instance, the libp2p spec. Contributions here that would be most helpful are top-level comments about how it should look based on our understanding. Again, the more eyes the better.
• Add tests. There can never be enough tests.
• 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?

License