Git Product home page Git Product logo

backpack-client's Introduction

backpack-client

Client side library for creating and retrieving remote backpack backups.

⚠️ Warning

This is pre-alpha software. Please use at your own risk. Expect breaking changes

Install

yarn add @synonymdev/backpack-client

Usage

import bint from 'bint8array';
import Client from '@synonymdev/backpack-client';
const username = 'testuser';
const password = 'testpass';
const server = { id: 'test123', url: 'wss://my-backup-server.com' };
const opts = {
  memlimit: 16777216, // crypto_pwhash_MEMLIMIT_MIN
  opslimit: 2, // crypto_pwhash_OPSLIMIT_MIN
};
const padding = 1024;

const client = new Client({ username, password }, server, opts, padding);

// Setup
try {
  // Encryption key derived from the username and password.
  // Hashing can take some time depending on environment and opts.
  // Hex version of encryption key can be stored in device keychain and passed when creating the client next time so it doesn't need to be dervied on each use.
  const keyHexToCache = await client.createKey();

  // Server registration required on first use
  await client.register();
} catch (e) {
  console.error(e);
}

// Storing
try {
  const uniqueBackupStr = 'Back me up';
  const backupBytes = bint.fromString(uniqueBackupStr); //Accepts Uint8Array
  await client.store(backupBytes);
} catch (e) {
  console.error(e);
}

// Retrieving
try {
  const retrievedBackup = await client.retrieve();
  const backup = bint.toString(retrievedBackup);
} catch (e) {
  console.error(e);
}

Development

git clone https://github.com/synonymdev/backpack-client.git
cd backpack-client
yarn
yarn build

Tests

yarn test:unit

Integration test

SERVER_ID=test123 SERVER_URL=wss://my-backup-server.com yarn test:integration

Code formatting

yarn format

backpack-client's People

Contributors

bitcoinerrorlog avatar jasonvdb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.