fedimint_server/
db.rs

1use std::collections::BTreeSet;
2
3use bitcoin::hex::DisplayHex as _;
4use fedimint_core::db::{
5    DatabaseTransaction, IDatabaseTransactionOpsCore as _, MODULE_GLOBAL_PREFIX,
6};
7use fedimint_core::encoding::{Decodable, Encodable};
8use fedimint_core::impl_db_record;
9use futures::StreamExt as _;
10use strum::{EnumIter, IntoEnumIterator as _};
11
12#[repr(u8)]
13#[derive(Clone, EnumIter, Debug)]
14pub enum DbKeyPrefix {
15    AcceptedItem = 0x01,
16    AcceptedTransaction = 0x02,
17    SignedSessionOutcome = 0x04,
18    AlephUnits = 0x05,
19    // TODO: do we want to split the server DB into consensus/non-consensus?
20    ApiAnnouncements = 0x06,
21    ServerInfo = 0x07,
22
23    DatabaseVersion = fedimint_core::db::DbKeyPrefix::DatabaseVersion as u8,
24    ClientBackup = fedimint_core::db::DbKeyPrefix::ClientBackup as u8,
25    Module = MODULE_GLOBAL_PREFIX,
26}
27
28pub(crate) async fn verify_server_db_integrity_dbtx(dbtx: &mut DatabaseTransaction<'_>) {
29    let prefixes: BTreeSet<u8> = DbKeyPrefix::iter().map(|prefix| prefix as u8).collect();
30
31    let mut records = dbtx.raw_find_by_prefix(&[]).await.expect("DB fail");
32    while let Some((k, v)) = records.next().await {
33        // We don't want to waste time checking these
34        if k[0] == DbKeyPrefix::Module as u8 {
35            break;
36        }
37
38        assert!(
39            prefixes.contains(&k[0]),
40            "Unexpected server db record found: {}: {}",
41            k.as_hex(),
42            v.as_hex()
43        );
44    }
45}
46
47impl std::fmt::Display for DbKeyPrefix {
48    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
49        write!(f, "{self:?}")
50    }
51}
52
53#[derive(Clone, Debug, Encodable, Decodable)]
54pub struct ServerInfoKey;
55
56#[derive(Clone, Debug, Encodable, Decodable)]
57pub struct ServerInfo {
58    /// The initial version that set up the consensus
59    pub init_version: String,
60    /// The last version that passed db migration checks
61    pub last_version: String,
62}
63
64impl_db_record!(
65    key = ServerInfoKey,
66    value = ServerInfo,
67    db_prefix = DbKeyPrefix::ServerInfo,
68    notify_on_modify = false,
69);
fedimint_server/db.rs

fedimint_server/
db.rs
