Skip to content

Commit

Permalink
Publish autogenerated nightly docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Dec 13, 2023
1 parent 740597d commit 18db06b
Show file tree
Hide file tree
Showing 53 changed files with 395 additions and 219 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/enum.Descriptor.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Wallet"><meta name="keywords" content="rust, rustlang, rust-lang, wallet"><title>bdk::wallet - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-64f7dca12162a801.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-94f39d4346842c1e.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-a211dbb005fb8161.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../bdk/index.html"><div class="logo-container"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../bdk/index.html"><div class="logo-container">
<img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div></a><h2 class="location"><a href="#">Module wallet</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">bdk</a>::<wbr><a class="mod" href="#">wallet</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/bdk/wallet/mod.rs.html#12-2428">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Wallet</p>
<p>This module defines the <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a> structure.</p>
<p>This module defines the <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a>.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="coin_selection/index.html" title="bdk::wallet::coin_selection mod">coin_selection</a></div><div class="item-right docblock-short">Coin selection</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="bdk::wallet::error mod">error</a></div><div class="item-right docblock-short">Errors that can be thrown by the <a href="struct.Wallet.html"><code>Wallet</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="export/index.html" title="bdk::wallet::export mod">export</a></div><div class="item-right docblock-short">Wallet export</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="signer/index.html" title="bdk::wallet::signer mod">signer</a></div><div class="item-right docblock-short">Generalized signers</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tx_builder/index.html" title="bdk::wallet::tx_builder mod">tx_builder</a></div><div class="item-right docblock-short">Transaction builder</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AddressInfo.html" title="bdk::wallet::AddressInfo struct">AddressInfo</a></div><div class="item-right docblock-short">A derived address and the index it was found at.
For convenience this automatically derefs to <code>Address</code></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Balance.html" title="bdk::wallet::Balance struct">Balance</a></div><div class="item-right docblock-short">Balance, differentiated into various categories.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ChangeSet.html" title="bdk::wallet::ChangeSet struct">ChangeSet</a></div><div class="item-right docblock-short">The changes made to a wallet by applying an <a href="struct.Update.html" title="Update"><code>Update</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Update.html" title="bdk::wallet::Update struct">Update</a></div><div class="item-right docblock-short">An update to <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Wallet.html" title="bdk::wallet::Wallet struct">Wallet</a></div><div class="item-right docblock-short">A Bitcoin wallet</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AddressIndex.html" title="bdk::wallet::AddressIndex enum">AddressIndex</a></div><div class="item-right docblock-short">The address index selection strategy to use to derived an address from the wallet’s external
descriptor. See <a href="struct.Wallet.html#method.get_address" title="Wallet::get_address"><code>Wallet::get_address</code></a>. If you’re unsure which one to use use <code>WalletIndex::New</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.InsertTxError.html" title="bdk::wallet::InsertTxError enum">InsertTxError</a></div><div class="item-right docblock-short">An error that may occur when inserting a transaction into <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LoadError.html" title="bdk::wallet::LoadError enum">LoadError</a></div><div class="item-right docblock-short">The error type when loading a <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a> from persistence.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.NewError.html" title="bdk::wallet::NewError enum">NewError</a></div><div class="item-right docblock-short">The error type when constructing a fresh <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.NewOrLoadError.html" title="bdk::wallet::NewOrLoadError enum">NewOrLoadError</a></div><div class="item-right docblock-short">Error type for when we try load a <a href="struct.Wallet.html" title="Wallet"><code>Wallet</code></a> from persistence and creating it if non-existant.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IsDust.html" title="bdk::wallet::IsDust trait">IsDust</a></div><div class="item-right docblock-short">Trait to check if a value is below the dust limit.
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@
Arc::new(custom_signer)
);
</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignOptions.html" title="bdk::wallet::signer::SignOptions struct">SignOptions</a></div><div class="item-right docblock-short">Options for a software signer</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignerOrdering.html" title="bdk::wallet::signer::SignerOrdering struct">SignerOrdering</a></div><div class="item-right docblock-short">Defines the order in which signers are called</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignerWrapper.html" title="bdk::wallet::signer::SignerWrapper struct">SignerWrapper</a></div><div class="item-right docblock-short">Wrapper structure to pair a signer with its context</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignersContainer.html" title="bdk::wallet::signer::SignersContainer struct">SignersContainer</a></div><div class="item-right docblock-short">Container for multiple signers</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignerContext.html" title="bdk::wallet::signer::SignerContext enum">SignerContext</a></div><div class="item-right docblock-short">Signing context</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignerError.html" title="bdk::wallet::signer::SignerError enum">SignerError</a></div><div class="item-right docblock-short">Signing error</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignerId.html" title="bdk::wallet::signer::SignerId enum">SignerId</a></div><div class="item-right docblock-short">Identifier of a signer in the <code>SignersContainers</code>. Used as a key to find the right signer among
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignOptions.html" title="bdk::wallet::signer::SignOptions struct">SignOptions</a></div><div class="item-right docblock-short">Options for a software signer</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignerOrdering.html" title="bdk::wallet::signer::SignerOrdering struct">SignerOrdering</a></div><div class="item-right docblock-short">Defines the order in which signers are called</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignerWrapper.html" title="bdk::wallet::signer::SignerWrapper struct">SignerWrapper</a></div><div class="item-right docblock-short">Wrapper to pair a signer with its context</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignersContainer.html" title="bdk::wallet::signer::SignersContainer struct">SignersContainer</a></div><div class="item-right docblock-short">Container for multiple signers</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignerContext.html" title="bdk::wallet::signer::SignerContext enum">SignerContext</a></div><div class="item-right docblock-short">Signing context</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignerError.html" title="bdk::wallet::signer::SignerError enum">SignerError</a></div><div class="item-right docblock-short">Signing error</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignerId.html" title="bdk::wallet::signer::SignerId enum">SignerId</a></div><div class="item-right docblock-short">Identifier of a signer in the <code>SignersContainers</code>. Used as a key to find the right signer among
multiple of them</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TapLeavesOptions.html" title="bdk::wallet::signer::TapLeavesOptions enum">TapLeavesOptions</a></div><div class="item-right docblock-short">Customize which taproot script-path leaves the signer should sign.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.InputSigner.html" title="bdk::wallet::signer::InputSigner trait">InputSigner</a></div><div class="item-right docblock-short">PSBT Input signer</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SignerCommon.html" title="bdk::wallet::signer::SignerCommon trait">SignerCommon</a></div><div class="item-right docblock-short">Common signer methods</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TransactionSigner.html" title="bdk::wallet::signer::TransactionSigner trait">TransactionSigner</a></div><div class="item-right docblock-short">PSBT signer</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="bdk" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.0-nightly (0f529f0f4 2022-12-13)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>
2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/sidebar-items.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 18db06b

Please sign in to comment.