JSDoc: Class: WalletClient

Constructor

new WalletClient(optionsnullable)

Create a wallet client.

Parameters:

Name	Type	Attributes	Description
`options`	Object	<nullable>

Source:

client/wallet.js, line 24

Extends

bcurl.Client

Methods

abandon(id, hash) → {Promise}

Parameters:

Name	Type	Description
`id`	Number
`hash`	Hash

Source:

client/wallet.js, line 353

Returns:

Type: Promise

addSharedKey(id, account, key) → {Promise}

Add a public account key to the wallet for multisig.

Parameters:

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

Source:

client/wallet.js, line 632

Returns:

Type: Promise

all(token)

Join a wallet.

Parameters:

Name	Type	Description
`token`	String

Source:

client/wallet.js, line 132

(async) auth() → {Promise}

Auth with server.

Source:

client/wallet.js, line 104

Returns:

Type: Promise

backup(path) → {Promise}

Backup the walletdb.

Parameters:

Name	Type	Description
`path`	String

Source:

client/wallet.js, line 188

Returns:

Type: Promise

(async) close() → {Promise}

Close the client.

Source:

client/wallet.js, line 94

Returns:

Type: Promise

createAccount(id, name, options) → {Promise}

Create account.

Parameters:

Name	Type	Description
`id`	Number
`name`	String
`options`	Object

Source:

client/wallet.js, line 441

Returns:

Type: Promise

createAddress(id, options) → {Promise}

Create address.

Parameters:

Name	Type	Description
`id`	Number
`options`	Object

Source:

client/wallet.js, line 452

Returns:

Type: Promise

createChange(id, options) → {Promise}

Create change address.

Parameters:

Name	Type	Description
`id`	Number
`options`	Object

Source:

client/wallet.js, line 463

Returns:

Type: Promise

createNested(id, account) → {Promise}

Create nested address.

Parameters:

Name	Type	Description
`id`	Number
`account`	String

Source:

client/wallet.js, line 474

Returns:

Type: Promise

createTX(id, options) → {Promise}

Create a transaction, fill.

Parameters:

Name	Type	Description
`id`	Number
`options`	Object

Source:

client/wallet.js, line 364

Returns:

Type: Promise

createWallet(id, options) → {Promise}

Create a wallet.

Parameters:

Name	Type	Description
`id`	Number
`options`	Object

Source:

client/wallet.js, line 208

Returns:

Type: Promise

(private) dispatch(id, event)

Dispatch event.

Parameters:

Name	Type	Description
`id`	Number
`event`	String

Source:

client/wallet.js, line 72

execute() → {Promise}

Make an RPC call.

Source:

client/wallet.js, line 113

Returns:

Type: Promise

getAccount(id, account) → {Promise}

Get wallet account.

Parameters:

Name	Type	Description
`id`	Number
`account`	String

Source:

client/wallet.js, line 429

Returns:

Type: Promise

getAccounts(id) → {Promise}

Get wallet accounts.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 408

Returns:

Returns Array.

Type: Promise

getBalance(id, account) → {Promise}

Calculate wallet balance.

Parameters:

Name	Type	Description
`id`	Number
`account`	String

Source:

client/wallet.js, line 252

Returns:

Type: Promise

getBlock(id, height) → {Promise}

Get wallet block.

Parameters:

Name	Type	Description
`id`	Number
`height`	Number

Source:

client/wallet.js, line 319

Returns:

Type: Promise

getBlocks(id) → {Promise}

Get wallet blocks.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 308

Returns:

Type: Promise

getCoin(id, hash, index) → {Promise}

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

Parameters:

Name	Type	Description
`id`	Number
`hash`	Hash
`index`	Number

Source:

client/wallet.js, line 332

Returns:

Type: Promise

getCoins(id, account) → {Promise}

Get wallet coins.

Parameters:

Name	Type	Description
`id`	Number
`account`	String

Source:

client/wallet.js, line 230

Returns:

Type: Promise

getHistory(id, account) → {Promise}

Get wallet transaction history.

Parameters:

Name	Type	Description
`id`	Number
`account`	String

Source:

client/wallet.js, line 219

Returns:

Type: Promise

getInfo(id) → {Promise}

Get the raw wallet JSON.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 398

Returns:

Type: Promise

getKey(id, address) → {Promise}

Get wallet key.

Parameters:

Name	Type	Description
`id`	Number
`address`	String

Source:

client/wallet.js, line 608

Returns:

Type: Promise

getLast(id, account, limit) → {Promise}

Get last N wallet transactions.

Parameters:

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

Source:

client/wallet.js, line 264

Returns:

Type: Promise

getLocked(id) → {Promise}

Get locked coins.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 575

Returns:

Type: Promise

getMaster(id) → {Promise}

Get wallet master key.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 418

Returns:

Type: Promise

getPending(id, account) → {Promise}

Get all unconfirmed transactions.

Parameters:

Name	Type	Description
`id`	Number
`account`	String

Source:

client/wallet.js, line 241

Returns:

Type: Promise

getRange(id, account, options) → {Promise}

Get wallet transactions by timestamp range.

Parameters:

Name Type Description

id Number

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 280

Returns:

Type: Promise

getTX(id, hash) → {Promise}

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

Parameters:

Name	Type	Description
`id`	Number
`hash`	Hash

Source:

client/wallet.js, line 298

Returns:

Type: Promise

getWallets() → {Promise}

Get list of all wallet IDs.

Source:

client/wallet.js, line 197

Returns:

Type: Promise

getWIF(id, address, passphrasenullable) → {Promise}

Get wallet key WIF dump.

Parameters:

Name	Type	Attributes
`id`	Number
`address`	String
`passphrase`	String	<nullable>

Source:

client/wallet.js, line 620

Returns:

Type: Promise

importAddress(id, account, address) → {Promise}

Import address.

Parameters:

Name	Type	Description
`id`	Number
`account`	String
`address`	String

Source:

client/wallet.js, line 542

Returns:

Type: Promise

importPrivate(id, account, key) → {Promise}

Import private key.

Parameters:

Name	Type	Description
`id`	Number
`account`	String
`key`	String

Source:

client/wallet.js, line 511

Returns:

Type: Promise

importPublic(id, account, publicKey) → {Promise}

Import public key.

Parameters:

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

Source:

client/wallet.js, line 527

Returns:

Type: Promise

(private) init() → {Promise}

Open the client.

Source:

client/wallet.js, line 35

Returns:

Type: Promise

join(id, token)

Join a wallet.

Parameters:

Name	Type	Description
`id`	Number
`token`	String

Source:

client/wallet.js, line 150

leave(id)

Leave a wallet.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 159

lock(id) → {Promise}

Lock wallet.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 585

Returns:

Type: Promise

lockCoin(hash, index) → {Promise}

Lock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 553

Returns:

Type: Promise

none()

Leave a wallet.

Source:

client/wallet.js, line 140

(async) open() → {Promise}

Open the client.

Source:

client/wallet.js, line 84

Returns:

Type: Promise

removeSharedKey(id, account, accountKey) → {Promise}

Remove a public account key to the wallet for multisig.

Parameters:

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

Source:

client/wallet.js, line 644

Returns:

Type: Promise

rescan(height) → {Promise}

Rescan the chain.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 169

Returns:

Type: Promise

resend() → {Promise}

Resend pending transactions.

Source:

client/wallet.js, line 178

Returns:

Type: Promise

resendWallet(id) → {Promise}

Resend wallet transactions.

Parameters:

Name	Type	Description
`id`	Number

Source:

client/wallet.js, line 654

Returns:

Type: Promise

retoken(id, passphrasenullable) → {Promise}

Generate a new token.

Parameters:

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

Source:

client/wallet.js, line 497

Returns:

Type: Promise

send(id, options) → {Promise}

Create a transaction, fill, sign, and broadcast.

Parameters:

Name Type Description

id Number

options

Object

Properties

Name	Type	Description
`address`	String
`value`	Amount

Source:

client/wallet.js, line 377

Returns:

Type: Promise

setPassphrase(id, passphrase, oldnullable) → {Promise}

Change or set master key`s passphrase.

Parameters:

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

Source:

client/wallet.js, line 486

Returns:

Type: Promise

sign(id, options) → {Promise}

Sign a transaction.

Parameters:

Name	Type	Description
`id`	Number
`options`	Object

Source:

client/wallet.js, line 388

Returns:

Type: Promise

unlock(id, passphrase, timeout) → {Promise}

Unlock wallet.

Parameters:

Name	Type	Description
`id`	Number
`passphrase`	String
`timeout`	Number

Source:

client/wallet.js, line 597

Returns:

Type: Promise

unlockCoin(id, hash, index) → {Promise}

Unlock a coin.

Parameters:

Name	Type	Description
`id`	Number
`hash`	String
`index`	Number

Source:

client/wallet.js, line 565

Returns:

Type: Promise

wallet(id, token)

Create a wallet object.

Parameters:

Name	Type	Description
`id`	Number
`token`	String

Source:

client/wallet.js, line 123

zap(id, account, age) → {Promise}

Parameters:

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

Source:

client/wallet.js, line 343

Returns:

Type: Promise