fedimint_client_module/sm/
dbtx.rs

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
use fedimint_core::core::ModuleInstanceId;
use fedimint_core::db::DatabaseTransaction;

/// A transaction that acts as isolated for module code but can be accessed as a
/// normal transaction in this crate.
pub struct ClientSMDatabaseTransaction<'inner, 'parent> {
    dbtx: &'inner mut DatabaseTransaction<'parent>,
    module_instance: ModuleInstanceId,
}

impl<'inner, 'parent> ClientSMDatabaseTransaction<'inner, 'parent> {
    pub fn new(
        dbtx: &'inner mut DatabaseTransaction<'parent>,
        module_instance: ModuleInstanceId,
    ) -> Self {
        Self {
            dbtx,
            module_instance,
        }
    }

    /// Returns the isolated database transaction for the module.
    pub fn module_tx(&mut self) -> DatabaseTransaction<'_> {
        self.dbtx
            .to_ref_with_prefix_module_id(self.module_instance)
            .0
            .into_nc()
    }

    /// Returns the non-isolated database transaction only accessible to the
    /// client internal code. This is useful for submitting Fedimint
    /// transactions from within state transitions.
    // TODO: We don't want the client module to call this directly, ideally this
    // would be private, but after we've split fedimint-client-module and fedimint-client
    // we need to make it public.
    #[doc(hidden)]
    pub fn global_tx(&mut self) -> &mut DatabaseTransaction<'parent> {
        self.dbtx
    }

    pub(crate) fn module_id(&self) -> ModuleInstanceId {
        self.module_instance
    }
}