nostr-sqlite 0.45.0-alpha.1

SQLite storage backend for nostr apps
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

//! Nostr SQLite database builder

use std::path::{Path, PathBuf};

use nostr::types::RelayUrl;

use crate::error::Error;
use crate::store::NostrSqlite;

#[derive(Default)]
pub(crate) enum DatabaseConnType {
    #[default]
    InMemory,
    #[cfg(not(target_arch = "wasm32"))]
    File(PathBuf),
    WithVFS {
        path: PathBuf,
        vfs: String,
    },
}

/// Builder for [`NostrSqlite`] database.
pub struct NostrSqliteBuilder {
    /// Database connection type. In-memory by default
    pub(crate) db_type: DatabaseConnType,
    /// Whether to process request to vanish (NIP-62) events
    pub(crate) process_nip62: bool,
    /// Whether to process event deletion request (NIP-09) events
    pub(crate) process_nip09: bool,
    /// Relay URL for relay-specific request to vanish (NIP-62)
    pub(crate) relay_url: Option<RelayUrl>,
}

impl NostrSqliteBuilder {
    /// Use an in-memory database.
    ///
    /// This overrides any previous connection setting.
    #[inline]
    pub fn in_memory(mut self) -> Self {
        self.db_type = DatabaseConnType::InMemory;
        self
    }

    /// Connect to a SQLite database file.
    ///
    /// This overrides any previous connection setting.
    #[inline]
    #[cfg(not(target_arch = "wasm32"))]
    pub fn in_file<P>(mut self, path: P) -> Self
    where
        P: AsRef<Path>,
    {
        self.db_type = DatabaseConnType::File(path.as_ref().to_path_buf());
        self
    }

    /// Connect to a SQLite database file using a specific VFS.
    ///
    /// This overrides any previous connection setting.
    #[inline]
    pub fn persistent_with_vfs<P, S>(mut self, path: P, vfs: S) -> Self
    where
        P: AsRef<Path>,
        S: Into<String>,
    {
        self.db_type = DatabaseConnType::WithVFS {
            path: path.as_ref().to_path_buf(),
            vfs: vfs.into(),
        };
        self
    }

    /// Whether to process request to vanish (NIP-62) events
    ///
    /// Defaults to `true`
    #[inline]
    pub fn process_nip62(mut self, process_nip62: bool) -> Self {
        self.process_nip62 = process_nip62;
        self
    }

    /// Whether to process event deletion request (NIP-09) events
    ///
    /// Defaults to `true`
    #[inline]
    pub fn process_nip09(mut self, process_nip09: bool) -> Self {
        self.process_nip09 = process_nip09;
        self
    }

    /// Set the relay URL to handle relay-specific request to vanish
    #[inline]
    pub fn relay_url(mut self, relay_url: RelayUrl) -> Self {
        self.relay_url = Some(relay_url);
        self
    }

    /// Build [`NostrSqlite`] database
    #[inline]
    pub async fn build(self) -> Result<NostrSqlite, Error> {
        NostrSqlite::from_builder(self).await
    }
}

impl Default for NostrSqliteBuilder {
    /// Creates a new builder with default settings.
    ///
    /// This builder uses an in-memory database connection and enables
    /// processing for NIP-62 and NIP-09 features by default.
    fn default() -> Self {
        Self {
            db_type: Default::default(),
            process_nip62: true,
            process_nip09: true,
            relay_url: None,
        }
    }
}