swarm-backup v1.0.3

Swarm Backup

A library to back up and restore encrypted data using swarm.

Overview

Installation

$ npm i

Data Disclaimer

Swarm is in beta and as such data retention cannot be guaranteed, be sure to keep data safe and secure in a secondary location.

Usage

Instantiate the Class

new SwarmBackup()

Instantiate the class passing the URL of the Swarm gateway and a valid private key.

Example

const gateway = 'http://localhost:1633';
const w1 = await new Wallet().generate('test-pw-1');
const privateKey = w1.wallet.privateKey;

const sb = new SwarmBackup(gateway, privateKey);

Backup Data

backup()

Pass the data key as a string and the value of the data you want to backup.

Example

const key = 'name';
const value = 'John';
const backup = sb.backup(key, value); //returns private key on success

Restore Data

restore()

Pass the data key as a string and it returns the latest data available for this key and private key.

Example

const key = 'name';
const backup = sb.restore(key); //returns "John"

Use in a Web Browser

To use this library in the web browser use webpack to create a bundle.

npm run pack

The bundle will be generated and stored in dist/web/bundle.js

Include the library as normal and instantiate the class using the same example as above.

Testing

To run tests:

1. Install bee following the instructions at https://docs.ethswarm.org.
2. Run locally in standalone mode bee start --standalone --password="password" --swap-enable="false"
3. npm test

License

Swarm Backup is released under the MIT License.