import LocalWallet from '@simbachain/libsimba-js/src/wallet/localwallet.js'

public class | source

LocalWallet

Extends:

Wallet → LocalWallet

libsimba-js Local Wallet implementation Stores the wallet as encrypted json within the browsers localstorage Wraps the [ethersjs]https://docs.ethers.io/ethers.js/html/ library.

Constructor Summary

Public Constructor
public	constructor(signingConfirmation: function) Use a wallet stored in the browsers local storage

Member Summary

Public Members
public	wallet: *
public	window: *

Method Summary

Public Methods
public	deleteWallet()
public	generateWallet(passkey: string, progressCB: function): Promise
public	generateWalletFromEncryptedJson(json: string, passkey: string, progressCB: function): Promise Generate a wallet from a encrypted json (see [ethers docs]{@link https://docs.ethers.io/ethers.js/html/api-wallet.html?highlight=fromencryptedjson})
public	generateWalletFromMnemonic(mnemonic: string, passkey: string, progressCB: function): Promise Generate a wallet from a mnemonic
public	generateWalletFromPrivateKey(key: string, passkey: string, progressCB: function): Promise Generate a wallet from an existing private key
public	getAddress(): Promise<string>
public	getEncryptedJson(passkey: string, progressCB: function): Promise<string>
public	getMnemonic(): string The mnemonic phrase for this wallet, or null if the mnemonic is unknown.
public	unlockWallet(passkey: string, progressCB: function): Promise
public	walletExists(): boolean

Protected Methods
protected	sign(payload: Object): Promise<string>

Private Methods
private	cleanPayload(payload: Object): string

Inherited Summary

From class Wallet
public	signingConfirmation: *
public abstract	deleteWallet()
public abstract	generateWallet(passkey: string): Promise
public abstract	getAddress(): Promise<string>
public abstract	unlockWallet(passkey: string): Promise
public abstract	walletExists(): boolean
protected abstract	sign(payload: Object): Promise<string>

Public Constructors

public constructor(signingConfirmation: function) source

Use a wallet stored in the browsers local storage

Override:

Wallet#constructor

Params:

Name	Type	Attribute	Description
signingConfirmation	function	optional	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.

Public Members

public wallet: * source

public window: * source

Public Methods

public deleteWallet() source

Override:

Wallet#deleteWallet

public generateWallet(passkey: string, progressCB: function): Promise source

Override:

Wallet#generateWallet

Params:

Name	Type	Attribute	Description
passkey	string		The pass key to lock the wallet
progressCB	function	optional	A callback, accepting a number between 0-1, indicating decryption progress

Return:

Promise

Returns a promise resolving when the wallet is created

public generateWalletFromEncryptedJson(json: string, passkey: string, progressCB: function): Promise source

Generate a wallet from a encrypted json (see [ethers docs]{@link https://docs.ethers.io/ethers.js/html/api-wallet.html?highlight=fromencryptedjson})

Params:

Name	Type	Attribute	Description
json	string		The json
passkey	string		The pass key to lock the wallet
progressCB	function	optional	A callback, accepting a number between 0-1, indicating decryption progress

Return:

Promise

Returns a promise resolving when the wallet is created

public generateWalletFromMnemonic(mnemonic: string, passkey: string, progressCB: function): Promise source

Generate a wallet from a mnemonic

Params:

Name	Type	Attribute	Description
mnemonic	string		The mnemonic
passkey	string		The pass key to lock the wallet
progressCB	function	optional	A callback, accepting a number between 0-1, indicating decryption progress

Return:

Promise

Returns a promise resolving when the wallet is created

public generateWalletFromPrivateKey(key: string, passkey: string, progressCB: function): Promise source

Generate a wallet from an existing private key

Params:

Name	Type	Attribute	Description
key	string		The existing private key
passkey	string		The pass key to lock the wallet
progressCB	function	optional	A callback, accepting a number between 0-1, indicating decryption progress

Return:

Promise

Returns a promise resolving when the wallet is created

public getAddress(): Promise<string> source

Override:

Wallet#getAddress

Return:

Promise<string>

Returns a promise resolving to the wallets address

public getEncryptedJson(passkey: string, progressCB: function): Promise<string> source

Params:

Name	Type	Attribute	Description
passkey	string		Passkey to encrypt the wallet
progressCB	function	optional	An optional callback to monitor progress of encryption, calls with a value between 0-1

Return:

Promise<string>

A promise that resolves with the JSON wallet

public getMnemonic(): string source

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.

public unlockWallet(passkey: string, progressCB: function): Promise source

Override:

Wallet#unlockWallet

Params:

Name	Type	Attribute	Description
passkey	string		The pass key to unlock the wallet
progressCB	function	optional	A callback, accepting a number between 0-1, indicating decryption progress