Home Reference Source Test

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

public class | source

Wallet

Direct Subclass:

LocalWallet, PKWallet

Constructor Summary

Public Constructor
public	constructor(signingConfirmation: *) Base class for libsimba Wallet implementations

Member Summary

Public Members
public	signingConfirmation: *

Method Summary

Public Methods
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 Methods
protected abstract	sign(payload: Object): Promise<string>

Public Constructors

public constructor(signingConfirmation: *) source

Base class for libsimba Wallet implementations

Params:

Name	Type	Attribute	Description
signingConfirmation	*		{function} - 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 signingConfirmation: * source

Public Methods

public abstract deleteWallet() source

public abstract generateWallet(passkey: string): Promise source

Params:

Name	Type	Attribute	Description
passkey	string		The pass key to lock the wallet

Return:

Returns a promise resolving when the wallet is created

public abstract getAddress(): Promise<string> source

Return:

Promise<string>

Returns a promise resolving to the wallets address

public abstract unlockWallet(passkey: string): Promise source

Params:

Name	Type	Attribute	Description
passkey	string		The pass key to unlock the wallet

Return:

Returns a promise resolving when the wallet is unlocked

public abstract walletExists(): boolean source

Return:

does the wallet exist

Protected Methods

protected abstract sign(payload: Object): Promise<string> source

Params:

Name	Type	Attribute	Description
payload	Object		The transaction to sign

Return:

Promise<string>

Returns a promise resolving to the signed transaction