blvm-node 0.1.10

Bitcoin Commons BLVM: Minimal Bitcoin node implementation using blvm-protocol and blvm-consensus
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

//! Canonical list of core RPC method names.
//!
//! Single source of truth for (1) getrpcinfo active_commands and (2) module
//! registration conflict check. Adding or renaming a method is done here only.

/// RPC methods that a trusted loaded module may override via `register_core_rpc_override`.
///
/// Rules:
/// - Any method listed here may be delegated to a module at runtime.
/// - Methods that affect money, consensus, or node control must NEVER appear here.
/// - The node validates that a module's `rpc_overrides` manifest field is a subset of this list.
pub const OVERRIDABLE_CORE_RPC_METHODS: &[&str] = &["getdescriptorinfo", "analyzepsbt"];

/// All core RPC methods that cannot be overridden by modules (except those in
/// `OVERRIDABLE_CORE_RPC_METHODS`, which have a separate override path).
/// Used by getrpcinfo (active_commands) and by `register_module_endpoint` (conflict check).
pub const CORE_RPC_METHODS: &[&str] = &[
    // Blockchain
    "getblockchaininfo",
    "getblock",
    "getblockhash",
    "getblockheader",
    "getbestblockhash",
    "getblockcount",
    "getdifficulty",
    "gettxoutsetinfo",
    "loadtxoutset",
    "verifychain",
    "getchaintips",
    "getchaintxstats",
    "getblockstats",
    "pruneblockchain",
    "getpruneinfo",
    "invalidateblock",
    "reconsiderblock",
    "waitfornewblock",
    "waitforblock",
    "waitforblockheight",
    // Raw tx / mempool
    "getrawtransaction",
    "sendrawtransaction",
    "testmempoolaccept",
    "decoderawtransaction",
    "createrawtransaction",
    "gettxout",
    "gettxoutproof",
    "verifytxoutproof",
    "getmempoolinfo",
    "getrawmempool",
    "savemempool",
    "getmempoolancestors",
    "getmempooldescendants",
    "getmempoolentry",
    // Network
    "getnetworkinfo",
    "getpeerinfo",
    "getconnectioncount",
    "ping",
    "addnode",
    "disconnectnode",
    "getnettotals",
    "clearbanned",
    "setban",
    "listbanned",
    "getaddednodeinfo",
    "getnodeaddresses",
    "setnetworkactive",
    // Mining
    "getmininginfo",
    "getblocktemplate",
    "generatetoaddress",
    "submitblock",
    "estimatesmartfee",
    "prioritisetransaction",
    // Index / filter
    "getblockfilter",
    "getindexinfo",
    "getblockchainstate",
    // Address / tx details
    "validateaddress",
    "getaddressinfo",
    "gettransactiondetails",
    // Control / node
    "stop",
    "uptime",
    "getmemoryinfo",
    "getrpcinfo",
    "help",
    "logging",
    "gethealth",
    "getmetrics",
    // Modules
    "loadmodule",
    "unloadmodule",
    "reloadmodule",
    "listmodules",
    "getmoduleclispecs",
    "runmodulecli",
    "getdescriptorinfo",
    "analyzepsbt",
];

#[cfg(test)]
mod tests {
    use super::*;

    /// Ensures no duplicate method names in the canonical list (catches copy-paste drift).
    #[test]
    fn core_rpc_methods_no_duplicates() {
        let mut seen = std::collections::HashSet::new();
        for name in CORE_RPC_METHODS {
            assert!(seen.insert(*name), "duplicate core RPC method: {name}");
        }
    }

    /// OVERRIDABLE list must be a subset of CORE_RPC_METHODS (method must be advertised to be overridable).
    #[test]
    fn overridable_methods_are_subset_of_core() {
        let core: std::collections::HashSet<_> = CORE_RPC_METHODS.iter().copied().collect();
        for method in OVERRIDABLE_CORE_RPC_METHODS {
            assert!(
                core.contains(*method),
                "overridable method '{method}' is not in CORE_RPC_METHODS",
            );
        }
    }

    /// Safety: OVERRIDABLE list must never contain money/consensus/control methods.
    #[test]
    fn overridable_methods_are_not_dangerous() {
        const FORBIDDEN: &[&str] = &[
            "sendrawtransaction",
            "stop",
            "invalidateblock",
            "reconsiderblock",
            "loadmodule",
            "unloadmodule",
            "reloadmodule",
            "submitblock",
            "setban",
            "clearbanned",
        ];
        let forbidden: std::collections::HashSet<_> = FORBIDDEN.iter().copied().collect();
        for method in OVERRIDABLE_CORE_RPC_METHODS {
            assert!(
                !forbidden.contains(*method),
                "dangerous method '{method}' must not be in OVERRIDABLE_CORE_RPC_METHODS",
            );
        }
    }
}