Skip to content

README.md

Latest commit

 

History

History
61 lines (50 loc) · 2.01 KB

README.md

File metadata and controls

61 lines (50 loc) · 2.01 KB

Base Platform Tutorial

This reference application demonstrates how to use BASE API using BASE JS LIBRARY.

The application lets user to choose a passphrase to create his private & public key pair and use his private key to encrypt data and save it to BASE. User can retrieve his data any time and decrypt it using his private key. Either passphrase or private key is never sent to BASE platform.

How to use Base Platform

  1. Install using npm

        npm install --save @bitclave/base-client-js

  2. Initialise Base

    const base = new Base("https://base-node-staging.herokuapp.com", 'localhost', '', '');

  3. Choose a passphrase and crate a keypair

    base.createKeyPairHelper('').createKeyPair("some passphrase").then(keyPair => {
    console.log("PublicKey:" + keyPair.publicKey);
    console.log("PrivateKey:" + keyPair.privateKey);     
});

  4. Create account or check for existence

    let account;
try {
    account = await base.accountManager.checkAccount(passphrase, "somemessage");
} catch(e) {
    account = await base.accountManager.registration(passphrase, "somemessage");
}

  5. Save & Read your data

    //Save
let data = new Map();
data.set("email", "im@host.com");
let encryptedData = await base.profileManager.updateData(data);

//Read
let decryptedData = await base.profileManager.getData();
console.log(decryptedData.get("email"));

How to run this application

$ node --version
v8.11.2
$ npm --version
6.1.0

$ npm i
$ npm run start

FAQs

  1. I see an error when using base-client-js - Error: More than one instance of bitcore-lib found. Please make sure to require bitcore-lib and check that submodules do not also include their own bitcore-lib dependency.

    This is caused by version gaurd in bitcore-lib. So use a similar postinstall script to remove all transitive bitcore-lib dependencies.