Package Exports

ipld

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipld) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

The JavaScript implementation of the IPLD

The JavaScript implementation of the IPLD, InterPlanetary Linked-Data

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 js-ipld Waffle Board.

Weekly Core Dev Calls

Tech Lead

Volker Mische

Lead Maintainer

Volker Mische

Install
Usage
API
- IPLD Resolver
Packages
Contribute
License

Install

> npm install --save ipld

Usage

const Ipld = require('ipld')
const IpfsRepo = require('ipfs-repo')
const IpfsBlockService = require('ipfs-block-service')

const initIpld = (ipfsRepoPath, callback) => {
  const repo = new IpfsRepo(ipfsRepoPath)
  repo.init({}, (err) => {
    if (err) {
      return callback(err)
    }
    repo.open((err) => {
      if (err) {
        return callback(err)
      }
      const blockService = new IpfsBlockService(repo)
      const ipld = new Ipld(blockService)
      return callback(null, ipld)
    })
  })
}

initIpld('/tmp/ifpsrepo', (err, ipld) => {
  // Do something with the `ipld`, e.g. `ipld.get(…)`
})

API

`.put(node, options, callback)`

Store the given node of a recognized IPLD Format.

options is an object that must contain one of the following combinations:

cid - the CID of the node
[hashAlg], [version] and format - the hashAlg, version and the format that should be used to create the CID of the node. The hashAlg and version defaults to the default values for the format.

callback is a function that should have the signature as following: function (err, cid) {}, where err is an Error object in case of error and cid is the cid of the stored object.

`.get(cid [, path] [, options], callback)`

Retrieve a node by the given cid or cid + path

options is an optional object containing:

localResolve: bool - if true, get will only attempt to resolve the path locally

callback should be a function with the signature function (err, result), the result being an object with:

value - the value that resulted from the get
remainderPath - If it didn't manage to successfully resolve the whole path through or if simply the localResolve option was passed.

`.getStream(cid [, path] [, options])`

Same as get, but returns a source pull-stream that is used to pass the fetched node.

`.treeStream(cid [, path] [, options])`

Returns all the paths under a cid + path through a pull-stream. Accepts the following options:

recursive - bool - traverse through links to complete the graph.

`.remove(cid, callback)`

Remove a node by the given cid

`.support.add(multicodec, formatResolver, formatUtil)`

Add support to another IPLD Format

`.support.rm(multicodec)`

Removes support of an IPLD Format

Packages

Listing of dependencies from the IPLD ecosystem.

This table is generated using the module package-table with package-table --data=package-list.json.

Package	CI	Lead Maintainer
IPLD Formats
`ipld-bitcoin`		Volker Mische
`ipld-dag-cbor`		Volker Mische
`ipld-dag-pb`		Volker Mische
`ipld-ethereum`	N/A	kumavis
`ipld-git`	N/A	Volker Mische
`ipld-raw`	N/A	Volker Mische
`ipld-zcash`		Volker Mische
Data Types (non IPLD specific)
`multihashes`		David Dias
`ipfs-block`		N/A
Storage
`ipfs-repo`		Jacob Heun
`interface-datastore`	N/A	N/A
`ipfs-block-service`		N/A
Generics/Utils
`is-ipfs`		Marcin Rataj