Enum bdk::database::any::AnyDatabase

pub enum AnyDatabase {
    Memory(MemoryDatabase),
    Sled(Tree),
}

Type that can contain any of the Database types defined by the library

It allows switching database type at runtime.

See this module's documentation for a usage example.

Variants

Memory(MemoryDatabase)

In-memory ephemeral database

Sled(Tree)

This is supported on crate feature key-value-db only.

Simple key-value embedded database based on sled

Trait Implementations

impl BatchDatabase for AnyDatabase

type Batch = AnyBatch

Container for the operations

pub fn begin_batch(&self) -> Self::Batch

Create a new batch container

pub fn commit_batch(&mut self, batch: Self::Batch) -> Result<(), Error>

Consume and apply a batch of operations

impl BatchOperations for AnyDatabase

pub fn set_script_pubkey(
    &mut self,
    script: &Script,
    keychain: KeychainKind,
    child: u32
) -> Result<(), Error>

Store a script_pubkey along with its keychain and child number.

pub fn set_utxo(&mut self, utxo: &UTXO) -> Result<(), Error>

Store a UTXO

pub fn set_raw_tx(&mut self, transaction: &Transaction) -> Result<(), Error>

Store a raw transaction

pub fn set_tx(&mut self, transaction: &TransactionDetails) -> Result<(), Error>

Store the metadata of a transaction

pub fn set_last_index(
    &mut self,
    keychain: KeychainKind,
    value: u32
) -> Result<(), Error>

Store the last derivation index for a given keychain.

pub fn del_script_pubkey_from_path(
    &mut self,
    keychain: KeychainKind,
    child: u32
) -> Result<Option<Script>, Error>

Delete a script_pubkey given the keychain and its child number.

pub fn del_path_from_script_pubkey(
    &mut self,
    script: &Script
) -> Result<Option<(KeychainKind, u32)>, Error>

Delete the data related to a specific script_pubkey, meaning the keychain and the child number.

pub fn del_utxo(&mut self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error>

Delete a UTXO given its OutPoint

pub fn del_raw_tx(&mut self, txid: &Txid) -> Result<Option<Transaction>, Error>

Delete a raw transaction given its Txid

pub fn del_tx(
    &mut self,
    txid: &Txid,
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>

Delete the metadata of a transaction and optionally the raw transaction itself

pub fn del_last_index(
    &mut self,
    keychain: KeychainKind
) -> Result<Option<u32>, Error>

Delete the last derivation index for a keychain.

impl ConfigurableDatabase for AnyDatabase

type Config = AnyDatabaseConfig

Type that contains the configuration

pub fn from_config(config: &Self::Config) -> Result<Self, Error>

Create a new instance given a configuration

impl Database for AnyDatabase

pub fn check_descriptor_checksum<B: AsRef<[u8]>>(
    &mut self,
    keychain: KeychainKind,
    bytes: B
) -> Result<(), Error>

Read and checks the descriptor checksum for a given keychain.

pub fn iter_script_pubkeys(
    &self,
    keychain: Option<KeychainKind>
) -> Result<Vec<Script>, Error>

Return the list of script_pubkeys

pub fn iter_utxos(&self) -> Result<Vec<UTXO>, Error>

Return the list of UTXOs

pub fn iter_raw_txs(&self) -> Result<Vec<Transaction>, Error>

Return the list of raw transactions

pub fn iter_txs(
    &self,
    include_raw: bool
) -> Result<Vec<TransactionDetails>, Error>

Return the list of transactions metadata

pub fn get_script_pubkey_from_path(
    &self,
    keychain: KeychainKind,
    child: u32
) -> Result<Option<Script>, Error>

Fetch a script_pubkey given the child number of a keychain.

pub fn get_path_from_script_pubkey(
    &self,
    script: &Script
) -> Result<Option<(KeychainKind, u32)>, Error>

Fetch the keychain and child number of a given script_pubkey

pub fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error>

Fetch a UTXO given its OutPoint

pub fn get_raw_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error>

Fetch a raw transaction given its Txid

pub fn get_tx(
    &self,
    txid: &Txid,
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>

Fetch the transaction metadata and optionally also the raw transaction

pub fn get_last_index(
    &self,
    keychain: KeychainKind
) -> Result<Option<u32>, Error>

Return the last defivation index for a keychain.

pub fn increment_last_index(
    &mut self,
    keychain: KeychainKind
) -> Result<u32, Error>

Increment the last derivation index for a keychain and return it

impl Debug for AnyDatabase

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<MemoryDatabase> for AnyDatabase

pub fn from(inner: MemoryDatabase) -> Self

Performs the conversion.

impl From<Tree> for AnyDatabase

pub fn from(inner: Tree) -> Self

Performs the conversion.