brk_server 0.2.5

A server with an API for anything from BRK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use aide::axum::{ApiRouter, routing::get_with};
use axum::{
    extract::State,
    http::{HeaderMap, Uri},
    response::Redirect,
    routing::get,
};
use brk_types::{Dollars, MempoolBlock, MempoolInfo, RecommendedFees, Txid};

use crate::extended::TransformResponseExtended;

use super::AppState;

pub trait MempoolRoutes {
    fn add_mempool_routes(self) -> Self;
}

impl MempoolRoutes for ApiRouter<AppState> {
    fn add_mempool_routes(self) -> Self {
        self
            .route("/api/mempool", get(Redirect::temporary("/api#tag/mempool")))
            .api_route(
                "/api/mempool/info",
                get_with(
                    async |uri: Uri, headers: HeaderMap, State(state): State<AppState>| {
                        state.cached_json(&headers, state.mempool_cache(), &uri, |q| q.mempool_info()).await
                    },
                    |op| {
                        op.id("get_mempool")
                            .mempool_tag()
                            .summary("Mempool statistics")
                            .description("Get current mempool statistics including transaction count, total vsize, and total fees.\n\n*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool)*")
                            .ok_response::<MempoolInfo>()
                            .server_error()
                    },
                ),
            )
            .api_route(
                "/api/mempool/txids",
                get_with(
                    async |uri: Uri, headers: HeaderMap, State(state): State<AppState>| {
                        state.cached_json(&headers, state.mempool_cache(), &uri, |q| q.mempool_txids()).await
                    },
                    |op| {
                        op.id("get_mempool_txids")
                            .mempool_tag()
                            .summary("Mempool transaction IDs")
                            .description("Get all transaction IDs currently in the mempool.\n\n*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-transaction-ids)*")
                            .ok_response::<Vec<Txid>>()
                            .server_error()
                    },
                ),
            )
            .api_route(
                "/api/mempool/price",
                get_with(
                    async |uri: Uri, headers: HeaderMap, State(state): State<AppState>| {
                        state.cached_json(&headers, state.mempool_cache(), &uri, |q| q.live_price()).await
                    },
                    |op| {
                        op.id("get_live_price")
                            .mempool_tag()
                            .summary("Live BTC/USD price")
                            .description(
                                "Returns the current BTC/USD price in dollars, derived from \
                                on-chain round-dollar output patterns in the last 12 blocks \
                                plus mempool.",
                            )
                            .ok_response::<Dollars>()
                            .server_error()
                    },
                ),
            )
            .api_route(
                "/api/v1/fees/recommended",
                get_with(
                    async |uri: Uri, headers: HeaderMap, State(state): State<AppState>| {
                        state.cached_json(&headers, state.mempool_cache(), &uri, |q| q.recommended_fees()).await
                    },
                    |op| {
                        op.id("get_recommended_fees")
                            .mempool_tag()
                            .summary("Recommended fees")
                            .description("Get recommended fee rates for different confirmation targets based on current mempool state.\n\n*[Mempool.space docs](https://mempool.space/docs/api/rest#get-recommended-fees)*")
                            .ok_response::<RecommendedFees>()
                            .server_error()
                    },
                ),
            )
            .api_route(
                "/api/v1/fees/mempool-blocks",
                get_with(
                    async |uri: Uri, headers: HeaderMap, State(state): State<AppState>| {
                        state.cached_json(&headers, state.mempool_cache(), &uri, |q| q.mempool_blocks()).await
                    },
                    |op| {
                        op.id("get_mempool_blocks")
                            .mempool_tag()
                            .summary("Projected mempool blocks")
                            .description("Get projected blocks from the mempool for fee estimation. Each block contains statistics about transactions that would be included if a block were mined now.\n\n*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-blocks-fees)*")
                            .ok_response::<Vec<MempoolBlock>>()
                            .server_error()
                    },
                ),
            )
    }
}