Struct bdk_coin_select :: SelectionError Copy item path

impl Clone for SelectionError

fn clone(&self) -> SelectionError

Returns a copy of the value. Read more

1.0.0 Â· sourceÂ§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for SelectionError

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

Formats the value using the given formatter. Read more

impl Display for SelectionError

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

Formats the value using the given formatter. Read more

impl Error for SelectionError

1.30.0 Â· sourceÂ§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more

1.0.0 Â· sourceÂ§

fn description(&self) -> &str

ðDeprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

ðDeprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

ð¬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports. Read more

Auto Trait ImplementationsÂ§

impl Freeze for SelectionError

impl RefUnwindSafe for SelectionError

impl UnwindSafe for SelectionError

Blanket ImplementationsÂ§

impl<T> Any for T

where +SelectionError in bdk_coin_select - Rust

Struct bdk_coin_select::SelectionError

source Â·

pub struct SelectionError { /* private fields */ }

Trait ImplementationsÂ§

impl Clone for SelectionError

fn clone(&self) -> SelectionError

Returns a copy of the value. Read more

1.0.0 Â· sourceÂ§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for SelectionError

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

Formats the value using the given formatter. Read more

impl Display for SelectionError

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

Formats the value using the given formatter. Read more

impl Error for SelectionError

1.30.0 Â· sourceÂ§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more

1.0.0 Â· sourceÂ§

fn description(&self) -> &str

ðDeprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

ðDeprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

ð¬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports. Read more

Auto Trait ImplementationsÂ§

impl Freeze for SelectionError

impl RefUnwindSafe for SelectionError

impl UnwindSafe for SelectionError

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/index.html index 868f8fed17..09c3960e57 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/index.html @@ -1,4 +1,4 @@ -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 BdkElectrumClient::sync and BdkElectrumClient::full_scan. In most cases BdkElectrumClient::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 @@ -6,7 +6,7 @@ has shown a user. bdk_chain].

+bdk_chain.

Refer to example_electrum for a complete example.

-

Re-exportsÂ§

pub use bdk_chain;
pub use electrum_client;

StructsÂ§

BdkElectrumClient
Wrapper around an [electrum_client::ElectrumApi] which includes an internal in-memory +

Re-exportsÂ§

pub use bdk_chain;
pub use electrum_client;

StructsÂ§

BdkElectrumClient
Wrapper around an [electrum_client::ElectrumApi] which includes an internal in-memory transaction cache to avoid re-fetching already downloaded transactions.
ElectrumFullScanResult
The result of BdkElectrumClient::full_scan.
ElectrumSyncResult
The result of BdkElectrumClient::sync.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.BdkElectrumClient.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.BdkElectrumClient.html index 67a8f827fd..3f8de38535 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.BdkElectrumClient.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.BdkElectrumClient.html @@ -5,7 +5,7 @@ transaction cache to avoid re-fetching already downloaded transactions.

FieldsÂ§

Â§inner: E

The internal [electrum_client::ElectrumApi]

ImplementationsÂ§

impl<E: ElectrumApi> BdkElectrumClient<E>

pub fn new(client: E) -> Self

Creates a new bdk client from a [electrum_client::ElectrumApi]

-

pub fn populate_tx_cache<A>(&self, tx_graph: impl AsRef<TxGraph<A>>)

Inserts transactions into the transaction cache so that the client will not fetch these +

pub fn populate_tx_cache<A>(&self, tx_graph: impl AsRef<TxGraph<A>>)

Inserts transactions into the transaction cache so that the client will not fetch these transactions.

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

Fetch transaction of given txid.

If it hits the cache it will return the cached version and avoid making the request.

@@ -13,15 +13,15 @@ transactions.

This is a re-export of [ElectrumApi::transaction_broadcast].

pub fn full_scan<K: Ord + Clone>( &self, - request: FullScanRequest<K>, + request: FullScanRequest<K>, stop_gap: usize, batch_size: usize, fetch_prev_txouts: bool ) -> Result<ElectrumFullScanResult<K>, Error>

Full scan the keychain scripts specified with the blockchain (via an Electrum client) and -returns updates for [bdk_chain] data structures.

+returns updates for bdk_chain data structures.

request: struct with data required to perform a spk-based blockchain client full scan, -see [FullScanRequest]

FullScanRequest

stop_gap: the full scan for each keychain stops after a gap of script pubkeys with no associated transactions
batch_size: specifies the max number of script pubkeys to request for in a single batch @@ -30,14 +30,14 @@ request

pub fn sync( &self, - request: SyncRequest, + request: SyncRequest, batch_size: usize, fetch_prev_txouts: bool ) -> Result<ElectrumSyncResult, Error>

Sync a set of scripts with the blockchain (via an Electrum client) for the data specified -and returns updates for [bdk_chain] data structures.

+and returns updates for bdk_chain data structures.

request: struct with data required to perform a spk-based blockchain client sync, -see [SyncRequest]

SyncRequest

batch_size: specifies the max number of script pubkeys to request for in a single batch request
fetch_prev_txouts: specifies whether or not we want previous TxOuts for fee diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.ElectrumFullScanResult.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.ElectrumFullScanResult.html index 8c5c8511af..da3560e155 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.ElectrumFullScanResult.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_electrum/struct.ElectrumFullScanResult.html @@ -1,13 +1,13 @@ ElectrumFullScanResult in bdk_electrum - Rust
bdk_electrum0.15.0
ElectrumFullScanResult
Methods
- with_confirmation_height_anchor
- with_confirmation_time_height_anchor
Auto Trait Implementations
Blanket Implementations
In crate bdk_electrum
Struct bdk_electrum::ElectrumFullScanResult
source Â·
```
pub struct ElectrumFullScanResult<K>(/* private fields */);
```
Expand description
The result of BdkElectrumClient::full_scan.
-
This can be transformed into a [FullScanResult] with either [ConfirmationHeightAnchor] or -[ConfirmationTimeHeightAnchor] anchor types.
+
This can be transformed into a FullScanResult with either ConfirmationHeightAnchor or +ConfirmationTimeHeightAnchor anchor types.

ImplementationsÂ§
source Â§
impl<K> ElectrumFullScanResult<K>
source
pub fn with_confirmation_height_anchor( self -) -> FullScanResult<K, ConfirmationHeightAnchor>
Return [FullScanResult] with [ConfirmationHeightAnchor].
+) -> FullScanResult<K, ConfirmationHeightAnchor>

Return FullScanResult with ConfirmationHeightAnchor.