feat: add bdk_sqlite_store crate implementing PersistBackend backed by a SQLite database

Author: notmandatory

Cargo.toml

@@ -3,6 +3,7 @@ members = [
     "crates/bdk",
     "crates/chain",
     "crates/file_store",
+    "crates/sqlite_store",
     "crates/electrum",
     "crates/esplora",
     "example-crates/example_cli",

crates/sqlite_store/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "bdk_sqlite_store"
+version = "0.2.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/bitcoindevkit/bdk"
+documentation = "https://docs.rs/bdk_file_store"
+description = "A simple append-only SQLite based implementation of Persist for Bitcoin Dev Kit."
+keywords = ["bitcoin", "persist", "persistence", "bdk", "sqlite"]
+authors = ["Bitcoin Dev Kit Developers"]
+readme = "README.md"
+
+[dependencies]
+bdk_chain = { path = "../chain", version = "0.5.0", features = [ "serde", "miniscript" ] }
+rusqlite = { version = "0.29.0", features = ["bundled"]}
+serde = { version = "1", features = ["derive"] }
+log = { version = "0.4", features = [] }
+serde_json = "1.0.107"
+
+[dev-dependencies]
+tempfile = "3"

crates/sqlite_store/README.md

@@ -0,0 +1,11 @@
+# BDK SQLite Store
+
+This is a simple append-only [SQLite] database backed implementation of
+[`Persist`](`bdk_chain::Persist`).
+
+The main structure is [`Store`](`crate::Store`), which can be used with [`bdk`]'s
+`Wallet` to persist wallet data into a SQLite database file.
+
+[`bdk`]: https://docs.rs/bdk/latest
+[`bdk_chain`]: https://docs.rs/bdk_chain/latest
+[SQLite]: https://www.sqlite.org/index.html

crates/sqlite_store/src/lib.rs

@@ -0,0 +1,59 @@
+#![doc = include_str!("../README.md")]
+
+mod store;
+
+pub use store::*;
+
+/// Error that occurs while appending new change sets to the DB.
+#[derive(Debug)]
+pub enum AppendError {
+    /// JSON encoding error.
+    Json(serde_json::Error),
+    /// SQLite error.
+    Sqlite(rusqlite::Error),
+}
+
+impl<'a> core::fmt::Display for AppendError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            Self::Json(e) => write!(f, "json error trying to append change set: {}", e),
+            Self::Sqlite(e) => write!(f, "sqlite error trying to append change set: {}", e),
+        }
+    }
+}
+
+impl<'a> From<serde_json::Error> for AppendError {
+    fn from(error: serde_json::Error) -> Self {
+        Self::Json(error)
+    }
+}
+
+impl<'a> std::error::Error for AppendError {}
+
+/// Error the occurs while iterating stored change sets from the DB.
+#[derive(Debug)]
+pub enum IterError {
+    /// Json decoding
+    Json {
+        rowid: usize,
+        err: serde_json::Error,
+    },
+    /// Sqlite error
+    Sqlite(rusqlite::Error),
+    /// FromSql error
+    FromSql(rusqlite::types::FromSqlError),
+}
+
+impl core::fmt::Display for IterError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            IterError::Json { rowid, err } => write!(
+                f,
+                "json error trying to decode change set {}, {}",
+                rowid, err
+            ),
+            IterError::Sqlite(err) => write!(f, "Sqlite error {}", err),
+            IterError::FromSql(err) => write!(f, "FromSql error {}", err),
+        }
+    }
+}