JSDoc: Class: MTX

Constructor

new MTX(options)

Create a mutable transaction.

Extends:

Parameters:

Name	Type	Description
`options`	Object

Properties:

Name	Type	Description
`changeIndex`	Number
`view`	CoinView

Source:

primitives/mtx.js, line 45

Extends

Methods

(static) fromJSON(json) → {MTX}

Instantiate a transaction from a jsonified transaction object.

Parameters:

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

Source:

primitives/mtx.js, line 1499

Returns:

Type: MTX

(static) fromOptions(options) → {MTX}

Instantiate MTX from options.

Parameters:

Name	Type	Description
`options`	Object

Source:

primitives/mtx.js, line 106

Returns:

Type: MTX

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

Instantiate a transaction from a serialized Buffer.

Parameters:

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

Source:

primitives/mtx.js, line 1520

Returns:

Type: MTX

(static) fromReader(br) → {MTX}

Instantiate a transaction from a buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

primitives/mtx.js, line 1509

Returns:

Type: MTX

(static) fromTX(tx) → {MTX}

Instantiate MTX from TX.

Parameters:

Name	Type	Description
`tx`	TX

Source:

primitives/mtx.js, line 1550

Returns:

Type: MTX

(static) isMTX(obj) → {Boolean}

Test whether an object is an MTX.

Parameters:

Name	Type	Description
`obj`	Object

Source:

primitives/mtx.js, line 1560

Returns:

Type: Boolean

addCoin(coin) → {Input}

Add a coin as an input. Note that this will add the coin to the internal coin viewpoint.

Parameters:

Name	Type	Description
`coin`	Coin

Source:

primitives/mtx.js, line 166

Returns:

Type: Input

Example

mtx.addCoin(Coin.fromTX(tx, 0, -1));

addInput(options) → {Input}

Add an input to the transaction.

Parameters:

Name	Type	Description
`options`	Input \| Object

Source:

primitives/mtx.js, line 133

Returns:

Type: Input

Example

mtx.addInput({ prevout: { hash: ... }, script: ... });
mtx.addInput(new Input());

addOutpoint(outpoint) → {Input}

Add an outpoint as an input.

Parameters:

Name	Type	Description
`outpoint`	Outpoint \| Object

Source:

primitives/mtx.js, line 149

Returns:

Type: Input

Example

mtx.addOutpoint({ hash: ..., index: 0 });
mtx.addOutpoint(new Outpoint(hash, index));

addOutput(script, valuenullable) → {Output}

Add an output.

Parameters:

Name	Type	Attributes	Description
`script`	Address \| Script \| Output \| Object		Script or output options.
`value`	Amount	<nullable>

Source:

primitives/mtx.js, line 218

Returns:

Type: Output

Example

mtx.addOutput(new Output());
mtx.addOutput({ address: ..., value: 100000 });
mtx.addOutput(address, 100000);
mtx.addOutput(script, 100000);

addTX(tx, index, heightnullable) → {Input}

Add a transaction as an input. Note that this will add the coin to the internal coin viewpoint.

Parameters:

Name	Type	Attributes
`tx`	TX
`index`	Number
`height`	Number	<nullable>

Source:

primitives/mtx.js, line 190

Returns:

Type: Input

Example

mtx.addTX(tx, 0);

avoidFeeSniping(height)

Avoid fee sniping.

Parameters:

Name	Type	Description
`height`	Number	Current chain height.

Source:

primitives/mtx.js, line 1373

See:

bitcoin/src/wallet/wallet.cpp

check(flagsopt) → {Boolean}

Verify all transaction inputs.

Parameters:

Name	Type	Attributes	Default	Description
`flags`	VerifyFlags	<optional>	STANDARD_VERIFY_FLAGS

Source:

primitives/mtx.js, line 238

Throws:

on invalid inputs
Type ScriptError

Returns:

Whether the inputs are valid.

Type: Boolean

checkAsync(flagsopt, nullable, poolnullable) → {Promise}

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

Parameters:

Name	Type	Attributes	Default	Description
`flags`	VerifyFlags	<optional> <nullable>	STANDARD_VERIFY_FLAGS
`pool`	WorkerPool	<nullable>

Source:

primitives/mtx.js, line 250

Returns:

Type: Promise

checkInputs(height) → {Array}

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	Description
`height`	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.

Source:

primitives/mtx.js, line 413

Returns:

[fee, reason, score]

Type: Array

clone() → {MTX}

Clone the transaction. Note that this will not carry over the view.

Source:

primitives/mtx.js, line 116

Returns:

Type: MTX

commit() → {Array}

Convert the MTX to a TX.

Source:

primitives/mtx.js, line 1540

Returns:

[tx, view]

Type: Array

(async) estimateSize(estimatenullable) → {Number}

Estimate maximum possible size.

Parameters:

Name	Type	Attributes	Description
`estimate`	function	<nullable>	Input script size estimator.

Source:

primitives/mtx.js, line 1097

Returns:

Type: Number

format() → {Object}

Inspect the transaction.

Source:

primitives/mtx.js, line 1443

Returns:

Type: Object

fromJSON(json)

Inject properties from a json object

Parameters:

Name	Type	Description
`json`	Object

Source:

primitives/mtx.js, line 1471

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

primitives/mtx.js, line 62

(async) fund(coins, options) → {CoinSelector}

Select coins and fill the inputs.

Parameters:

Name	Type	Description
`coins`	Array.<Coin>
`options`	Object	See MTX#selectCoins options.

Source:

primitives/mtx.js, line 1306

Returns:

Type: CoinSelector

getAddresses() → {Array.<Address>}

Get all addresses.

Source:

primitives/mtx.js, line 322

Returns:

addresses

Type: Array.<Address>

getFee() → {Amount}

Calculate the fee for the transaction.

Source:

primitives/mtx.js, line 295

Returns:

fee (zero if not all coins are available).

Type: Amount

getHashes() → {Array.<Hash>}

Get all address hashes.

Source:

primitives/mtx.js, line 340

Returns:

hashes

Type: Array.<Hash>

getInputAddresses() → {Array.<Address>}

Get all input addresses.

Source:

primitives/mtx.js, line 313

Returns:

addresses

Type: Array.<Address>

getInputHashes() → {Array.<Hash>}

Get all input address hashes.

Source:

primitives/mtx.js, line 331

Returns:

hashes

Type: Array.<Hash>

getInputValue() → {Amount}

Calculate the total input value.

Source:

primitives/mtx.js, line 304

Returns:

value

Type: Amount

getJSON(network) → {Object}

Convert transaction to JSON.

Parameters:

Name	Type	Description
`network`	Network

Source:

primitives/mtx.js, line 1462

Returns:

Type: Object

getSigops(flagsnullable) → {Number}

Calculate virtual sigop count.

Parameters:

Name	Type	Attributes	Description
`flags`	VerifyFlags	<nullable>

Source:

primitives/mtx.js, line 360

Returns:

sigop count

Type: Number

getSigopsCost(flagsnullable) → {Number}

Calculate sigops weight, taking into account witness programs.

Parameters:

Name	Type	Attributes	Description
`flags`	VerifyFlags	<nullable>

Source:

primitives/mtx.js, line 370

Returns:

sigop weight

Type: Number

getSigopsSize() → {Number}

Calculate the virtual size of the transaction (weighted against bytes per sigop cost).

Source:

primitives/mtx.js, line 380

Returns:

vsize

Type: Number

hasCoins() → {Boolean}

Test whether the transaction has all coins available/filled.

Source:

primitives/mtx.js, line 350

Returns:

Type: Boolean

inspectSymbol() → {Object}

Inspect the transaction.

Source:

primitives/mtx.js, line 1434

Returns:

Type: Object

isInputSigned(index, coin) → {Boolean}

Test whether an input is fully-signed.

Parameters:

Name	Type	Description
`index`	Number
`coin`	Coin \| Output

Source:

primitives/mtx.js, line 898

Returns:

Type: Boolean

isSigned() → {Boolean}

Test whether the transaction is fully-signed.

Source:

primitives/mtx.js, line 876

Returns:

Type: Boolean

isVectorSigned(prev, vector) → {Boolean}

Test whether a vector is fully-signed.

Parameters:

Name	Type	Description
`prev`	Script
`vector`	Stack

Source:

primitives/mtx.js, line 949

Returns:

Type: Boolean

scriptInput(index, coin, ring) → {Boolean}

Build input script (or witness) templates (with OP_0 in place of signatures).

Parameters:

Name	Type	Description
`index`	Number	Input index.
`coin`	Coin \| Output
`ring`	KeyRing

Source:

primitives/mtx.js, line 426

Returns:

Whether the script was able to be built.

Type: Boolean

scriptVector(prev, ring) → {Stack}

Build script for a single vector based on a previous script.

Parameters:

Name	Type	Description
`prev`	Script
`ring`	Buffer

Source:

primitives/mtx.js, line 568

Returns:

Type: Stack

selectCoins(coins, optionsnullable) → {CoinSelection}

Select necessary coins based on total output value.

Parameters:

Name	Type	Attributes	Description
`coins`	Array.<Coin>
`options`	Object	<nullable>

Source:

primitives/mtx.js, line 1223

Throws:

on not enough funds available.

Returns:

Type: CoinSelection

setLocktime(locktime)

Set locktime and sequences appropriately.

Parameters:

Name	Type	Description
`locktime`	Number

Source:

primitives/mtx.js, line 1391

setSequence(index, locktime, secondsnullable)

Set sequence locktime.

Parameters:

Name	Type	Attributes	Description
`index`	Number		Input index.
`locktime`	Number
`seconds`	Boolean	<nullable>

Source:

primitives/mtx.js, line 1410

sign(ring, type) → {Number}

Build input scripts (or witnesses) and sign the inputs.

Parameters:

Name	Type	Description
`ring`	KeyRing	Address used to sign. The address must be able to redeem the coin.
`type`	SighashType

Source:

primitives/mtx.js, line 1039

Returns:

Number of inputs signed.

Type: Number

(async) signAsync(ring, typenullable, poolnullable) → {Promise}

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

Parameters:

Name	Type	Attributes
`ring`	KeyRing
`type`	SighashType	<nullable>
`pool`	WorkerPool	<nullable>

Source:

primitives/mtx.js, line 1084

Returns:

Type: Promise

signInput(index, coin, ring, type) → {Boolean}

Sign an input.

Parameters:

Name	Type	Description
`index`	Number	Index of input being signed.
`coin`	Coin \| Output
`ring`	KeyRing	Private key.
`type`	SighashType

Source:

primitives/mtx.js, line 646

Returns:

Whether the input was able to be signed.

Type: Boolean

(async) signInputAsync(index, coin, ring, typenullable, poolnullable) → {Promise}

Sign a transaction input on the worker pool (if workers are enabled).

Parameters:

Name	Type	Attributes
`index`	Number
`coin`	Coin \| Output
`ring`	KeyRing
`type`	SighashType	<nullable>
`pool`	WorkerPool	<nullable>

Source:

primitives/mtx.js, line 630

Returns:

Type: Promise

signVector(prev, vector, sig, ring) → {Boolean}

Add a signature to a vector based on a previous script.

Parameters:

Name	Type	Description
`prev`	Script
`vector`	Stack
`sig`	Buffer
`ring`	KeyRing

Source:

primitives/mtx.js, line 731

Returns:

Type: Boolean

sortMembers()

Sort inputs and outputs according to BIP69.

Source:

primitives/mtx.js, line 1350

See:

https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki

subtractFee(fee)

Attempt to subtract a fee from all outputs evenly.

Parameters:

Name	Type	Description
`fee`	Amount

Source:

primitives/mtx.js, line 1254

subtractIndex(index, fee)

Attempt to subtract a fee from a single output.

Parameters:

Name	Type	Description
`index`	Number
`fee`	Amount

Source:

primitives/mtx.js, line 1234

template(ring) → {Number}

Build input scripts (or witnesses).

Parameters:

Name	Type	Description
`ring`	KeyRing	Address used to sign. The address must be able to redeem the coin.

Source:

primitives/mtx.js, line 1001

Returns:

Number of inputs templated.

Type: Number

toJSON() → {Object}

Convert transaction to JSON.

Source:

primitives/mtx.js, line 1452

Returns:

Type: Object

toTX() → {TX}

Convert the MTX to a TX.

Source:

primitives/mtx.js, line 1531

Returns:

Type: TX

verify(flagsopt) → {Boolean}

Verify all transaction inputs.

Parameters:

Name	Type	Attributes	Default	Description
`flags`	VerifyFlags	<optional>	STANDARD_VERIFY_FLAGS

Source:

primitives/mtx.js, line 260

Returns:

Whether the inputs are valid.

Type: Boolean

(async) verifyAsync(flagsopt, nullable, poolnullable) → {Promise}

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

Parameters:

Name	Type	Attributes	Default	Description
`flags`	VerifyFlags	<optional> <nullable>	STANDARD_VERIFY_FLAGS
`pool`	WorkerPool	<nullable>

Source:

primitives/mtx.js, line 279

Returns:

Type: Promise

verifyInputs(height) → {Boolean}

Parameters:

Name	Type	Description
`height`	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.

Source:

primitives/mtx.js, line 396

Returns:

Type: Boolean