Crate bdk

impl Wallet

pub fn new_no_persist<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    network: Network
) -> Result<Self, DescriptorError>

Creates a wallet that does not persist data.

pub fn new_no_persist_with_genesis_hash<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    network: Network,
    genesis_hash: BlockHash
) -> Result<Self, DescriptorError>

Creates a wallet that does not persist data, with a custom genesis hash.

-

impl Wallet

pub fn new<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network
) -> Result<Self, NewError>

Initialize an empty Wallet.

-

pub fn new_with_genesis_hash<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network,
    genesis_hash: BlockHash
) -> Result<Self, NewError>

Initialize an empty Wallet with a custom genesis hash.

+

impl Wallet

pub fn new<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network
) -> Result<Self, NewError>

Initialize an empty Wallet.

+

pub fn new_with_genesis_hash<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network,
    genesis_hash: BlockHash
) -> Result<Self, NewError>

Initialize an empty Wallet with a custom genesis hash.

This is like Wallet::new with an additional genesis_hash parameter. This is useful for syncing from alternative networks.

-

pub fn load<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static
) -> Result<Self, LoadError>

Load Wallet from the given persistence backend.

-

pub fn new_or_load<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network
) -> Result<Self, NewOrLoadError>

Either loads Wallet from persistence, or initializes it if it does not exist.

+

pub fn load<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static
) -> Result<Self, LoadError>

Load Wallet from the given persistence backend.

+

pub fn new_or_load<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network
) -> Result<Self, NewOrLoadError>

Either loads Wallet from persistence, or initializes it if it does not exist.

This method will fail if the loaded Wallet has different parameters to those provided.

-

pub fn new_or_load_with_genesis_hash<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network,
    genesis_hash: BlockHash
) -> Result<Self, NewOrLoadError>

Either loads Wallet from persistence, or initializes it if it does not exist (with a +

pub fn new_or_load_with_genesis_hash<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: impl PersistBackend<ChangeSet> + Send + Sync + 'static,
    network: Network,
    genesis_hash: BlockHash
) -> Result<Self, NewOrLoadError>

Either loads Wallet from persistence, or initializes it if it does not exist (with a custom genesis hash).

This method will fail if the loaded Wallet has different parameters to those provided. This is like Wallet::new_or_load with an additional genesis_hash parameter. This is diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html index 6ad6c202bd..84de06daa0 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html @@ -1,4 +1,4 @@ -bdk_bitcoind_rpc - Rust

Crate bdk_bitcoind_rpc

source Â·

Expand description

This crate is used for emitting blockchain data from the bitcoind RPC interface. It does not +bdk_bitcoind_rpc - Rust

Crate bdk_bitcoind_rpc

source Â·

Expand description

This crate is used for emitting blockchain data from the bitcoind RPC interface. It does not use the wallet RPC API, so this crate can be used with wallet-disabled Bitcoin Core nodes.

Emitter is the main structure which sources blockchain data from [bitcoincore_rpc::Client].

To only get block updates (exclude mempool transactions), the caller can use diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html index bda9482605..ee29db7bb2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html @@ -1,4 +1,4 @@ -bdk_chain - Rust

Crate bdk_chain

source Â·

Expand description

This crate is a collection of core structures for Bitcoin Dev Kit.

+bdk_chain - Rust

Crate bdk_chain

source Â·

Expand description

This crate is a collection of core structures for Bitcoin Dev Kit.

The goal of this crate is to give wallets the mechanisms needed to:

Figure out what data they need to fetch.

bdk_electrum - Rust

Crate bdk_electrum

source Â·

Expand description

This crate is used for updating structures of [bdk_chain] with data from an Electrum server.

+bdk_electrum - Rust

Crate bdk_electrum

source Â·

Expand description

This crate is used for updating structures of [bdk_chain] with data from an Electrum server.

The two primary methods are ElectrumExt::sync and ElectrumExt::full_scan. In most cases ElectrumExt::sync is used to sync the transaction histories of scripts that the application cares about, for example the scripts for all the receive addresses of a Walletâs keychain that it diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html index 9cfd92e9cb..7a163c163a 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html @@ -1,4 +1,4 @@ -bdk_esplora - Rust

Crate bdk_esplora

source Â·

Expand description

BDK Esplora

+bdk_esplora - Rust

Crate bdk_esplora

source Â·

Expand description

BDK Esplora

BDK Esplora extends esplora-client to update bdk_chain structures from an Esplora server.

Usage

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html index 2eb97803e4..154c3cd371 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html @@ -1,6 +1,6 @@ -bdk_file_store - Rust

Crate bdk_file_store

source Â·

Expand description

BDK File Store

+bdk_file_store - Rust

Crate bdk_file_store

source Â·

Expand description

BDK File Store

This is a simple append-only flat file implementation of -PersistBackend.

+PersistBackend.

The main structure is Store, which can be used with bdkâs Wallet to persist wallet data into a flat file.

Structs

AggregateChangesetsError

Error type for Store::aggregate_changesets.

EntryIter

Iterator over entries in a file store.

Store

Persists an append-only list of changesets (C) to a single file.

Enums

FileError

Error that occurs due to problems encountered with the file.

IterError

Error type for EntryIter.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html index d6a1cc9e94..4aba297caf 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.Store.html @@ -29,7 +29,7 @@ changeset will be written over the erroring entry (or the end of the file if non changeset.

The truncation is to avoid the possibility of having a valid but inconsistent changeset directly after the appended changeset.

-

Trait ImplementationsÂ§

impl<C> Debug for Store<C>where
C: Sync + Send + Debug,

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

Formats the value using the given formatter. Read more

impl<C> PersistBackend<C> for Store<C>where
C: Append + Serialize + DeserializeOwned + Send + Sync,

fn write_changes(&mut self, changeset: &C) -> Result<()>

Writes a changeset to the persistence backend. Read more

fn load_from_persistence(&mut self) -> Result<Option<C>>

Return the aggregate changeset C from persistence.

Auto Trait ImplementationsÂ§

impl<C> UnwindSafe for Store<C>where
C: UnwindSafe,

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

+

Trait ImplementationsÂ§

impl<C> Debug for Store<C>where
C: Sync + Send + Debug,

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

Formats the value using the given formatter. Read more

impl<C> PersistBackend<C> for Store<C>where
C: Append + Serialize + DeserializeOwned + Send + Sync,

fn write_changes(&mut self, changeset: &C) -> Result<()>

Writes a changeset to the persistence backend. Read more

fn load_from_persistence(&mut self) -> Result<Option<C>>

Return the aggregate changeset C from persistence.

Auto Trait ImplementationsÂ§

impl<C> RefUnwindSafe for Store<C>where
C: RefUnwindSafe,

impl<C> Send for Store<C>

impl<C> Sync for Store<C>

impl<C> Unpin for Store<C>where
C: Unpin,

impl<C> UnwindSafe for Store<C>where
C: UnwindSafe,

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.