Vault-base-controller

A Module written in javascript for managing various keyrings of Base accounts, encrypting them, and using them.

• Installation
• Initialize the Base Controller class
• Methods
  • Generate Keyring with 1 account and encrypt
  • Restore a keyring with the first account using a mnemonic
  • Add a new account to the keyring object
  • Export the private key of an address present in the keyring
  • Sign a transaction
  • Sign a message
  • Get balance

Installation

npm install --save @getsafle/vault-base-controller

Initialize the Base Controller class

const { KeyringController, getBalance } = require('@getsafle/vault-base-controller');

const baseController = new KeyringController({
  encryptor: {
    // An optional object for defining encryption schemes:
    // Defaults to Browser-native SubtleCrypto.
    encrypt(password, object) {
      return new Promise('encrypted!');
    },
    decrypt(password, encryptedString) {
      return new Promise({ foo: 'bar' });
    },
  },
});

Methods

Generate Keyring with 1 account and encrypt

const keyringState = await baseController.createNewVaultAndKeychain(password);

Restore a keyring with the first account using a mnemonic

const keyringState = await baseController.createNewVaultAndRestore(password, mnemonic);

Add a new account to the keyring object

const keyringState = await baseController.addNewAccount(keyringObject);

Export the private key of an address present in the keyring

const privateKey = await baseController.exportAccount(address);

Sign a transaction

const signedTx = await baseController.signTransaction(baseTx, privateKey);

Sign a message

const signedMsg = await baseController.signMessage(msgParams);

Sign a message

const signedObj = await baseController.sign(msgParams, pvtKey, web3Obj);

Sign Typed Data (EIP-712)

const signedData = await baseController.signTypedMessage(msgParams);

Get balance

const balance = await getBalance(address, web3);