From: github-actions Date: Thu, 18 Jan 2024 11:27:31 +0000 (+0000) Subject: Publish autogenerated nightly docs X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/struct.EncoderStringWriter.html?a=commitdiff_plain;h=99ecb6736744da9582f5f060ca3356bfe2370049;p=bitcoindevkit.org Publish autogenerated nightly docs --- diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html index 03c25d48bd..6c631fc480 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html @@ -1,5 +1,5 @@ bdk - Rust

Crate bdk

source ·
Expand description
+ logo

Crate bdk

Crate bdk

source ·
Expand description

BDK

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html index 2b86ed61d2..8b32f11e2f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html @@ -1,4 +1,4 @@ -bdk_bitcoind_rpc - Rust

Crate bdk_bitcoind_rpc

source ·
Expand description

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

Crate bdk_bitcoind_rpc

source ·
Expand description

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

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

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

Crate bdk_chain

source ·
Expand description

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

+bdk_chain - Rust

Crate bdk_chain

source ·
Expand description

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

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

  1. Figure out what data they need to fetch.
    2. 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 fba4b6e5b6..df1718c9f1 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 ElectrumExt::sync and ElectrumExt::full_scan. In most cases ElectrumExt::sync is used to sync the transaction histories of scripts that the application cares about, for example the scripts for all the receive addresses of a Wallet’s keychain that it diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html index 4c0780dd3c..4437348f60 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/index.html @@ -1,4 +1,4 @@ -bdk_esplora - Rust

    Crate bdk_esplora

    source ·
    Expand description

    BDK Esplora

    +bdk_esplora - Rust

    Crate bdk_esplora

    source ·
    Expand description

    BDK Esplora

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

    Usage

    @@ -27,6 +27,6 @@ has shown a user. bdk_chain -via a new TxGraph to be appended to any existing TxGraph data.

    +via a new TxGraph to be appended to any existing TxGraph data.

    Refer to example_esplora for a complete example.

    Re-exports

    pub use esplora_client;

    Traits

    EsploraAsyncExt
    Trait to extend the functionality of [esplora_client::AsyncClient].
    EsploraExt
    Trait to extend the functionality of [esplora_client::BlockingClient].
    \ No newline at end of file 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 274745fcc5..0632ffca01 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 @@ -1,31 +1,31 @@ EsploraAsyncExt in bdk_esplora - Rust

    Trait bdk_esplora::EsploraAsyncExt

    source · 
    pub trait EsploraAsyncExt {
-    fn update_local_chain<'life0, 'async_trait>(
            &'life0 self,
            local_tip: CheckPoint,
            request_heights: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = u32> + Send> + Send
        ) -> Pin<Box<dyn Future<Output = Result<Update, Error>> + Send + 'async_trait>>
        where
            Self: 'async_trait,
            'life0: 'async_trait    ;
-    fn full_scan<'life0, 'async_trait, K>(
            &'life0 self,
            keychain_spks: BTreeMap<K, impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = (u32, ScriptBuf)> + Send> + Send>,
            stop_gap: usize,
            parallel_requests: usize
        ) -> Pin<Box<dyn Future<Output = Result<(TxGraph<ConfirmationTimeHeightAnchor>, BTreeMap<K, u32>), Error>> + Send + 'async_trait>>
        where
            K: 'async_trait + Ord + Clone + Send,
            Self: 'async_trait,
            'life0: 'async_trait    ;
-    fn sync<'life0, 'async_trait>(
            &'life0 self,
            misc_spks: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = ScriptBuf> + Send> + Send,
            txids: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = Txid> + Send> + Send,
            outpoints: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = OutPoint> + Send> + Send,
            parallel_requests: usize
        ) -> Pin<Box<dyn Future<Output = Result<TxGraph<ConfirmationTimeHeightAnchor>, Error>> + Send + 'async_trait>>
        where
            Self: 'async_trait,
            'life0: 'async_trait    ;
+    fn update_local_chain<'life0, 'async_trait>(
            &'life0 self,
            local_tip: CheckPoint,
            request_heights: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = u32> + Send> + Send
        ) -> Pin<Box<dyn Future<Output = Result<Update, Error>> + Send + 'async_trait>>
        where
            Self: 'async_trait,
            'life0: 'async_trait    ;
+    fn full_scan<'life0, 'async_trait, K>(
            &'life0 self,
            keychain_spks: BTreeMap<K, impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = (u32, ScriptBuf)> + Send> + Send>,
            stop_gap: usize,
            parallel_requests: usize
        ) -> Pin<Box<dyn Future<Output = Result<(TxGraph<ConfirmationTimeHeightAnchor>, BTreeMap<K, u32>), Error>> + Send + 'async_trait>>
        where
            K: 'async_trait + Ord + Clone + Send,
            Self: 'async_trait,
            'life0: 'async_trait    ;
+    fn sync<'life0, 'async_trait>(
            &'life0 self,
            misc_spks: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = ScriptBuf> + Send> + Send,
            txids: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = Txid> + Send> + Send,
            outpoints: impl 'async_trait + IntoIterator<IntoIter = impl 'async_trait + Iterator<Item = OutPoint> + Send> + Send,
            parallel_requests: usize
        ) -> Pin<Box<dyn Future<Output = Result<TxGraph<ConfirmationTimeHeightAnchor>, Error>> + Send + 'async_trait>>
        where
            Self: 'async_trait,
            'life0: 'async_trait    ;
 }
    Expand description

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

    Refer to crate-level documentation for more.

    -

    Required Methods§

    Prepare an LocalChain update with blocks fetched from Esplora.

    +

    Required Methods§

    Prepare an LocalChain update with blocks fetched from Esplora.

      -
    • local_tip is the previous tip of LocalChain::tip.
      • +
    • local_tip is the previous tip of LocalChain::tip.
    • request_heights is the block heights that we are interested in fetching from Esplora.
    -

    The result of this method can be applied to LocalChain::apply_update.

    -

    Full scan the keychain scripts specified with the blockchain (via an Esplora client) and -returns a TxGraph and a map of last active indices.

    +

    The result of this method can be applied to LocalChain::apply_update.

    +

    Full scan the keychain scripts specified with the blockchain (via an Esplora client) and +returns a [TxGraph] and a map of last active indices.

    • keychain_spks: keychains that we want to scan transactions for

    The full scan for each keychain stops after a gap of stop_gap script pubkeys with no associated transactions. parallel_requests specifies the max number of HTTP requests to make in parallel.

    -

    Sync a set of scripts with the blockchain (via an Esplora client) for the data -specified and return a TxGraph.

    +

    Sync a set of scripts with the blockchain (via an Esplora client) for the data +specified and return a [TxGraph].

    • misc_spks: scripts that we want to sync transactions for
      • -
    • txids: transactions for which we want updated ConfirmationTimeHeightAnchors
      • +
    • txids: transactions for which we want updated [ConfirmationTimeHeightAnchor]s
    • outpoints: transactions associated with these outpoints (residing, spending) that we want to include in the update

    If the scripts to sync are unknown, such as when restoring or importing a keychain that may include scripts that have been used, use full_scan with the keychain.

    -

    Implementations on Foreign Types§

    Implementors§

    \ No newline at end of file +

    Implementations on Foreign Types§

    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 d551bf7144..045f193f0c 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,31 +1,31 @@ EsploraExt in bdk_esplora - Rust

    Trait bdk_esplora::EsploraExt

    source · 
    pub trait EsploraExt {
-    fn update_local_chain(
            &self,
            local_tip: CheckPoint,
            request_heights: impl IntoIterator<Item = u32>
        ) -> Result<Update, Error>;
-    fn full_scan<K: Ord + Clone>(
            &self,
            keychain_spks: BTreeMap<K, impl IntoIterator<Item = (u32, ScriptBuf)>>,
            stop_gap: usize,
            parallel_requests: usize
        ) -> Result<(TxGraph<ConfirmationTimeHeightAnchor>, BTreeMap<K, u32>), Error>;
-    fn sync(
            &self,
            misc_spks: impl IntoIterator<Item = ScriptBuf>,
            txids: impl IntoIterator<Item = Txid>,
            outpoints: impl IntoIterator<Item = OutPoint>,
            parallel_requests: usize
        ) -> Result<TxGraph<ConfirmationTimeHeightAnchor>, Error>;
+    fn update_local_chain(
            &self,
            local_tip: CheckPoint,
            request_heights: impl IntoIterator<Item = u32>
        ) -> Result<Update, Error>;
+    fn full_scan<K: Ord + Clone>(
            &self,
            keychain_spks: BTreeMap<K, impl IntoIterator<Item = (u32, ScriptBuf)>>,
            stop_gap: usize,
            parallel_requests: usize
        ) -> Result<(TxGraph<ConfirmationTimeHeightAnchor>, BTreeMap<K, u32>), Error>;
+    fn sync(
            &self,
            misc_spks: impl IntoIterator<Item = ScriptBuf>,
            txids: impl IntoIterator<Item = Txid>,
            outpoints: impl IntoIterator<Item = OutPoint>,
            parallel_requests: usize
        ) -> Result<TxGraph<ConfirmationTimeHeightAnchor>, Error>;
 }
    Expand description

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

    Refer to crate-level documentation for more.

    -

    Required Methods§

    Prepare an LocalChain update with blocks fetched from Esplora.

    +

    Required Methods§

    Prepare an LocalChain update with blocks fetched from Esplora.

      -
    • local_tip is the previous tip of LocalChain::tip.
      • +
    • local_tip is the previous tip of LocalChain::tip.
    • request_heights is the block heights that we are interested in fetching from Esplora.
    -

    The result of this method can be applied to LocalChain::apply_update.

    -

    Full scan the keychain scripts specified with the blockchain (via an Esplora client) and -returns a TxGraph and a map of last active indices.

    +

    The result of this method can be applied to LocalChain::apply_update.

    +

    Full scan the keychain scripts specified with the blockchain (via an Esplora client) and +returns a [TxGraph] and a map of last active indices.

    • keychain_spks: keychains that we want to scan transactions for

    The full scan for each keychain stops after a gap of stop_gap script pubkeys with no associated transactions. parallel_requests specifies the max number of HTTP requests to make in parallel.

    -

    Sync a set of scripts with the blockchain (via an Esplora client) for the data -specified and return a TxGraph.

    +

    Sync a set of scripts with the blockchain (via an Esplora client) for the data +specified and return a [TxGraph].

    • misc_spks: scripts that we want to sync transactions for
      • -
    • txids: transactions for which we want updated ConfirmationTimeHeightAnchors
      • +
    • txids: transactions for which we want updated [ConfirmationTimeHeightAnchor]s
    • outpoints: transactions associated with these outpoints (residing, spending) that we want to include in the update

    If the scripts to sync are unknown, such as when restoring or importing a keychain that may include scripts that have been used, use full_scan with the keychain.

    -

    Implementations on Foreign Types§

    Implementors§

    \ No newline at end of file +

    Implementations on Foreign Types§

    Implementors§

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html index 874437eba2..a3708321a2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/index.html @@ -1,4 +1,4 @@ -bdk_file_store - Rust

Crate bdk_file_store

source ·
Expand description

BDK File Store

+bdk_file_store - Rust

Crate bdk_file_store

source ·
Expand description

BDK File Store

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

The main structure is Store, which can be used with bdk’s diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/index.html index 95f156eb26..f569b7755d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/index.html @@ -1,5 +1,5 @@ bdk_hwi - Rust

Crate bdk_hwi

source ·
Expand description

HWI Signer

-

This crate contains HWISigner, an implementation of a TransactionSigner to be +

This crate contains HWISigner, an implementation of a TransactionSigner to be used with hardware wallets.

let mut devices = HWIClient::enumerate()?;
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/struct.HWISigner.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/struct.HWISigner.html
index 4b048d0ca2..9ed341ed66 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/struct.HWISigner.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_hwi/struct.HWISigner.html
@@ -1,7 +1,7 @@
 HWISigner in bdk_hwi - Rust
Struct bdk_hwi::HWISigner
source · 
pub struct HWISigner { /* private fields */ }
Expand description
Custom signer for Hardware Wallets

 
This ignores sign_options and leaves the decisions up to the hardware wallet.

 
Implementations§
Create a instance from the specified device and chain

-
Trait Implementations§
Formats the value using the given formatter. Read more
Return the [SignerId] for this signer Read more
Return the secret key for the signer Read more
Sign all the inputs of the psbt
Auto Trait Implementations§
Blanket Implementations§
Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Returns the argument unchanged.

+
Trait Implementations§
Formats the value using the given formatter. Read more
Return the SignerId for this signer Read more
Return the secret key for the signer Read more
Sign all the inputs of the psbt
Auto Trait Implementations§
Blanket Implementations§
Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Returns the argument unchanged.

 
Calls U::from(self).

 
That is, this conversion is whatever the implementation of
 From<T> for U chooses to do.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_esplora/type.ChangeSet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_esplora/type.ChangeSet.html
index b687a49edc..37ae0540c0 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_esplora/type.ChangeSet.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_esplora/type.ChangeSet.html
@@ -1 +1 @@
-ChangeSet in example_esplora - Rust
Type Definition example_esplora::ChangeSet
source · 
pub(crate) type ChangeSet = (ChangeSet, ChangeSet<ConfirmationTimeHeightAnchor, ChangeSet<Keychain>>);

\ No newline at end of file
+ChangeSet in example_esplora - Rust
Type Definition example_esplora::ChangeSet
source · 
pub(crate) type ChangeSet = (ChangeSet, ChangeSet<ConfirmationTimeHeightAnchor, ChangeSet<Keychain>>);

\ No newline at end of file
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 9718299c0d..8659dfcc0d 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 @@
-Rustdoc help
Rustdoc help
Back

\ No newline at end of file
+Rustdoc help
Rustdoc help
Back

\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.SignerCommon.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.SignerCommon.js
index fb042c4512..b008aa7a79 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.SignerCommon.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.SignerCommon.js
@@ -1,4 +1,4 @@
 (function() {var implementors = {
 "bdk":[],
-"bdk_hwi":[["impl SignerCommon for HWISigner"]]
+"bdk_hwi":[["impl SignerCommon for HWISigner"]]
 };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/implementors/bdk/wallet/signer/trait.TransactionSigner.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.TransactionSigner.js
index 68919d45f8..ea6c96cd81 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.TransactionSigner.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/implementors/bdk/wallet/signer/trait.TransactionSigner.js
@@ -1,4 +1,4 @@
 (function() {var implementors = {
 "bdk":[],
-"bdk_hwi":[["impl TransactionSigner for HWISigner"]]
+"bdk_hwi":[["impl TransactionSigner for HWISigner"]]
 };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/settings.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html
index 049190cef7..84a9af5c58 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 @@
-Rustdoc settings
Rustdoc settings
Back

\ No newline at end of file
+Rustdoc settings
Rustdoc settings
Back

\ No newline at end of file