mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 22:59:58 -07:00
docs: update generated docs
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
# Interface: DifficultyAdjustment
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:195](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L195)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:195](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L195)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:195](https://github.com/b
|
||||
|
||||
> **adjustedTimeAvg**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:204](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L204)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:204](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L204)
|
||||
|
||||
Time-adjusted average (accounting for timestamp manipulation)
|
||||
|
||||
@@ -24,7 +24,7 @@ Time-adjusted average (accounting for timestamp manipulation)
|
||||
|
||||
> **difficultyChange**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:197](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L197)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:197](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L197)
|
||||
|
||||
Estimated difficulty change at next retarget (%)
|
||||
|
||||
@@ -34,7 +34,7 @@ Estimated difficulty change at next retarget (%)
|
||||
|
||||
> **estimatedRetargetDate**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:198](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L198)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:198](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L198)
|
||||
|
||||
Estimated Unix timestamp of next retarget
|
||||
|
||||
@@ -44,7 +44,7 @@ Estimated Unix timestamp of next retarget
|
||||
|
||||
> **nextRetargetHeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:202](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L202)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:202](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L202)
|
||||
|
||||
Height of next retarget
|
||||
|
||||
@@ -54,7 +54,7 @@ Height of next retarget
|
||||
|
||||
> **previousRetarget**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:201](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L201)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:201](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L201)
|
||||
|
||||
Previous difficulty adjustment (%)
|
||||
|
||||
@@ -64,7 +64,7 @@ Previous difficulty adjustment (%)
|
||||
|
||||
> **progressPercent**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:196](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L196)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:196](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L196)
|
||||
|
||||
Progress through current difficulty epoch (0-100%)
|
||||
|
||||
@@ -74,7 +74,7 @@ Progress through current difficulty epoch (0-100%)
|
||||
|
||||
> **remainingBlocks**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:199](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L199)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:199](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L199)
|
||||
|
||||
Blocks remaining until retarget
|
||||
|
||||
@@ -84,7 +84,7 @@ Blocks remaining until retarget
|
||||
|
||||
> **remainingTime**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:200](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L200)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:200](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L200)
|
||||
|
||||
Estimated seconds until retarget
|
||||
|
||||
@@ -94,7 +94,7 @@ Estimated seconds until retarget
|
||||
|
||||
> **timeAvg**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:203](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L203)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:203](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L203)
|
||||
|
||||
Average block time in current epoch (seconds)
|
||||
|
||||
@@ -104,6 +104,6 @@ Average block time in current epoch (seconds)
|
||||
|
||||
> **timeOffset**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:205](https://github.com/bitcoinresearchkit/brk/blob/1e76e137abea038ab55fde16571abe1d31a780c4/modules/brk-client/index.js#L205)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:205](https://github.com/bitcoinresearchkit/brk/blob/79f7e89740d35d2bbc56505cbbcf3e6a4fe4a0f3/modules/brk-client/index.js#L205)
|
||||
|
||||
Time offset from expected schedule (seconds)
|
||||
|
||||
Reference in New Issue
Block a user