JSDoc: Class: WalletClient

Constructor

new WalletClient(optionsnullable)

Create a wallet client.

Extends:

bcurl.Client

Parameters:

Name	Type	Attributes	Description
`options`	Object	<nullable>

Source:

client/wallet.js, line 22

Extends

bcurl.Client

Methods

abandon(id, hash) → {Promise}

Parameters:

Name	Type	Description
`id`	Number
`hash`	Hash

Source:

client/wallet.js, line 462

Returns:

Type: Promise

addSharedKey(account, key) → {Promise}

Add a public account key to the wallet for multisig.

Parameters:

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

Source:

client/wallet.js, line 850

Returns:

Type: Promise

all()

Join a wallet.

Source:

client/wallet.js, line 134

(async) auth() → {Promise}

Auth with server.

Source:

client/wallet.js, line 106

Returns:

Type: Promise

backup(path) → {Promise}

Backup the walletdb.

Parameters:

Name	Type	Description
`path`	String

Source:

client/wallet.js, line 187

Returns:

Type: Promise

(async) close() → {Promise}

Close the client.

Source:

client/wallet.js, line 96

Returns:

Type: Promise

createAccount(name, options) → {Promise}

Create account.

Parameters:

Name	Type	Description
`name`	String
`options`	Object

Source:

client/wallet.js, line 669

Returns:

Type: Promise

createAddress(options) → {Promise}

Create address.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 694

Returns:

Type: Promise

createAuctionTXs(options) → {Promise}

Create pre-signed bid and reveal txs, fill, and optionally sign and broadcast.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`name`	String
`bid`	Number
`lockup`	Number
`passphrase`	String
`sign`	Boolean
`broadcastBid`	Boolean

Source:

client/wallet.js, line 489

Returns:

Type: Promise

createBid(id, options) → {Promise}

Create bid transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 523

Returns:

Type: Promise

createCancel(id, options) → {Promise}

Create cancel transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 589

Returns:

Type: Promise

createChange(options) → {Promise}

Create change address.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 704

Returns:

Type: Promise

createFinalize(id, options) → {Promise}

Create finalize transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 600

Returns:

Type: Promise

createOpen(id, options) → {Promise}

Create open transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 512

Returns:

Type: Promise

createRedeem(id, options) → {Promise}

Create redeem transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 545

Returns:

Type: Promise

createRenewal(id, options) → {Promise}

Create renewal transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 567

Returns:

Type: Promise

createReveal(id, options) → {Promise}

Create reveal transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 534

Returns:

Type: Promise

createRevoke(id, options) → {Promise}

Create revoke transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 611

Returns:

Type: Promise

createTransfer(id, options) → {Promise}

Create transfer transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 578

Returns:

Type: Promise

createTX(options) → {Promise}

Create a transaction, fill.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 472

Returns:

Type: Promise

createUpdate(id, options) → {Promise}

Create update transaction.

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 556

Returns:

Type: Promise

createWallet(options) → {Promise}

Create a wallet.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 206

Returns:

Type: Promise

(private) dispatch()

Dispatch event.

Source:

client/wallet.js, line 74

execute() → {Promise}

Make an RPC call.

Source:

client/wallet.js, line 115

Returns:

Type: Promise

getAccount(account) → {Promise}

Get wallet account.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 658

Returns:

Type: Promise

getAccounts() → {Promise}

Get wallet accounts.

Source:

client/wallet.js, line 639

Returns:

Returns Array.

Type: Promise

getAuctionByName(id, name) → {Promise}

Get bids, reveals and name state for the given name. {@see hsd.NameState} {@see hsd.BlindBid} {@see hsd.BidReveal}

Parameters:

Name	Type	Description
`id`	String
`name`	String

Source:

client/wallet.js, line 345

Returns:

Type: Promise

getAuctions(id, options) → {Promise}

Get bids, reveals and name state for all names the wallet manages. {@see hsd.NameState} {@see hsd.BlindBid} {@see hsd.BidReveal}

Parameters:

Name	Type	Description
`id`	String
`options`	Object

Source:

client/wallet.js, line 360

Returns:

Type: Promise

getBalance(account) → {Promise}

Calculate wallet balance.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 261

Returns:

Type: Promise

getBids(id, optionsnullable) → {Promise}

Get bids for all names. the wallet manages. {@see hsd.BlindBid}

Parameters:

Name Type Attributes Description

id String

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 388

Returns:

Type: Promise

getBidsByName(id, namenullable, optionsnullable) → {Promise}

Get bids for a given name. {@see hsd.BlindBid}

Parameters:

Name Type Attributes Description

id String

name String <nullable>

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 374

Returns:

Type: Promise

getBlock(height) → {Promise}

Get wallet block.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 292

Returns:

Type: Promise

getBlocks(height) → {Promise}

Get wallet blocks.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 282

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 304

Returns:

Type: Promise

getCoins(account) → {Promise}

Get wallet coins.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 235

Returns:

Type: Promise

getHistory(id, options) → {Promise}

Get wallet transaction history.

Parameters:

Name Type Description

id

String

wallet id

options

Object

Properties

Name	Type	Attributes	Default
`account`	String \| Number	<optional>	-1
`limit`	Number	<optional>
`reverse`	Boolean	<optional>	false
`after`	Hash	<optional>
`time`	Number	<optional>

Source:

client/wallet.js, line 225

Returns:

Type: Promise

getInfo() → {Promise}

Get the raw wallet JSON.

Source:

client/wallet.js, line 630

Returns:

Type: Promise

getKey(address) → {Promise}

Get wallet key.

Parameters:

Name	Type	Description
`address`	String

Source:

client/wallet.js, line 828

Returns:

Type: Promise

getLocked() → {Promise}

Get locked coins.

Source:

client/wallet.js, line 798

Returns:

Type: Promise

getMaster() → {Promise}

Get wallet master key.

Source:

client/wallet.js, line 648

Returns:

Type: Promise

getName(id, name) → {Promise}

Get name state for the given name. {@see hsd.NameState}

Parameters:

Name	Type	Description
`id`	String
`name`	String

Source:

client/wallet.js, line 316

Returns:

Type: Promise

getNames(id, options) → {Promise}

Get name state for all names that the wallet is managing. {@see hsd.NameState}

Parameters:

Name	Type	Attributes	Default
`id`	String
`options`	Object
`optoins.own`	Boolean	<optional>	false

Source:

client/wallet.js, line 330

Returns:

Type: Promise

getPending(id, options) → {Promise}

Get all unconfirmed transactions.

Parameters:

Name Type Description

id

String

wallet id

options

Object

Properties

Name	Type	Attributes	Default
`account`	String \| Number	<optional>	-1
`limit`	Number	<optional>
`reverse`	Boolean	<optional>	false
`after`	Hash	<optional>
`time`	Number	<optional>

Source:

client/wallet.js, line 251

Returns:

Type: Promise

getResource(id, name) → {Promise}

Get name resource. {@see hsd.Resource}

Parameters:

Name	Type	Description
`id`	String
`name`	String

Source:

client/wallet.js, line 428

Returns:

Type: Promise

getReveals(id, optionsnullable) → {Promise}

Get wallet reveals for all names the wallet manages. {@see hsd.BidReveal}

Parameters:

Name Type Attributes Description

id String

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 416

Returns:

Type: Promise

getRevealsByName(id, namenullable, optionsnullable) → {Promise}

Get wallet reveal for a given name. {@see hsd.BidReveal}

Parameters:

Name Type Attributes Description

id String

name String <nullable>

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 402

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 272

Returns:

Type: Promise

getWallets() → {Promise}

Get list of all wallet IDs.

Source:

client/wallet.js, line 196

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 839

Returns:

Type: Promise

importAddress(account, address) → {Promise}

Import address.

Parameters:

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

Source:

client/wallet.js, line 767

Returns:

Type: Promise

importPrivate(account, key) → {Promise}

Import private key.

Parameters:

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

Source:

client/wallet.js, line 738

Returns:

Type: Promise

importPublic(account, key) → {Promise}

Import public key.

Parameters:

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

Source:

client/wallet.js, line 753

Returns:

Type: Promise

(private) init() → {Promise}

Open the client.

Source:

client/wallet.js, line 39

Returns:

Type: Promise

join()

Join a wallet.

Source:

client/wallet.js, line 150

leave()

Leave a wallet.

Source:

client/wallet.js, line 158

lock() → {Promise}

Lock wallet.

Source:

client/wallet.js, line 807

Returns:

Type: Promise

lockCoin(hash, index) → {Promise}

Lock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 778

Returns:

Type: Promise

modifyAccount(id, name, options) → {Promise.<Object>}

Modify account.

Parameters:

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

Source:

client/wallet.js, line 684

Returns:

Type: Promise.<Object>

none()

Leave a wallet.

Source:

client/wallet.js, line 142

(async) open() → {Promise}

Open the client.

Source:

client/wallet.js, line 86

Returns:

Type: Promise

removeSharedKey(account, key) → {Promise}

Remove a public account key to the wallet for multisig.

Parameters:

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

Source:

client/wallet.js, line 861

Returns:

Type: Promise

rescan(height) → {Promise}

Rescan the chain.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 168

Returns:

Type: Promise

resend() → {Promise}

Resend pending transactions.

Source:

client/wallet.js, line 177

Returns:

Type: Promise

resendWallet() → {Promise}

Resend wallet transactions.

Source:

client/wallet.js, line 870

Returns:

Type: Promise

retoken(passphrasenullable) → {Promise}

Generate a new token.

Parameters:

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

Source:

client/wallet.js, line 725

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 501

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 715

Returns:

Type: Promise

sign(options) → {Promise}

Sign a transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 621

Returns:

Type: Promise

unlock(passphrase, timeout) → {Promise}

Unlock wallet.

Parameters:

Name	Type	Description
`passphrase`	String
`timeout`	Number

Source:

client/wallet.js, line 818

Returns:

Type: Promise

unlockCoin(hash, index) → {Promise}

Unlock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 789

Returns:

Type: Promise

wallet(id, tokenopt) → {Wallet}

Create a wallet object.

Parameters:

Name	Type	Attributes	Description
`id`	String
`token`	String	<optional>

Source:

client/wallet.js, line 126

Returns:

Type: Wallet

zap(now, age) → {Promise}

Parameters:

Name	Type	Description
`now`	Number	Current time.
`age`	Number	Age delta.

Source:

client/wallet.js, line 452

Returns:

Type: Promise