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

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-05-08 00:35:52 +02:00
parent 6e8be1af22
commit 1643cf86ed
606 changed files with 5386 additions and 4545 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
modules/brk-client/docs/interfaces/UrpdBucket.md
View File

@@ -6,7 +6,7 @@
# Interface: UrpdBucket
Defined in: [Developer/brk/modules/brk-client/index.js:1213](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1213)
Defined in: [Developer/brk/modules/brk-client/index.js:1300](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1300)
## Properties
@@ -14,9 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1213](https://github.com/
> **priceFloor**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:1214](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1214)
Defined in: [Developer/brk/modules/brk-client/index.js:1301](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1301)
Inclusive lower bound of the bucket, in USD.
Lower bound of the bucket, in USD. Equals the exact realized price for `Raw`.
***
@@ -24,9 +24,9 @@ Inclusive lower bound of the bucket, in USD.
> **realizedCap**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:1216](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1216)
Defined in: [Developer/brk/modules/brk-client/index.js:1303](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1303)
Realized cap contribution in USD: `price_floor * supply`.
Realized cap contribution in USD: sum of `realized_price * supply` over the coins in this bucket.
***
@@ -34,7 +34,7 @@ Realized cap contribution in USD: `price_floor * supply`.
> **supply**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:1215](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1215)
Defined in: [Developer/brk/modules/brk-client/index.js:1302](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1302)
Supply held with a last-move price inside this bucket, in BTC.
@@ -44,6 +44,6 @@ Supply held with a last-move price inside this bucket, in BTC.
> **unrealizedPnl**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:1217](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1217)
Defined in: [Developer/brk/modules/brk-client/index.js:1304](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1304)
Unrealized P&L in USD against the close on the snapshot date: `(close - price_floor) * supply`. Can be negative.
Unrealized P&L in USD against the close on the snapshot date: `close * supply - realized_cap`. Can be negative.