mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-05-20 23:04:46 -07:00
docs: update generated docs
This commit is contained in:
39
modules/brk-client/docs/interfaces/CpfpCluster.md
Normal file
39
modules/brk-client/docs/interfaces/CpfpCluster.md
Normal file
@@ -0,0 +1,39 @@
|
||||
[**brk-client**](../README.md)
|
||||
|
||||
***
|
||||
|
||||
[brk-client](../globals.md) / CpfpCluster
|
||||
|
||||
# Interface: CpfpCluster
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:379](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L379)
|
||||
|
||||
## Properties
|
||||
|
||||
### chunkIndex
|
||||
|
||||
> **chunkIndex**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:382](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L382)
|
||||
|
||||
Index into `chunks` of the chunk containing the seed tx.
|
||||
|
||||
***
|
||||
|
||||
### chunks
|
||||
|
||||
> **chunks**: [`CpfpClusterChunk`](CpfpClusterChunk.md)[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:381](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L381)
|
||||
|
||||
SFL-emitted chunks ordered by descending feerate.
|
||||
|
||||
***
|
||||
|
||||
### txs
|
||||
|
||||
> **txs**: [`CpfpClusterTx`](CpfpClusterTx.md)[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:380](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L380)
|
||||
|
||||
All txs in the cluster, in topological order (parents before children).
|
||||
Reference in New Issue
Block a user