Class: WalletClient

wallet.WalletClient

new WalletClient(uri, optionsnullable)

Bcoin HTTP client.

Parameters:
Name Type Attributes Description
uri String
options Object <nullable>
Source:

Methods

addFilter(data) → {Promise}

Add data to filter.

Parameters:
Name Type Description
data Buffer
Source:
Returns:
Type
Promise

estimateFee(blocksnullable) → {Promise}

Esimate smart fee.

Parameters:
Name Type Attributes Description
blocks Number <nullable>
Source:
Returns:
Type
Promise

getEntry(hash) → {Promise}

Get chain entry.

Parameters:
Name Type Description
hash Hash
Source:
Returns:
Type
Promise

getTip() → {Promise}

Get chain tip.

Source:
Returns:
Type
Promise

(private) onConnect() → {Promise}

Wait for websocket connection.

Source:
Returns:
Type
Promise

rescan(start, filter, iter) → {Promise}

Rescan for any missed transactions.

Parameters:
Name Type Description
start Number | Hash

Start block.

filter Bloom
iter function

Iterator.

Source:
Returns:
Type
Promise

resetFilter() → {Promise}

Reset filter.

Source:
Returns:
Type
Promise

send(tx) → {Promise}

Send a transaction. Do not wait for promise.

Parameters:
Name Type Description
tx TX
Source:
Returns:
Type
Promise

(private) sendAuth() → {Promise}

Wait for websocket auth.

Source:
Returns:
Type
Promise

(private) sendOptions() → {Promise}

Wait for websocket options.

Source:
Returns:
Type
Promise

setFilter(filter) → {Promise}

Set bloom filter.

Parameters:
Name Type Description
filter Bloom
Source:
Returns:
Type
Promise

(private) watchChain() → {Promise}

Wait for websocket options.

Source:
Returns:
Type
Promise