vmx / js-libp2p

The JavaScript Implementation of libp2p networking stack.

The JavaScript implementation of the libp2p Networking Stack.

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. You can check the development status at the Waffle Board.

Tech Lead

David Dias

Lead Maintainer

David Dias

Table of Contents

• Background
• Bundles
• Usage
  • Install
  • Usage
  • API
• Development
  • Tests
  • Packages
• Contribute
• License

Background

libp2p is the product of a long and arduous quest to understand the evolution of the Internet networking stack. In order to build P2P applications, devs have long had to made custom ad-hoc solutions to fit their needs, sometimes making some hard assumptions about their runtimes and the state of the network at the time of their development. Today, looking back more than 20 years, we see a clear pattern in the types of mechanisms built around the Internet Protocol, IP, which can be found throughout many layers of the OSI layer system, libp2p distils these mechanisms into flat categories and defines clear interfaces that once exposed, enable other protocols and applications to use and swap them, enabling upgradability and adaptability for the runtime, without breaking the API.

We are in the process of writing better documentation, blog posts, tutorials and a formal specification. Today you can find:

• libp2p.io
• Specification (WIP)
• Talks
  • libp2p <3 ethereum at DEVCON2 📼 video slides 📼 demo-1 📼 demo-2
• Articles
  • The overview of libp2p

To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.

Bundles

With its modular nature, libp2p can be found being used in different projects with different sets of features, while preserving the same top level API. js-libp2p is only a skeleton and should not be installed directly, if you are looking for a prebundled libp2p stack, please check:

• libp2p-ipfs-nodejs - The libp2p build used by js-ipfs when run in Node.js
• libp2p-ipfs-browser - The libp2p build used by js-ipfs when run in a Browser (that supports WebRTC)

If you have developed a libp2p bundle, please consider submitting it to this list so that it can be found easily by the users of libp2p.

Install

Again, as noted above, this module is only a skeleton and should not be used directly other than libp2p bundle implementors that want to extend its code.

npm install --save libp2p

Usage

Tutorials and Examples

You can find multiple examples on the examples folder that will guide you through using libp2p for several scenarios.

Extending libp2p skeleton

libp2p becomes very simple and basically acts as a glue for every module that compose this library. Since it can be highly customized, it requires some setup. What we recommend is to have a libp2p build for the system you are developing taking into account in your needs (e.g. for a browser working version of libp2p that acts as the network layer of IPFS, we have a built and minified version that browsers can require).

Example:

// Creating a bundle that adds:
//   transport: websockets + tcp
//   stream-muxing: SPDY
//   crypto-channel: secio
//   discovery: multicast-dns

const libp2p = require('libp2p')
const TCP = require('libp2p-tcp')
const WS = require('libp2p-websockets')
const spdy = require('libp2p-spdy')
const secio = require('libp2p-secio')
const MulticastDNS = require('libp2p-mdns')
const DHT = require('libp2p-kad-dht')

class Node extends libp2p {
  constructor (peerInfo, peerBook, options) {
    options = options || {}

    const modules = {
      transport: [
        new TCP(),
        new WS()
      ],
      connection: {
        muxer: [
          spdy
        ],
        crypto: [
          secio
        ]
      },
      discovery: [
        new MulticastDNS(peerInfo)
      ],
      // DHT is passed as its own enabling PeerRouting, ContentRouting and DHT itself components
      dht: DHT
    }

    super(modules, peerInfo, peerBook, options)
  }
}

// Now all the nodes you create, will have TCP, WebSockets, SPDY, SECIO and MulticastDNS support.

API

Create a Node - new libp2p.Node([peerInfo, peerBook, options])

Creates an instance of the libp2p.Node.

• peerInfo: instance of PeerInfo that contains the PeerId, Keys and multiaddrs of the libp2p Node. Optional.
• peerBook: instance of PeerBook that contains the PeerInfo of known peers. Optional.
• options: Object containing custom options for the bundle.

libp2p.start(callback)

Start the libp2p Node.

callback is a function with the following function (err) {} signature, where err is an Error in case starting the node fails.

libp2p.stop(callback)

Stop the libp2p Node.

callback is a function with the following function (err) {} signature, where err is an Error in case stopping the node fails.

libp2p.dial(peer, callback)

Dials to another peer in the network, establishes the connection.

• peer: can be an instance of PeerInfo, PeerId, multiaddr, or a multiaddr string
• callback: Function with signature function (err, conn) {} where conn is a Connection object

callback is a function with the following function (err, conn) {} signature, where err is an Error in of failure to dial the connection and conn is a Connection instance in case of a protocol selected, if not it is undefined.

libp2p.dialProtocol(peer, protocol, callback)

Dials to another peer in the network and selects a protocol to talk with that peer.

• peer: can be an instance of PeerInfo, PeerId, multiaddr, or a multiaddr string
• protocol: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
• callback: Function with signature function (err, conn) {} where conn is a Connection object

callback is a function with the following function (err, conn) {} signature, where err is an Error in of failure to dial the connection and conn is a Connection instance in case of a protocol selected, if not it is undefined.

libp2p.hangUp(peer, callback)

Closes an open connection with a peer, graciously.

• peer: can be an instance of PeerInfo, PeerId or multiaddr

callback is a function with the following function (err) {} signature, where err is an Error in case stopping the node fails.

libp2p.peerRouting.findPeer(id, callback)

Looks up for multiaddrs of a peer in the DHT

• id: instance of PeerId

libp2p.contentRouting.findProviders(key, timeout, callback)

• key: Buffer
• timeout: Number miliseconds

libp2p.contentRouting.provide(key, callback)

• key: Buffer

libp2p.handle(protocol, handlerFunc [, matchFunc])

Handle new protocol

• protocol: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
• handlerFunc: Function with signature function (protocol, conn) {} where conn is a Connection object
• matchFunc: Function for matching on protocol (exact matching, semver, etc). Default to exact match.

libp2p.unhandle(protocol)

Stop handling protocol

• protocol: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')

libp2p.on('peer:discovery', (peer) => {})

Peer has been discovered.

• peer: instance of PeerInfo

libp2p.on('peer:connect', (peer) => {})

We connected to a new peer

• peer: instance of PeerInfo

libp2p.on('peer:disconnect', (peer) => {})

We disconnected from Peer

• peer: instance of PeerInfo

libp2p.isStarted()

Check if libp2p is started

libp2p.ping(peer [, options], callback)

Ping a node in the network

libp2p.peerBook

PeerBook instance of the node

libp2p.peerInfo

PeerInfo instance of the node

libp2p.pubsub

Same API as IPFS PubSub, defined in the CORE API Spec. Just replace ipfs by libp2p and you are golden.

---

DHT methods also exposed for the time being

libp2p.dht.put(key, value, callback)

• key: Buffer
• value: Buffer

libp2p.dht.get(key, callback)

• key: Buffer

libp2p.dht.getMany(key, nVals, callback)

• key: Buffer
• nVals: Number

---

Switch Stats API

libp2p.stats.emit('update')

Every time any stat value changes, this object emits an update event.

Global stats

libp2p.stats.global.snapshot

Should return a stats snapshot, which is an object containing the following keys and respective values:

• dataSent: amount of bytes sent, Big number
• dataReceived: amount of bytes received, Big number

libp2p.stats.global.movingAverages

Returns an object containing the following keys:

• dataSent
• dataReceived

Each one of them contains an object that has a key for each interval (60000, 300000 and 900000 miliseconds).

Each one of these values is an exponential moving-average instance.

Per-transport stats

libp2p.stats.transports()

Returns an array containing the tags (string) for each observed transport.

libp2p.stats.forTransport(transportTag).snapshot

Should return a stats snapshot, which is an object containing the following keys and respective values:

• dataSent: amount of bytes sent, Big number
• dataReceived: amount of bytes received, Big number

libp2p.stats.forTransport(transportTag).movingAverages

Returns an object containing the following keys:

dataSent dataReceived

Each one of them contains an object that has a key for each interval (60000, 300000 and 900000 miliseconds).

Each one of these values is an exponential moving-average instance.

Per-protocol stats

libp2p.stats.protocols()

Returns an array containing the tags (string) for each observed protocol.

libp2p.stats.forProtocol(protocolTag).snapshot

Should return a stats snapshot, which is an object containing the following keys and respective values:

• dataSent: amount of bytes sent, Big number
• dataReceived: amount of bytes received, Big number

libp2p.stats.forProtocol(protocolTag).movingAverages

Returns an object containing the following keys:

• dataSent
• dataReceived

Each one of them contains an object that has a key for each interval (60000, 300000 and 900000 miliseconds).

Each one of these values is an exponential moving-average instance.

Per-peer stats

libp2p.stats.peers()

Returns an array containing the peerIDs (B58-encoded string) for each observed peer.

libp2p.stats.forPeer(peerId:String).snapshot

Should return a stats snapshot, which is an object containing the following keys and respective values:

• dataSent: amount of bytes sent, Big number
• dataReceived: amount of bytes received, Big number

libp2p.stats.forPeer(peerId:String).movingAverages

Returns an object containing the following keys:

• dataSent
• dataReceived

Each one of them contains an object that has a key for each interval (60000, 300000 and 900000 miliseconds).

Each one of these values is an exponential moving-average instance.

Stats update interval

Stats are not updated in real-time. Instead, measurements are buffered and stats are updated at an interval. The maximum interval can be defined through the Switch constructor option stats.computeThrottleTimeout, defined in miliseconds.

Development

Clone and install dependencies:

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

Tests

Run unit tests

# run all the unit tsts
> npm test

# run just Node.js tests
> npm run test:node

# run just Browser tests (Chrome)
> npm run test:browser

Run interop tests

N/A

Run benchmark tests

N/A

Packages

List of packages currently in existence for libp2p

Package	Version	Dependencies	DevDependencies
Transports
libp2p-utp
libp2p-websockets
libp2p-webrtc-star
libp2p-websocket-star
libp2p-websocket-star-rendezvous
Connection Upgrades
interface-connection
Stream Muxers
interface-stream-muxer
libp2p-spdy
libp2p-multiplex
Discovery
libp2p-mdns-discovery
libp2p-railing
Crypto Channels
libp2p-secio
Peer Routing
libp2p-kad-routing
Content Routing
interface-record-store
libp2p-record
libp2p-distributed-record-store
libp2p-kad-record-store
Generics
libp2p-swarm
libp2p-ping
multistream-select
Data Types
peer-book
peer-id

Contribute

The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:

• Go through the modules and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p 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. Most of this has been developed by @diasdavid, which means that 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.

License

MIT © David Dias