bsv-wallet-toolbox 0.2.23

Pure Rust BSV wallet-toolbox implementation
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

//! StorageProvider trait -- the top of the storage trait hierarchy.
//!
//! Extends StorageReaderWriter with high-level operations like migration,
//! settings management, and lifecycle control. This is the trait that
//! WalletStorageManager and Wallet hold via `Arc<dyn StorageProvider>`.

use async_trait::async_trait;

use crate::error::WalletResult;
use crate::storage::traits::reader_writer::StorageReaderWriter;
use crate::storage::TrxToken;
use crate::tables::Settings;
use crate::types::Chain;

/// Top-level storage provider interface for the wallet.
///
/// Adds high-level operations (migration, settings, lifecycle) on top of
/// the full CRUD interface provided by StorageReaderWriter.
///
/// Designed for dynamic dispatch: `Arc<dyn StorageProvider>`.
#[async_trait]
pub trait StorageProvider: StorageReaderWriter {
    /// Run database migrations to bring the schema up to date.
    async fn migrate_database(&self) -> WalletResult<String>;

    /// Get the current settings record.
    /// Typically reads from a cached value after `make_available()`.
    async fn get_settings(&self, trx: Option<&TrxToken>) -> WalletResult<Settings>;

    /// Ensure the storage is ready for use. Reads settings and caches them.
    async fn make_available(&self) -> WalletResult<Settings>;

    /// Destroy the storage, cleaning up all resources.
    async fn destroy(&self) -> WalletResult<()>;

    /// Drop all data from all tables. Used for testing.
    async fn drop_all_data(&self) -> WalletResult<()>;

    /// Get the storage identity key.
    fn get_storage_identity_key(&self) -> WalletResult<String>;

    /// Check whether the storage is currently available.
    fn is_available(&self) -> bool;

    /// Get the chain this storage is configured for.
    fn get_chain(&self) -> Chain;

    /// Set the active state of this storage provider.
    fn set_active(&self, active: bool);

    /// Check whether this is an active storage provider.
    fn is_active(&self) -> bool;
}