@getsafle/vault-velas-controller
v1.3.1
Published
Velas controller for safle vault.
Downloads
33
Readme
Vault-velas-controller
A Module written in javascript for managing various keyrings of Velas accounts, encrypting them, and using them.
Installation
npm install --save @getsafle/vault-velas-controller
Initialize the Velas Controller class
const { KeyringController, getBalance } = require('@getsafle/vault-velas-controller');
const velasController = 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 velasController.createNewVaultAndKeychain(password);
Restore a keyring with the first account using a mnemonic
const keyringState = await velasController.createNewVaultAndRestore(password, mnemonic);
Add a new account to the keyring object
const keyringState = await velasController.addNewAccount(keyringObject);
Export the private key of an address present in the keyring
const privateKey = await velasController.exportAccount(address);
Sign a transaction
const signedTx = await velasController.signTransaction(velasTx, _fromAddress);
Sign a message
const signedMsg = await velasController.signMessage(msgParams);
Sign a message
const signedObj = await velasController.sign(msgParams, pvtKey, web3Obj);
Sign Typed Data (EIP-712)
const signedData = await velasController.signTypedMessage(msgParams);
Raw transaction object
rawTx: {
to, // receiver address
from, // sender address
value, // amount to send
gas, // gas Limit of transaction
gasPrice, // gasPrice
data, // data in hex to send
nonce, // transaction nonce
chainId, // chainID | 111 - TESTNET, 106 - MAINNET
}
Get balance
const balance = await getBalance(address, web3);