etherfs

Description

Use Ethereum as a Key-Value secured distributed database to add mutability and source verification to the IPFS. The initial target was to support both nodejs and browser. But, the browser is delayed to be implemented.

Purpose

provide a simple, easy and convenient library for developers to develop application using Ethereum + IPFS

Language

ES6 (Babel transpile)

Proposed dependencies

• Web3
• Ipfs

Management tool

• yarn npm

Potential use case

See "Use Case.md"

Feature

Why not use IPFS to share files directly?

1. You can't verify who uploaded that. e.g. if you provide
2. The mutability is limited. Although you can use IPNS to have an address mapped to a hash, you can't have multiple users modify the mapping and one node is binded to only one object(hash) for now.

Bugs

1. Deletion doesn't work at the moment.

Installation

$ npm install --save etherfs

Usage

var etherfs = require('etherfs');

API

etherfs(data, [options])

Description

Parameters

• Array data: An array of data
• Object options: An object containing the following fields:

Return

• Array - Result

Development

• npm run build - Build task that generates both minified and non-minified scripts;
• npm run test-server - Run Mocha tests once;
• npm run test-browser - Run Mocha tests in the browser using Karma once;
• npm run test - Shortcut for npm run test-server && npm run test-browser;
• npm run tdd - Run Mocha tests & watch files for changes;
• npm run tdd-browser - Run Karma (w/ Mocha) tests & watch files for changes;
• npm run coverage - Run Isparta, a code coverage tool;

License

MIT © yxliang01