Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ipfs/js-ipfs-block-service

JavaScript Implementation of Block and BlockService
https://github.com/ipfs/js-ipfs-block-service

Last synced: 3 months ago
JSON representation

JavaScript Implementation of Block and BlockService

Host: GitHub
URL: https://github.com/ipfs/js-ipfs-block-service
Owner: ipfs
License: mit
Archived: true
Created: 2016-01-29T07:07:15.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2021-08-11T16:50:59.000Z (over 3 years ago)
Last Synced: 2024-04-13T21:59:02.869Z (8 months ago)
Language: JavaScript
Size: 1.39 MB
Stars: 13
Watchers: 30
Forks: 20
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-peer-to-peer - ipfs-blocks

README

        ⛔️ DEPRECATED: This module has been merged into [ipfs](https://github.com/ipfs/js-ipfs) 

======

# IPFS Block Service

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)

[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)

[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

[![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-block-service)](https://travis-ci.com/ipfs/js-ipfs-block-service)

[![Dependency Status](https://david-dm.org/ipfs/js-ipfs-block-service.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-block-service)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)

![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)

> [IPFS][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][repo] as its datastore for blocks, and uses [Bitswap][bitswap] to fetch blocks from the network.

```markdown

┌───────────────────┐

│    BlockService   │

└───────────────────┘

     ┌─────┴─────┐

     ▼           ▼

┌─────────┐ ┌───────┐

│IPFS Repo│ |Bitswap│

└─────────┘ └───────┘

```

## Lead Maintainer

[Volker Mische](https://github.com/vmx)

## Table of Contents

- [IPFS Block Service](#ipfs-block-service)

  - [Lead Maintainer](#lead-maintainer)

  - [Table of Contents](#table-of-contents)

  - [Install](#install)

    - [npm](#npm)

  - [Usage](#usage)

    - [Node.js](#nodejs)

    - [Example](#example)

    - [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)

    - [Browser: `` Tag](#browser-script-tag)

  - [API](#api)

  - [Contribute](#contribute)

  - [License](#license)

## Install

### npm

```sh

> npm install ipfs-block-service

```

## Usage

### Node.js

```js

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

```

### Example

```js

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

const Block = require('ipld-block')

const multihashing = require('multihashing-async')

const IPFSRepo = require('ipfs-repo')  // storage repo

const uint8ArrayEquals = require('uint8arrays/equals')

const uint8ArrayFromString = require('uint8arrays/from-string')

// setup a repo

const repo = new IPFSRepo('example')

// create a block

const data = uint8ArrayFromString('hello world')

const multihash = await multihashing(data, 'sha2-256')

const cid = new CID(multihash)

const block = new Block(data, cid)

// create a service

const service = new BlockService(repo)

// add the block, then retrieve it

await service.put(block)

const result = await service.get(cid)

console.log(uint8ArrayEquals(block.data, result.data))

// => true

```

### Browser: Browserify, Webpack, other bundlers

```JavaScript

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.

```html

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

```

## API

See https://ipfs.github.io/js-ipfs-block-service

## Contribute

Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-block-service/issues)!

This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

## License

[MIT](LICENSE)

[ipfs]: https://ipfs.io

[bitswap]: https://github.com/ipfs/specs/tree/master/bitswap

[repo]: https://github.com/ipfs/specs/tree/master/repo