JSDoc: Class: TX

new TX(data)

A static transaction object.

Parameters:

Name	Type	Description
`data`	NakedTX	Transaction fields.

Properties:

Name	Type	Description
`type`	String	"tx" (inv type).
`version`	Number	Transaction version. Note that BCoin reads versions as unsigned even though they are signed at the protocol level. This value will never be negative.
`flag`	Number	Flag field for segregated witness. Always non-zero (1 if not present).
`inputs`	Array.<Input>
`outputs`	Array.<Output>
`locktime`	Number	nLockTime
`ts`	Number	Timestamp of the block the transaction was included in (unix time).
`block`	Hash \| null	Hash of the block the transaction was included in.
`index`	Number	Transaction's index in the block tx vector.
`ps`	Number	"Pending Since": The time at which the transaction was first seen. Only non-zero on unconfirmed transactions.
`changeIndex`	Number	Index of the change output (-1 if unknown).
`height`	Number	Height of the block the transaction was included in (-1 if unconfirmed).
`rblock`	ReversedHash \| null	Reversed block hash (uint256le).
`rhash`	ReversedHash	Reversed transaction hash (uint256le).
`rwhash`	ReversedHash	Reversed witness transaction hash (uint256le).
`txid`	String	Transaction ID.
`wtxid`	String	Witness transaction ID (Same as txid if no witness is present. All zeroes if coinbase).

Source:

bcoin/tx.js, line 49

Methods

(static) fromExtended(data, saveCoinsnullable, encnullable) → {TX}

Instantiate a transaction from a Buffer in "extended" serialization format.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`saveCoins`	Boolean	<nullable>	If true, the function will attempt to parse the coins.
`enc`	String	<nullable>	One of `"hex"` or `null`.

Source:

bcoin/tx.js, line 1961

Returns:

Type: TX

(static) fromJSON(json) → {TX}

Instantiate a transaction from a jsonified transaction object.

Parameters:

Name	Type	Description
`json`	Object	The jsonified transaction object.

Source:

bcoin/tx.js, line 1852

Returns:

Type: TX

(static) fromRaw(data, encnullable) → {TX}

Instantiate a transaction from a serialized Buffer.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`enc`	String	<nullable>	Encoding, can be `'hex'` or null.

Source:

bcoin/tx.js, line 1894

Returns:

Type: TX

(static) getMinFee(sizenullable, ratenullable) → {Amount}

Calculate minimum fee based on rate and size.

Parameters:

Name	Type	Attributes	Description
`size`	Number	<nullable>
`rate`	Rate	<nullable>	Rate of satoshi per kB.

Source:

bcoin/tx.js, line 1726

Returns:

fee

Type: Amount

(static) getRate(size, fee) → {Rate}

Calculate a fee rate based on size and fees.

Parameters:

Name	Type	Description
`size`	Number
`fee`	Amount

Source:

bcoin/tx.js, line 1747

Returns:

Type: Rate

(static) isTX(obj) → {Boolean}

Test whether an object is a TX.

Parameters:

Name	Type	Description
`obj`	Object

Source:

bcoin/tx.js, line 1980

Returns:

Type: Boolean

(static) parseExtended(data, saveCoinsnullable, encnullable) → {NakedTX}

Parse a transaction in "extended" serialization format.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`saveCoins`	Boolean	<nullable>	If true, the function will attempt to parse the coins.
`enc`	String	<nullable>	One of `"hex"` or `null`.

Source:

bcoin/tx.js, line 1936

Returns:

A "naked" transaction object.

Type: NakedTX

(static) parseJSON(json) → {NakedTX}

Handle a deserialized JSON transaction object.

Parameters:

Name	Type	Description
`json`	Object

Source:

bcoin/tx.js, line 1824

Returns:

A "naked" transaction (a plain javascript object which is suitable for passing to the TX constructor).

Type: NakedTX

(static) parseRaw(data, encnullable) → {NakedTX}

Parse a serialized transaction.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`enc`	String	<nullable>	Encoding, can be `'hex'` or null.

Source:

bcoin/tx.js, line 1880

Returns:

A "naked" transaction object.

Type: NakedTX

checkInputs(spendHeight, retnullable) → {Boolean}

Perform contextual checks to verify input, output, and fee values, as well as coinbase spend maturity (coinbases can only be spent 100 blocks or more after they're created). Note that this function is consensus critical.

Parameters:

Name	Type	Attributes	Description
`spendHeight`	Number		Height at which the transaction is being spent. In the mempool this is the chain height plus one at the time it entered the pool.
`ret`	Object	<nullable>	Return object, may be set with properties `reason` and `score`.

Source:

bcoin/tx.js, line 1333

Returns:

Type: Boolean

clone() → {TX}

Clone the transaction.

Source:

bcoin/tx.js, line 99

Returns:

Type: TX

fillCoins(coins) → {Boolean}

Attempt to connect coins to prevouts.

Parameters:

Name	Type	Description
`coins`	Coin \| TX \| Array.<Coin> \| Array.<TX>

Source:

bcoin/tx.js, line 924

Returns:

Whether the transaction is now completely filled.

Type: Boolean

getAddresses() → {Array.<Base58Address>}

Get all addresses.

Source:

bcoin/tx.js, line 793

Returns:

addresses

Type: Array.<Base58Address>

getBaseSize() → {Number}

Calculate the size of the transaction without the witness. with the witness included.

Source:

bcoin/tx.js, line 347

Returns:

size

Type: Number

getConfirmations(heightnullable) → {Number}

Calculate current number of transaction confirmations.

Parameters:

Name	Type	Attributes	Description
`height`	Number	<nullable>	Current chain height. If not present, network chain height will be used.

Source:

bcoin/tx.js, line 1567

Returns:

confirmations

Type: Number

getCost() → {Number}

Calculate the cost of the transaction. Note that this is cached.

Source:

bcoin/tx.js, line 324

Returns:

cost

Type: Number

getFee() → {Amount}

Calculate the fee for the transaction.

Source:

bcoin/tx.js, line 684

Returns:

fee (zero if not all coins are available).

Type: Amount

getHashes() → {Array.<Hash>}

Get all address hashes.

Source:

bcoin/tx.js, line 832

Returns:

hashes

Type: Array.<Hash>

getInputAddresses() → {Array.<Base58Address>}

Get all input addresses.

Source:

bcoin/tx.js, line 741

Returns:

addresses

Type: Array.<Base58Address>

getInputHashes() → {Array.<Hash>}

Get all input address hashes.

Source:

bcoin/tx.js, line 814

Returns:

hashes

Type: Array.<Hash>

getInputValue() → {Amount}

Calculate the total input value.

Source:

bcoin/tx.js, line 696

Returns:

value

Type: Amount

getLegacySigops() → {Number}

Calculate legacy (inaccurate) sigop count.

Source:

bcoin/tx.js, line 1005

Returns:

sigop count

Type: Number

getMinFee(sizenullable, ratenullable) → {Amount}

Calculate minimum fee in order for the transaction to be relayable (not the constant min relay fee).

Parameters:

Name	Type	Attributes	Description
`size`	Number	<nullable>	If not present, max size estimation will be calculated and used.
`rate`	Rate	<nullable>	Rate of satoshi per kB.

Source:

bcoin/tx.js, line 1512

Returns:

fee

Type: Amount

getModifiedSize(sizenullable) → {Number}

Calculate the modified size of the transaction. This is used in the mempool for calculating priority.

Parameters:

Name	Type	Attributes	Description
`size`	Number	<nullable>	The size to modify. If not present, virtual size will be used.

Source:

bcoin/tx.js, line 1411

Returns:

Modified size.

Type: Number

getOutputAddresses() → {Array.<Base58Address>}

Get all output addresses.

Source:

bcoin/tx.js, line 767

Returns:

addresses

Type: Array.<Base58Address>

getOutputHashes() → {Array.<Hash>}

Get all output address hashes.

Source:

bcoin/tx.js, line 823

Returns:

hashes

Type: Array.<Hash>

getOutputValue() → {Amount}

Calculate the total output value.

Source:

bcoin/tx.js, line 720

Returns:

value

Type: Amount

getPrevout() → {Array.<Hash>}

Get all unique outpoint hashes.

Source:

bcoin/tx.js, line 1585

Returns:

Outpoint hashes.

Type: Array.<Hash>

getPriority(heightnullable, sizenullable) → {Object}

Calculate the transaction priority.

Parameters:

Name	Type	Attributes	Description
`height`	Number	<nullable>	If not present, tx height or mempool height will be used.
`size`	Number	<nullable>	Size to calculate priority based on. If not present, modified size will be calculated and used.

Source:

bcoin/tx.js, line 1437

Returns:

data - Object containing priority and value.

Type: Object

getRate(sizenullable) → {Rate}

Calculate the transaction's rate based on size and fees. Size will be calculated if not present.

Parameters:

Name	Type	Attributes	Description
`size`	Number	<nullable>

Source:

bcoin/tx.js, line 1526

Returns:

Type: Rate

getRaw() → {Buffer}

Serialize the transaction. Note that this is cached. This will use the witness serialization if a witness is present.

Source:

bcoin/tx.js, line 267

Returns:

Serialized transaction.

Type: Buffer

getRoundFee(sizenullable, ratenullable) → {Amount}

Calculate the minimum fee in order for the transaction to be relayable, but _round to the nearest kilobyte when taking into account size.

Parameters:

Name	Type	Attributes	Description
`size`	Number	<nullable>	If not present, max size estimation will be calculated and used.
`rate`	Rate	<nullable>	Rate of satoshi per kB.

Source:

bcoin/tx.js, line 1543

Returns:

fee

Type: Amount

getScripthashSigops() → {Number}

Calculate accurate sigop count, taking into account redeem scripts.

Source:

bcoin/tx.js, line 1023

Returns:

sigop count

Type: Number

getSigops(flagsnullable) → {Number}

Calculate virtual sigop count.

Parameters:

Name	Type	Attributes	Description
`flags`	VerifyFlags	<nullable>

Source:

bcoin/tx.js, line 1084

Returns:

sigop count

Type: Number

getSigopsCost(flagsnullable) → {Number}

Calculate sigops cost, taking into account witness programs.

Parameters:

Name	Type	Attributes	Description
`flags`	VerifyFlags	<nullable>

Source:

bcoin/tx.js, line 1049

Returns:

sigop cost

Type: Number

getSize() → {Number}

Calculate the real size of the transaction with the witness included.

Source:

bcoin/tx.js, line 336

Returns:

size

Type: Number

getSizes() → {Object}

Calculate real size and size of the witness bytes.

Source:

bcoin/tx.js, line 295

Returns:

Contains size and witnessSize.

Type: Object

getVirtualSize() → {Number}

Calculate the virtual size of the transaction. Note that this is cached.

Source:

bcoin/tx.js, line 313

Returns:

vsize

Type: Number

hasCoins() → {Boolean}

Test whether the transaction has all coins available/filled.

Source:

bcoin/tx.js, line 904

Returns:

Type: Boolean

hash(encnullable) → {Hash|Buffer}

Hash the transaction with the non-witness serialization.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	Can be `'hex'` or `null`.

Source:

bcoin/tx.js, line 177

Returns:

hash

Type: Hash | Buffer

hasStandardInputs(flagsnullable) → {Boolean}

Perform contextual checks to verify coin and input script standardness (including the redeem script).

Parameters:

Name	Type	Attributes	Description
`flags`	VerifyFlags	<nullable>

Source:

bcoin/tx.js, line 1273

See:

AreInputsStandard()

Returns:

Type: Boolean

hasWitness() → {Boolean}

Test whether the transaction has a non-empty witness.

Source:

bcoin/tx.js, line 357

Returns:

Type: Boolean

inspect() → {Object}

Inspect the transaction and return a more user-friendly representation of the data.

Source:

bcoin/tx.js, line 1757

Returns:

Type: Object

isCoinbase() → {Boolean}

Test whether the transaction is a coinbase by examining the inputs.

Source:

bcoin/tx.js, line 674

Returns:

Type: Boolean

isFinal(height, ts) → {Boolean}

Check finality of transaction by examining nLockTime and nSequences.

Parameters:

Name	Type	Description
`height`	Number	Height at which to test. This is usually the chain height, or the chain height + 1 when the transaction entered the mempool.
`ts`	Number	Time at which to test. This is usually the chain tip's parent's median time, or the time at which the transaction entered the mempool. If MEDIAN_TIME_PAST is enabled this will be the median time of the chain tip's previous entry's median time.

Source:

bcoin/tx.js, line 982

Returns:

Type: Boolean

Example

tx.isFinal(network.height + 1, utils.now());

isFree(heightnullable, sizenullable) → {Boolean}

Determine whether the transaction is above the free threshold in priority. A transaction which passed this test is most likely relayable without a fee.

Parameters:

Name	Type	Attributes	Description
`height`	Number	<nullable>	If not present, tx height or mempool height will be used.
`size`	Number	<nullable>	If not present, modified size will be calculated and used.

Source:

bcoin/tx.js, line 1489

Returns:

Type: Boolean

isSane(retnullable) → {Boolean}

Non-contextual sanity checks for the transaction. Will mostly verify coin and output values.

Parameters:

Name	Type	Attributes	Description
`ret`	Object	<nullable>	Return object, may be set with properties `reason` and `score`.

Source:

bcoin/tx.js, line 1102

See:

CheckTransaction()

Returns:

sane

Type: Boolean

isStandard(retnullable) → {Boolean}

Non-contextual checks to determine whether the transaction has all standard output script types and standard input script size with only pushdatas in the code. Will mostly verify coin and output values.

Parameters:

Name	Type	Attributes	Description
`ret`	Object	<nullable>	Return object, may be set with properties `reason` and `score`.

Source:

bcoin/tx.js, line 1197

See:

IsStandardTx()

Returns:

Type: Boolean

isWatched(filter) → {Boolean}

Test a transaction against a bloom filter using the BIP37 matching algorithm. Note that this may update the filter depending on what the update value is.

Parameters:

Name	Type	Description
`filter`	Bloom

Source:

bcoin/tx.js, line 1611

See:

"Filter matching algorithm":
https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki

Returns:

True if the transaction matched.

Type: Boolean

maxSize() → {Number}

Estimate the max possible size of transaction once the inputs are scripted. If the transaction is non-mutable, this will just return the virtual size.

Source:

bcoin/tx.js, line 1399

Returns:

size

Type: Number

render() → {Buffer}

Serialize the transaction. Note that this is cached. This will use the witness serialization if a witness is present.

Source:

bcoin/tx.js, line 227

Returns:

Serialized transaction.

Type: Buffer

renderNormal() → {Buffer}

Serialize the transaction without the witness vector, regardless of whether it is a witness transaction or not.

Source:

bcoin/tx.js, line 238

Returns:

Serialized transaction.

Type: Buffer

renderWitness() → {Buffer}

Serialize the transaction with the witness vector, regardless of whether it is a witness transaction or not.

Source:

bcoin/tx.js, line 252

Returns:

Serialized transaction.

Type: Buffer

setBlock(block, index)

Set the block the transaction was included in.

Parameters:

Name	Type	Description
`block`	Block \| MerkleBlock
`index`	Number

Source:

bcoin/tx.js, line 151

signatureHash(index, prev, type, version) → {Buffer}

Get the signature hash of the transaction for signing verifying.

Parameters:

Name	Type	Description
`index`	Number	Index of input being signed/verified.
`prev`	Script	Previous output script or redeem script (in the case of witnesspubkeyhash, this should be the generated p2pkh script).
`type`	SighashType	Sighash type.
`version`	Number	Sighash version (0=legacy, 1=segwit).

Source:

bcoin/tx.js, line 382

Returns:

Signature hash.

Type: Buffer

testInputs(addressMap, indexnullable) → {Boolean}

Test the inputs against an address, an array of address hashes, or a map of address hashes.

Parameters:

Name	Type	Attributes	Description
`addressMap`	Hash \| Array.<Hash> \| AddressHashMap
`index`	Number	<nullable>

Source:

bcoin/tx.js, line 844

Returns:

Whether the transaction matched.

Type: Boolean

testOutputs(addressMap, indexnullable) → {Boolean}

Test the outputs against an address, an array of address hashes, or a map of address hashes.

Parameters:

Name	Type	Attributes	Description
`addressMap`	Hash \| Array.<Hash> \| AddressHashMap
`index`	Number	<nullable>

Source:

bcoin/tx.js, line 875

Returns:

Whether the transaction matched.

Type: Boolean

toCoins() → {Coins}

Convert transaction outputs to a {Coins} object.

Source:

bcoin/tx.js, line 1970

Returns:

Type: Coins

toExtended(saveCoinsnullable, encnullable) → {Buffer}

Serialize a transaction to BCoin "extended format". This is the serialization format BCoin uses internally to store transactions in the database. The extended serialization includes the height, block hash, index, timestamp, pending-since time, and optionally a vector for the serialized coins.

Parameters:

Name	Type	Attributes	Description
`saveCoins`	Boolean	<nullable>	Whether to serialize the coins.
`enc`	String	<nullable>	One of `"hex"` or `null`.

Source:

bcoin/tx.js, line 1910

Returns:

Type: Buffer

toInv() → {InvItem}

Convert the tx to an inv item.

Source:

bcoin/tx.js, line 1712

Returns:

Type: InvItem

toJSON() → {Object}

Convert the transaction to an object suitable for JSON serialization. Note that the hashes will be reversed to abide by bitcoind's legacy of little-endian uint256s.

Source:

bcoin/tx.js, line 1793

Returns:

Type: Object

toRaw(encnullable) → {Buffer|String}

Serialize the transaction.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	Encoding, can be `'hex'` or null.

Source:

bcoin/tx.js, line 1864

See:

{TX#render}

Returns:

Type: Buffer | String

unsetBlock()

Remove all relevant block data from the transaction.

Source:

bcoin/tx.js, line 163

verify(indexnullable, forcenullable, flagsnullable) → {Boolean}

Verify the transaction inputs.

Parameters:

Name	Type	Attributes	Description
`index`	Number	<nullable>	Index of output being verified. If not present, all outputs will be verified.
`force`	Boolean	<nullable>	Force the transaction to be verified, even if it has been confirmed.
`flags`	VerifyFlags	<nullable>

Source:

bcoin/tx.js, line 579

Returns:

Whether the inputs are valid.

Type: Boolean

verifyAsync(indexnullable, forcenullable, flagsnullable, callback) → {Boolean}

Verify the transaction inputs on the worker pool (if workers are enabled).

Parameters:

Name	Type	Attributes	Description
`index`	Number	<nullable>	Index of output being verified. If not present, all outputs will be verified.
`force`	Boolean	<nullable>	Force the transaction to be verified, even if it has been confirmed.
`flags`	VerifyFlags	<nullable>
`callback`	function

Source:

bcoin/tx.js, line 642

Returns:

Whether the inputs are valid.

Type: Boolean

witnessHash(encnullable) → {Hash|Buffer}

Hash the transaction with the witness serialization, return the wtxid (normal hash if no witness is present, all zeroes if coinbase).

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	Can be `'hex'` or `null`.

Source:

bcoin/tx.js, line 198

Returns:

hash

Type: Hash | Buffer