Class: MempoolEntry

mempool.MempoolEntry

new MempoolEntry(options)

Represents a mempool entry.

Parameters:
Name Type Description
options Object
Properties
Name Type Description
tx TX

Transaction in mempool.

height Number

Entry height.

priority Number

Entry priority.

ts Number

Entry time.

value Amount

Value of on-chain coins.

Properties:
Name Type Description
tx TX
height Number
priority Number
ts Number
value Amount
Source:

Methods

(static) fromOptions(options) → {MempoolEntry}

Instantiate mempool entry from options.

Parameters:
Name Type Description
options Object
Source:
Returns:
Type
MempoolEntry

(static) fromTX(tx, height) → {MempoolEntry}

Create a mempool entry from a TX.

Parameters:
Name Type Description
tx TX
height Number

Entry height.

Source:
Returns:
Type
MempoolEntry

(private) fromOptions(options)

Inject properties from options object.

Parameters:
Name Type Description
options Object
Source:

(private) fromTX(tx, height)

Inject properties from transaction.

Parameters:
Name Type Description
tx TX
height Number
Source:

getFee() → {Amount}

Get fee.

Source:
Returns:
Type
Amount

getPriority(height) → {Number}

Calculate priority, taking into account the entry height delta, modified size, and chain value.

Parameters:
Name Type Description
height Number
Source:
Returns:

Priority.

Type
Number

getRate() → {Rate}

Calculate fee rate.

Source:
Returns:
Type
Rate

isFree(height) → {Boolean}

Test whether the entry is free with the current priority (calculated by current height).

Parameters:
Name Type Description
height Number
Source:
Returns:
Type
Boolean