{"_id":"ipfs-blocks","_rev":"4631878","name":"ipfs-blocks","description":"JavaScript Implementation of Block and BlockService","dist-tags":{"latest":"0.2.3"},"maintainers":[{"name":"daviddias","email":"daviddias.p@gmail.com"}],"time":{"modified":"2026-04-10T18:56:24.000Z","created":"2016-01-29T07:27:58.544Z","0.2.3":"2016-04-24T21:12:02.020Z","0.2.2":"2016-04-24T20:47:42.190Z","0.2.1":"2016-04-24T17:32:58.597Z","0.2.0":"2016-04-19T20:37:11.167Z","0.1.2":"2016-04-11T12:46:57.043Z","0.1.1":"2016-04-08T20:42:02.764Z","0.1.0":"2016-01-29T07:27:58.544Z"},"users":{},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs-blocks.git"},"versions":{"0.2.3":{"name":"ipfs-blocks","version":"0.2.3","description":"JavaScript Implementation of Block and BlockService","main":"lib/index.js","jsnext:main":"src/index.js","scripts":{"lint":"aegir-lint","build":"aegir-build","test":"aegir-test","test:node":"aegir-test node","test:browser":"aegir-test browser","release":"aegir-release","release-minor":"aegir-release minor","release-major":"aegir-release major","coverage":"aegir-coverage","coverage-publish":"aegir-coverage publish"},"pre-commit":["lint","test"],"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs-blocks.git"},"keywords":["IPFS"],"authors":["David Dias ","Vijayee Kulkaa ","Vijayee Kulkaa ","Vijayee Kulkaa ","Vijayee Kulkaa ","Vijayee Kulkaa ","Vijayee Kulkaa ","Vijayee Kulkaa [IPFS][ipfs] implementation of the BlockService and Block data structure in\n> JavaScript.\n\n## Description\n\n**Block** - A block is a blob of binary data.\n\n**BlockService** - A BlockService is a content-addressable store for blocks,\nproviding an API for adding, deleting, and retrieving blocks. A BlockService is\nbacked by an [IPFS Repo][repo] as its datastore for blocks, and uses an [IPFS\nExchange][bitswap] implementation to fetch blocks from the network.\n\n```markdown\n┌────────────────────┐\n│ BlockService │\n└────────────────────┘\n │\n ┌─────┴─────┐\n ▼ ▼\n┌─────────┐ ┌────────┐\n│IPFS Repo│ │Exchange│\n└─────────┘ └────────┘\n```\n\n## Example\n\n```js\nconst blocks = require('ipfs-blocks')\nconst IPFSRepo = require('ipfs-repo') // storage repo\nconst memstore = require('abstract-blob-store') // in-memory store\n\n// setup a repo\nvar repo = new IPFSRepo('example', { stores: memstore })\n\n// create a block\nconst block = new blocks.Block('hello warld')\nconsole.log(block.data)\nconsole.log(block.key)\n\n// create a service\nconst bs = new blocks.BlockService(repo)\n\n// add the block, then retrieve it\nbs.addBlock(block, function (err) {\n bs.getBlock(block.key, function (err, b) {\n console.log(block.data.toString() === b.data.toString())\n })\n})\n```\n\noutputs\n\n```\n\n\n\n\ntrue\n\n```\n\n## Installation\n\n### npm\n\n```sh\n> npm i ipfs-blocks\n```\n\n## Setup\n\n### Node.js\n\n```js\nconst blocks = require('ipfs-blocks')\n```\n\n### Browser: Browserify, Webpack, other bundlers\n\nThe code published to npm that gets loaded on require is in fact a ES5\ntranspiled version with the right shims added. This means that you can require\nit and use with your favourite bundler without having to adjust asset management\nprocess.\n\n```JavaScript\nvar blocks = require('ipfs-blocks')\n```\n\n### Browser: `\n\n\n```\n\n## API\n\n```js\nconst blocks = require('ipfs-blocks')\n```\n\n### Block\n\n#### var block = new blocks.Block(data)\n\nCreates a new block with raw data `data`.\n\n#### block.data\n\nThe raw data of the block. Its format matches whatever was provided in its\nconstructor.\n\n#### block.key\n\nThe [multihash][multihash] of the block's data, as a buffer.\n\n### var bs = new blocks.BlockService(repo[, exchange])\n\nCreates a new block service backed by [IPFS Repo][repo] `repo` for storage, and\n[IPFS Exchange][bitswap] for retrieving blocks from the network. Providing an\n`exchange` is optional.\n\n#### bs.addBlock(block, callback(err))\n\nAsynchronously adds a block instance to the underlying repo.\n\n#### bs.addBlocks(blocks, callback(err))\n\nAsynchronously adds an array of block instances to the underlying repo.\n\n*Does not guarantee atomicity.*\n\n#### bs.getBlock(multihash, callback(err, block))\n\nAsynchronously returns the block whose content multihash matches `multihash`.\nReturns an error (`err.code === 'ENOENT'`) if the block does not exist.\n\nIf the block could not be found, expect `err.code` to be `'ENOENT'`.\n\n#### bs.getBlocks(multihashes, callback(err, blocks))\n\nAsynchronously returns the blocks whose content multihashes match the array\n`multihashes`.\n\n`blocks` is an object that maps each `multihash` to an object of the form\n\n```js\n{\n err: Error\n block: Block\n}\n```\n\nExpect `blocks[multihash].err.code === 'ENOENT'` and `blocks[multihash].block\n=== null` if a block did not exist.\n\n*Does not guarantee atomicity.*\n\n#### bs.deleteBlock(multihash, callback(err))\n\nAsynchronously deletes the block from the store with content multihash matching\n`multihash`, if it exists.\n\n#### bs.deleteBlocks(multihashes, callback(err))\n\nAsynchronously deletes all blocks from the store with content multihashes matching\nfrom the array `multihashes`.\n\n*Does not guarantee atomicity.*\n\n## License\n\nMIT\n\n[ipfs]: https://ipfs.io\n[repo]: https://github.com/ipfs/specs/tree/master/repo\n[bitswap]: https://github.com/ipfs/specs/tree/master/bitswap\n[multihash]: https://github.com/jbenet/js-multihash\n","_attachments":{},"homepage":"https://github.com/ipfs/js-ipfs-blocks#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs-blocks/issues"},"license":"MIT"}