Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-07-05 08:08:15 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-06-01 19:18:42 +02:00
parent d161462137
commit dc2ca0ca27
612 changed files with 4031 additions and 3380 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/brk-client/docs/interfaces/PoolDetail.md
+7 -7
View File
@@ -6,7 +6,7 @@
# Interface: PoolDetail
Defined in: [Developer/brk/modules/brk-client/index.js:875](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L875)
Defined in: [Developer/brk/modules/brk-client/index.js:883](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L883)
## Properties
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:875](https://github.com/b
> **blockCount**: [`PoolBlockCounts`](PoolBlockCounts.md)
Defined in: [Developer/brk/modules/brk-client/index.js:877](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L877)
Defined in: [Developer/brk/modules/brk-client/index.js:885](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L885)
Block counts for different time periods
@@ -24,7 +24,7 @@ Block counts for different time periods
> **blockShare**: [`PoolBlockShares`](PoolBlockShares.md)
Defined in: [Developer/brk/modules/brk-client/index.js:878](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L878)
Defined in: [Developer/brk/modules/brk-client/index.js:886](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L886)
Pool's share of total blocks for different time periods
@@ -34,7 +34,7 @@ Pool's share of total blocks for different time periods
> **estimatedHashrate**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:879](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L879)
Defined in: [Developer/brk/modules/brk-client/index.js:887](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L887)
Estimated hashrate based on blocks mined (H/s)
@@ -44,7 +44,7 @@ Estimated hashrate based on blocks mined (H/s)
> **pool**: [`PoolDetailInfo`](PoolDetailInfo.md)
Defined in: [Developer/brk/modules/brk-client/index.js:876](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L876)
Defined in: [Developer/brk/modules/brk-client/index.js:884](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L884)
Pool information
@@ -54,7 +54,7 @@ Pool information
> `optional` **reportedHashrate?**: `number` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:880](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L880)
Defined in: [Developer/brk/modules/brk-client/index.js:888](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L888)
Self-reported hashrate (if available, H/s)
@@ -64,6 +64,6 @@ Self-reported hashrate (if available, H/s)
> `optional` **totalReward?**: `number` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:881](https://github.com/bitcoinresearchkit/brk/blob/0b871e86004ed9dd0c54dd9336049531d6fe4d23/modules/brk-client/index.js#L881)
Defined in: [Developer/brk/modules/brk-client/index.js:889](https://github.com/bitcoinresearchkit/brk/blob/d161462137a58a76f972f5e15b0029af02a165ca/modules/brk-client/index.js#L889)
Total reward earned by this pool (sats, all time; None for minor pools)