JSDoc: Class: TXDB

new TXDB(prefix, db, optionsnullable)

TXDB

Parameters:

Name Type Attributes Description

prefix

String

The prefix for the database (txdb/ by default).

db LowlevelUp

options

Object

Properties

Name	Type	Attributes	Description
`mapAddress`	Boolean	<nullable>	Map addresses to IDs.
`indexAddress`	Boolean	<nullable>	Index addresses/IDs.
`indexExtra`	Boolean	<nullable>	Index timestamps, heights, etc.
`verify`	Boolean	<nullable>	Verify transactions as they come in (note that this will not happen on the worker pool).

Properties:

Name	Type	Description
`prefix`	String

Source:

bcoin/txdb.js, line 35

Methods

(private) _addOrphan(key, hash, index, callback)

Add an orphan (tx hash + input index) to orphan list. Stored by its required coin ID.

Parameters:

Name	Type	Description
`key`	String	Required coin hash + index.
`hash`	Hash	Orphan transaction hash.
`index`	Number	Orphan input index.
`callback`	function	Returns [Error, Buffer].

Source:

bcoin/txdb.js, line 215

(private) _confirm(tx, map, callback)

Attempt to confirm a transaction.

Parameters:

Name	Type	Description
`tx`	TX
`map`	AddressMap
`callback`	function	Returns [Error, Boolean]. `false` if the transaction should be added to the database, `true` if the transaction was confirmed, or should be ignored.

Source:

bcoin/txdb.js, line 690

(private) _getOrphans(key, callback)

Retrieve orphan list by coin ID.

Parameters:

Name	Type	Description
`key`	String
`callback`	function	Returns [Error, Orphan].

Source:

bcoin/txdb.js, line 248

(private) _remove(tx, map, callback)

Remove a transaction from the database. Disconnect inputs.

Parameters:

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

Source:

bcoin/txdb.js, line 861

(private) _removeSpenders(hash, ref, callback)

Remove spenders that have not been confirmed. We do this in the odd case of stuck transactions or when a coin is double-spent by a newer transaction. All previously-spending transactions of that coin that are not confirmed will be removed from the database.

Parameters:

Name	Type	Description
`hash`	Hash
`ref`	TX	Reference tx, the tx that double-spent.
`callback`	function	Returns [Error, Boolean].

Source:

bcoin/txdb.js, line 597

_unconfirm(hash, map, callback)

Unconfirm a transaction. This is usually necessary after a reorg.

Parameters:

Name	Type	Description
`hash`	Hash
`map`	AddressMap
`callback`	function

Source:

bcoin/txdb.js, line 1009

add(tx, callback)

Add a transaction to the database, map addresses to wallet IDs, potentially store orphans, resolve orphans, or confirm a transaction.

Parameters:

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

Source:

bcoin/txdb.js, line 300

fillCoins(tx, callback)

Fill a transaction with coins.

Parameters:

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

Source:

bcoin/txdb.js, line 1717

fillHistory(tx, callback)

Fill a transaction with coins (all historical coins).

Parameters:

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

Source:

bcoin/txdb.js, line 1672

getBalance(address, callback)

Calculate balance.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Balance].

Source:

bcoin/txdb.js, line 1849

getBalanceByAddress(address, callback)

Calculate balance.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Balance].

Source:

bcoin/txdb.js, line 1924

getCoin(hash, index, callback)

Get coin.

Parameters:

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

Source:

bcoin/txdb.js, line 1805

getCoinHashes(address, callback)

Get all coin hashes in the database.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1236

getCoins(address, callback)

Get coins.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Coin[]].

Source:

bcoin/txdb.js, line 1632

getCoinsByAddress(address, callback)

Get coins.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Coin[]].

Source:

bcoin/txdb.js, line 1904

getHeightHashes(height, callback)

Get TX hashes by height.

Parameters:

Name	Type	Description
`height`	Number
`callback`	function	Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1378

getHeightRangeHashes(address, options, callback)

Get TX hashes by height range.

Parameters:

Name Type Description

address

WalletID | Array.<WalletID>

By address (can be null).

options

Object

Properties

Name	Type	Attributes	Description
`start`	Number		Start height.
`end`	Number		End height.
`limit`	Number	<nullable>	Max number of records.
`reverse`	Boolean	<nullable>	Reverse order.

callback

function

Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1319

getHistory(address, callback)

Get all transactions.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/txdb.js, line 1519

getHistoryByAddress(address, callback)

Get all transactions.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/txdb.js, line 1894

getHistoryHashes(address, callback)

Get hashes of all transactions in the database.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1087

getHistoryHashesByAddress(address, callback)

Get hashes of all transactions in the database.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1884

getLast(address, limit, callback)

Get last N transactions.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`limit`	Number	Max number of transactions.
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/txdb.js, line 1498

getLastTime(address, callback)

Get last active timestamp and height.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Number(ts), Number(height)].

Source:

bcoin/txdb.js, line 1559

getMap(tx, callback)

Map a transactions' addresses to wallet IDs.

Parameters:

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

Source:

bcoin/txdb.js, line 88

getRange(address, options, callback)

Get transactions by timestamp range.

Parameters:

Name Type Description

address

WalletID | Array.<WalletID>

By address (can be null).

options

Object

Properties

Name	Type	Attributes	Description
`start`	Number		Start height.
`end`	Number		End height.
`limit`	Number	<nullable>	Max number of records.
`reverse`	Boolean	<nullable>	Reverse order.

callback

function

Returns [Error, TX[]].

Source:

bcoin/txdb.js, line 1457

getRangeHashes(address, options, callback)

Get TX hashes by timestamp range.

Parameters:

Name Type Description

address

WalletID | Array.<WalletID>

By address (can be null).

options

Object

Properties

Name	Type	Attributes	Description
`start`	Number		Start height.
`end`	Number		End height.
`limit`	Number	<nullable>	Max number of records.
`reverse`	Boolean	<nullable>	Reverse order.

callback

function

Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1393

getTX(hash, callback)

Get transaction.

Parameters:

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

Source:

bcoin/txdb.js, line 1762

getUnconfirmed(address, callback)

Get unconfirmed transactions.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/txdb.js, line 1592

getUnconfirmedByAddress(address, callback)

Get unconfirmed transactions.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, TX[]].

Source:

bcoin/txdb.js, line 1914

getUnconfirmedHashes(address, callback)

Get hashes of all unconfirmed transactions in the database.

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`callback`	function	Returns [Error, Hash[]].

Source:

bcoin/txdb.js, line 1161

hasCoin(hash, callback)

Test whether the database has a transaction.

Parameters:

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

Source:

bcoin/txdb.js, line 1834

hasTX(hash, callback)

Test whether the database has a transaction.

Parameters:

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

Source:

bcoin/txdb.js, line 1789

isDoubleSpend(tx, callback)

Test an entire transaction to see if any of its outpoints are a double-spend.

Parameters:

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

Source:

bcoin/txdb.js, line 639

isSpent(hash, index, callback)

Test a whether a coin has been spent.

Parameters:

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

Source:

bcoin/txdb.js, line 664

lazyRemove(tx, callback)

Remove a transaction from the database, but do not look up the transaction. Use the passed-in transaction to disconnect.

Parameters:

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

Source:

bcoin/txdb.js, line 831

mapAddresses(address, callback)

Map an address to a wallet ID.

Parameters:

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

Source:

bcoin/txdb.js, line 143

remove(hash, callback)

Remove a transaction from the database. Disconnect inputs.

Parameters:

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

Source:

bcoin/txdb.js, line 788

unconfirm(hash, callback)

Unconfirm a transaction. This is usually necessary after a reorg.

Parameters:

Name	Type	Description
`hash`	Hash
`callback`	function

Source:

bcoin/txdb.js, line 965

zap(address, now, age, callback)

Parameters:

Name	Type	Description
`address`	WalletID \| Array.<WalletID>	By address (can be null).
`now`	Number	Current time.
`age`	Number	Age delta (delete transactions older than `now - age`).
`callback`	function

Source:

bcoin/txdb.js, line 1935