400 lines
14 KiB
Rust
400 lines
14 KiB
Rust
// Magical Bitcoin Library
|
|
// Written in 2020 by
|
|
// Alekos Filini <alekos.filini@gmail.com>
|
|
//
|
|
// Copyright (c) 2020 Magical Bitcoin
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in all
|
|
// copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
|
|
//! Runtime-checked database types
|
|
//!
|
|
//! This module provides the implementation of [`AnyDatabase`] which allows switching the
|
|
//! inner [`Database`] type at runtime.
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! In this example, `wallet_memory` and `wallet_sled` have the same type of `Wallet<OfflineBlockchain, AnyDatabase>`.
|
|
//!
|
|
//! ```no_run
|
|
//! # use bitcoin::Network;
|
|
//! # use bdk::database::{AnyDatabase, MemoryDatabase};
|
|
//! # use bdk::{Wallet, OfflineWallet};
|
|
//! let memory = MemoryDatabase::default().into();
|
|
//! let wallet_memory: OfflineWallet<AnyDatabase> = Wallet::new_offline("...", None, Network::Testnet, memory)?;
|
|
//!
|
|
//! # #[cfg(feature = "key-value-db")]
|
|
//! # {
|
|
//! let sled = sled::open("my-database")?.open_tree("default_tree")?.into();
|
|
//! let wallet_sled: OfflineWallet<AnyDatabase> = Wallet::new_offline("...", None, Network::Testnet, sled)?;
|
|
//! # }
|
|
//! # Ok::<(), bdk::Error>(())
|
|
//! ```
|
|
//!
|
|
//! When paired with the use of [`ConfigurableDatabase`], it allows creating wallets with any
|
|
//! database supported using a single line of code:
|
|
//!
|
|
//! ```no_run
|
|
//! # use bitcoin::Network;
|
|
//! # use bdk::database::*;
|
|
//! # use bdk::{Wallet, OfflineWallet};
|
|
//! let config = serde_json::from_str("...")?;
|
|
//! let database = AnyDatabase::from_config(&config)?;
|
|
//! let wallet: OfflineWallet<_> = Wallet::new_offline("...", None, Network::Testnet, database)?;
|
|
//! # Ok::<(), bdk::Error>(())
|
|
//! ```
|
|
|
|
use super::*;
|
|
|
|
macro_rules! impl_from {
|
|
( $from:ty, $to:ty, $variant:ident, $( $cfg:tt )* ) => {
|
|
$( $cfg )*
|
|
impl From<$from> for $to {
|
|
fn from(inner: $from) -> Self {
|
|
<$to>::$variant(inner)
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
macro_rules! impl_inner_method {
|
|
( $enum_name:ident, $self:expr, $name:ident $(, $args:expr)* ) => {
|
|
match $self {
|
|
$enum_name::Memory(inner) => inner.$name( $($args, )* ),
|
|
#[cfg(feature = "key-value-db")]
|
|
$enum_name::Sled(inner) => inner.$name( $($args, )* ),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Type that can contain any of the [`Database`] types defined by the library
|
|
///
|
|
/// It allows switching database type at runtime.
|
|
///
|
|
/// See [this module](crate::database::any)'s documentation for a usage example.
|
|
#[derive(Debug)]
|
|
pub enum AnyDatabase {
|
|
#[allow(missing_docs)]
|
|
Memory(memory::MemoryDatabase),
|
|
#[cfg(feature = "key-value-db")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
|
|
#[allow(missing_docs)]
|
|
Sled(sled::Tree),
|
|
}
|
|
|
|
impl_from!(memory::MemoryDatabase, AnyDatabase, Memory,);
|
|
impl_from!(sled::Tree, AnyDatabase, Sled, #[cfg(feature = "key-value-db")]);
|
|
|
|
/// Type that contains any of the [`BatchDatabase::Batch`] types defined by the library
|
|
pub enum AnyBatch {
|
|
#[allow(missing_docs)]
|
|
Memory(<memory::MemoryDatabase as BatchDatabase>::Batch),
|
|
#[cfg(feature = "key-value-db")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
|
|
#[allow(missing_docs)]
|
|
Sled(<sled::Tree as BatchDatabase>::Batch),
|
|
}
|
|
|
|
impl_from!(
|
|
<memory::MemoryDatabase as BatchDatabase>::Batch,
|
|
AnyBatch,
|
|
Memory,
|
|
);
|
|
impl_from!(<sled::Tree as BatchDatabase>::Batch, AnyBatch, Sled, #[cfg(feature = "key-value-db")]);
|
|
|
|
impl BatchOperations for AnyDatabase {
|
|
fn set_script_pubkey(
|
|
&mut self,
|
|
script: &Script,
|
|
script_type: ScriptType,
|
|
child: u32,
|
|
) -> Result<(), Error> {
|
|
impl_inner_method!(
|
|
AnyDatabase,
|
|
self,
|
|
set_script_pubkey,
|
|
script,
|
|
script_type,
|
|
child
|
|
)
|
|
}
|
|
fn set_utxo(&mut self, utxo: &UTXO) -> Result<(), Error> {
|
|
impl_inner_method!(AnyDatabase, self, set_utxo, utxo)
|
|
}
|
|
fn set_raw_tx(&mut self, transaction: &Transaction) -> Result<(), Error> {
|
|
impl_inner_method!(AnyDatabase, self, set_raw_tx, transaction)
|
|
}
|
|
fn set_tx(&mut self, transaction: &TransactionDetails) -> Result<(), Error> {
|
|
impl_inner_method!(AnyDatabase, self, set_tx, transaction)
|
|
}
|
|
fn set_last_index(&mut self, script_type: ScriptType, value: u32) -> Result<(), Error> {
|
|
impl_inner_method!(AnyDatabase, self, set_last_index, script_type, value)
|
|
}
|
|
|
|
fn del_script_pubkey_from_path(
|
|
&mut self,
|
|
script_type: ScriptType,
|
|
child: u32,
|
|
) -> Result<Option<Script>, Error> {
|
|
impl_inner_method!(
|
|
AnyDatabase,
|
|
self,
|
|
del_script_pubkey_from_path,
|
|
script_type,
|
|
child
|
|
)
|
|
}
|
|
fn del_path_from_script_pubkey(
|
|
&mut self,
|
|
script: &Script,
|
|
) -> Result<Option<(ScriptType, u32)>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, del_path_from_script_pubkey, script)
|
|
}
|
|
fn del_utxo(&mut self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, del_utxo, outpoint)
|
|
}
|
|
fn del_raw_tx(&mut self, txid: &Txid) -> Result<Option<Transaction>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, del_raw_tx, txid)
|
|
}
|
|
fn del_tx(
|
|
&mut self,
|
|
txid: &Txid,
|
|
include_raw: bool,
|
|
) -> Result<Option<TransactionDetails>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, del_tx, txid, include_raw)
|
|
}
|
|
fn del_last_index(&mut self, script_type: ScriptType) -> Result<Option<u32>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, del_last_index, script_type)
|
|
}
|
|
}
|
|
|
|
impl Database for AnyDatabase {
|
|
fn check_descriptor_checksum<B: AsRef<[u8]>>(
|
|
&mut self,
|
|
script_type: ScriptType,
|
|
bytes: B,
|
|
) -> Result<(), Error> {
|
|
impl_inner_method!(
|
|
AnyDatabase,
|
|
self,
|
|
check_descriptor_checksum,
|
|
script_type,
|
|
bytes
|
|
)
|
|
}
|
|
|
|
fn iter_script_pubkeys(&self, script_type: Option<ScriptType>) -> Result<Vec<Script>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, iter_script_pubkeys, script_type)
|
|
}
|
|
fn iter_utxos(&self) -> Result<Vec<UTXO>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, iter_utxos)
|
|
}
|
|
fn iter_raw_txs(&self) -> Result<Vec<Transaction>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, iter_raw_txs)
|
|
}
|
|
fn iter_txs(&self, include_raw: bool) -> Result<Vec<TransactionDetails>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, iter_txs, include_raw)
|
|
}
|
|
|
|
fn get_script_pubkey_from_path(
|
|
&self,
|
|
script_type: ScriptType,
|
|
child: u32,
|
|
) -> Result<Option<Script>, Error> {
|
|
impl_inner_method!(
|
|
AnyDatabase,
|
|
self,
|
|
get_script_pubkey_from_path,
|
|
script_type,
|
|
child
|
|
)
|
|
}
|
|
fn get_path_from_script_pubkey(
|
|
&self,
|
|
script: &Script,
|
|
) -> Result<Option<(ScriptType, u32)>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, get_path_from_script_pubkey, script)
|
|
}
|
|
fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, get_utxo, outpoint)
|
|
}
|
|
fn get_raw_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, get_raw_tx, txid)
|
|
}
|
|
fn get_tx(&self, txid: &Txid, include_raw: bool) -> Result<Option<TransactionDetails>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, get_tx, txid, include_raw)
|
|
}
|
|
fn get_last_index(&self, script_type: ScriptType) -> Result<Option<u32>, Error> {
|
|
impl_inner_method!(AnyDatabase, self, get_last_index, script_type)
|
|
}
|
|
|
|
fn increment_last_index(&mut self, script_type: ScriptType) -> Result<u32, Error> {
|
|
impl_inner_method!(AnyDatabase, self, increment_last_index, script_type)
|
|
}
|
|
}
|
|
|
|
impl BatchOperations for AnyBatch {
|
|
fn set_script_pubkey(
|
|
&mut self,
|
|
script: &Script,
|
|
script_type: ScriptType,
|
|
child: u32,
|
|
) -> Result<(), Error> {
|
|
impl_inner_method!(
|
|
AnyBatch,
|
|
self,
|
|
set_script_pubkey,
|
|
script,
|
|
script_type,
|
|
child
|
|
)
|
|
}
|
|
fn set_utxo(&mut self, utxo: &UTXO) -> Result<(), Error> {
|
|
impl_inner_method!(AnyBatch, self, set_utxo, utxo)
|
|
}
|
|
fn set_raw_tx(&mut self, transaction: &Transaction) -> Result<(), Error> {
|
|
impl_inner_method!(AnyBatch, self, set_raw_tx, transaction)
|
|
}
|
|
fn set_tx(&mut self, transaction: &TransactionDetails) -> Result<(), Error> {
|
|
impl_inner_method!(AnyBatch, self, set_tx, transaction)
|
|
}
|
|
fn set_last_index(&mut self, script_type: ScriptType, value: u32) -> Result<(), Error> {
|
|
impl_inner_method!(AnyBatch, self, set_last_index, script_type, value)
|
|
}
|
|
|
|
fn del_script_pubkey_from_path(
|
|
&mut self,
|
|
script_type: ScriptType,
|
|
child: u32,
|
|
) -> Result<Option<Script>, Error> {
|
|
impl_inner_method!(
|
|
AnyBatch,
|
|
self,
|
|
del_script_pubkey_from_path,
|
|
script_type,
|
|
child
|
|
)
|
|
}
|
|
fn del_path_from_script_pubkey(
|
|
&mut self,
|
|
script: &Script,
|
|
) -> Result<Option<(ScriptType, u32)>, Error> {
|
|
impl_inner_method!(AnyBatch, self, del_path_from_script_pubkey, script)
|
|
}
|
|
fn del_utxo(&mut self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error> {
|
|
impl_inner_method!(AnyBatch, self, del_utxo, outpoint)
|
|
}
|
|
fn del_raw_tx(&mut self, txid: &Txid) -> Result<Option<Transaction>, Error> {
|
|
impl_inner_method!(AnyBatch, self, del_raw_tx, txid)
|
|
}
|
|
fn del_tx(
|
|
&mut self,
|
|
txid: &Txid,
|
|
include_raw: bool,
|
|
) -> Result<Option<TransactionDetails>, Error> {
|
|
impl_inner_method!(AnyBatch, self, del_tx, txid, include_raw)
|
|
}
|
|
fn del_last_index(&mut self, script_type: ScriptType) -> Result<Option<u32>, Error> {
|
|
impl_inner_method!(AnyBatch, self, del_last_index, script_type)
|
|
}
|
|
}
|
|
|
|
impl BatchDatabase for AnyDatabase {
|
|
type Batch = AnyBatch;
|
|
|
|
fn begin_batch(&self) -> Self::Batch {
|
|
match self {
|
|
AnyDatabase::Memory(inner) => inner.begin_batch().into(),
|
|
#[cfg(feature = "key-value-db")]
|
|
AnyDatabase::Sled(inner) => inner.begin_batch().into(),
|
|
}
|
|
}
|
|
fn commit_batch(&mut self, batch: Self::Batch) -> Result<(), Error> {
|
|
// TODO: refactor once `move_ref_pattern` is stable
|
|
#[allow(irrefutable_let_patterns)]
|
|
match self {
|
|
AnyDatabase::Memory(db) => {
|
|
if let AnyBatch::Memory(batch) = batch {
|
|
db.commit_batch(batch)
|
|
} else {
|
|
unimplemented!()
|
|
}
|
|
}
|
|
#[cfg(feature = "key-value-db")]
|
|
AnyDatabase::Sled(db) => {
|
|
if let AnyBatch::Sled(batch) = batch {
|
|
db.commit_batch(batch)
|
|
} else {
|
|
unimplemented!()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Configuration type for a [`sled::Tree`] database
|
|
#[cfg(feature = "key-value-db")]
|
|
#[derive(Debug, serde::Serialize, serde::Deserialize)]
|
|
pub struct SledDbConfiguration {
|
|
/// Main directory of the db
|
|
pub path: String,
|
|
/// Name of the database tree, a separated namespace for the data
|
|
pub tree_name: String,
|
|
}
|
|
|
|
#[cfg(feature = "key-value-db")]
|
|
impl ConfigurableDatabase for sled::Tree {
|
|
type Config = SledDbConfiguration;
|
|
|
|
fn from_config(config: &Self::Config) -> Result<Self, Error> {
|
|
Ok(sled::open(&config.path)?.open_tree(&config.tree_name)?)
|
|
}
|
|
}
|
|
|
|
/// Type that can contain any of the database configurations defined by the library
|
|
///
|
|
/// This allows storing a single configuration that can be loaded into an [`AnyDatabase`]
|
|
/// instance. Wallets that plan to offer users the ability to switch blockchain backend at runtime
|
|
/// will find this particularly useful.
|
|
#[derive(Debug, serde::Serialize, serde::Deserialize)]
|
|
pub enum AnyDatabaseConfig {
|
|
/// Memory database has no config
|
|
Memory(()),
|
|
#[cfg(feature = "key-value-db")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
|
|
#[allow(missing_docs)]
|
|
Sled(SledDbConfiguration),
|
|
}
|
|
|
|
impl ConfigurableDatabase for AnyDatabase {
|
|
type Config = AnyDatabaseConfig;
|
|
|
|
fn from_config(config: &Self::Config) -> Result<Self, Error> {
|
|
Ok(match config {
|
|
AnyDatabaseConfig::Memory(inner) => {
|
|
AnyDatabase::Memory(memory::MemoryDatabase::from_config(inner)?)
|
|
}
|
|
#[cfg(feature = "key-value-db")]
|
|
AnyDatabaseConfig::Sled(inner) => AnyDatabase::Sled(sled::Tree::from_config(inner)?),
|
|
})
|
|
}
|
|
}
|
|
|
|
impl_from!((), AnyDatabaseConfig, Memory,);
|
|
impl_from!(SledDbConfiguration, AnyDatabaseConfig, Sled, #[cfg(feature = "key-value-db")]);
|