Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-24 14:49:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-04-03 00:15:43 +02:00
parent 6cd45c1f1f
commit 3a8a9ddecc
552 changed files with 3325 additions and 3051 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
modules/brk-client/docs/interfaces/DifficultyAdjustment.md
View File

@@ -6,7 +6,7 @@
# Interface: DifficultyAdjustment
Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L386)
Defined in: [Developer/brk/modules/brk-client/index.js:392](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L392)
## Properties
@@ -14,9 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/b
> **adjustedTimeAvg**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L395)
Defined in: [Developer/brk/modules/brk-client/index.js:402](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L402)
Time-adjusted average (accounting for timestamp manipulation)
Time-adjusted average (milliseconds)
***
@@ -24,7 +24,7 @@ Time-adjusted average (accounting for timestamp manipulation)
> **difficultyChange**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:388](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L388)
Defined in: [Developer/brk/modules/brk-client/index.js:394](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L394)
Estimated difficulty change at next retarget (%)
@@ -34,9 +34,19 @@ Estimated difficulty change at next retarget (%)
> **estimatedRetargetDate**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:389](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L389)
Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L395)
Estimated Unix timestamp of next retarget
Estimated timestamp of next retarget (milliseconds)
***
### expectedBlocks
> **expectedBlocks**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:404](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L404)
Expected blocks based on wall clock time since epoch start
***
@@ -44,7 +54,7 @@ Estimated Unix timestamp of next retarget
> **nextRetargetHeight**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:393](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L393)
Defined in: [Developer/brk/modules/brk-client/index.js:400](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L400)
Height of next retarget
@@ -54,17 +64,27 @@ Height of next retarget
> **previousRetarget**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:392](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L392)
Defined in: [Developer/brk/modules/brk-client/index.js:398](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L398)
Previous difficulty adjustment (%)
***
### previousTime
> **previousTime**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:399](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L399)
Timestamp of most recent retarget (seconds)
***
### progressPercent
> **progressPercent**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:387](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L387)
Defined in: [Developer/brk/modules/brk-client/index.js:393](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L393)
Progress through current difficulty epoch (0-100%)
@@ -74,7 +94,7 @@ Progress through current difficulty epoch (0-100%)
> **remainingBlocks**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:390](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L390)
Defined in: [Developer/brk/modules/brk-client/index.js:396](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L396)
Blocks remaining until retarget
@@ -84,9 +104,9 @@ Blocks remaining until retarget
> **remainingTime**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:391](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L391)
Defined in: [Developer/brk/modules/brk-client/index.js:397](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L397)
Estimated seconds until retarget
Estimated time until retarget (milliseconds)
***
@@ -94,9 +114,9 @@ Estimated seconds until retarget
> **timeAvg**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:394](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L394)
Defined in: [Developer/brk/modules/brk-client/index.js:401](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L401)
Average block time in current epoch (seconds)
Average block time in current epoch (milliseconds)
***
@@ -104,6 +124,6 @@ Average block time in current epoch (seconds)
> **timeOffset**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:396](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L396)
Defined in: [Developer/brk/modules/brk-client/index.js:403](https://github.com/bitcoinresearchkit/brk/blob/6cd45c1f1f755807c6e6ab6ba61b54aff4b07f3b/modules/brk-client/index.js#L403)
Time offset from expected schedule (seconds)