-

Module bdk::database

source Â· [−]

Expand description

Database types

+

Module bdk::database

source Â· [−]

Expand description

Database types

This module provides the implementation of some defaults database types, along with traits that can be implemented externally to let Wallets use customized databases.

Itâs important to note that the databases defined here only contains âblockchain-relatedâ data. diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/struct.SqliteDatabase.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/struct.SqliteDatabase.html index aca9731f24..6f8d8fcb86 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/struct.SqliteDatabase.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/struct.SqliteDatabase.html @@ -6,7 +6,7 @@ logo

SqliteDatabase

-

Struct bdk::database::SqliteDatabase

source Â· [−]

pub struct SqliteDatabase {
+    Struct bdk::database::SqliteDatabase
source Â· [−]

pub struct SqliteDatabase {
     pub path: String,
     pub connection: Connection,
 }

Expand description

Sqlite database stored on filesystem


@@ -14,43 +14,43 @@
 crate::database

`Fields`

path: StringPath on the local filesystem to store the sqlite file
 
connection: ConnectionA rusqlite connection object to the sqlite database
-
Implementations
source
impl SqliteDatabase
source
pub fn new(path: String) -> Self
Instantiate a new SqliteDatabase instance by creating a connection
+
Implementations
source
impl SqliteDatabase
source
pub fn new(path: String) -> Self
Instantiate a new SqliteDatabase instance by creating a connection
 to the database stored at path
-
Trait Implementations
source
impl BatchDatabase for SqliteDatabase
type Batch = SqliteDatabase
Container for the operations
-
source
fn begin_batch(&self) -> Self::Batch
Create a new batch container
-
source
fn commit_batch(&mut self, batch: Self::Batch) -> Result<(), Error>
Consume and apply a batch of operations
-
source
impl BatchOperations for SqliteDatabase
source
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.
-
source
fn set_utxo(&mut self, utxo: &LocalUtxo) -> Result<(), Error>
Store a LocalUtxo
-
source
fn set_raw_tx(&mut self, transaction: &Transaction) -> Result<(), Error>
Store a raw transaction
-
source
fn set_tx(&mut self, transaction: &TransactionDetails) -> Result<(), Error>
Store the metadata of a transaction
-
source
fn set_last_index(
    &mut self, 
    keychain: KeychainKind, 
    value: u32
) -> Result<(), Error>
Store the last derivation index for a given keychain.
-
source
fn set_sync_time(&mut self, ct: SyncTime) -> Result<(), Error>
Store the sync time
-
source
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.
-
source
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
+
Trait Implementations
source
impl BatchDatabase for SqliteDatabase
type Batch = SqliteDatabase
Container for the operations
+
source
fn begin_batch(&self) -> Self::Batch
Create a new batch container
+
source
fn commit_batch(&mut self, batch: Self::Batch) -> Result<(), Error>
Consume and apply a batch of operations
+
source
impl BatchOperations for SqliteDatabase
source
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.
+
source
fn set_utxo(&mut self, utxo: &LocalUtxo) -> Result<(), Error>
Store a LocalUtxo
+
source
fn set_raw_tx(&mut self, transaction: &Transaction) -> Result<(), Error>
Store a raw transaction
+
source
fn set_tx(&mut self, transaction: &TransactionDetails) -> Result<(), Error>
Store the metadata of a transaction
+
source
fn set_last_index(
    &mut self, 
    keychain: KeychainKind, 
    value: u32
) -> Result<(), Error>
Store the last derivation index for a given keychain.
+
source
fn set_sync_time(&mut self, ct: SyncTime) -> Result<(), Error>
Store the sync time
+
source
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.
+
source
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. Read more
-
source
fn del_utxo(&mut self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, Error>
Delete a LocalUtxo given its [OutPoint]
-
source
fn del_raw_tx(&mut self, txid: &Txid) -> Result<Option<Transaction>, Error>
Delete a raw transaction given its [Txid]
-
source
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
-
source
fn del_last_index(
    &mut self, 
    keychain: KeychainKind
) -> Result<Option<u32>, Error>
Delete the last derivation index for a keychain.
-
source
fn del_sync_time(&mut self) -> Result<Option<SyncTime>, Error>
Reset the sync time to None Read more
+
source
fn del_utxo(&mut self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, Error>
Delete a LocalUtxo given its [OutPoint]
+
source
fn del_raw_tx(&mut self, txid: &Txid) -> Result<Option<Transaction>, Error>
Delete a raw transaction given its [Txid]
+
source
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
+
source
fn del_last_index(
    &mut self, 
    keychain: KeychainKind
) -> Result<Option<u32>, Error>
Delete the last derivation index for a keychain.
+
source
fn del_sync_time(&mut self) -> Result<Option<SyncTime>, Error>
Reset the sync time to None Read more
 
source
impl ConfigurableDatabase for SqliteDatabase
type Config = SqliteDbConfiguration
Type that contains the configuration
 
source
fn from_config(config: &Self::Config) -> Result<Self, Error>
Create a new instance given a configuration
-
source
impl Database for SqliteDatabase
source
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. Read more
-
source
fn iter_script_pubkeys(
    &self, 
    keychain: Option<KeychainKind>
) -> Result<Vec<Script>, Error>
Return the list of script_pubkeys
-
source
fn iter_utxos(&self) -> Result<Vec<LocalUtxo>, Error>
Return the list of LocalUtxos
-
source
fn iter_raw_txs(&self) -> Result<Vec<Transaction>, Error>
Return the list of raw transactions
-
source
fn iter_txs(&self, include_raw: bool) -> Result<Vec<TransactionDetails>, Error>
Return the list of transactions metadata
-
source
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.
-
source
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
-
source
fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, Error>
Fetch a LocalUtxo given its [OutPoint]
-
source
fn get_raw_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error>
Fetch a raw transaction given its [Txid]
-
source
fn get_tx(
    &self, 
    txid: &Txid, 
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>
Fetch the transaction metadata and optionally also the raw transaction
-
source
fn get_last_index(&self, keychain: KeychainKind) -> Result<Option<u32>, Error>
Return the last derivation index for a keychain.
-
source
fn get_sync_time(&self) -> Result<Option<SyncTime>, Error>
Return the sync time, if present
-
source
fn increment_last_index(&mut self, keychain: KeychainKind) -> Result<u32, Error>
Increment the last derivation index for a keychain and return it Read more
-
source
fn flush(&mut self) -> Result<(), Error>
ð Deprecated since 0.18.0: The flush function is only needed for the sled database on mobile, instead for mobile use the sqlite database.
+
source
impl Database for SqliteDatabase
source
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. Read more
+
source
fn iter_script_pubkeys(
    &self, 
    keychain: Option<KeychainKind>
) -> Result<Vec<Script>, Error>
Return the list of script_pubkeys
+
source
fn iter_utxos(&self) -> Result<Vec<LocalUtxo>, Error>
Return the list of LocalUtxos
+
source
fn iter_raw_txs(&self) -> Result<Vec<Transaction>, Error>
Return the list of raw transactions
+
source
fn iter_txs(&self, include_raw: bool) -> Result<Vec<TransactionDetails>, Error>
Return the list of transactions metadata
+
source
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.
+
source
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
+
source
fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, Error>
Fetch a LocalUtxo given its [OutPoint]
+
source
fn get_raw_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error>
Fetch a raw transaction given its [Txid]
+
source
fn get_tx(
    &self, 
    txid: &Txid, 
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>
Fetch the transaction metadata and optionally also the raw transaction
+
source
fn get_last_index(&self, keychain: KeychainKind) -> Result<Option<u32>, Error>
Return the last derivation index for a keychain.
+
source
fn get_sync_time(&self) -> Result<Option<SyncTime>, Error>
Return the sync time, if present
+
source
fn increment_last_index(&mut self, keychain: KeychainKind) -> Result<u32, Error>
Increment the last derivation index for a keychain and return it Read more
+
source
fn flush(&mut self) -> Result<(), Error>
ð Deprecated since 0.18.0: The flush function is only needed for the sled database on mobile, instead for mobile use the sqlite database.
 
Force changes to be written to disk
-
source
impl Debug for SqliteDatabase
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
+
source
impl Debug for SqliteDatabase
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
 
source
impl From<<SqliteDatabase as BatchDatabase>::Batch> for AnyBatch
source
fn from(inner: <SqliteDatabase as BatchDatabase>::Batch) -> Self
Performs the conversion.
 
source
impl From<SqliteDatabase> for AnyDatabase
source
fn from(inner: SqliteDatabase) -> Self
Performs the conversion.
 
Auto Trait Implementations
impl !RefUnwindSafe for SqliteDatabase
impl Send for SqliteDatabase
impl !Sync for SqliteDatabase
impl Unpin for SqliteDatabase
impl !UnwindSafe for SqliteDatabase
Blanket Implementations
source
impl<T> Any for T where
    T: 'static + ?Sized, 
source
pub fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/trait.BatchDatabase.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/trait.BatchDatabase.html
index 1590e261a9..60bfc27192 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/trait.BatchDatabase.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/database/trait.BatchDatabase.html
@@ -15,5 +15,5 @@
 
Associated Types
source
type Batch: BatchOperations
Container for the operations
 
Required methods
source
fn begin_batch(&self) -> Self::Batch
Create a new batch container
 
source
fn commit_batch(&mut self, batch: Self::Batch) -> Result<(), Error>
Consume and apply a batch of operations
-
Implementations on Foreign Types
source
impl BatchDatabase for Tree
type Batch = Batch
source
fn begin_batch(&self) -> Self::Batch
source
fn commit_batch(&mut self, batch: Self::Batch) -> Result<(), Error>
Implementors
source
impl BatchDatabase for AnyDatabase
type Batch = AnyBatch
source
impl BatchDatabase for MemoryDatabase
type Batch = Self
source
impl BatchDatabase for SqliteDatabase
type Batch = SqliteDatabase

Module bdk::database

Module bdk::database

In bdk::database

Struct bdk::database::SqliteDatabase

Struct bdk::database::SqliteDatabase

Fields

Implementations

impl SqliteDatabase

pub fn new(path: String) -> Self

Implementations

impl SqliteDatabase

pub fn new(path: String) -> Self

Trait Implementations

impl BatchDatabase for SqliteDatabase

type Batch = SqliteDatabase

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

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

impl BatchOperations for SqliteDatabase

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

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

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

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

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

fn set_sync_time(&mut self, ct: SyncTime) -> Result<(), Error>

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

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

Trait Implementations

impl BatchDatabase for SqliteDatabase

type Batch = SqliteDatabase

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

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

impl BatchOperations for SqliteDatabase

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

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

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

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

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

fn set_sync_time(&mut self, ct: SyncTime) -> Result<(), Error>

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

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

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

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

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

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

fn del_sync_time(&mut self) -> Result<Option<SyncTime>, Error>

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

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

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

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

fn del_sync_time(&mut self) -> Result<Option<SyncTime>, Error>

impl ConfigurableDatabase for SqliteDatabase

type Config = SqliteDbConfiguration

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

impl Database for SqliteDatabase

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

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

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

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

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

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

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

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

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

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

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

fn get_sync_time(&self) -> Result<Option<SyncTime>, Error>

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

fn flush(&mut self) -> Result<(), Error>

impl Database for SqliteDatabase

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

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

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

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

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

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

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

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

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

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

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

`Fields`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

`Implementations on Foreign Types`

`Implementors`

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

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

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

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

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