mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 06:39:58 -07:00
docs: update generated docs
This commit is contained in:
nym21
269
modules/brk-client/docs/interfaces/BlockExtras.md
Normal file
269
modules/brk-client/docs/interfaces/BlockExtras.md
Normal file
@@ -0,0 +1,269 @@
|
||||
[**brk-client**](../README.md)
|
||||
|
||||
***
|
||||
|
||||
[brk-client](../globals.md) / BlockExtras
|
||||
|
||||
# Interface: BlockExtras
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:113](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L113)
|
||||
|
||||
## Properties
|
||||
|
||||
### avgFee
|
||||
|
||||
> **avgFee**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:119](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L119)
|
||||
|
||||
Average fee per transaction in satoshis
|
||||
|
||||
***
|
||||
|
||||
### avgFeeRate
|
||||
|
||||
> **avgFeeRate**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:120](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L120)
|
||||
|
||||
Average fee rate in sat/vB
|
||||
|
||||
***
|
||||
|
||||
### avgTxSize
|
||||
|
||||
> **avgTxSize**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:126](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L126)
|
||||
|
||||
Average transaction size in bytes
|
||||
|
||||
***
|
||||
|
||||
### coinbaseAddress?
|
||||
|
||||
> `optional` **coinbaseAddress?**: `string` \| `null`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:122](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L122)
|
||||
|
||||
Primary coinbase output address
|
||||
|
||||
***
|
||||
|
||||
### coinbaseAddresses
|
||||
|
||||
> **coinbaseAddresses**: `string`[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:123](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L123)
|
||||
|
||||
All coinbase output addresses
|
||||
|
||||
***
|
||||
|
||||
### coinbaseRaw
|
||||
|
||||
> **coinbaseRaw**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:121](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L121)
|
||||
|
||||
Raw coinbase transaction scriptsig as hex
|
||||
|
||||
***
|
||||
|
||||
### coinbaseSignature
|
||||
|
||||
> **coinbaseSignature**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:124](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L124)
|
||||
|
||||
Coinbase output script in ASM format
|
||||
|
||||
***
|
||||
|
||||
### coinbaseSignatureAscii
|
||||
|
||||
> **coinbaseSignatureAscii**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:125](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L125)
|
||||
|
||||
Coinbase scriptsig decoded as ASCII
|
||||
|
||||
***
|
||||
|
||||
### feePercentiles
|
||||
|
||||
> **feePercentiles**: `number`[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:131](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L131)
|
||||
|
||||
Fee amount percentiles in satoshis: [min, 10%, 25%, 50%, 75%, 90%, max]
|
||||
|
||||
***
|
||||
|
||||
### feeRange
|
||||
|
||||
> **feeRange**: `number`[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:116](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L116)
|
||||
|
||||
Fee rate range: [min, 10%, 25%, 50%, 75%, 90%, max]
|
||||
|
||||
***
|
||||
|
||||
### header
|
||||
|
||||
> **header**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:135](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L135)
|
||||
|
||||
Raw 80-byte block header as hex
|
||||
|
||||
***
|
||||
|
||||
### medianFee
|
||||
|
||||
> **medianFee**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:115](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L115)
|
||||
|
||||
Median fee rate in sat/vB
|
||||
|
||||
***
|
||||
|
||||
### medianFeeAmt
|
||||
|
||||
> **medianFeeAmt**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:130](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L130)
|
||||
|
||||
Median fee amount in satoshis
|
||||
|
||||
***
|
||||
|
||||
### pool
|
||||
|
||||
> **pool**: [`BlockPool`](BlockPool.md)
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:118](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L118)
|
||||
|
||||
Mining pool that mined this block
|
||||
|
||||
***
|
||||
|
||||
### reward
|
||||
|
||||
> **reward**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:117](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L117)
|
||||
|
||||
Total block reward (subsidy + fees) in satoshis
|
||||
|
||||
***
|
||||
|
||||
### segwitTotalSize
|
||||
|
||||
> **segwitTotalSize**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:133](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L133)
|
||||
|
||||
Total size of segwit transactions in bytes
|
||||
|
||||
***
|
||||
|
||||
### segwitTotalTxs
|
||||
|
||||
> **segwitTotalTxs**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:132](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L132)
|
||||
|
||||
Number of segwit transactions
|
||||
|
||||
***
|
||||
|
||||
### segwitTotalWeight
|
||||
|
||||
> **segwitTotalWeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:134](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L134)
|
||||
|
||||
Total weight of segwit transactions
|
||||
|
||||
***
|
||||
|
||||
### totalFees
|
||||
|
||||
> **totalFees**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:114](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L114)
|
||||
|
||||
Total fees in satoshis
|
||||
|
||||
***
|
||||
|
||||
### totalInputAmt
|
||||
|
||||
> **totalInputAmt**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:138](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L138)
|
||||
|
||||
Total input amount in satoshis
|
||||
|
||||
***
|
||||
|
||||
### totalInputs
|
||||
|
||||
> **totalInputs**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:127](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L127)
|
||||
|
||||
Total number of inputs (excluding coinbase)
|
||||
|
||||
***
|
||||
|
||||
### totalOutputAmt
|
||||
|
||||
> **totalOutputAmt**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:129](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L129)
|
||||
|
||||
Total output amount in satoshis
|
||||
|
||||
***
|
||||
|
||||
### totalOutputs
|
||||
|
||||
> **totalOutputs**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:128](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L128)
|
||||
|
||||
Total number of outputs
|
||||
|
||||
***
|
||||
|
||||
### utxoSetChange
|
||||
|
||||
> **utxoSetChange**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:136](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L136)
|
||||
|
||||
UTXO set change (outputs created minus inputs spent)
|
||||
|
||||
***
|
||||
|
||||
### utxoSetSize
|
||||
|
||||
> **utxoSetSize**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:137](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L137)
|
||||
|
||||
Total UTXO set size at this height
|
||||
|
||||
***
|
||||
|
||||
### virtualSize
|
||||
|
||||
> **virtualSize**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:139](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L139)
|
||||
|
||||
Virtual size in vbytes
|
||||
Reference in New Issue
Block a user