mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-06-30 14:08:34 -07:00
nym21
105 lines
3.1 KiB
Markdown
105 lines
3.1 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / CpfpInfo
|
|
|
|
# Interface: CpfpInfo
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:479](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L479)
|
|
|
|
## Properties
|
|
|
|
### adjustedVsize
|
|
|
|
> **adjustedVsize**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:490](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L490)
|
|
|
|
Policy-adjusted virtual size: `max(vsize, sigops * 5)`.
|
|
|
|
***
|
|
|
|
### ancestors
|
|
|
|
> **ancestors**: [`CpfpEntry`](CpfpEntry.md)[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:480](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L480)
|
|
|
|
Ancestor transactions in the CPFP chain.
|
|
|
|
***
|
|
|
|
### bestDescendant?
|
|
|
|
> `optional` **bestDescendant?**: [`CpfpEntry`](CpfpEntry.md) \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:481](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L481)
|
|
|
|
Best (highest fee rate) descendant, if any.
|
|
|
|
***
|
|
|
|
### cluster?
|
|
|
|
> `optional` **cluster?**: [`CpfpCluster`](CpfpCluster.md) \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:491](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L491)
|
|
|
|
Cluster the seed belongs to: full tx list, SFL-linearized chunks,
|
|
and the seed's chunk index. Omitted when the seed has no
|
|
ancestors and no descendants (matches mempool.space).
|
|
|
|
***
|
|
|
|
### descendants
|
|
|
|
> **descendants**: [`CpfpEntry`](CpfpEntry.md)[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:482](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L482)
|
|
|
|
Descendant transactions in the CPFP chain.
|
|
|
|
***
|
|
|
|
### effectiveFeePerVsize
|
|
|
|
> **effectiveFeePerVsize**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:483](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L483)
|
|
|
|
Effective fee rate considering CPFP relationships (sat/vB).
|
|
This is the seed's chunk feerate after lift-merging, i.e. the
|
|
rate Core/mempool.space would surface for this tx.
|
|
|
|
***
|
|
|
|
### fee
|
|
|
|
> **fee**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:488](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L488)
|
|
|
|
Transaction fee (sats).
|
|
|
|
***
|
|
|
|
### sigops
|
|
|
|
> **sigops**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:486](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L486)
|
|
|
|
BIP-141 sigop cost for the seed tx (witness sigops count as 1,
|
|
legacy and P2SH-redeem sigops count as 4).
|
|
|
|
***
|
|
|
|
### vsize
|
|
|
|
> **vsize**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:489](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L489)
|
|
|
|
Virtual size of the seed tx (vbytes).
|