ipfs-block-service

IPFS Block Service JavaScript Implementation

IPFS implementation of the BlockService and Block data structure in JavaScript.

BlockService - A BlockService is a content-addressable store for blocks, providing an API for adding, deleting, and retrieving blocks. A BlockService is backed by an IPFS Repo as its datastore for blocks, and uses Bitswap to fetch blocks from the network.

┌────────────────────┐
│     BlockService   │
└────────────────────┘
           │
     ┌─────┴─────┐
     ▼           ▼
┌─────────┐ ┌───────┐
│IPFS Repo│ |Bitswap│
└─────────┘ └───────┘

Table of Contents

• Install
  • npm
• Usage
  • Node.js
  • Example
  • Browser: Browserify, Webpack, other bundlers
  • Browser: <script> Tag
• Contribute
• License

Install

npm

> npm i ipfs-block-service

Usage

Node.js

const BlockService = require('ipfs-block-service')

Example

const BlockService = require('ipfs-block-service')
const Block = require('ipfs-block')
const IPFSRepo = require('ipfs-repo')  // storage repo
const Store = require('interface-pull-blob-store')  // in-memory store

// setup a repo
var repo = new IPFSRepo('example', { stores: Store })

// create a block
const block = new Block('hello world')
console.log(block.data)
console.log(block.key())

// create a service
const bs = new BlockService(repo)

// add the block, then retrieve it
bs.put({
  block: block,
  cid: cid,
}, function (err) {
  bs.get(cid, function (err, b) {
    console.log(block.data.toString() === b.data.toString())
  })
})

outputs

<Buffer 68 65 6c 6c 6f 20 77 61 72 6c 64>

<Buffer 12 20 db 3c 15 23 3f f3 84 8f 42 fe 3b 74 78 90 90 5a 80 7e a6 ef 2b 6d 2f 3c 8b 2c b7 ae be 86 3c 4d>

true

Browser: Browserify, Webpack, other bundlers

The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.

var BlockService = require('ipfs-block-service')

Browser: <script> Tag

Loading this module through a script tag will make the IpfsBlockService obj available in the global namespace.

<script src="https://unpkg.com/ipfs-block-service/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/ipfs-block-service/dist/index.js"></script>

API

const BlockService = require('ipfs-block-service')

new BlockService(repo)

• repo: Repo

Creates a new block service backed by IPFS Repo repo for storage.

goOnline(bitswap)

• bitswap: Bitswap

Add a bitswap instance that communicates with the network to retreive blocks that are not in the local store.

If the node is online all requests for blocks first check locally and afterwards ask the network for the blocks.

goOffline()

Remove the bitswap instance and fall back to offline mode.

isOnline()

Returns a Boolean indicating if the block service is online or not.

put(blockAndCID, callback)

• blockAndCID: { block: block, cid: cid }
• callback: Function

Asynchronously adds a block instance to the underlying repo.

putStream()

Returns a through pull-stream, which blockAndCIDs can be written to, and that emits the meta data about the written block.

get(cid [, extension], callback)

• cid: CID
• extension: String, defaults to 'data'
• callback: Function

Asynchronously returns the block whose content multihash matches multihash.

getStream(cid [, extension])

• cid: CID
• extension: String, defaults to 'data'

Returns a source pull-stream, which emits the requested block.

delete(cids, [, extension], callback)

• cids: CID | []CID
• extension: String, defaults to 'data' - extension: String, defaults to 'data'
• callback: Function

Deletes all blocks referenced by multihashes.

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT