Skip to content

Commit 1d1c07f

Browse files
author
github-actions
committed
Publish autogenerated nightly docs
1 parent e2ee3f3 commit 1d1c07f

File tree

90 files changed

+295
-353
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+295
-353
lines changed

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/enum.ChainPosition.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/enum.ConfirmationTime.html

Lines changed: 9 additions & 9 deletions
Large diffs are not rendered by default.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
<li>Data persistence agnostic – <code>bdk_chain</code> does not care where you cache on-chain data, what you
1515
cache or how you retrieve it from persistent storage.</li>
1616
</ol>
17-
</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 rusqlite_crate as rusqlite;</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_crate</a> as serde;</code></div></li><li><div class="item-name" id="reexport.IndexedTxGraph"><code>pub use indexed_tx_graph::<a class="struct" href="indexed_tx_graph/struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph">IndexedTxGraph</a>;</code></div></li><li><div class="item-name" id="reexport.spk_txout"><code>pub use indexer::<a class="mod" href="indexer/spk_txout/index.html" title="mod bdk_chain::indexer::spk_txout">spk_txout</a>;</code></div></li><li><div class="item-name" id="reexport.Indexer"><code>pub use indexer::<a class="trait" href="indexer/trait.Indexer.html" title="trait bdk_chain::indexer::Indexer">Indexer</a>;</code></div></li><li><div class="item-name" id="reexport.TxGraph"><code>pub use tx_graph::<a class="struct" href="tx_graph/struct.TxGraph.html" title="struct bdk_chain::tx_graph::TxGraph">TxGraph</a>;</code></div></li><li><div class="item-name" id="reexport.keychain_txout"><code>pub use indexer::<a class="mod" href="indexer/keychain_txout/index.html" title="mod bdk_chain::indexer::keychain_txout">keychain_txout</a>;</code></div></li><li><div class="item-name" id="reexport.bitcoin"><code>pub use bitcoin;</code></div></li><li><div class="item-name" id="reexport.miniscript"><code>pub use miniscript;</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="indexed_tx_graph/index.html" title="mod bdk_chain::indexed_tx_graph">indexed_tx_graph</a></div><div class="desc docblock-short">Contains the <a href="indexed_tx_graph/struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> and associated types. Refer to the
17+
</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 rusqlite;</code></div></li><li><div class="item-name"><code>pub extern crate <a class="mod" href="https://docs.rs/serde/1.0.205/serde/index.html" title="mod serde">serde</a>;</code></div></li><li><div class="item-name" id="reexport.IndexedTxGraph"><code>pub use indexed_tx_graph::<a class="struct" href="indexed_tx_graph/struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph">IndexedTxGraph</a>;</code></div></li><li><div class="item-name" id="reexport.spk_txout"><code>pub use indexer::<a class="mod" href="indexer/spk_txout/index.html" title="mod bdk_chain::indexer::spk_txout">spk_txout</a>;</code></div></li><li><div class="item-name" id="reexport.Indexer"><code>pub use indexer::<a class="trait" href="indexer/trait.Indexer.html" title="trait bdk_chain::indexer::Indexer">Indexer</a>;</code></div></li><li><div class="item-name" id="reexport.TxGraph"><code>pub use tx_graph::<a class="struct" href="tx_graph/struct.TxGraph.html" title="struct bdk_chain::tx_graph::TxGraph">TxGraph</a>;</code></div></li><li><div class="item-name" id="reexport.keychain_txout"><code>pub use indexer::<a class="mod" href="indexer/keychain_txout/index.html" title="mod bdk_chain::indexer::keychain_txout">keychain_txout</a>;</code></div></li><li><div class="item-name" id="reexport.bitcoin"><code>pub use bitcoin;</code></div></li><li><div class="item-name" id="reexport.miniscript"><code>pub use miniscript;</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="indexed_tx_graph/index.html" title="mod bdk_chain::indexed_tx_graph">indexed_tx_graph</a></div><div class="desc docblock-short">Contains the <a href="indexed_tx_graph/struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> and associated types. Refer to the
1818
<a href="indexed_tx_graph/struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> documentation for more.</div></li><li><div class="item-name"><a class="mod" href="indexer/index.html" title="mod bdk_chain::indexer">indexer</a></div><div class="desc docblock-short"><a href="indexer/trait.Indexer.html" title="trait bdk_chain::indexer::Indexer"><code>Indexer</code></a> provides utilities for indexing transaction data.</div></li><li><div class="item-name"><a class="mod" href="local_chain/index.html" title="mod bdk_chain::local_chain">local_chain</a></div><div class="desc docblock-short">The <a href="local_chain/struct.LocalChain.html" title="struct bdk_chain::local_chain::LocalChain"><code>LocalChain</code></a> is a local implementation of <a href="trait.ChainOracle.html" title="trait bdk_chain::ChainOracle"><code>ChainOracle</code></a>.</div></li><li><div class="item-name"><a class="mod" href="rusqlite_impl/index.html" title="mod bdk_chain::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="spk_client/index.html" title="mod bdk_chain::spk_client">spk_client</a></div><div class="desc docblock-short">Helper types for spk-based blockchain clients.</div></li><li><div class="item-name"><a class="mod" href="tx_graph/index.html" title="mod bdk_chain::tx_graph">tx_graph</a></div><div class="desc docblock-short">Module for structures that store and traverse transactions.</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.Balance.html" title="struct bdk_chain::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.BlockId.html" title="struct bdk_chain::BlockId">BlockId</a></div><div class="desc docblock-short">A reference to a block in the canonical chain.</div></li><li><div class="item-name"><a class="struct" href="struct.ConfirmationBlockTime.html" title="struct bdk_chain::ConfirmationBlockTime">ConfirmationBlockTime</a></div><div class="desc docblock-short">An <a href="trait.Anchor.html" title="trait bdk_chain::Anchor"><code>Anchor</code></a> implementation that also records the exact confirmation time of the transaction.</div></li><li><div class="item-name"><a class="struct" href="struct.DescriptorId.html" title="struct bdk_chain::DescriptorId">DescriptorId</a></div><div class="desc docblock-short">Represents the unique ID of a descriptor.</div></li><li><div class="item-name"><a class="struct" href="struct.FullTxOut.html" title="struct bdk_chain::FullTxOut">FullTxOut</a></div><div class="desc docblock-short">A <code>TxOut</code> with as much data as we can retrieve about it</div></li><li><div class="item-name"><a class="struct" href="struct.Impl.html" title="struct bdk_chain::Impl">Impl</a></div><div class="desc docblock-short">A wrapper that we use to impl remote traits for types in our crate or dependency crates.</div></li><li><div class="item-name"><a class="struct" href="struct.Persisted.html" title="struct bdk_chain::Persisted">Persisted</a></div><div class="desc docblock-short">Represents a persisted <code>T</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.SpkIterator.html" title="struct bdk_chain::SpkIterator">SpkIterator</a></div><div class="desc docblock-short">An iterator for derived script pubkeys.</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.ChainPosition.html" title="enum bdk_chain::ChainPosition">ChainPosition</a></div><div class="desc docblock-short">Represents the observed position of some chain data.</div></li><li><div class="item-name"><a class="enum" href="enum.ConfirmationTime.html" title="enum bdk_chain::ConfirmationTime">ConfirmationTime</a></div><div class="desc docblock-short">Block height and timestamp at which a transaction is confirmed.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.BIP32_MAX_INDEX.html" title="constant bdk_chain::BIP32_MAX_INDEX">BIP32_MAX_INDEX</a></div><div class="desc docblock-short">Maximum <a href="https://bips.xyz/32">BIP32</a> derivation index.</div></li><li><div class="item-name"><a class="constant" href="constant.COINBASE_MATURITY.html" title="constant bdk_chain::COINBASE_MATURITY">COINBASE_MATURITY</a></div><div class="desc docblock-short">How many confirmations are needed f or a coinbase output to be spent.</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.Anchor.html" title="trait bdk_chain::Anchor">Anchor</a></div><div class="desc docblock-short">Trait that “anchors” blockchain data to a specific block of height and hash.</div></li><li><div class="item-name"><a class="trait" href="trait.AnchorFromBlockPosition.html" title="trait bdk_chain::AnchorFromBlockPosition">AnchorFromBlockPosition</a></div><div class="desc docblock-short">An <a href="trait.Anchor.html" title="trait bdk_chain::Anchor"><code>Anchor</code></a> that can be constructed from a given block, block height and transaction position
1919
within the block.</div></li><li><div class="item-name"><a class="trait" href="trait.ChainOracle.html" title="trait bdk_chain::ChainOracle">ChainOracle</a></div><div class="desc docblock-short">Represents a service that tracks the blockchain.</div></li><li><div class="item-name"><a class="trait" href="trait.DescriptorExt.html" title="trait bdk_chain::DescriptorExt">DescriptorExt</a></div><div class="desc docblock-short">A trait to extend the functionality of a miniscript descriptor.</div></li><li><div class="item-name"><a class="trait" href="trait.Merge.html" title="trait bdk_chain::Merge">Merge</a></div><div class="desc docblock-short">Trait that makes an object mergeable.</div></li><li><div class="item-name"><a class="trait" href="trait.PersistAsyncWith.html" title="trait bdk_chain::PersistAsyncWith">PersistAsyncWith</a></div><div class="desc docblock-short">Trait that persists the type with an async <code>Db</code>.</div></li><li><div class="item-name"><a class="trait" href="trait.PersistWith.html" title="trait bdk_chain::PersistWith">PersistWith</a></div><div class="desc docblock-short">Trait that persists the type with <code>Db</code>.</div></li><li><div class="item-name"><a class="trait" href="trait.Staged.html" title="trait bdk_chain::Staged">Staged</a></div><div class="desc docblock-short">Represents a type that contains staged changes.</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.Indexed.html" title="type bdk_chain::Indexed">Indexed</a></div><div class="desc docblock-short">A tuple of keychain index and <code>T</code> representing the indexed value.</div></li><li><div class="item-name"><a class="type" href="type.KeychainIndexed.html" title="type bdk_chain::KeychainIndexed">KeychainIndexed</a></div><div class="desc docblock-short">A tuple of keychain <code>K</code>, derivation index (<code>u32</code>) and a <code>T</code> associated with them.</div></li></ul></section></div></main></body></html>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<!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="Contains the `IndexedTxGraph` and associated types. Refer to the `IndexedTxGraph` documentation for more."><title>bdk_chain::indexed_tx_graph - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bdk_chain" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bdk_chain/index.html">bdk_chain</a><span class="version">0.17.0</span></h2></div><h2 class="location"><a href="#">Module indexed_tx_graph</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate bdk_chain</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">bdk_chain</a>::<wbr><a class="mod" href="#">indexed_tx_graph</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/bdk_chain/indexed_tx_graph.rs.html#1-362">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contains the <a href="struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> and associated types. Refer to the
1+
<!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="Contains the `IndexedTxGraph` and associated types. Refer to the `IndexedTxGraph` documentation for more."><title>bdk_chain::indexed_tx_graph - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bdk_chain" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bdk_chain/index.html">bdk_chain</a><span class="version">0.17.0</span></h2></div><h2 class="location"><a href="#">Module indexed_tx_graph</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate bdk_chain</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">bdk_chain</a>::<wbr><a class="mod" href="#">indexed_tx_graph</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/bdk_chain/indexed_tx_graph.rs.html#1-359">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contains the <a href="struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> and associated types. Refer to the
22
<a href="struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> documentation for more.</p>
33
</div></details><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.ChangeSet.html" title="struct bdk_chain::indexed_tx_graph::ChangeSet">ChangeSet</a></div><div class="desc docblock-short">Represents changes to an <a href="struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph">IndexedTxGraph</a></div><div class="desc docblock-short">The <a href="struct.IndexedTxGraph.html" title="struct bdk_chain::indexed_tx_graph::IndexedTxGraph"><code>IndexedTxGraph</code></a> combines a <a href="../tx_graph/struct.TxGraph.html" title="struct bdk_chain::tx_graph::TxGraph"><code>TxGraph</code></a> and an <a href="../indexer/trait.Indexer.html" title="trait bdk_chain::indexer::Indexer"><code>Indexer</code></a> implementation.</div></li></ul></section></div></main></body></html>

0 commit comments

Comments
 (0)