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

use axum::http::HeaderMap;

use crate::{VERSION, extended::HeaderMapExtended};

/// Cache strategy for HTTP responses.
pub enum CacheStrategy {
    /// Data that changes with each new block (addresses, mining stats, txs, outspends)
    /// Etag = VERSION-{height}, Cache-Control: must-revalidate
    Height,

    /// Static/immutable data (blocks by hash, validate-address, series catalog)
    /// Etag = VERSION only, Cache-Control: must-revalidate
    Static,

    /// Mempool data - etag from next projected block hash + short max-age
    /// Etag = VERSION-m{hash:x}, Cache-Control: max-age=1, must-revalidate
    MempoolHash(u64),
}

/// Resolved cache parameters
pub struct CacheParams {
    pub etag: Option<String>,
    pub cache_control: String,
}

impl CacheParams {
    /// Cache params using VERSION as etag
    pub fn version() -> Self {
        Self::resolve(&CacheStrategy::Static, || unreachable!())
    }

    pub fn etag_str(&self) -> &str {
        self.etag.as_deref().unwrap_or("")
    }

    pub fn matches_etag(&self, headers: &HeaderMap) -> bool {
        self.etag
            .as_ref()
            .is_some_and(|etag| headers.has_etag(etag))
    }

    pub fn resolve(strategy: &CacheStrategy, height: impl FnOnce() -> u32) -> Self {
        use CacheStrategy::*;
        match strategy {
            Height => Self {
                etag: Some(format!("{VERSION}-{}", height())),
                cache_control: "public, max-age=1, must-revalidate".into(),
            },
            Static => Self {
                etag: Some(VERSION.to_string()),
                cache_control: "public, max-age=1, must-revalidate".into(),
            },
            MempoolHash(hash) => Self {
                etag: Some(format!("{VERSION}-m{hash:x}")),
                cache_control: "public, max-age=1, must-revalidate".into(),
            },
        }
    }
}