@simbachain/libsimba-js
Version:
libsimba-js is a library simplifying the use of SIMBAChain APIs. We aim to abstract away the various blockchain concepts, reducing the necessary time needed to get to working code.
230 lines (205 loc) • 12.8 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../../">
<title data-ice="title">src/wallet/pkwallet.js | libsimba-js</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
<meta name="description" content="Simbachain Blockchain abstraction and interaction library"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="libsimba-js"><meta property="twitter:description" content="Simbachain Blockchain abstraction and interaction library"></head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a href="test.html" data-ice="testLink">Test</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
<a style="position:relative; top:3px;" href="https://github.com/simbachain/libsimba-js"><img width="20px" src="./image/github.png"></a></header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~BadMetadataException.html">BadMetadataException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~BaseException.html">BaseException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~GenerateTransactionException.html">GenerateTransactionException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~GetRequestException.html">GetRequestException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~GetTransactionsException.html">GetTransactionsException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~MethodCallValidationMetadataException.html">MethodCallValidationMetadataException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~MissingMetadataException.html">MissingMetadataException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~NotImplementedException.html">NotImplementedException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~NotInBrowserException.html">NotInBrowserException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~RetriesExceededException.html">RetriesExceededException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~SigningException.html">SigningException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~SubmitTransactionException.html">SubmitTransactionException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~TransactionStatusCheckException.html">TransactionStatusCheckException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~UserRejectedSigningException.html">UserRejectedSigningException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~WalletLockedException.html">WalletLockedException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/exceptions.js~WalletNotFoundException.html">WalletNotFoundException</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getSimbaInstance">getSimbaInstance</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#simba">simba</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/simba/pagedresponse.js~PagedResponse.html">PagedResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/simba/simba.js~Simbachain.html">Simbachain</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/simba/simbabase.js~SimbaBase.html">SimbaBase</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#wallet">wallet</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/wallet/localwallet.js~LocalWallet.html">LocalWallet</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/wallet/pkwallet.js~PKWallet.html">PKWallet</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/wallet/wallet.js~Wallet.html">Wallet</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><h1 data-ice="title">src/wallet/pkwallet.js</h1>
<pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import Wallet from './wallet';
import { Wallet as EthersWallet } from '@ethersproject/wallet';
import { SigningException, UserRejectedSigningException, WalletNotFoundException, WalletLockedException} from "../exceptions";
/**
* libsimba-js Private Key Wallet implementation
* Use when you already have access to the decrypted private key
* Wraps the [ethersjs]{@link https://docs.ethers.io/ethers.js/html/} library.
*/
export default class PKWallet extends Wallet {
/**
* Use when you already have access to the decrypted private key
* @param {string} [private_key] - The private key in hexidecimal format
* @param {function} [signingConfirmation] - - an optional callback for requesting user permission to sign a
* transaction. Should resolve a promise with true for accept, and false (or reject) for reject.
*/
constructor(private_key, signingConfirmation) {
super(signingConfirmation);
this.pk = private_key;
this.wallet = new EthersWallet(this.pk);
}
/**
* @override
* Unlock the wallet - noop for this wallet
* @param {string} passkey - The pass key to unlock the wallet
* @param {function} [progressCB] - A callback, accepting a number between 0-1, indicating decryption progress
* @returns {Promise} - Returns a promise resolving when the wallet is unlocked
*/
unlockWallet(passkey, progressCB){
return Promise.resolve();
}
/**
* @override
* Generate a wallet
* @param {string} passkey - The pass key to lock the wallet
* @param {function} [progressCB] - A callback, accepting a number between 0-1, indicating decryption progress
* @returns {Promise} - Returns a promise resolving with the private key when the wallet is created
*/
generateWallet(progressCB){
this.wallet = EthersWallet.createRandom();
this.pk = this.wallet.privateKey;
return Promise.resolve(this.pk);
}
/**
* @override
* Delete the wallet
*/
deleteWallet(){}
/**
* @override
* Check if a wallet exists
* @return {boolean} - does the wallet exist
*/
walletExists(){
return !!this.pk && !!this.wallet;
}
/**
* The mnemonic phrase for this wallet, or null if the mnemonic is unknown.
* @return {string} - The mnemonic phrase for this wallet, or null if the mnemonic is unknown.
*/
getMnemonic(){
if(!this.walletExists()){
throw new WalletNotFoundException("No wallet generated!")
}
if(!this.wallet) {
throw new WalletLockedException("Wallet not unlocked!");
}
return this.wallet.mnemonic;
}
/**
*
* @param {string} passkey - Passkey to encrypt the wallet
* @param {function} [progressCB] - An optional callback to monitor progress of encryption, calls with a value between 0-1
* @returns {Promise<string>} A promise that resolves with the JSON wallet
*/
getEncryptedJson(passkey, progressCB){
if(!this.walletExists()){
throw new WalletNotFoundException("No wallet generated!")
}
if(!this.wallet) {
throw new WalletLockedException("Wallet not unlocked!");
}
return this.wallet.encrypt(passkey, progressCB);
}
/**
* @protected
* @override
* Sign a transaction payload
* @param {Object} payload - The transaction to sign
* @returns {Promise<string>} - Returns a promise resolving to the signed transaction
*/
sign(payload) {
if(!this.walletExists()){
throw new WalletNotFoundException("No wallet generated!")
}
if(!this.wallet) {
throw new WalletLockedException("Wallet not unlocked!");
}
return this.signingConfirmation().then(allow=>{
if(allow){
const cleanedPayload = this.cleanPayload(payload);
return this.wallet.signTransaction(cleanedPayload)
.catch(error=>{throw new SigningException("Failed to sign transaction", error)});
}
throw new UserRejectedSigningException("User rejected signing");
});
}
/**
* @private
* Clean the payload before signing
* @param {Object} payload - The transaction to clean
* @returns {string} - The cleaned transaction
*/
cleanPayload(payload){
const allowedKeys = [ 'to','nonce','gasLimit','gasPrice', 'data','value','chainId'];
let cleanedPayload = {};
Object.keys(payload).forEach(key=>{
if(allowedKeys.indexOf(key) >= 0){
cleanedPayload[key] = payload[key];
if((typeof payload[key] === 'string' || payload[key] instanceof String) &&
payload[key].startsWith('0x') &&
payload[key].length % 2 !== 0){
cleanedPayload[key] = payload[key].replace('0x', '0x0');
console.log(`Bad Hex - txn.${key} = ${payload[key]}, reformatted to ${cleanedPayload[key]}`);
}
}
});
return cleanedPayload;
}
/**
* @override
* Get the wallets address
* @returns {Promise<string>} - Returns a promise resolving to the wallets address
*/
getAddress(){
return this.wallet.getAddress();
}
}
</code></pre>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>