JSDoc: Class: Wallet

Constructor

new Wallet(parent, id, tokenopt)

Create a wallet client.

Parameters:

Name	Type	Attributes
`parent`	WalletClient
`id`	String
`token`	String	<optional>

Source:

client/wallet.js, line 880

Extends

EventEmitter

Members

client :WalletClient

Type:

WalletClient

Source:

client/wallet.js, line 895

id :String

Type:

String

Source:

client/wallet.js, line 899

parent :WalletClient

Type:

WalletClient

Source:

client/wallet.js, line 892

token :String

Type:

String

Source:

client/wallet.js, line 902

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 1165

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 1537

Returns:

Type: Promise

(async) close() → {Promise}

Close wallet.

Source:

client/wallet.js, line 920

Returns:

Type: Promise

createAccount(name, options) → {Promise}

Create account.

Parameters:

Name	Type	Description
`name`	String
`options`	Object

Source:

client/wallet.js, line 1362

Returns:

Type: Promise

createAddress(options) → {Promise}

Create address.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1383

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 1192

Returns:

Type: Promise

createBid(options) → {Promise}

Create bid transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1224

Returns:

Type: Promise

createCancel(options) → {Promise}

Create cancel transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1284

Returns:

Type: Promise

createChange(options) → {Promise}

Create change address.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1393

Returns:

Type: Promise

createFinalize(options) → {Promise}

Create finalize transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1294

Returns:

Type: Promise

createOpen(options) → {Promise}

Create open transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1214

Returns:

Type: Promise

createRedeem(options) → {Promise}

Create redeem transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1244

Returns:

Type: Promise

createRenewal(options) → {Promise}

Create renewal transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1264

Returns:

Type: Promise

createReveal(options) → {Promise}

Create reveal transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1234

Returns:

Type: Promise

createRevoke(options) → {Promise}

Create revoke transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1304

Returns:

Type: Promise

createTransfer(options) → {Promise}

Create transfer transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1274

Returns:

Type: Promise

createTX(options) → {Promise}

Create a transaction, fill.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1175

Returns:

Type: Promise

createUpdate(options) → {Promise}

Create update transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1254

Returns:

Type: Promise

getAccount(account) → {Promise}

Get wallet account.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 1351

Returns:

Type: Promise

getAccounts() → {Promise}

Get wallet accounts.

Source:

client/wallet.js, line 1332

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 1053

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 1067

Returns:

Type: Promise

getBalance(account) → {Promise}

Calculate wallet balance.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 970

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 1093

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 1080

Returns:

Type: Promise

getBlock(height) → {Promise}

Get wallet block.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 1001

Returns:

Type: Promise

getBlocks(height) → {Promise}

Get wallet blocks.

Parameters:

Name	Type	Description
`height`	Number

Source:

client/wallet.js, line 991

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 1013

Returns:

Type: Promise

getCoins(account) → {Promise}

Get wallet coins.

Parameters:

Name	Type	Description
`account`	String

Source:

client/wallet.js, line 945

Returns:

Type: Promise

getHistory(options) → {Promise.<Array.<TX>>}

Get wallet transaction history.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Default
`limit`	Number	<optional>
`reverse`	Boolean	<optional>	false
`after`	Hash	<optional>
`time`	Number	<optional>

Source:

client/wallet.js, line 935

Returns:

Type: Promise.<Array.<TX>>

getInfo() → {Promise}

Get the raw wallet JSON.

Source:

client/wallet.js, line 1323

Returns:

Type: Promise

getKey(address) → {Promise}

Get wallet key.

Parameters:

Name	Type	Description
`address`	String

Source:

client/wallet.js, line 1515

Returns:

Type: Promise

getLocked() → {Promise}

Get locked coins.

Source:

client/wallet.js, line 1485

Returns:

Type: Promise

getMaster() → {Promise}

Get wallet master key.

Source:

client/wallet.js, line 1341

Returns:

Type: Promise

getName(name, optionsopt) → {Promise}

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

Parameters:

Name Type Attributes Description

name String

options

Object

Properties

Name	Type	Attributes	Default	Description
`own`	Boolean	<optional>	false

Source:

client/wallet.js, line 1026

Returns:

Type: Promise

getNames(optionsopt) → {Promise}

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

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`own`	Boolean	<optional>	false

Source:

client/wallet.js, line 1039

Returns:

Type: Promise

getPending(options) → {Promise}

Get all unconfirmed transactions.

Parameters:

Name Type Description

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 960

Returns:

Type: Promise

getResource(name) → {Promise}

Get name resource. {@see hsd.Resource}

Parameters:

Name	Type	Description
`name`	String

Source:

client/wallet.js, line 1130

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 1119

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 1106

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 981

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 1526

Returns:

Type: Promise

importAddress(account, address) → {Promise}

Import address.

Parameters:

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

Source:

client/wallet.js, line 1454

Returns:

Type: Promise

importPrivate(account, key) → {Promise}

Import private key.

Parameters:

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

Source:

client/wallet.js, line 1432

Returns:

Type: Promise

importPublic(account, key) → {Promise}

Import public key.

Parameters:

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

Source:

client/wallet.js, line 1443

Returns:

Type: Promise

lock() → {Promise}

Lock wallet.

Source:

client/wallet.js, line 1494

Returns:

Type: Promise

lockCoin(hash, index) → {Promise}

Lock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 1465

Returns:

Type: Promise

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

Modify account.

Parameters:

Name	Type	Description
`name`	String
`options`	Object

Source:

client/wallet.js, line 1373

Returns:

Type: Promise.<Object>

(async) open() → {Promise}

Open wallet.

Source:

client/wallet.js, line 910

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 1548

Returns:

Type: Promise

resend() → {Promise}

Resend wallet transactions.

Source:

client/wallet.js, line 1557

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 1414

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 1204

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 1404

Returns:

Type: Promise

sign(options) → {Promise}

Sign a transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

client/wallet.js, line 1314

Returns:

Type: Promise

unlock(passphrase, timeout) → {Promise}

Unlock wallet.

Parameters:

Name	Type	Description
`passphrase`	String
`timeout`	Number

Source:

client/wallet.js, line 1505

Returns:

Type: Promise

unlockCoin(hash, index) → {Promise}

Unlock a coin.

Parameters:

Name	Type	Description
`hash`	String
`index`	Number

Source:

client/wallet.js, line 1476

Returns:

Type: Promise

zap(now, age) → {Promise}

Parameters:

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

Source:

client/wallet.js, line 1153

Returns:

Type: Promise