brk/crates/brk_server/src/api/oracle.rs

use aide::axum::{ApiRouter, routing::get_with};
use axum::{
    extract::{Path, State},
    http::{HeaderMap, Uri},
};
use brk_oracle::{HistogramEmaCompact, HistogramRaw};
use brk_types::{Dollars, Version};

use crate::{
    AppState,
    extended::TransformResponseExtended,
    params::{Empty, HeightParam},
};

pub trait OracleRoutes {
    fn add_oracle_routes(self) -> Self;
}

impl OracleRoutes for ApiRouter<AppState> {
    fn add_oracle_routes(self) -> Self {
        self.api_route(
            "/api/oracle/price",
            get_with(
                async |uri: Uri, headers: HeaderMap, _: Empty, State(state): State<AppState>| {
                    state
                        .respond_json(&headers, state.mempool_strategy(), &uri, |q| q.live_price())
                        .await
                },
                |op| {
                    op.id("get_oracle_price")
                        .oracle_tag()
                        .summary("Live BTC/USD price")
                        .description(
                            "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()
                        .server_error()
                },
            ),
        )
        .api_route(
            "/api/oracle/histogram/ema/live",
            get_with(
                async |uri: Uri, headers: HeaderMap, _: Empty, State(state): State<AppState>| {
                    state
                        .respond_json(&headers, state.mempool_strategy(), &uri, |q| {
                            q.live_histogram_ema()
                        })
                        .await
                },
                |op| {
                    op.id("get_oracle_histogram_ema_live")
                        .oracle_tag()
                        .summary("Live EMA histogram")
                        .description(
                            "Smoothed round-dollar payment histogram at the live tip: the \
                            committed EMA with the forming mempool block blended in. \
                            A flat array of log-scale bins.",
                        )
                        .json_response::<HistogramEmaCompact>()
                        .not_modified()
                        .server_error()
                },
            ),
        )
        .api_route(
            "/api/oracle/histogram/ema/{height}",
            get_with(
                async |uri: Uri,
                       headers: HeaderMap,
                       Path(path): Path<HeightParam>,
                       _: Empty,
                       State(state): State<AppState>| {
                    let strategy = state.height_strategy(Version::new(brk_oracle::VERSION), path.height);
                    state
                        .respond_json(&headers, strategy, &uri, move |q| {
                            q.confirmed_histogram_ema(usize::from(path.height))
                        })
                        .await
                },
                |op| {
                    op.id("get_oracle_histogram_ema")
                        .oracle_tag()
                        .summary("EMA histogram at height")
                        .description(
                            "Smoothed round-dollar payment histogram for a confirmed height. \
                            A flat array of log-scale bins.",
                        )
                        .json_response::<HistogramEmaCompact>()
                        .not_modified()
                        .bad_request()
                        .not_found()
                        .server_error()
                },
            ),
        )
        .api_route(
            "/api/oracle/histogram/raw/live",
            get_with(
                async |uri: Uri, headers: HeaderMap, _: Empty, State(state): State<AppState>| {
                    state
                        .respond_json(&headers, state.mempool_strategy(), &uri, |q| {
                            q.live_histogram_raw()
                        })
                        .await
                },
                |op| {
                    op.id("get_oracle_histogram_raw_live")
                        .oracle_tag()
                        .summary("Live raw histogram")
                        .description(
                            "Un-smoothed per-block round-dollar counts for the forming mempool \
                            block. A flat array of log-scale bins, all zero when no mempool is \
                            configured.",
                        )
                        .json_response::<HistogramRaw>()
                        .not_modified()
                        .server_error()
                },
            ),
        )
        .api_route(
            "/api/oracle/histogram/raw/{height}",
            get_with(
                async |uri: Uri,
                       headers: HeaderMap,
                       Path(path): Path<HeightParam>,
                       _: Empty,
                       State(state): State<AppState>| {
                    let strategy = state.height_strategy(Version::new(brk_oracle::VERSION), path.height);
                    state
                        .respond_json(&headers, strategy, &uri, move |q| {
                            q.confirmed_histogram_raw(usize::from(path.height))
                        })
                        .await
                },
                |op| {
                    op.id("get_oracle_histogram_raw")
                        .oracle_tag()
                        .summary("Raw histogram at height")
                        .description(
                            "Un-smoothed round-dollar counts for a single confirmed block. A \
                            flat array of log-scale bins.",
                        )
                        .json_response::<HistogramRaw>()
                        .not_modified()
                        .bad_request()
                        .not_found()
                        .server_error()
                },
            ),
        )
    }
}