JSDoc: Class: HTTPClient

new HTTPClient(uri, optionsnullable)

BCoin HTTP client.

Parameters:

Name	Type	Attributes	Description
`uri`	String
`options`	Object	<nullable>

Source:

bcoin/http/client.js, line 22

Methods

(private) _del(endpoint, json, callback)

Make a DELETE http request to endpoint.

Parameters:

Name	Type	Description
`endpoint`	String	Path.
`json`	Object	Body.
`callback`	function	Returns [Error, Object?].

Source:

bcoin/http/client.js, line 305

(private) _get(endpoint, json, callback)

Make a GET http request to endpoint.

Parameters:

Name	Type	Description
`endpoint`	String	Path.
`json`	Object	Querystring.
`callback`	function	Returns [Error, Object?].

Source:

bcoin/http/client.js, line 269

(private) _post(endpoint, json, callback)

Make a POST http request to endpoint.

Parameters:

Name	Type	Description
`endpoint`	String	Path.
`json`	Object	Body.
`callback`	function	Returns [Error, Object?].

Source:

bcoin/http/client.js, line 281

(private) _put(endpoint, json, callback)

Make a PUT http request to endpoint.

Parameters:

Name	Type	Description
`endpoint`	String	Path.
`json`	Object	Body.
`callback`	function	Returns [Error, Object?].

Source:

bcoin/http/client.js, line 293

(private) _request(method, endpoint, json, callback)

Make an http request to endpoint.

Parameters:

Name	Type	Description
`method`	String
`endpoint`	String	Path.
`json`	Object	Body or query depending on method.
`callback`	function	Returns [Error, Object?].

Source:

bcoin/http/client.js, line 212

addKey(id, keys, callback)

Add a public account/purpose key to the wallet for multisig.

Parameters:

Name	Type	Description
`id`	WalletID
`keys`	Array.<HDPublicKey> \| Array.<Base58String>	Account (bip44) or Purpose (bip45) key (can be in base58 form).
`callback`	function

Source:

bcoin/http/client.js, line 979

all()

Listen for events on all wallets.

Source:

bcoin/http/client.js, line 172

broadcast(tx, callback)

Add a transaction to the mempool and broadcast it.

Parameters:

Name	Type	Description
`tx`	TX
`callback`	function

Source:

bcoin/http/client.js, line 772

close(callback)

Close the client, wait for the socket to close.

Parameters:

Name	Type	Description
`callback`	function

Source:

bcoin/http/client.js, line 190

(private) createWallet(options, callback)

Request the raw wallet JSON (will create wallet if it does not exist).

Parameters:

Name	Type	Description
`options`	Object	See Wallet.
`callback`	function	Returns [Error, Object].

Source:

bcoin/http/client.js, line 316

createWalletAccount(id, options, callback)

Create account.

Parameters:

Name	Type	Description
`id`	WalletID
`options`	Object
`callback`	function	Returns [Error, Array].

Source:

bcoin/http/client.js, line 1067

getBlock(hash, callback)

Retrieve a block from the chain database.

Parameters:

Name	Type	Description
`hash`	Hash
`callback`	function	Returns [Error, Block].

Source:

bcoin/http/client.js, line 745

getCoin(hash, index, callback)

Retrieve a coin from the mempool or chain database. Takes into account spent coins in the mempool.

Parameters:

Name	Type	Description
`hash`	Hash
`index`	Number
`callback`	function	Returns [Error, Coin].

Source:

bcoin/http/client.js, line 664

getCoinsByAddress(addresses, callback)

Get coins that pertain to an address from the mempool or chain database. Takes into account spent coins in the mempool.

Parameters:

Name	Type	Description
`addresses`	Base58Address \| Array.<Base58Address>
`callback`	function	Returns [Error, Coin[]].

Source:

bcoin/http/client.js, line 634

getInfo(callback)

Get some info about the server (network and version).

Parameters:

Name	Type	Description
`callback`	function	Returns [Error, Object].

Source:

bcoin/http/client.js, line 1125

getMempool(callback)

Get a mempool snapshot.

Parameters:

Name	Type	Description
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 1100

getTX(hash, callback)

Retrieve a transaction from the mempool or chain database.

Parameters:

Name	Type	Description
`hash`	Hash
`callback`	function	Returns [Error, TX].

Source:

bcoin/http/client.js, line 719

getTXByAddress(addresses, callback)

Retrieve transactions pertaining to an address from the mempool or chain database.

Parameters:

Name	Type	Description
`addresses`	Base58Address \| Array.<Base58Address>
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 691

(private) getWallet(id, callback)

Get the raw wallet JSON.

Parameters:

Name	Type	Description
`id`	WalletID
`callback`	function	Returns [Error, Object].

Source:

bcoin/http/client.js, line 327

getWalletAccounts(id, callback)

Get wallet accounts.

Parameters:

Name	Type	Description
`id`	WalletID
`callback`	function	Returns [Error, Array].

Source:

bcoin/http/client.js, line 1047

getWalletBalance(id, callback)

Calculate wallet balance.

Parameters:

Name	Type	Description
`id`	WalletID
`callback`	function	Returns [Error, Balance].

Source:

bcoin/http/client.js, line 442

getWalletCoin(id, hash, index, callback)

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

Parameters:

Name	Type	Description
`id`	WalletID
`hash`	Hash
`index`	Number
`callback`	function	Returns [Error, Coin[]].

Source:

bcoin/http/client.js, line 595

getWalletCoins(id, callback)

Get wallet coins.

Parameters:

Name	Type	Description
`id`	WalletID
`callback`	function	Returns [Error, Coin[]].

Source:

bcoin/http/client.js, line 372

getWalletHistory(id, callback)

Get wallet transaction history.

Parameters:

Name	Type	Description
`id`	WalletID
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 337

getWalletLast(id, limit, callback)

Get last N wallet transactions.

Parameters:

Name	Type	Description
`id`	WalletID
`limit`	Number	Max number of transactions.
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 474

getWalletRange(id, options, callback)

Get wallet transactions by timestamp range.

Parameters:

Name Type Description

id WalletID

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.

callback

function

Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 514

getWalletTX(id, hash, callback)

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

Parameters:

Name	Type	Description
`id`	WalletID
`hash`	Hash
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 556

getWalletUnconfirmed(id, callback)

Get all unconfirmed transactions.

Parameters:

Name	Type	Description
`id`	WalletID
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/http/client.js, line 407

join(id)

Listen for events on wallet id.

Parameters:

Name	Type	Description
`id`	WalletID

Source:

bcoin/http/client.js, line 149

leave(id)

Unlisten for events on wallet id.

Parameters:

Name	Type	Description
`id`	WalletID

Source:

bcoin/http/client.js, line 161

none()

Unlisten for events on all wallets.

Source:

bcoin/http/client.js, line 180

open(callback)

Open the client, wait for the socket to load.

Parameters:

Name	Type	Description
`callback`	function

Source:

bcoin/http/client.js, line 137

removeKey(id, keys, callback)

Remove a public account/purpose key to the wallet for multisig.

Parameters:

Name	Type	Description
`id`	WalletID
`keys`	Array.<HDPublicKey> \| Array.<Base58String>	Account (bip44) or Purpose (bip45) key (can be in base58 form).
`callback`	function

Source:

bcoin/http/client.js, line 1014

walletCreate(id, options, callback)

Create a transaction, fill.

Parameters:

Name Type Description

id WalletID

options

Object

Properties

Name	Type	Description
`address`	Base58Address
`value`	Amount

callback

function

Returns [Error, TX].

Source:

bcoin/http/client.js, line 840

walletFill(tx, callback)

Fill a transaction with coins.

Parameters:

Name	Type	Description
`tx`	TX
`callback`	function	Returns [Error, TX].

Source:

bcoin/http/client.js, line 920

walletSend(id, options, callback)

Create a transaction, fill, sign, and broadcast.

Parameters:

Name Type Description

id WalletID

options

Object

Properties

Name	Type	Description
`address`	Base58Address
`value`	Amount

callback

function

Returns [Error, TX].

Source:

bcoin/http/client.js, line 793

walletSign(id, tx, options, callback)

Sign a transaction.

Parameters:

Name	Type	Description
`id`	WalletID
`tx`	TX
`options`	Object
`callback`	function	Returns [Error, TX].

Source:

bcoin/http/client.js, line 886

walletZap(id, now, age, callback)

Parameters:

Name	Type	Description
`id`	WalletID
`now`	Number	Current time.
`age`	Number	Age delta (delete transactions older than `now - age`).
`callback`	function

Source:

bcoin/http/client.js, line 946