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

oracle: doc fixes

Browse Source
This commit is contained in:
nym21
2026-05-23 12:18:34 +02:00
parent 9c74881c5d
commit 0aaffc6c43
4 changed files with 137 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/brk_server/src/api/openapi/mod.rs
+14
View File
@@ -177,6 +177,20 @@ All errors return structured JSON with a consistent format:
),
..Default::default()
},
Tag {
name: "Oracle".to_string(),
description: Some(
"On-chain BTC/USD price derived purely from round-dollar payment patterns in \
transaction outputs, with no external price feed. Payment activity is binned on a \
log scale, and a smoothed EMA over recent blocks locates the price.\n\n\
Histograms come in two flavors, each available at the live tip (mempool-blended) \
or at any confirmed height: `raw` (per-block counts) and `ema` (the smoothed \
window). The live price is also at `/api/mempool/price`. Confirmed per-height \
price history is at `/api/vecs/height-to-price`."
.to_string(),
),
..Default::default()
},
Tag {
name: "URPD".to_string(),
description: Some(
crates/brk_server/src/api/oracle.rs
+9 -15
View File
@@ -31,10 +31,9 @@ impl OracleRoutes for ApiRouter<AppState> {
.oracle_tag()
.summary("Live BTC/USD price")
.description(
"Current BTC/USD price in dollars, derived purely from on-chain \
round-dollar output patterns over the last 12 blocks plus the \
forming mempool block. Same value as `/api/mempool/price`. \
Confirmed per-height history is available at `/api/vecs/height-to-price`.",
"Current BTC/USD price in dollars. Same value as \
`/api/mempool/price`. Confirmed per-height history is available at \
`/api/vecs/height-to-price`.",
)
.json_response::<Dollars>()
.not_modified()
@@ -58,9 +57,8 @@ impl OracleRoutes for ApiRouter<AppState> {
.summary("Live EMA histogram")
.description(
"Smoothed round-dollar payment histogram at the live tip: the \
committed 12-block EMA with the forming mempool block blended in \
as a final slot. A flat array of 2400 log-scale bins, quantized \
to `u16` for the wire. This is the heatmap column you render.",
committed EMA with the forming mempool block blended in. \
A flat array of log-scale bins.",
)
.json_response::<HistogramEmaCompact>()
.not_modified()
@@ -88,11 +86,8 @@ impl OracleRoutes for ApiRouter<AppState> {
.oracle_tag()
.summary("EMA histogram at height")
.description(
"Smoothed round-dollar payment histogram for a confirmed height, \
deterministically reconstructed by replaying the 12-block window \
ending at that height. Immutable once buried, so repeated requests \
return byte-identical results. A flat array of 2400 log-scale bins, \
quantized to `u16`.",
"Smoothed round-dollar payment histogram for a confirmed height. \
A flat array of log-scale bins.",
)
.json_response::<HistogramEmaCompact>()
.not_modified()
@@ -118,8 +113,7 @@ impl OracleRoutes for ApiRouter<AppState> {
.summary("Live raw histogram")
.description(
"Un-smoothed per-block round-dollar counts for the forming mempool \
block: the spiky primitive the EMA smooths over. A flat array of \
2400 log-scale bins (`u32` counts), all zero when no mempool is \
block. A flat array of log-scale bins, all zero when no mempool is \
configured.",
)
.json_response::<HistogramRaw>()
@@ -149,7 +143,7 @@ impl OracleRoutes for ApiRouter<AppState> {
.summary("Raw histogram at height")
.description(
"Un-smoothed round-dollar counts for a single confirmed block. A \
flat array of 2400 log-scale bins (`u32` counts).",
flat array of log-scale bins.",
)
.json_response::<HistogramRaw>()
.not_modified()