JSDoc: Class: Wallet

Constructor

new Wallet(optionsnullable)

Create a wallet client.

Parameters:

Name	Type	Attributes	Description
`options`	Object	<nullable>

Source:

client/wallet.js, line 895

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 1183

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 1555

Returns:

Type: Promise

(async) close() → {Promise}

Close wallet.

Source:

client/wallet.js, line 925

Returns:

Type: Promise

createAccount(name, options) → {Promise}

Create account.

Parameters:

Name	Type	Description
`name`	String
`options`	Object

Source:

client/wallet.js, line 1380

Returns:

Type: Promise

createAddress(options) → {Promise}

Create address.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1401

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 1210

Returns:

Type: Promise

createBid(options) → {Promise}

Create bid transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1242

Returns:

Type: Promise

createCancel(options) → {Promise}

Create cancel transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1302

Returns:

Type: Promise

createChange(options) → {Promise}

Create change address.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1411

Returns:

Type: Promise

createFinalize(options) → {Promise}

Create finalize transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1312

Returns:

Type: Promise

createOpen(options) → {Promise}

Create open transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1232

Returns:

Type: Promise

createRedeem(options) → {Promise}

Create redeem transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1262

Returns:

Type: Promise

createRenewal(options) → {Promise}

Create renewal transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1282

Returns:

Type: Promise

createReveal(options) → {Promise}

Create reveal transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1252

Returns:

Type: Promise

createRevoke(options) → {Promise}

Create revoke transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1322

Returns:

Type: Promise

createTransfer(options) → {Promise}

Create transfer transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1292

Returns:

Type: Promise

createTX(options) → {Promise}

Create a transaction, fill.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1193

Returns:

Type: Promise

createUpdate(options) → {Promise}

Create update transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1272

Returns:

Type: Promise

getAccount(account) → {Promise}

Get wallet account.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 1369

Returns:

Type: Promise

getAccounts() → {Promise}

Get wallet accounts.

Source:

client/wallet.js, line 1350

Returns:

Returns Array.

Type: Promise

getAuctionByName(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
`name`	String

Source:

client/wallet.js, line 1071

Returns:

Type: Promise

getAuctions(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
`options`	Object

Source:

client/wallet.js, line 1085

Returns:

Type: Promise

getBalance(account) → {Promise}

Calculate wallet balance.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 966

Returns:

Type: Promise

getBids(optionsnullable) → {Promise}

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

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 1111

Returns:

Type: Promise

getBidsByName(namenullable, optionsnullable) → {Promise}

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

Parameters:

Name Type Attributes Description

name String <nullable>

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 1098

Returns:

Type: Promise

getBlock(height) → {Promise}

Get wallet block.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 1023

Returns:

Type: Promise

getBlocks(height) → {Promise}

Get wallet blocks.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 1013

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 1035

Returns:

Type: Promise

getCoins(account) → {Promise}

Get wallet coins.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 946

Returns:

Type: Promise

getHistory(account) → {Promise}

Get wallet transaction history.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 936

Returns:

Type: Promise

getInfo() → {Promise}

Get the raw wallet JSON.

Source:

client/wallet.js, line 1341

Returns:

Type: Promise

getKey(address) → {Promise}

Get wallet key.

Parameters:

Name	Type	Description
`address`	String

Source:

client/wallet.js, line 1533

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 977

Returns:

Type: Promise

getLocked() → {Promise}

Get locked coins.

Source:

client/wallet.js, line 1503

Returns:

Type: Promise

getMaster() → {Promise}

Get wallet master key.

Source:

client/wallet.js, line 1359

Returns:

Type: Promise

getName(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String

Source:

client/wallet.js, line 1046

Returns:

Type: Promise

getNames() → {Promise}

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

Source:

client/wallet.js, line 1057

Returns:

Type: Promise

getPending(account) → {Promise}

Get all unconfirmed transactions.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 956

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 992

Returns:

Type: Promise

getResource(name) → {Promise}

Get name resource. {@see hsd.Resource}

Parameters:

Name	Type	Description
`name`	String

Source:

client/wallet.js, line 1148

Returns:

Type: Promise

getReveals(optionsnullable) → {Promise}

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

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 1137

Returns:

Type: Promise

getRevealsByName(namenullable, optionsnullable) → {Promise}

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

Parameters:

Name Type Attributes Description

name String <nullable>

options

Object

Properties

Name	Type	Attributes	Description
`own`	Boolean	<nullable>

Source:

client/wallet.js, line 1124

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 1003

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 1544

Returns:

Type: Promise

importAddress(account, address) → {Promise}

Import address.

Parameters:

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

Source:

client/wallet.js, line 1472

Returns:

Type: Promise

importPrivate(account, key) → {Promise}

Import private key.

Parameters:

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

Source:

client/wallet.js, line 1450

Returns:

Type: Promise

importPublic(account, key) → {Promise}

Import public key.

Parameters:

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

Source:

client/wallet.js, line 1461

Returns:

Type: Promise

lock() → {Promise}

Lock wallet.

Source:

client/wallet.js, line 1512

Returns:

Type: Promise

lockCoin(hash, index) → {Promise}

Lock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 1483

Returns:

Type: Promise

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

Modify account.

Parameters:

Name	Type	Description
`name`	String
`options`	Object

Source:

client/wallet.js, line 1391

Returns:

Type: Promise.<Object>

(async) open() → {Promise}

Open wallet.

Source:

client/wallet.js, line 915

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 1566

Returns:

Type: Promise

resend() → {Promise}

Resend wallet transactions.

Source:

client/wallet.js, line 1575

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 1432

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 1222

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 1422

Returns:

Type: Promise

sign(options) → {Promise}

Sign a transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1332

Returns:

Type: Promise

unlock(passphrase, timeout) → {Promise}

Unlock wallet.

Parameters:

Name	Type	Description
`passphrase`	String
`timeout`	Number

Source:

client/wallet.js, line 1523

Returns:

Type: Promise

unlockCoin(hash, index) → {Promise}

Unlock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 1494

Returns:

Type: Promise

zap(now, age) → {Promise}

Parameters:

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

Source:

client/wallet.js, line 1171

Returns:

Type: Promise