Skip to content

Commit cee2493

Browse files
author
github-actions
committed
Publish autogenerated nightly docs
1 parent 10962ec commit cee2493

File tree

7 files changed

+12
-14
lines changed

7 files changed

+12
-14
lines changed

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ <h2 id="contribution"><a class="doc-anchor" href="#contribution">§</a>Contribut
182182
submitted for inclusion in the work by you, as defined in the Apache-2.0
183183
license, shall be dual licensed as above, without any additional terms or
184184
conditions.</p>
185-
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><code>pub extern crate bitcoin;</code></div></li><li><div class="item-name"><code>pub extern crate bdk_chain as chain;</code></div></li><li><div class="item-name"><code>pub extern crate bdk_file_store as file_store;</code></div></li><li><div class="item-name"><code>pub extern crate miniscript;</code></div></li><li><div class="item-name"><code>pub extern crate <a class="mod" href="https://docs.rs/serde/1.0.204/serde/index.html" title="mod serde">serde</a>;</code></div></li><li><div class="item-name"><code>pub extern crate <a class="mod" href="https://docs.rs/serde_json/1.0.121/serde_json/index.html" title="mod serde_json">serde_json</a>;</code></div></li><li><div class="item-name" id="reexport.template"><code>pub use descriptor::<a class="mod" href="descriptor/template/index.html" title="mod bdk_wallet::descriptor::template">template</a>;</code></div></li><li><div class="item-name" id="reexport.HdKeyPaths"><code>pub use descriptor::<a class="type" href="descriptor/type.HdKeyPaths.html" title="type bdk_wallet::descriptor::HdKeyPaths">HdKeyPaths</a>;</code></div></li><li><div class="item-name" id="reexport.signer"><code>pub use <a class="mod" href="signer/index.html" title="mod bdk_wallet::signer">signer</a>;</code></div></li><li><div class="item-name" id="reexport.rusqlite"><code>pub use bdk_chain::rusqlite;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="coin_selection/index.html" title="mod bdk_wallet::coin_selection">coin_selection</a></div><div class="desc docblock-short">Coin selection</div></li><li><div class="item-name"><a class="mod" href="descriptor/index.html" title="mod bdk_wallet::descriptor">descriptor</a></div><div class="desc docblock-short">Descriptors</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod bdk_wallet::error">error</a></div><div class="desc docblock-short">Errors that can be thrown by the <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a></div></li><li><div class="item-name"><a class="mod" href="export/index.html" title="mod bdk_wallet::export">export</a></div><div class="desc docblock-short">Wallet export</div></li><li><div class="item-name"><a class="mod" href="keys/index.html" title="mod bdk_wallet::keys">keys</a></div><div class="desc docblock-short">Key formats</div></li><li><div class="item-name"><a class="mod" href="psbt/index.html" title="mod bdk_wallet::psbt">psbt</a></div><div class="desc docblock-short">Additional functions on the <code>rust-bitcoin</code> <code>Psbt</code> structure.</div></li><li><div class="item-name"><a class="mod" href="rusqlite_impl/index.html" title="mod bdk_wallet::rusqlite_impl">rusqlite_impl</a></div><div class="desc docblock-short">Module for stuff</div></li><li><div class="item-name"><a class="mod" href="signer/index.html" title="mod bdk_wallet::signer">signer</a></div><div class="desc docblock-short">Generalized signers</div></li><li><div class="item-name"><a class="mod" href="tx_builder/index.html" title="mod bdk_wallet::tx_builder">tx_builder</a></div><div class="desc docblock-short">Transaction builder</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.descriptor.html" title="macro bdk_wallet::descriptor">descriptor</a></div><div class="desc docblock-short">Macro to write full descriptors with code</div></li><li><div class="item-name"><a class="macro" href="macro.fragment.html" title="macro bdk_wallet::fragment">fragment</a></div><div class="desc docblock-short">Macro to write descriptor fragments with code</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AddressInfo.html" title="struct bdk_wallet::AddressInfo">AddressInfo</a></div><div class="desc docblock-short">A derived address and the index it was found at.
185+
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><code>pub extern crate bitcoin;</code></div></li><li><div class="item-name"><code>pub extern crate bdk_chain as chain;</code></div></li><li><div class="item-name"><code>pub extern crate <a class="mod" href="../bdk_file_store/index.html" title="mod bdk_file_store">bdk_file_store</a> as file_store;</code></div></li><li><div class="item-name"><code>pub extern crate miniscript;</code></div></li><li><div class="item-name"><code>pub extern crate <a class="mod" href="https://docs.rs/serde/1.0.204/serde/index.html" title="mod serde">serde</a>;</code></div></li><li><div class="item-name"><code>pub extern crate <a class="mod" href="https://docs.rs/serde_json/1.0.121/serde_json/index.html" title="mod serde_json">serde_json</a>;</code></div></li><li><div class="item-name" id="reexport.template"><code>pub use descriptor::<a class="mod" href="descriptor/template/index.html" title="mod bdk_wallet::descriptor::template">template</a>;</code></div></li><li><div class="item-name" id="reexport.HdKeyPaths"><code>pub use descriptor::<a class="type" href="descriptor/type.HdKeyPaths.html" title="type bdk_wallet::descriptor::HdKeyPaths">HdKeyPaths</a>;</code></div></li><li><div class="item-name" id="reexport.signer"><code>pub use <a class="mod" href="signer/index.html" title="mod bdk_wallet::signer">signer</a>;</code></div></li><li><div class="item-name" id="reexport.rusqlite"><code>pub use bdk_chain::rusqlite;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="coin_selection/index.html" title="mod bdk_wallet::coin_selection">coin_selection</a></div><div class="desc docblock-short">Coin selection</div></li><li><div class="item-name"><a class="mod" href="descriptor/index.html" title="mod bdk_wallet::descriptor">descriptor</a></div><div class="desc docblock-short">Descriptors</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod bdk_wallet::error">error</a></div><div class="desc docblock-short">Errors that can be thrown by the <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a></div></li><li><div class="item-name"><a class="mod" href="export/index.html" title="mod bdk_wallet::export">export</a></div><div class="desc docblock-short">Wallet export</div></li><li><div class="item-name"><a class="mod" href="keys/index.html" title="mod bdk_wallet::keys">keys</a></div><div class="desc docblock-short">Key formats</div></li><li><div class="item-name"><a class="mod" href="psbt/index.html" title="mod bdk_wallet::psbt">psbt</a></div><div class="desc docblock-short">Additional functions on the <code>rust-bitcoin</code> <code>Psbt</code> structure.</div></li><li><div class="item-name"><a class="mod" href="rusqlite_impl/index.html" title="mod bdk_wallet::rusqlite_impl">rusqlite_impl</a></div><div class="desc docblock-short">Module for stuff</div></li><li><div class="item-name"><a class="mod" href="signer/index.html" title="mod bdk_wallet::signer">signer</a></div><div class="desc docblock-short">Generalized signers</div></li><li><div class="item-name"><a class="mod" href="tx_builder/index.html" title="mod bdk_wallet::tx_builder">tx_builder</a></div><div class="desc docblock-short">Transaction builder</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.descriptor.html" title="macro bdk_wallet::descriptor">descriptor</a></div><div class="desc docblock-short">Macro to write full descriptors with code</div></li><li><div class="item-name"><a class="macro" href="macro.fragment.html" title="macro bdk_wallet::fragment">fragment</a></div><div class="desc docblock-short">Macro to write descriptor fragments with code</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AddressInfo.html" title="struct bdk_wallet::AddressInfo">AddressInfo</a></div><div class="desc docblock-short">A derived address and the index it was found at.
186186
For convenience this automatically derefs to <code>Address</code></div></li><li><div class="item-name"><a class="struct" href="struct.Balance.html" title="struct bdk_wallet::Balance">Balance</a></div><div class="desc docblock-short">Balance, differentiated into various categories.</div></li><li><div class="item-name"><a class="struct" href="struct.ChangeSet.html" title="struct bdk_wallet::ChangeSet">ChangeSet</a></div><div class="desc docblock-short">A changeset for <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.CreateParams.html" title="struct bdk_wallet::CreateParams">CreateParams</a></div><div class="desc docblock-short">Parameters for <a href="struct.Wallet.html#method.create" title="associated function bdk_wallet::Wallet::create"><code>Wallet::create</code></a> or [<code>PersistedWallet::create</code>].</div></li><li><div class="item-name"><a class="struct" href="struct.LoadParams.html" title="struct bdk_wallet::LoadParams">LoadParams</a></div><div class="desc docblock-short">Parameters for <a href="struct.Wallet.html#method.load" title="associated function bdk_wallet::Wallet::load"><code>Wallet::load</code></a> or [<code>PersistedWallet::load</code>].</div></li><li><div class="item-name"><a class="struct" href="struct.LocalOutput.html" title="struct bdk_wallet::LocalOutput">LocalOutput</a></div><div class="desc docblock-short">An unspent output owned by a <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.SignOptions.html" title="struct bdk_wallet::SignOptions">SignOptions</a></div><div class="desc docblock-short">Options for a software signer</div></li><li><div class="item-name"><a class="struct" href="struct.TxBuilder.html" title="struct bdk_wallet::TxBuilder">TxBuilder</a></div><div class="desc docblock-short">A transaction builder</div></li><li><div class="item-name"><a class="struct" href="struct.Update.html" title="struct bdk_wallet::Update">Update</a></div><div class="desc docblock-short">An update to <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Wallet.html" title="struct bdk_wallet::Wallet">Wallet</a></div><div class="desc docblock-short">A Bitcoin wallet</div></li><li><div class="item-name"><a class="struct" href="struct.WeightedUtxo.html" title="struct bdk_wallet::WeightedUtxo">WeightedUtxo</a></div><div class="desc docblock-short">A <a href="enum.Utxo.html" title="enum bdk_wallet::Utxo"><code>Utxo</code></a> with its <code>satisfaction_weight</code>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AddForeignUtxoError.html" title="enum bdk_wallet::AddForeignUtxoError">AddForeignUtxoError</a></div><div class="desc docblock-short">Error returned from <a href="tx_builder/struct.TxBuilder.html#method.add_foreign_utxo" title="method bdk_wallet::tx_builder::TxBuilder::add_foreign_utxo"><code>TxBuilder::add_foreign_utxo</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.AddUtxoError.html" title="enum bdk_wallet::AddUtxoError">AddUtxoError</a></div><div class="desc docblock-short">Error returned from <a href="tx_builder/struct.TxBuilder.html#method.add_utxo" title="method bdk_wallet::tx_builder::TxBuilder::add_utxo"><code>TxBuilder::add_utxo</code></a> and <a href="tx_builder/struct.TxBuilder.html#method.add_utxos" title="method bdk_wallet::tx_builder::TxBuilder::add_utxos"><code>TxBuilder::add_utxos</code></a></div></li><li><div class="item-name"><a class="enum" href="enum.ApplyBlockError.html" title="enum bdk_wallet::ApplyBlockError">ApplyBlockError</a></div><div class="desc docblock-short">An error that may occur when applying a block to <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.ChangeSpendPolicy.html" title="enum bdk_wallet::ChangeSpendPolicy">ChangeSpendPolicy</a></div><div class="desc docblock-short">Policy regarding the use of change outputs when creating a transaction</div></li><li><div class="item-name"><a class="enum" href="enum.CreateWithPersistError.html" title="enum bdk_wallet::CreateWithPersistError">CreateWithPersistError</a></div><div class="desc docblock-short">Error type for [<code>PersistedWallet::create</code>].</div></li><li><div class="item-name"><a class="enum" href="enum.KeychainKind.html" title="enum bdk_wallet::KeychainKind">KeychainKind</a></div><div class="desc docblock-short">Types of keychains</div></li><li><div class="item-name"><a class="enum" href="enum.LoadError.html" title="enum bdk_wallet::LoadError">LoadError</a></div><div class="desc docblock-short">The error type when loading a <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a> from a <a href="struct.ChangeSet.html" title="struct bdk_wallet::ChangeSet"><code>ChangeSet</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.LoadMismatch.html" title="enum bdk_wallet::LoadMismatch">LoadMismatch</a></div><div class="desc docblock-short">Represents a mismatch with what is loaded and what is expected from <a href="struct.LoadParams.html" title="struct bdk_wallet::LoadParams"><code>LoadParams</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.LoadWithPersistError.html" title="enum bdk_wallet::LoadWithPersistError">LoadWithPersistError</a></div><div class="desc docblock-short">Error type for [<code>PersistedWallet::load</code>].</div></li><li><div class="item-name"><a class="enum" href="enum.TxOrdering.html" title="enum bdk_wallet::TxOrdering">TxOrdering</a></div><div class="desc docblock-short">Ordering of the transaction’s inputs and outputs</div></li><li><div class="item-name"><a class="enum" href="enum.Utxo.html" title="enum bdk_wallet::Utxo">Utxo</a></div><div class="desc docblock-short">An unspent transaction output (UTXO).</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.IsDust.html" title="trait bdk_wallet::IsDust">IsDust</a></div><div class="desc docblock-short">Trait to check if a value is below the dust limit.
187187
We are performing dust value calculation for a given script public key using rust-bitcoin to
188188
keep it compatible with network dust rate</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.version.html" title="fn bdk_wallet::version">version</a></div><div class="desc docblock-short">Get the version of <a href="index.html" title="mod bdk_wallet"><code>bdk_wallet</code></a> at runtime.</div></li><li><div class="item-name"><a class="fn" href="fn.wallet_name_from_descriptor.html" title="fn bdk_wallet::wallet_name_from_descriptor">wallet_name_from_descriptor</a></div><div class="desc docblock-short">Deterministically generate a unique name given the descriptors defining the wallet</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.PersistedWallet.html" title="type bdk_wallet::PersistedWallet">PersistedWallet</a></div><div class="desc docblock-short">Represents a persisted wallet.</div></li></ul></section></div></main></body></html>

0 commit comments

Comments
 (0)