From 1241773fcf1fd72ac9b25fc0f7efd9c996017061 Mon Sep 17 00:00:00 2001 From: github-actions Date: Sat, 28 Sep 2024 01:00:56 +0000 Subject: [PATCH] Publish autogenerated nightly docs --- .../bdk_bitcoind_rpc/struct.BlockEvent.html | 12 ++++---- .../bdk_bitcoind_rpc/struct.Emitter.html | 2 +- .../bdk/nightly/latest/bdk_esplora/index.html | 4 +-- .../bdk_esplora/trait.EsploraAsyncExt.html | 28 +++++++++---------- .../latest/bdk_esplora/trait.EsploraExt.html | 26 ++++++++--------- .../latest/bdk_file_store/struct.Store.html | 2 +- .../bdk_wallet/enum.FileStoreError.html | 6 ++-- .../bdk/nightly/latest/bdk_wallet/index.html | 4 +-- .../latest/bdk_wallet/struct.ChangeSet.html | 22 +++++++-------- .../bdk_wallet/struct.PersistedWallet.html | 24 ++++++++-------- .../latest/bdk_wallet/struct.Update.html | 10 +++---- .../latest/bdk_wallet/struct.Wallet.html | 26 ++++++++--------- .../bdk_wallet/trait.WalletPersister.html | 4 +-- .../latest/bdk_wallet/type.WalletTx.html | 10 +++---- .../constant.CHANNEL_BOUND.html | 2 +- .../enum.Emission.html | 4 +-- .../example_bitcoind_rpc_polling/index.html | 2 +- .../latest/example_cli/fn.create_tx.html | 4 +-- .../example_cli/fn.handle_commands.html | 2 +- .../latest/example_cli/fn.planned_utxos.html | 4 +-- .../latest/example_cli/struct.ChangeInfo.html | 4 +-- .../latest/example_cli/struct.ChangeSet.html | 14 +++++----- .../latest/example_cli/struct.Init.html | 4 +-- .../example_cli/type.KeychainTxGraph.html | 6 ++-- .../latest/example_cli/type.PlanUtxo.html | 2 +- .../example_wallet_rpc/enum.Emission.html | 4 +-- .../docs-rs/bdk/nightly/latest/help.html | 2 +- .../docs-rs/bdk/nightly/latest/settings.html | 2 +- .../src/bdk_wallet/wallet/changeset.rs.html | 2 -- .../bdk_chain/tx_data_traits/trait.Merge.js | 2 +- .../trait.impl/core/convert/trait.AsRef.js | 2 +- .../trait.impl/core/convert/trait.From.js | 2 +- .../indexed_tx_graph/struct.IndexedTxGraph.js | 2 +- 33 files changed, 122 insertions(+), 124 deletions(-) diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.BlockEvent.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.BlockEvent.html index a47fa8a1a7..2264ac2597 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.BlockEvent.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.BlockEvent.html @@ -1,18 +1,18 @@ BlockEvent in bdk_bitcoind_rpc - Rust

Struct bdk_bitcoind_rpc::BlockEvent

source ·
pub struct BlockEvent<B> {
     pub block: B,
-    pub checkpoint: CheckPoint,
+    pub checkpoint: CheckPoint,
 }
Expand description

A newly emitted block from Emitter.

Fields§

§block: B

Either a full [Block] or [Header] of the new block.

-
§checkpoint: CheckPoint

The checkpoint of the new block.

-

A [CheckPoint] is a node of a linked list of [BlockId]s. This checkpoint is linked to -all [BlockId]s originally passed in Emitter::new as well as emitted blocks since then. +

§checkpoint: CheckPoint

The checkpoint of the new block.

+

A CheckPoint is a node of a linked list of BlockIds. This checkpoint is linked to +all BlockIds originally passed in Emitter::new as well as emitted blocks since then. These blocks are guaranteed to be of the same chain.

This is important as BDK structures require block-to-apply to be connected with another block in the original chain.

Implementations§

source§

impl<B> BlockEvent<B>

source

pub fn block_height(&self) -> u32

The block height of this new block.

source

pub fn block_hash(&self) -> BlockHash

The block hash of this new block.

-
source

pub fn connected_to(&self) -> BlockId

The [BlockId] of a previous block that this block connects to.

-

This either returns a [BlockId] of a previously emitted block or from the chain we started +

source

pub fn connected_to(&self) -> BlockId

The BlockId of a previous block that this block connects to.

+

This either returns a BlockId of a previously emitted block or from the chain we started with (passed in as last_cp in Emitter::new).

This value is derived from BlockEvent::checkpoint.

Trait Implementations§

source§

impl<B: Debug> Debug for BlockEvent<B>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<B> Freeze for BlockEvent<B>
where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html index 50547c2c1c..9fddb5fdf0 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html @@ -1,6 +1,6 @@ Emitter in bdk_bitcoind_rpc - Rust

Struct bdk_bitcoind_rpc::Emitter

source ·
pub struct Emitter<'c, C> { /* private fields */ }
Expand description

The Emitter is used to emit data sourced from [bitcoincore_rpc::Client].

Refer to module-level documentation for more.

-

Implementations§

source§

impl<'c, C: RpcApi> Emitter<'c, C>

source

pub fn new(client: &'c C, last_cp: CheckPoint, start_height: u32) -> Self

Construct a new Emitter.

+

Implementations§

source§

impl<'c, C: RpcApi> Emitter<'c, C>

source

pub fn new(client: &'c C, last_cp: CheckPoint, start_height: u32) -> Self

Construct a new Emitter.

last_cp informs the emitter of the chain we are starting off with. This way, the emitter can start emission from a block that connects to the original chain.

start_height starts emission from a given height (if there are no conflicts with the 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 1beeadb8c5..b601a357f4 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,8 +1,8 @@ bdk_esplora - Rust

Crate bdk_esplora

source ·
Expand description

§BDK Esplora

BDK Esplora extends esplora-client (with extension traits: EsploraExt and EsploraAsyncExt) to update bdk_chain structures from an Esplora server.

-

The extension traits are primarily intended to satisfy SyncRequests with sync and -FullScanRequests with full_scan.

+

The extension traits are primarily intended to satisfy SyncRequests with sync and +FullScanRequests with full_scan.

§Usage

For blocking-only:

bdk_esplora = { version = "0.3", features = ["blocking"] }
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraAsyncExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraAsyncExt.html
index f7409093dd..c1b176b317 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraAsyncExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraAsyncExt.html
@@ -5,18 +5,18 @@
         request: R,
         stop_gap: usize,
         parallel_requests: usize
-    ) -> Pin<Box<dyn Future<Output = Result<FullScanResult<K>, Box<Error>>> + Send + 'async_trait>>
+    ) -> Pin<Box<dyn Future<Output = Result<FullScanResult<K>, Box<Error>>> + Send + 'async_trait>>
        where K: 'async_trait + Ord + Clone + Send,
-             R: 'async_trait + Into<FullScanRequest<K>> + Send,
+             R: 'async_trait + Into<FullScanRequest<K>> + Send,
              Self: 'async_trait,
              'life0: 'async_trait;
     fn sync<'life0, 'async_trait, I, R>(
         &'life0 self,
         request: R,
         parallel_requests: usize
-    ) -> Pin<Box<dyn Future<Output = Result<SyncResult, Box<Error>>> + Send + 'async_trait>>
+    ) -> Pin<Box<dyn Future<Output = Result<SyncResult, Box<Error>>> + Send + 'async_trait>>
        where I: 'async_trait + Send,
-             R: 'async_trait + Into<SyncRequest<I>> + Send,
+             R: 'async_trait + Into<SyncRequest<I>> + Send,
              Self: 'async_trait,
              'life0: 'async_trait;
 }
Expand description

Trait to extend the functionality of [esplora_client::AsyncClient].

@@ -26,14 +26,14 @@ request: R, stop_gap: usize, parallel_requests: usize -) -> Pin<Box<dyn Future<Output = Result<FullScanResult<K>, Box<Error>>> + Send + 'async_trait>>
where +) -> Pin<Box<dyn Future<Output = Result<FullScanResult<K>, Box<Error>>> + Send + 'async_trait>>
where K: 'async_trait + Ord + Clone + Send, - R: 'async_trait + Into<FullScanRequest<K>> + Send, + R: 'async_trait + Into<FullScanRequest<K>> + Send, Self: 'async_trait, 'life0: 'async_trait,

Scan keychain scripts for transactions against Esplora, returning an update that can be applied to the receiving structures.

request provides the data required to perform a script-pubkey-based full scan -(see [FullScanRequest]). The full scan for each keychain (K) stops after a gap of +(see FullScanRequest). The full scan for each keychain (K) stops after a gap of stop_gap script pubkeys with no associated transactions. parallel_requests specifies the maximum number of HTTP requests to make in parallel.

Refer to crate-level docs for more.

@@ -41,13 +41,13 @@ the maximum number of HTTP requests to make in parallel.

&'life0 self, request: R, parallel_requests: usize -) -> Pin<Box<dyn Future<Output = Result<SyncResult, Box<Error>>> + Send + 'async_trait>>
where +) -> Pin<Box<dyn Future<Output = Result<SyncResult, Box<Error>>> + Send + 'async_trait>>
where I: 'async_trait + Send, - R: 'async_trait + Into<SyncRequest<I>> + Send, + R: 'async_trait + Into<SyncRequest<I>> + Send, Self: 'async_trait, 'life0: 'async_trait,

Sync a set of scripts, txids, and/or outpoints against Esplora.

request provides the data required to perform a script-pubkey-based sync (see -[SyncRequest]). parallel_requests specifies the maximum number of HTTP requests to make +SyncRequest). parallel_requests specifies the maximum number of HTTP requests to make in parallel.

Refer to crate-level docs for more.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl EsploraAsyncExt for AsyncClient

source§

fn full_scan<'life0, 'async_trait, K, R>( @@ -55,16 +55,16 @@ in parallel.

request: R, stop_gap: usize, parallel_requests: usize -) -> Pin<Box<dyn Future<Output = Result<FullScanResult<K>, Box<Error>>> + Send + 'async_trait>>
where +) -> Pin<Box<dyn Future<Output = Result<FullScanResult<K>, Box<Error>>> + Send + 'async_trait>>
where K: 'async_trait + Ord + Clone + Send, - R: 'async_trait + Into<FullScanRequest<K>> + Send, + R: 'async_trait + Into<FullScanRequest<K>> + Send, Self: 'async_trait, 'life0: 'async_trait,

source§

fn sync<'life0, 'async_trait, I, R>( &'life0 self, request: R, parallel_requests: usize -) -> Pin<Box<dyn Future<Output = Result<SyncResult, Box<Error>>> + Send + 'async_trait>>
where +) -> Pin<Box<dyn Future<Output = Result<SyncResult, Box<Error>>> + Send + 'async_trait>>
where I: 'async_trait + Send, - R: 'async_trait + Into<SyncRequest<I>> + Send, + R: 'async_trait + Into<SyncRequest<I>> + Send, Self: 'async_trait, 'life0: 'async_trait,

Implementors§

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html index 6a8c786ed9..e0d23a585f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html @@ -1,46 +1,46 @@ EsploraExt in bdk_esplora - Rust

Trait bdk_esplora::EsploraExt

source ·
pub trait EsploraExt {
     // Required methods
-    fn full_scan<K: Ord + Clone, R: Into<FullScanRequest<K>>>(
+    fn full_scan<K: Ord + Clone, R: Into<FullScanRequest<K>>>(
         &self,
         request: R,
         stop_gap: usize,
         parallel_requests: usize
-    ) -> Result<FullScanResult<K>, Error>;
-    fn sync<I: 'static, R: Into<SyncRequest<I>>>(
+    ) -> Result<FullScanResult<K>, Error>;
+    fn sync<I: 'static, R: Into<SyncRequest<I>>>(
         &self,
         request: R,
         parallel_requests: usize
-    ) -> Result<SyncResult, Error>;
+    ) -> Result<SyncResult, Error>;
 }
Expand description

Trait to extend the functionality of [esplora_client::BlockingClient].

Refer to crate-level documentation for more.

-

Required Methods§

source

fn full_scan<K: Ord + Clone, R: Into<FullScanRequest<K>>>( +

Required Methods§

source

fn full_scan<K: Ord + Clone, R: Into<FullScanRequest<K>>>( &self, request: R, stop_gap: usize, parallel_requests: usize -) -> Result<FullScanResult<K>, Error>

Scan keychain scripts for transactions against Esplora, returning an update that can be +) -> Result<FullScanResult<K>, Error>

Scan keychain scripts for transactions against Esplora, returning an update that can be applied to the receiving structures.

request provides the data required to perform a script-pubkey-based full scan -(see [FullScanRequest]). The full scan for each keychain (K) stops after a gap of +(see FullScanRequest). The full scan for each keychain (K) stops after a gap of stop_gap script pubkeys with no associated transactions. parallel_requests specifies the maximum number of HTTP requests to make in parallel.

Refer to crate-level docs for more.

-
source

fn sync<I: 'static, R: Into<SyncRequest<I>>>( +

source

fn sync<I: 'static, R: Into<SyncRequest<I>>>( &self, request: R, parallel_requests: usize -) -> Result<SyncResult, Error>

Sync a set of scripts, txids, and/or outpoints against Esplora.

+) -> Result<SyncResult, Error>

Sync a set of scripts, txids, and/or outpoints against Esplora.

request provides the data required to perform a script-pubkey-based sync (see -[SyncRequest]). parallel_requests specifies the maximum number of HTTP requests to make +SyncRequest). parallel_requests specifies the maximum number of HTTP requests to make in parallel.

Refer to crate-level docs for more.

-

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl EsploraExt for BlockingClient

source§

fn full_scan<K: Ord + Clone, R: Into<FullScanRequest<K>>>( +

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl EsploraExt for BlockingClient

source§

fn full_scan<K: Ord + Clone, R: Into<FullScanRequest<K>>>( &self, request: R, stop_gap: usize, parallel_requests: usize -) -> Result<FullScanResult<K>, Error>

source§

fn sync<I: 'static, R: Into<SyncRequest<I>>>( +) -> Result<FullScanResult<K>, Error>

source§

fn sync<I: 'static, R: Into<SyncRequest<I>>>( &self, request: R, parallel_requests: usize -) -> Result<SyncResult, Error>

Implementors§

\ No newline at end of file +) -> Result<SyncResult, Error>

Implementors§

\ 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 323a43c6e4..34cfa45502 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 @@ -1,7 +1,7 @@ Store in bdk_file_store - Rust

Struct bdk_file_store::Store

source ·
pub struct Store<C>
where C: Sync + Send,
{ /* private fields */ }
Expand description

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

Implementations§

source§

impl<C> Store<C>
where - C: Merge + Serialize + DeserializeOwned + Send + Sync,

source

pub fn create_new<P>(magic: &[u8], file_path: P) -> Result<Self, FileError>

source

pub fn create_new<P>(magic: &[u8], file_path: P) -> Result<Self, FileError>
where P: AsRef<Path>,

Create a new Store file in write-only mode; error if the file exists.

magic is the prefixed bytes to write to the new file. This will be checked when opening the Store in the future with open.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html index e505f7ca22..5589543e7e 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html @@ -1,8 +1,8 @@ FileStoreError in bdk_wallet - Rust

Enum bdk_wallet::FileStoreError

source ·
pub enum FileStoreError {
-    Load(AggregateChangesetsError<ChangeSet>),
+    Load(AggregateChangesetsError<ChangeSet>),
     Write(Error),
-}
Expand description

Error for bdk_file_store’s implementation of WalletPersister.

-

Variants§

§

Load(AggregateChangesetsError<ChangeSet>)

Error when loading from the store.

+}
Expand description

Error for [bdk_file_store]’s implementation of WalletPersister.

+

Variants§

§

Load(AggregateChangesetsError<ChangeSet>)

Error when loading from the store.

§

Write(Error)

Error when writing to the store.

Trait Implementations§

source§

impl Debug for FileStoreError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for FileStoreError

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for FileStoreError

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()
1.0.0 · source§

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

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

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§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html index 2a81563ac5..fdcce0fe6b 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html @@ -184,7 +184,7 @@ that the Wallet can use to update its view of the chain.

submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

-

Re-exports§

  • pub extern crate bitcoin;
  • pub extern crate bdk_chain as chain;
  • pub extern crate bdk_file_store as file_store;
  • pub extern crate miniscript;
  • pub extern crate serde;
  • pub extern crate serde_json;
  • pub use descriptor::template;
  • pub use descriptor::HdKeyPaths;
  • pub use signer;
  • pub use bdk_chain::rusqlite;

Modules§

Macros§

  • Macro to write full descriptors with code
  • Macro to write descriptor fragments with code

Structs§

Enums§

Traits§

Re-exports§

  • pub extern crate bitcoin;
  • pub extern crate bdk_chain as chain;
  • pub extern crate bdk_file_store as file_store;
  • pub extern crate miniscript;
  • pub extern crate serde;
  • pub extern crate serde_json;
  • pub use descriptor::template;
  • pub use descriptor::HdKeyPaths;
  • pub use signer;
  • pub use bdk_chain::rusqlite;

Modules§

Macros§

  • Macro to write full descriptors with code
  • Macro to write descriptor fragments with code

Structs§

Enums§

Traits§

Functions§

Type Aliases§

  • A CanonicalTx managed by a Wallet.
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.ChangeSet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.ChangeSet.html index dd5fff5853..f8291168a8 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.ChangeSet.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.ChangeSet.html @@ -1,25 +1,25 @@ -ChangeSet in bdk_wallet - Rust

Struct bdk_wallet::ChangeSet

source ·
#[non_exhaustive]
pub struct ChangeSet { +ChangeSet in bdk_wallet - Rust

Struct bdk_wallet::ChangeSet

source ·
pub struct ChangeSet {
     pub descriptor: Option<Descriptor<DescriptorPublicKey>>,
     pub change_descriptor: Option<Descriptor<DescriptorPublicKey>>,
     pub network: Option<Network>,
     pub local_chain: ChangeSet,
-    pub tx_graph: ChangeSet<ConfirmationBlockTime>,
+    pub tx_graph: ChangeSet<ConfirmationBlockTime>,
     pub indexer: ChangeSet,
 }
Expand description

A changeset for Wallet.

-

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§descriptor: Option<Descriptor<DescriptorPublicKey>>

Descriptor for recipient addresses.

+

Fields§

§descriptor: Option<Descriptor<DescriptorPublicKey>>

Descriptor for recipient addresses.

§change_descriptor: Option<Descriptor<DescriptorPublicKey>>

Descriptor for change addresses.

§network: Option<Network>

Stores the network type of the transaction data.

§local_chain: ChangeSet

Changes to the LocalChain.

-
§tx_graph: ChangeSet<ConfirmationBlockTime>

Changes to TxGraph.

+
§tx_graph: ChangeSet<ConfirmationBlockTime>

Changes to TxGraph.

§indexer: ChangeSet

Changes to KeychainTxOutIndex.

-

Implementations§

source§

impl ChangeSet

source

pub const WALLET_SCHEMA_NAME: &'static str = "bdk_wallet"

Schema name for wallet.

-
source

pub const WALLET_TABLE_NAME: &'static str = "bdk_wallet"

Name of table to store wallet descriptors and network.

-
source

pub fn init_sqlite_tables(db_tx: &Transaction<'_>) -> Result<()>

Initialize sqlite tables for wallet tables.

-
source

pub fn from_sqlite(db_tx: &Transaction<'_>) -> Result<Self>

Recover a ChangeSet from sqlite database.

-
source

pub fn persist_to_sqlite(&self, db_tx: &Transaction<'_>) -> Result<()>

Persist ChangeSet to sqlite database.

+

Implementations§

source§

impl ChangeSet

source

pub const WALLET_SCHEMA_NAME: &'static str = "bdk_wallet"

Schema name for wallet.

+
source

pub const WALLET_TABLE_NAME: &'static str = "bdk_wallet"

Name of table to store wallet descriptors and network.

+
source

pub fn init_sqlite_tables(db_tx: &Transaction<'_>) -> Result<()>

Initialize sqlite tables for wallet tables.

+
source

pub fn from_sqlite(db_tx: &Transaction<'_>) -> Result<Self>

Recover a ChangeSet from sqlite database.

+
source

pub fn persist_to_sqlite(&self, db_tx: &Transaction<'_>) -> Result<()>

Persist ChangeSet to sqlite database.

Trait Implementations§

source§

impl Clone for ChangeSet

source§

fn clone(&self) -> ChangeSet

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
source§

impl Debug for ChangeSet

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ChangeSet

source§

fn default() -> ChangeSet

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for ChangeSet

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where - __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<ChangeSet<ConfirmationBlockTime>> for ChangeSet

source§

fn from(tx_graph: ChangeSet<ConfirmationBlockTime>) -> Self

Converts to this type from the input type.
source§

impl From<ChangeSet<ConfirmationBlockTime, ChangeSet>> for ChangeSet

source§

fn from(indexed_tx_graph: ChangeSet<ConfirmationBlockTime, ChangeSet>) -> Self

Converts to this type from the input type.
source§

impl From<ChangeSet> for ChangeSet

source§

fn from(chain: ChangeSet) -> Self

Converts to this type from the input type.
source§

impl From<ChangeSet> for ChangeSet

source§

fn from(indexer: ChangeSet) -> Self

Converts to this type from the input type.
source§

impl Merge for ChangeSet

source§

fn merge(&mut self, other: Self)

Merge another ChangeSet into itself.

-
source§

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.
§

fn take(&mut self) -> Option<Self>

Take the value, replacing it with the default value.
source§

impl PartialEq for ChangeSet

source§

fn eq(&self, other: &ChangeSet) -> bool

This method tests for self and other values to be equal, and is used + __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§

impl From<ChangeSet<ConfirmationBlockTime>> for ChangeSet

source§

fn from(tx_graph: ChangeSet<ConfirmationBlockTime>) -> Self

Converts to this type from the input type.
source§

impl From<ChangeSet<ConfirmationBlockTime, ChangeSet>> for ChangeSet

source§

fn from(indexed_tx_graph: ChangeSet<ConfirmationBlockTime, ChangeSet>) -> Self

Converts to this type from the input type.
source§

impl From<ChangeSet> for ChangeSet

source§

fn from(chain: ChangeSet) -> Self

Converts to this type from the input type.
source§

impl From<ChangeSet> for ChangeSet

source§

fn from(indexer: ChangeSet) -> Self

Converts to this type from the input type.
source§

impl Merge for ChangeSet

source§

fn merge(&mut self, other: Self)

Merge another ChangeSet into itself.

+
source§

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.
§

fn take(&mut self) -> Option<Self>

Take the value, replacing it with the default value.
source§

impl PartialEq for ChangeSet

source§

fn eq(&self, other: &ChangeSet) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for ChangeSet

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for ChangeSet

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.PersistedWallet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.PersistedWallet.html index 077b86638a..c5cf69b045 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.PersistedWallet.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.PersistedWallet.html @@ -104,11 +104,11 @@ by using
source

pub fn list_unspent(&self) -> impl Iterator<Item = LocalOutput> + '_

Return the list of unspent outputs of this wallet

source

pub fn list_output(&self) -> impl Iterator<Item = LocalOutput> + '_

List all relevant outputs (includes both spent and unspent, confirmed and unconfirmed).

To list only unspent outputs (UTXOs), use Wallet::list_unspent instead.

-
source

pub fn checkpoints(&self) -> CheckPointIter

Get all the checkpoints the wallet is currently storing indexed by height.

-
source

pub fn latest_checkpoint(&self) -> CheckPoint

Returns the latest checkpoint.

+
source

pub fn checkpoints(&self) -> CheckPointIter

Get all the checkpoints the wallet is currently storing indexed by height.

+
source

pub fn latest_checkpoint(&self) -> CheckPoint

Returns the latest checkpoint.

source

pub fn all_unbounded_spk_iters( &self -) -> BTreeMap<KeychainKind, impl Iterator<Item = Indexed<ScriptBuf>> + Clone>

Get unbounded script pubkey iterators for both Internal and External keychains.

+) -> BTreeMap<KeychainKind, impl Iterator<Item = Indexed<ScriptBuf>> + Clone>

Get unbounded script pubkey iterators for both Internal and External keychains.

This is intended to be used when doing a full scan of your addresses (e.g. after restoring from seed words). You pass the BTreeMap of iterators to a blockchain data source (e.g. electrum server) which will go through each address until it reaches a stop gap.

@@ -117,7 +117,7 @@ script pubkeys the wallet is storing internally).

source

pub fn unbounded_spk_iter( &self, keychain: KeychainKind -) -> impl Iterator<Item = Indexed<ScriptBuf>> + Clone

Get an unbounded script pubkey iterator for the given keychain.

+) -> impl Iterator<Item = Indexed<ScriptBuf>> + Clone

Get an unbounded script pubkey iterator for the given keychain.

See all_unbounded_spk_iters for more documentation

source

pub fn get_utxo(&self, op: OutPoint) -> Option<LocalOutput>

Returns the utxo owned by this wallet corresponding to outpoint if it exists in the wallet’s database.

@@ -206,7 +206,7 @@ the transaction was last seen in the mempool is provided. }
source

pub fn insert_checkpoint( &mut self, - block_id: BlockId + block_id: BlockId ) -> Result<bool, AlterCheckPointError>

Add a new checkpoint to the wallet’s internal view of the chain.

Returns whether anything changed with the insertion (e.g. false if checkpoint was already there).

@@ -373,10 +373,10 @@ the current time.

source

pub fn staged(&self) -> Option<&ChangeSet>

Get a reference of the staged ChangeSet that is yet to be committed (if any).

source

pub fn staged_mut(&mut self) -> Option<&mut ChangeSet>

Get a mutable reference of the staged ChangeSet that is yet to be committed (if any).

source

pub fn take_staged(&mut self) -> Option<ChangeSet>

Take the staged ChangeSet to be persisted now (if any).

-
source

pub fn tx_graph(&self) -> &TxGraph<ConfirmationBlockTime>

Get a reference to the inner [TxGraph].

+
source

pub fn tx_graph(&self) -> &TxGraph<ConfirmationBlockTime>

Get a reference to the inner [TxGraph].

source

pub fn unbroadcast_transactions( &self -) -> impl Iterator<Item = TxNode<'_, Arc<Transaction>, ConfirmationBlockTime>>

Iterate over transactions in the wallet that are unseen and unanchored likely +) -> impl Iterator<Item = TxNode<'_, Arc<Transaction>, ConfirmationBlockTime>>

Iterate over transactions in the wallet that are unseen and unanchored likely because they haven’t been broadcast.

source

pub fn spk_index(&self) -> &KeychainTxOutIndex<KeychainKind>

Get a reference to the inner [KeychainTxOutIndex].

source

pub fn local_chain(&self) -> &LocalChain

Get a reference to the inner [LocalChain].

@@ -392,7 +392,7 @@ with prev_blockhash and height-1 as the connecte &mut self, block: &Block, height: u32, - connected_to: BlockId + connected_to: BlockId ) -> Result<(), ApplyHeaderError>

Applies relevant transactions from block of height to the wallet, and connects the block to the internal chain.

The connected_to parameter informs the wallet how this block connects to the internal @@ -415,13 +415,13 @@ if you need the applied unconfirmed transactions to be reloaded after closing th See Wallet::reveal_next_address.

source

pub fn start_sync_with_revealed_spks( &self -) -> SyncRequestBuilder<(KeychainKind, u32)>

Create a partial [SyncRequest] for this wallet for all revealed spks.

+) -> SyncRequestBuilder<(KeychainKind, u32)>

Create a partial SyncRequest for this wallet for all revealed spks.

This is the first step when performing a spk-based wallet partial sync, the returned -[SyncRequest] collects all revealed script pubkeys from the wallet keychain needed to +SyncRequest collects all revealed script pubkeys from the wallet keychain needed to start a blockchain sync with a spk based blockchain client.

-
source

pub fn start_full_scan(&self) -> FullScanRequestBuilder<KeychainKind>

Create a [`FullScanRequest] for this wallet.

+
source

pub fn start_full_scan(&self) -> FullScanRequestBuilder<KeychainKind>

Create a `FullScanRequest for this wallet.

This is the first step when performing a spk-based wallet full scan, the returned -[`FullScanRequest] collects iterators for the wallet’s keychain script pub keys needed to +`FullScanRequest collects iterators for the wallet’s keychain script pub keys needed to start a blockchain full scan with a spk based blockchain client.

This operation is generally only used when importing or restoring a previously used wallet in which the list of used scripts is not known.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Update.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Update.html index 264ae7309d..2d0ea2fd88 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Update.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Update.html @@ -1,14 +1,14 @@ Update in bdk_wallet - Rust

Struct bdk_wallet::Update

source ·
pub struct Update {
     pub last_active_indices: BTreeMap<KeychainKind, u32>,
-    pub tx_update: TxUpdate<ConfirmationBlockTime>,
-    pub chain: Option<CheckPoint>,
+    pub tx_update: TxUpdate<ConfirmationBlockTime>,
+    pub chain: Option<CheckPoint>,
 }
Expand description

An update to Wallet.

It updates [KeychainTxOutIndex], [bdk_chain::TxGraph] and [local_chain::LocalChain] atomically.

Fields§

§last_active_indices: BTreeMap<KeychainKind, u32>

Contains the last active derivation indices per keychain (K), which is used to update the [KeychainTxOutIndex].

-
§tx_update: TxUpdate<ConfirmationBlockTime>

Update for the wallet’s internal [TxGraph].

-
§chain: Option<CheckPoint>

Update for the wallet’s internal LocalChain.

-

Trait Implementations§

source§

impl Clone for Update

source§

fn clone(&self) -> Update

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
source§

impl Debug for Update

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Update

source§

fn default() -> Update

Returns the “default value” for a type. Read more
source§

impl From<FullScanResult<KeychainKind>> for Update

source§

fn from(value: FullScanResult<KeychainKind>) -> Self

Converts to this type from the input type.
source§

impl From<SyncResult> for Update

source§

fn from(value: SyncResult) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +
§tx_update: TxUpdate<ConfirmationBlockTime>

Update for the wallet’s internal [TxGraph].

+
§chain: Option<CheckPoint>

Update for the wallet’s internal LocalChain.

+

Trait Implementations§

source§

impl Clone for Update

source§

fn clone(&self) -> Update

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
source§

impl Debug for Update

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Update

source§

fn default() -> Update

Returns the “default value” for a type. Read more
source§

impl From<FullScanResult<KeychainKind>> for Update

source§

fn from(value: FullScanResult<KeychainKind>) -> Self

Converts to this type from the input type.
source§

impl From<SyncResult> for Update

source§

fn from(value: SyncResult) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Wallet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Wallet.html index 887fbf73c8..8d1615a981 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Wallet.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/struct.Wallet.html @@ -147,11 +147,11 @@ by using
source

pub fn list_unspent(&self) -> impl Iterator<Item = LocalOutput> + '_

Return the list of unspent outputs of this wallet

source

pub fn list_output(&self) -> impl Iterator<Item = LocalOutput> + '_

List all relevant outputs (includes both spent and unspent, confirmed and unconfirmed).

To list only unspent outputs (UTXOs), use Wallet::list_unspent instead.

-
source

pub fn checkpoints(&self) -> CheckPointIter

Get all the checkpoints the wallet is currently storing indexed by height.

-
source

pub fn latest_checkpoint(&self) -> CheckPoint

Returns the latest checkpoint.

+
source

pub fn checkpoints(&self) -> CheckPointIter

Get all the checkpoints the wallet is currently storing indexed by height.

+
source

pub fn latest_checkpoint(&self) -> CheckPoint

Returns the latest checkpoint.

source

pub fn all_unbounded_spk_iters( &self -) -> BTreeMap<KeychainKind, impl Iterator<Item = Indexed<ScriptBuf>> + Clone>

Get unbounded script pubkey iterators for both Internal and External keychains.

+) -> BTreeMap<KeychainKind, impl Iterator<Item = Indexed<ScriptBuf>> + Clone>

Get unbounded script pubkey iterators for both Internal and External keychains.

This is intended to be used when doing a full scan of your addresses (e.g. after restoring from seed words). You pass the BTreeMap of iterators to a blockchain data source (e.g. electrum server) which will go through each address until it reaches a stop gap.

@@ -160,7 +160,7 @@ script pubkeys the wallet is storing internally).

source

pub fn unbounded_spk_iter( &self, keychain: KeychainKind -) -> impl Iterator<Item = Indexed<ScriptBuf>> + Clone

Get an unbounded script pubkey iterator for the given keychain.

+) -> impl Iterator<Item = Indexed<ScriptBuf>> + Clone

Get an unbounded script pubkey iterator for the given keychain.

See all_unbounded_spk_iters for more documentation

source

pub fn get_utxo(&self, op: OutPoint) -> Option<LocalOutput>

Returns the utxo owned by this wallet corresponding to outpoint if it exists in the wallet’s database.

@@ -249,7 +249,7 @@ the transaction was last seen in the mempool is provided. }
source

pub fn insert_checkpoint( &mut self, - block_id: BlockId + block_id: BlockId ) -> Result<bool, AlterCheckPointError>

Add a new checkpoint to the wallet’s internal view of the chain.

Returns whether anything changed with the insertion (e.g. false if checkpoint was already there).

@@ -416,10 +416,10 @@ the current time.

source

pub fn staged(&self) -> Option<&ChangeSet>

Get a reference of the staged ChangeSet that is yet to be committed (if any).

source

pub fn staged_mut(&mut self) -> Option<&mut ChangeSet>

Get a mutable reference of the staged ChangeSet that is yet to be committed (if any).

source

pub fn take_staged(&mut self) -> Option<ChangeSet>

Take the staged ChangeSet to be persisted now (if any).

-
source

pub fn tx_graph(&self) -> &TxGraph<ConfirmationBlockTime>

Get a reference to the inner [TxGraph].

+
source

pub fn tx_graph(&self) -> &TxGraph<ConfirmationBlockTime>

Get a reference to the inner [TxGraph].

source

pub fn unbroadcast_transactions( &self -) -> impl Iterator<Item = TxNode<'_, Arc<Transaction>, ConfirmationBlockTime>>

Iterate over transactions in the wallet that are unseen and unanchored likely +) -> impl Iterator<Item = TxNode<'_, Arc<Transaction>, ConfirmationBlockTime>>

Iterate over transactions in the wallet that are unseen and unanchored likely because they haven’t been broadcast.

source

pub fn spk_index(&self) -> &KeychainTxOutIndex<KeychainKind>

Get a reference to the inner [KeychainTxOutIndex].

source

pub fn local_chain(&self) -> &LocalChain

Get a reference to the inner [LocalChain].

@@ -435,7 +435,7 @@ with prev_blockhash and height-1 as the connecte &mut self, block: &Block, height: u32, - connected_to: BlockId + connected_to: BlockId ) -> Result<(), ApplyHeaderError>

Applies relevant transactions from block of height to the wallet, and connects the block to the internal chain.

The connected_to parameter informs the wallet how this block connects to the internal @@ -459,17 +459,17 @@ See

source§

impl Wallet

Methods to construct sync/full-scan requests for spk-based chain sources.

source

pub fn start_sync_with_revealed_spks( &self -) -> SyncRequestBuilder<(KeychainKind, u32)>

Create a partial [SyncRequest] for this wallet for all revealed spks.

+) -> SyncRequestBuilder<(KeychainKind, u32)>

Create a partial SyncRequest for this wallet for all revealed spks.

This is the first step when performing a spk-based wallet partial sync, the returned -[SyncRequest] collects all revealed script pubkeys from the wallet keychain needed to +SyncRequest collects all revealed script pubkeys from the wallet keychain needed to start a blockchain sync with a spk based blockchain client.

-
source

pub fn start_full_scan(&self) -> FullScanRequestBuilder<KeychainKind>

Create a [`FullScanRequest] for this wallet.

+
source

pub fn start_full_scan(&self) -> FullScanRequestBuilder<KeychainKind>

Create a `FullScanRequest for this wallet.

This is the first step when performing a spk-based wallet full scan, the returned -[`FullScanRequest] collects iterators for the wallet’s keychain script pub keys needed to +`FullScanRequest collects iterators for the wallet’s keychain script pub keys needed to start a blockchain full scan with a spk based blockchain client.

This operation is generally only used when importing or restoring a previously used wallet in which the list of used scripts is not known.

-

Trait Implementations§

source§

impl AsRef<TxGraph<ConfirmationBlockTime>> for Wallet

source§

fn as_ref(&self) -> &TxGraph<ConfirmationBlockTime>

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Debug for Wallet

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl AsRef<TxGraph<ConfirmationBlockTime>> for Wallet

source§

fn as_ref(&self) -> &TxGraph<ConfirmationBlockTime>

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Debug for Wallet

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html index bff23e7009..f4d31051b5 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html @@ -30,10 +30,10 @@ persister implementations may NOT require initialization at all (and not error). changeset: &ChangeSet ) -> Result<(), Self::Error>

Persist the given changeset to the persister.

This method can fail if the persister is not initialized.

-

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl WalletPersister for Store<ChangeSet>

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl WalletPersister for Connection

§

type Error = Error

source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

source§

fn persist( persister: &mut Self, changeset: &ChangeSet -) -> Result<(), Self::Error>

source§

impl WalletPersister for Connection

§

type Error = Error

source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

source§

fn persist( +) -> Result<(), Self::Error>

source§

impl WalletPersister for Store<ChangeSet>

§

type Error = FileStoreError

source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

source§

fn persist( persister: &mut Self, changeset: &ChangeSet ) -> Result<(), Self::Error>

source§

impl<'c> WalletPersister for Transaction<'c>

§

type Error = Error

source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

source§

fn persist( diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/type.WalletTx.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/type.WalletTx.html index 794c55dc78..6c54c75b87 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/type.WalletTx.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/type.WalletTx.html @@ -1,7 +1,7 @@ -WalletTx in bdk_wallet - Rust

Type Alias bdk_wallet::WalletTx

source ·
pub type WalletTx<'a> = CanonicalTx<'a, Arc<Transaction>, ConfirmationBlockTime>;
Expand description

A CanonicalTx managed by a Wallet.

+WalletTx in bdk_wallet - Rust

Type Alias bdk_wallet::WalletTx

source ·
pub type WalletTx<'a> = CanonicalTx<'a, Arc<Transaction>, ConfirmationBlockTime>;
Expand description

A CanonicalTx managed by a Wallet.

Aliased Type§

struct WalletTx<'a> {
-    pub chain_position: ChainPosition<&'a ConfirmationBlockTime>,
-    pub tx_node: TxNode<'a, Arc<Transaction>, ConfirmationBlockTime>,
-}

Fields§

§chain_position: ChainPosition<&'a ConfirmationBlockTime>

How the transaction is observed as (confirmed or unconfirmed).

-
§tx_node: TxNode<'a, Arc<Transaction>, ConfirmationBlockTime>

The transaction node (as part of the graph).

+ pub chain_position: ChainPosition<&'a ConfirmationBlockTime>, + pub tx_node: TxNode<'a, Arc<Transaction>, ConfirmationBlockTime>, +}

Fields§

§chain_position: ChainPosition<&'a ConfirmationBlockTime>

How the transaction is observed as (confirmed or unconfirmed).

+
§tx_node: TxNode<'a, Arc<Transaction>, ConfirmationBlockTime>

The transaction node (as part of the graph).

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/constant.CHANNEL_BOUND.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/constant.CHANNEL_BOUND.html index 65ef732aa4..70955b3189 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/constant.CHANNEL_BOUND.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/constant.CHANNEL_BOUND.html @@ -1,2 +1,2 @@ -CHANNEL_BOUND in example_bitcoind_rpc_polling - Rust

Constant example_bitcoind_rpc_polling::CHANNEL_BOUND

source ·
pub(crate) const CHANNEL_BOUND: usize = 10;
Expand description

The mpsc channel bound for emissions from [Emitter].

+CHANNEL_BOUND in example_bitcoind_rpc_polling - Rust

Constant example_bitcoind_rpc_polling::CHANNEL_BOUND

source ·
pub(crate) const CHANNEL_BOUND: usize = 10;
Expand description

The mpsc channel bound for emissions from Emitter.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/enum.Emission.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/enum.Emission.html index 49b57eb900..6f474e84c7 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/enum.Emission.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/enum.Emission.html @@ -1,8 +1,8 @@ Emission in example_bitcoind_rpc_polling - Rust

Enum example_bitcoind_rpc_polling::Emission

source ·
pub(crate) enum Emission {
-    Block(BlockEvent<Block>),
+    Block(BlockEvent<Block>),
     Mempool(Vec<(Transaction, u64)>),
     Tip(u32),
-}

Variants§

§

Block(BlockEvent<Block>)

§

Mempool(Vec<(Transaction, u64)>)

§

Tip(u32)

Trait Implementations§

source§

impl Debug for Emission

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +}

Variants§

§

Block(BlockEvent<Block>)

§

Mempool(Vec<(Transaction, u64)>)

§

Tip(u32)

Trait Implementations§

source§

impl Debug for Emission

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/index.html index a9bfb2c0f0..3c7d8101c7 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_bitcoind_rpc_polling/index.html @@ -1 +1 @@ -example_bitcoind_rpc_polling - Rust

Crate example_bitcoind_rpc_polling

source ·

Structs§

Enums§

Constants§

Functions§

\ No newline at end of file +example_bitcoind_rpc_polling - Rust

Crate example_bitcoind_rpc_polling

source ·

Structs§

Enums§

Constants§

Functions§

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.create_tx.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.create_tx.html index 5cab6b5657..ad8a6f1783 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.create_tx.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.create_tx.html @@ -1,4 +1,4 @@ -create_tx in example_cli - Rust

Function example_cli::create_tx

source ·
pub fn create_tx<O: ChainOracle>(
+create_tx in example_cli - Rust

Function example_cli::create_tx

source ·
pub fn create_tx<O: ChainOracle>(
     graph: &mut KeychainTxGraph,
     chain: &O,
     assets: &Assets,
@@ -6,4 +6,4 @@
     address: Address,
     value: u64
 ) -> Result<(Psbt, Option<ChangeInfo>)>
where - O::Error: Error + Send + Sync + 'static,
\ No newline at end of file + O::Error: Error + Send + Sync + 'static,

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html index 3fa6efc799..373693d6f9 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html @@ -1,6 +1,6 @@ handle_commands in example_cli - Rust

Function example_cli::handle_commands

source ·
pub fn handle_commands<CS: Subcommand, S: Args>(
     graph: &Mutex<KeychainTxGraph>,
-    chain: &Mutex<LocalChain>,
+    chain: &Mutex<LocalChain>,
     db: &Mutex<Store<ChangeSet>>,
     network: Network,
     broadcast: impl FnOnce(S, &Transaction) -> Result<()>,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.planned_utxos.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.planned_utxos.html
index 3888f211a4..ec454f3afe 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.planned_utxos.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.planned_utxos.html
@@ -1,5 +1,5 @@
-planned_utxos in example_cli - Rust

Function example_cli::planned_utxos

source ·
pub fn planned_utxos<O: ChainOracle>(
+planned_utxos in example_cli - Rust

Function example_cli::planned_utxos

source ·
pub fn planned_utxos<O: ChainOracle>(
     graph: &KeychainTxGraph,
     chain: &O,
     assets: &Assets
-) -> Result<Vec<PlanUtxo>, O::Error>
\ No newline at end of file +) -> Result<Vec<PlanUtxo>, O::Error>
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeInfo.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeInfo.html index cffca80e66..744aa9c031 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeInfo.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeInfo.html @@ -1,8 +1,8 @@ ChangeInfo in example_cli - Rust

Struct example_cli::ChangeInfo

source ·
pub struct ChangeInfo {
     pub change_keychain: Keychain,
-    pub indexer: ChangeSet,
+    pub indexer: ChangeSet,
     pub index: u32,
-}

Fields§

§change_keychain: Keychain§indexer: ChangeSet§index: u32

Trait Implementations§

source§

impl Debug for ChangeInfo

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +}

Fields§

§change_keychain: Keychain§indexer: ChangeSet§index: u32

Trait Implementations§

source§

impl Debug for ChangeInfo

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeSet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeSet.html index 8a4f3d468a..a1ebff08dd 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeSet.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.ChangeSet.html @@ -2,18 +2,18 @@ pub descriptor: Option<Descriptor<DescriptorPublicKey>>, pub change_descriptor: Option<Descriptor<DescriptorPublicKey>>, pub network: Option<Network>, - pub local_chain: ChangeSet, - pub tx_graph: ChangeSet<ConfirmationBlockTime>, - pub indexer: ChangeSet, + pub local_chain: ChangeSet, + pub tx_graph: ChangeSet<ConfirmationBlockTime>, + pub indexer: ChangeSet, }
Expand description

ChangeSet

Fields§

§descriptor: Option<Descriptor<DescriptorPublicKey>>

Descriptor for recipient addresses.

§change_descriptor: Option<Descriptor<DescriptorPublicKey>>

Descriptor for change addresses.

§network: Option<Network>

Stores the network type of the transaction data.

-
§local_chain: ChangeSet

Changes to the [LocalChain].

-
§tx_graph: ChangeSet<ConfirmationBlockTime>

Changes to TxGraph.

-
§indexer: ChangeSet

Changes to [KeychainTxOutIndex].

+
§local_chain: ChangeSet

Changes to the LocalChain.

+
§tx_graph: ChangeSet<ConfirmationBlockTime>

Changes to TxGraph.

+
§indexer: ChangeSet

Changes to KeychainTxOutIndex.

Trait Implementations§

source§

impl Clone for ChangeSet

source§

fn clone(&self) -> ChangeSet

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
source§

impl Debug for ChangeSet

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ChangeSet

source§

fn default() -> ChangeSet

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for ChangeSet

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where - __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Merge for ChangeSet

source§

fn merge(&mut self, other: Self)

Merge another object of the same type onto self.
source§

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.
§

fn take(&mut self) -> Option<Self>

Take the value, replacing it with the default value.
source§

impl PartialEq for ChangeSet

source§

fn eq(&self, other: &ChangeSet) -> bool

This method tests for self and other values to be equal, and is used + __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Merge for ChangeSet

source§

fn merge(&mut self, other: Self)

Merge another object of the same type onto self.
source§

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.
source§

fn take(&mut self) -> Option<Self>

Take the value, replacing it with the default value.
source§

impl PartialEq for ChangeSet

source§

fn eq(&self, other: &ChangeSet) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for ChangeSet

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for ChangeSet

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html index 340c8f980c..ba5d9d652e 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html @@ -1,13 +1,13 @@ Init in example_cli - Rust

Struct example_cli::Init

source ·
pub struct Init<CS: Subcommand, S: Args> {
     pub args: Args<CS, S>,
     pub graph: Mutex<KeychainTxGraph>,
-    pub chain: Mutex<LocalChain>,
+    pub chain: Mutex<LocalChain>,
     pub db: Mutex<Store<ChangeSet>>,
     pub network: Network,
 }
Expand description

The initial state returned by init_or_load.

Fields§

§args: Args<CS, S>

CLI args

§graph: Mutex<KeychainTxGraph>

Indexed graph

-
§chain: Mutex<LocalChain>

Local chain

+
§chain: Mutex<LocalChain>

Local chain

§db: Mutex<Store<ChangeSet>>

Database

§network: Network

Network

Auto Trait Implementations§

§

impl<CS, S> !Freeze for Init<CS, S>

§

impl<CS, S> RefUnwindSafe for Init<CS, S>
where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html index 932716eefe..69421bcb1f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html @@ -1,6 +1,6 @@ -KeychainTxGraph in example_cli - Rust

Type Alias example_cli::KeychainTxGraph

source ·
pub type KeychainTxGraph = IndexedTxGraph<ConfirmationBlockTime, KeychainTxOutIndex<Keychain>>;
Expand description

Alias for a IndexedTxGraph with specific Anchor and Indexer.

+KeychainTxGraph in example_cli - Rust

Type Alias example_cli::KeychainTxGraph

source ·
pub type KeychainTxGraph = IndexedTxGraph<ConfirmationBlockTime, KeychainTxOutIndex<Keychain>>;
Expand description

Alias for a IndexedTxGraph with specific Anchor and Indexer.

Aliased Type§

struct KeychainTxGraph {
-    pub index: KeychainTxOutIndex<Keychain>,
+    pub index: KeychainTxOutIndex<Keychain>,
     /* private fields */
-}

Fields§

§index: KeychainTxOutIndex<Keychain>

Transaction index.

+}

Fields§

§index: KeychainTxOutIndex<Keychain>

Transaction index.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html index 38d6760ed6..575a1c700d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html @@ -1 +1 @@ -PlanUtxo in example_cli - Rust

Type Alias example_cli::PlanUtxo

source ·
pub type PlanUtxo = (Plan, FullTxOut<ConfirmationBlockTime>);
\ No newline at end of file +PlanUtxo in example_cli - Rust

Type Alias example_cli::PlanUtxo

source ·
pub type PlanUtxo = (Plan, FullTxOut<ConfirmationBlockTime>);
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html index c964ee5c8d..b84a18cd3e 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html @@ -1,8 +1,8 @@ Emission in example_wallet_rpc - Rust

Enum example_wallet_rpc::Emission

source ·
pub(crate) enum Emission {
     SigTerm,
-    Block(BlockEvent<Block>),
+    Block(BlockEvent<Block>),
     Mempool(Vec<(Transaction, u64)>),
-}

Variants§

§

SigTerm

§

Block(BlockEvent<Block>)

§

Mempool(Vec<(Transaction, u64)>)

Trait Implementations§

source§

impl Debug for Emission

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +}

Variants§

§

SigTerm

§

Block(BlockEvent<Block>)

§

Mempool(Vec<(Transaction, u64)>)

Trait Implementations§

source§

impl Debug for Emission

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html index 3ed950109f..08ff977b9d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html @@ -1 +1 @@ -Help

Rustdoc help

Back
\ No newline at end of file +Help

Rustdoc help

Back
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html index 7c96d06f34..d75e264032 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html @@ -1 +1 @@ -Settings

Rustdoc settings

Back
\ No newline at end of file +Settings

Rustdoc settings

Back
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/changeset.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/changeset.rs.html index c84383dd62..a7ed0379ca 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/changeset.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/changeset.rs.html @@ -210,7 +210,6 @@ 210 211 212 -213
use bdk_chain::{
     indexed_tx_graph, keychain_txout, local_chain, tx_graph, ConfirmationBlockTime, Merge,
 };
@@ -221,7 +220,6 @@
 
 /// A changeset for [`Wallet`](crate::Wallet).
 #[derive(Default, Debug, Clone, PartialEq, serde::Deserialize, serde::Serialize)]
-#[non_exhaustive]
 pub struct ChangeSet {
     /// Descriptor for recipient addresses.
     pub descriptor: Option<Descriptor<DescriptorPublicKey>>,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/bdk_chain/tx_data_traits/trait.Merge.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/bdk_chain/tx_data_traits/trait.Merge.js
index a543ed209b..28db80f208 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/bdk_chain/tx_data_traits/trait.Merge.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/bdk_chain/tx_data_traits/trait.Merge.js
@@ -1,5 +1,5 @@
 (function() {var implementors = {
 "bdk_chain":[],
 "bdk_wallet":[["impl Merge for ChangeSet"]],
-"example_cli":[["impl Merge for ChangeSet"]]
+"example_cli":[["impl Merge for ChangeSet"]]
 };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})()
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js
index a54eb9a2cf..d4e6c798fa 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js
@@ -1,4 +1,4 @@
 (function() {var implementors = {
 "bdk_chain":[["impl AsRef<[u8; 32]> for DescriptorId"],["impl AsRef<[u8]> for DescriptorId"],["impl<A> AsRef<TxGraph<A>> for TxGraph<A>"],["impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>"]],
-"bdk_wallet":[["impl AsRef<TxGraph<ConfirmationBlockTime>> for Wallet"],["impl AsRef<[u8]> for KeychainKind"]]
+"bdk_wallet":[["impl AsRef<TxGraph<ConfirmationBlockTime>> for Wallet"],["impl AsRef<[u8]> for KeychainKind"]]
 };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})()
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js
index 466c62e3df..97d96a6e68 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js
@@ -2,6 +2,6 @@
 "bdk_chain":[["impl From<ChainPosition<ConfirmationBlockTime>> for ConfirmationTime"],["impl From<Hash> for DescriptorId"],["impl From<DescriptorId> for Hash"],["impl<A> From<ChangeSet> for ChangeSet<A, ChangeSet>"],["impl<A> From<TxGraph<A>> for TxUpdate<A>"],["impl<A, IA: Default> From<ChangeSet<A>> for ChangeSet<A, IA>"],["impl<A: Ord + Clone> From<TxUpdate<A>> for TxGraph<A>"],["impl<B: IntoIterator<Item = (u32, Option<BlockHash>)>> From<B> for ChangeSet"],["impl<T> From<T> for AnchorImpl<T>"],["impl<T> From<T> for Impl<T>"]],
 "bdk_core":[["impl From<(&u32, &BlockHash)> for BlockId"],["impl From<(u32, BlockHash)> for BlockId"],["impl From<BlockId> for (u32, BlockHash)"],["impl<I> From<SyncRequestBuilder<I>> for SyncRequest<I>"],["impl<K> From<FullScanRequestBuilder<K>> for FullScanRequest<K>"]],
 "bdk_file_store":[["impl From<Error> for FileError"],["impl From<Error> for IterError"]],
-"bdk_wallet":[["impl From<Error> for CreateTxError"],["impl From<PolicyError> for Error"],["impl From<PolicyError> for CreateTxError"],["impl From<SatisfiableItem> for Policy"],["impl From<LoadMismatch> for LoadError"],["impl From<MiniscriptPsbtError> for CreateTxError"],["impl From<KeyError> for Error"],["impl From<bool> for Satisfaction"],["impl From<InsufficientFunds> for CreateTxError"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime>> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime, ChangeSet>> for ChangeSet"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for CreateTxError"],["impl From<Error> for KeyError"],["impl From<Error> for KeyError"],["impl From<Fingerprint> for SignerId"],["impl From<FullScanResult<KeychainKind>> for Update"],["impl From<Hash> for SignerId"],["impl From<HexToBytesError> for Error"],["impl From<ParsePublicKeyError> for Error"],["impl From<SyncResult> for Update"],["impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>"],["impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>"],["impl<E> From<LoadMismatch> for LoadWithPersistError<E>"]],
+"bdk_wallet":[["impl From<Error> for CreateTxError"],["impl From<PolicyError> for Error"],["impl From<PolicyError> for CreateTxError"],["impl From<SatisfiableItem> for Policy"],["impl From<LoadMismatch> for LoadError"],["impl From<MiniscriptPsbtError> for CreateTxError"],["impl From<KeyError> for Error"],["impl From<bool> for Satisfaction"],["impl From<FullScanResult<KeychainKind>> for Update"],["impl From<SyncResult> for Update"],["impl From<InsufficientFunds> for CreateTxError"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime>> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime, ChangeSet>> for ChangeSet"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for CreateTxError"],["impl From<Error> for KeyError"],["impl From<Error> for KeyError"],["impl From<Fingerprint> for SignerId"],["impl From<Hash> for SignerId"],["impl From<HexToBytesError> for Error"],["impl From<ParsePublicKeyError> for Error"],["impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>"],["impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>"],["impl<E> From<LoadMismatch> for LoadWithPersistError<E>"]],
 "example_bitcoind_rpc_polling":[["impl From<RpcArgs> for Auth"]]
 };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})()
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js
index 900874a68a..45bc5c7fe5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js
@@ -1,3 +1,3 @@
 (function() {var type_impls = {
-"example_cli":[["
§

impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>

§

fn as_ref(&self) -> &TxGraph<A>

Converts this type into a shared reference of the (usually inferred) input type.
","AsRef>","example_cli::KeychainTxGraph"],["
§

impl<A, I> Debug for IndexedTxGraph<A, I>
where\n A: Debug,\n I: Debug,

§

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

Formats the value using the given formatter. Read more
","Debug","example_cli::KeychainTxGraph"],["
§

impl<A, I> Default for IndexedTxGraph<A, I>
where\n I: Default,

§

fn default() -> IndexedTxGraph<A, I>

Returns the “default value” for a type. Read more
","Default","example_cli::KeychainTxGraph"],["
§

impl<A, I> IndexedTxGraph<A, I>

pub fn new(index: I) -> IndexedTxGraph<A, I>

Construct a new [IndexedTxGraph] with a given index.

\n

pub fn graph(&self) -> &TxGraph<A>

Get a reference of the internal transaction graph.

\n
",0,"example_cli::KeychainTxGraph"],["
§

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor + AnchorFromBlockPosition,\n I: Indexer,\n <I as Indexer>::ChangeSet: Default + Merge,

Methods are available if the anchor (A) implements [AnchorFromBlockPosition].

\n

pub fn apply_block_relevant(\n &mut self,\n block: &Block,\n height: u32\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Batch insert all transactions of the given block of height, filtering out those that are\nirrelevant.

\n

Each inserted transaction’s anchor will be constructed from\n[AnchorFromBlockPosition::from_block_position].

\n

Relevancy is determined by the internal [Indexer::is_tx_relevant] implementation of I.\nIrrelevant transactions in txs will be ignored.

\n

pub fn apply_block(\n &mut self,\n block: Block,\n height: u32\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Batch insert all transactions of the given block of height.

\n

Each inserted transaction’s anchor will be constructed from\n[AnchorFromBlockPosition::from_block_position].

\n

To only insert relevant transactions, use apply_block_relevant instead.

\n
",0,"example_cli::KeychainTxGraph"],["
§

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,

pub fn apply_changeset(\n &mut self,\n changeset: ChangeSet<A, <I as Indexer>::ChangeSet>\n)

Applies the [ChangeSet] to the [IndexedTxGraph].

\n

pub fn initial_changeset(&self) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Determines the [ChangeSet] between self and an empty [IndexedTxGraph].

\n
",0,"example_cli::KeychainTxGraph"],["
§

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,\n <I as Indexer>::ChangeSet: Default + Merge,

pub fn apply_update(\n &mut self,\n update: TxUpdate<A>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Apply an update directly.

\n

update is a [tx_graph::TxUpdate<A>] and the resultant changes is returned as [ChangeSet].

\n

pub fn apply_update_at(\n &mut self,\n update: TxUpdate<A>,\n seen_at: Option<u64>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Apply the given update with an optional seen_at timestamp.

\n

seen_at represents when the update is seen (in unix seconds). It is used to determine the\nlast_seens for all transactions in the update which have no corresponding anchor(s). The\nlast_seen value is used internally to determine precedence of conflicting unconfirmed\ntransactions (where the transaction with the lower last_seen value is omitted from the\ncanonical history).

\n

Not setting a seen_at value means unconfirmed transactions introduced by this update will\nnot be part of the canonical history of transactions.

\n

Use apply_update to have the seen_at value automatically\nset to the current time.

\n

pub fn insert_txout(\n &mut self,\n outpoint: OutPoint,\n txout: TxOut\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Insert a floating txout of given outpoint.

\n

pub fn insert_tx<T>(&mut self, tx: T) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Insert and index a transaction into the graph.

\n

pub fn insert_anchor(\n &mut self,\n txid: Txid,\n anchor: A\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Insert an anchor for a given transaction.

\n

pub fn insert_seen_at(\n &mut self,\n txid: Txid,\n seen_at: u64\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Insert a unix timestamp of when a transaction is seen in the mempool.

\n

This is used for transaction conflict resolution in [TxGraph] where the transaction with\nthe later last-seen is prioritized.

\n

pub fn batch_insert_relevant<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, impl IntoIterator<Item = A>)>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert transactions, filtering out those that are irrelevant.

\n

Relevancy is determined by the [Indexer::is_tx_relevant] implementation of I. Irrelevant\ntransactions in txs will be ignored. txs do not need to be in topological order.

\n

pub fn batch_insert_relevant_unconfirmed<T>(\n &mut self,\n unconfirmed_txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert unconfirmed transactions, filtering out those that are irrelevant.

\n

Relevancy is determined by the internal [Indexer::is_tx_relevant] implementation of I.\nIrrelevant transactions in txs will be ignored.

\n

Items of txs are tuples containing the transaction and a last seen timestamp. The\nlast seen communicates when the transaction is last seen in the mempool which is used for\nconflict-resolution in [TxGraph] (refer to [TxGraph::insert_seen_at] for details).

\n

pub fn batch_insert_unconfirmed<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert unconfirmed transactions.

\n

Items of txs are tuples containing the transaction and a last seen timestamp. The\nlast seen communicates when the transaction is last seen in the mempool which is used for\nconflict-resolution in [TxGraph] (refer to [TxGraph::insert_seen_at] for details).

\n

To filter out irrelevant transactions, use batch_insert_relevant_unconfirmed instead.

\n
",0,"example_cli::KeychainTxGraph"]] +"example_cli":[["
source§

impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>

source§

fn as_ref(&self) -> &TxGraph<A>

Converts this type into a shared reference of the (usually inferred) input type.
","AsRef>","example_cli::KeychainTxGraph"],["
source§

impl<A, I> Debug for IndexedTxGraph<A, I>
where\n A: Debug,\n I: Debug,

source§

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

Formats the value using the given formatter. Read more
","Debug","example_cli::KeychainTxGraph"],["
source§

impl<A, I> Default for IndexedTxGraph<A, I>
where\n I: Default,

source§

fn default() -> IndexedTxGraph<A, I>

Returns the “default value” for a type. Read more
","Default","example_cli::KeychainTxGraph"],["
source§

impl<A, I> IndexedTxGraph<A, I>

Methods are available if the anchor (A) implements AnchorFromBlockPosition.

\n
source

pub fn apply_block_relevant(\n &mut self,\n block: &Block,\n height: u32\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Batch insert all transactions of the given block of height, filtering out those that are\nirrelevant.

\n

Each inserted transaction’s anchor will be constructed from\nAnchorFromBlockPosition::from_block_position.

\n

Relevancy is determined by the internal Indexer::is_tx_relevant implementation of I.\nIrrelevant transactions in txs will be ignored.

\n
source

pub fn apply_block(\n &mut self,\n block: Block,\n height: u32\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Batch insert all transactions of the given block of height.

\n

Each inserted transaction’s anchor will be constructed from\nAnchorFromBlockPosition::from_block_position.

\n

To only insert relevant transactions, use apply_block_relevant instead.

\n
",0,"example_cli::KeychainTxGraph"],["
source§

impl<A, I> IndexedTxGraph<A, I>

source

pub fn new(index: I) -> IndexedTxGraph<A, I>

Construct a new IndexedTxGraph with a given index.

\n
source

pub fn graph(&self) -> &TxGraph<A>

Get a reference of the internal transaction graph.

\n
",0,"example_cli::KeychainTxGraph"],["
source§

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,

source

pub fn apply_changeset(\n &mut self,\n changeset: ChangeSet<A, <I as Indexer>::ChangeSet>\n)

Applies the ChangeSet to the IndexedTxGraph.

\n
source

pub fn initial_changeset(&self) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Determines the ChangeSet between self and an empty IndexedTxGraph.

\n
",0,"example_cli::KeychainTxGraph"],["
source§

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,\n <I as Indexer>::ChangeSet: Default + Merge,

source

pub fn apply_update(\n &mut self,\n update: TxUpdate<A>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Apply an update directly.

\n

update is a tx_graph::TxUpdate<A> and the resultant changes is returned as ChangeSet.

\n
source

pub fn apply_update_at(\n &mut self,\n update: TxUpdate<A>,\n seen_at: Option<u64>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Apply the given update with an optional seen_at timestamp.

\n

seen_at represents when the update is seen (in unix seconds). It is used to determine the\nlast_seens for all transactions in the update which have no corresponding anchor(s). The\nlast_seen value is used internally to determine precedence of conflicting unconfirmed\ntransactions (where the transaction with the lower last_seen value is omitted from the\ncanonical history).

\n

Not setting a seen_at value means unconfirmed transactions introduced by this update will\nnot be part of the canonical history of transactions.

\n

Use apply_update to have the seen_at value automatically\nset to the current time.

\n
source

pub fn insert_txout(\n &mut self,\n outpoint: OutPoint,\n txout: TxOut\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Insert a floating txout of given outpoint.

\n
source

pub fn insert_tx<T>(&mut self, tx: T) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Insert and index a transaction into the graph.

\n
source

pub fn insert_anchor(\n &mut self,\n txid: Txid,\n anchor: A\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Insert an anchor for a given transaction.

\n
source

pub fn insert_seen_at(\n &mut self,\n txid: Txid,\n seen_at: u64\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>

Insert a unix timestamp of when a transaction is seen in the mempool.

\n

This is used for transaction conflict resolution in TxGraph where the transaction with\nthe later last-seen is prioritized.

\n
source

pub fn batch_insert_relevant<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, impl IntoIterator<Item = A>)>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert transactions, filtering out those that are irrelevant.

\n

Relevancy is determined by the Indexer::is_tx_relevant implementation of I. Irrelevant\ntransactions in txs will be ignored. txs do not need to be in topological order.

\n
source

pub fn batch_insert_relevant_unconfirmed<T>(\n &mut self,\n unconfirmed_txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert unconfirmed transactions, filtering out those that are irrelevant.

\n

Relevancy is determined by the internal Indexer::is_tx_relevant implementation of I.\nIrrelevant transactions in txs will be ignored.

\n

Items of txs are tuples containing the transaction and a last seen timestamp. The\nlast seen communicates when the transaction is last seen in the mempool which is used for\nconflict-resolution in TxGraph (refer to TxGraph::insert_seen_at for details).

\n
source

pub fn batch_insert_unconfirmed<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, <I as Indexer>::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert unconfirmed transactions.

\n

Items of txs are tuples containing the transaction and a last seen timestamp. The\nlast seen communicates when the transaction is last seen in the mempool which is used for\nconflict-resolution in TxGraph (refer to TxGraph::insert_seen_at for details).

\n

To filter out irrelevant transactions, use batch_insert_relevant_unconfirmed instead.

\n
",0,"example_cli::KeychainTxGraph"]] };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})() \ No newline at end of file -- 2.49.0