JSDoc: Class: Wallet

Constructor

new Wallet(optionsnullable)

Create a wallet client.

Parameters:

Name	Type	Attributes	Description
`options`	Object	<nullable>

Source:

client/wallet.js, line 670

Extends

EventEmitter

Methods

abandon(hash) → {Promise}

Used to remove a pending transaction from the wallet. That is likely the case if it has a policy or low fee that prevents it from proper network propagation.

Parameters:

Name	Type	Description
`hash`	Hash

Source:

client/wallet.js, line 826

Returns:

Type: Promise

addSharedKey(account, accountKey) → {Promise}

Add a public account key to the wallet for multisig.

Parameters:

Name	Type	Description
`account`	String
`accountKey`	String	Account (bip44) key (base58).

Source:

client/wallet.js, line 1081

Returns:

Type: Promise

(async) close() → {Promise}

Close wallet.

Source:

client/wallet.js, line 694

Returns:

Type: Promise

createAccount(name, options) → {Promise}

Create account.

Parameters:

Name	Type	Description
`name`	String
`options`	Object

Source:

client/wallet.js, line 906

Returns:

Type: Promise

createAddress(account) → {Promise}

Create address.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 916

Returns:

Type: Promise

createChange(account) → {Promise}

Create change address.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 926

Returns:

Type: Promise

createNested(account) → {Promise}

Create nested address.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 936

Returns:

Type: Promise

createTX(options) → {Promise}

Create a transaction, fill.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 836

Returns:

Type: Promise

getAccount(account) → {Promise}

Get wallet account.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 895

Returns:

Type: Promise

getAccounts() → {Promise}

Get wallet accounts.

Source:

client/wallet.js, line 876

Returns:

Returns Array.

Type: Promise

getBalance(account) → {Promise}

Calculate wallet balance.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 735

Returns:

Type: Promise

getBlock(height) → {Promise}

Get wallet block.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 792

Returns:

Type: Promise

getBlocks(height) → {Promise}

Get wallet blocks.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 782

Returns:

Type: Promise

getCoin(hash, index) → {Promise}

Get unspent coin (only possible if the transaction is available in the wallet history).

Parameters:

Name	Type	Description
`hash`	Hash
`index`	Number

Source:

client/wallet.js, line 804

Returns:

Type: Promise

getCoins(account) → {Promise}

Get wallet coins.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 715

Returns:

Type: Promise

getHistory(account) → {Promise}

Get wallet transaction history.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 705

Returns:

Type: Promise

getInfo() → {Promise}

Get the raw wallet JSON.

Source:

client/wallet.js, line 867

Returns:

Type: Promise

getKey(address) → {Promise}

Get wallet key.

Parameters:

Name	Type	Description
`address`	String

Source:

client/wallet.js, line 1059

Returns:

Type: Promise

getLast(account, limit) → {Promise}

Get last N wallet transactions.

Parameters:

Name	Type	Description
`account`	String
`limit`	Number	Max number of transactions.

Source:

client/wallet.js, line 746

Returns:

Type: Promise

getLocked() → {Promise}

Get locked coins.

Source:

client/wallet.js, line 1029

Returns:

Type: Promise

getMaster() → {Promise}

Get wallet master key.

Source:

client/wallet.js, line 885

Returns:

Type: Promise

getPending(account) → {Promise}

Get all unconfirmed transactions.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 725

Returns:

Type: Promise

getRange(account, options) → {Promise}

Get wallet transactions by timestamp range.

Parameters:

Name Type Description

account String

options

Object

Properties

Name	Type	Attributes	Description
`start`	Number		Start time.
`end`	Number		End time.
`limit`	Number	<nullable>	Max number of records.
`reverse`	Boolean	<nullable>	Reverse order.

Source:

client/wallet.js, line 761

Returns:

Type: Promise

getTX(hash) → {Promise}

Get transaction (only possible if the transaction is available in the wallet history).

Parameters:

Name	Type	Description
`hash`	Hash

Source:

client/wallet.js, line 772

Returns:

Type: Promise

getWIF(address, passphrasenullable) → {Promise}

Get wallet key WIF dump.

Parameters:

Name	Type	Attributes	Description
`address`	String
`passphrase`	String	<nullable>

Source:

client/wallet.js, line 1070

Returns:

Type: Promise

importAddress(account, address) → {Promise}

Import address.

Parameters:

Name	Type	Description
`account`	Number \| String
`address`	String

Source:

client/wallet.js, line 998

Returns:

Type: Promise

importPrivate(account, privateKey, passphrase) → {Promise}

Import private key.

Parameters:

Name	Type	Description
`account`	Number \| String
`privateKey`	String
`passphrase`	String

Source:

client/wallet.js, line 976

Returns:

Type: Promise

importPublic(account, publicKey) → {Promise}

Import public key.

Parameters:

Name	Type	Description
`account`	Number \| String
`publicKey`	String

Source:

client/wallet.js, line 987

Returns:

Type: Promise

lock() → {Promise}

Lock wallet.

Source:

client/wallet.js, line 1038

Returns:

Type: Promise

lockCoin(hash, index) → {Promise}

Lock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 1009

Returns:

Type: Promise

(async) open() → {Promise}

Open wallet.

Source:

client/wallet.js, line 684

Returns:

Type: Promise

removeSharedKey(account, accountKey) → {Promise}

Remove a public account key to the wallet for multisig.

Parameters:

Name	Type	Description
`account`	String
`accountKey`	String	Account (bip44) key (base58).

Source:

client/wallet.js, line 1092

Returns:

Type: Promise

resend() → {Promise}

Resend wallet transactions.

Source:

client/wallet.js, line 1101

Returns:

Type: Promise

(async) retoken(passphrasenullable) → {Promise}

Generate a new token.

Parameters:

Name	Type	Attributes	Description
`passphrase`	String \| Buffer	<nullable>

Source:

client/wallet.js, line 957

Returns:

Type: Promise

send(options) → {Promise}

Create a transaction, fill, sign, and broadcast.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`address`	String
`value`	Amount

Source:

client/wallet.js, line 848

Returns:

Type: Promise

setPassphrase(passphrase, oldnullable) → {Promise}

Change or set master key`s passphrase.

Parameters:

Name	Type	Attributes	Description
`passphrase`	String \| Buffer
`old`	String \| Buffer	<nullable>

Source:

client/wallet.js, line 947

Returns:

Type: Promise

sign(options) → {Promise}

Sign a transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 858

Returns:

Type: Promise

unlock(passphrase, timeout) → {Promise}

Unlock wallet.

Parameters:

Name	Type	Description
`passphrase`	String
`timeout`	Number

Source:

client/wallet.js, line 1049

Returns:

Type: Promise

unlockCoin(hash, index) → {Promise}

Unlock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 1020

Returns:

Type: Promise

zap(account, age) → {Promise}

Parameters:

Name	Type	Description
`account`	String
`age`	Number	Age delta.

Source:

client/wallet.js, line 814

Returns:

Type: Promise