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 Sep 28, 2024
1 parent 149857a commit dd73b7d
Show file tree
Hide file tree
Showing 330 changed files with 933 additions and 868 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
<p>Implementation of BIP32 hierarchical deterministic wallets, as defined
at <a href="https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki">https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki</a>.</p>
</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.ChainCode.html" title="struct bdk_chain::bitcoin::bip32::ChainCode">ChainCode</a></div><div class="desc docblock-short">A chain code</div></li><li><div class="item-name"><a class="struct" href="struct.DerivationPath.html" title="struct bdk_chain::bitcoin::bip32::DerivationPath">DerivationPath</a></div><div class="desc docblock-short">A BIP-32 derivation path.</div></li><li><div class="item-name"><a class="struct" href="struct.DerivationPathIterator.html" title="struct bdk_chain::bitcoin::bip32::DerivationPathIterator">DerivationPathIterator</a></div><div class="desc docblock-short">An iterator over children of a <a href="struct.DerivationPath.html" title="struct bdk_chain::bitcoin::bip32::DerivationPath">DerivationPath</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Fingerprint.html" title="struct bdk_chain::bitcoin::bip32::Fingerprint">Fingerprint</a></div><div class="desc docblock-short">A fingerprint</div></li><li><div class="item-name"><a class="struct" href="struct.InvalidBase58PayloadLengthError.html" title="struct bdk_chain::bitcoin::bip32::InvalidBase58PayloadLengthError">InvalidBase58PayloadLengthError</a></div><div class="desc docblock-short">Decoded base58 data was an invalid length.</div></li><li><div class="item-name"><a class="struct" href="struct.XKeyIdentifier.html" title="struct bdk_chain::bitcoin::bip32::XKeyIdentifier">XKeyIdentifier</a></div><div class="desc docblock-short">Extended key identifier as defined in BIP-32.</div></li><li><div class="item-name"><a class="struct" href="struct.Xpriv.html" title="struct bdk_chain::bitcoin::bip32::Xpriv">Xpriv</a></div><div class="desc docblock-short">Extended private key</div></li><li><div class="item-name"><a class="struct" href="struct.Xpub.html" title="struct bdk_chain::bitcoin::bip32::Xpub">Xpub</a></div><div class="desc docblock-short">Extended public key</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.ChildNumber.html" title="enum bdk_chain::bitcoin::bip32::ChildNumber">ChildNumber</a></div><div class="desc docblock-short">A child number for a derived key</div></li><li><div class="item-name"><a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::bip32::Error">Error</a></div><div class="desc docblock-short">A BIP32 error</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.IntoDerivationPath.html" title="trait bdk_chain::bitcoin::bip32::IntoDerivationPath">IntoDerivationPath</a></div><div class="desc docblock-short">Trait that allows possibly failable conversion from a type into a
derivation path</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.ExtendendPrivKey.html" title="type bdk_chain::bitcoin::bip32::ExtendendPrivKey">ExtendendPrivKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">The old name for xpriv, extended public key.</div></li><li><div class="item-name"><a class="type" href="type.ExtendendPubKey.html" title="type bdk_chain::bitcoin::bip32::ExtendendPubKey">ExtendendPubKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">The old name for xpub, extended public key.</div></li><li><div class="item-name"><a class="type" href="type.KeySource.html" title="type bdk_chain::bitcoin::bip32::KeySource">KeySource</a></div><div class="desc docblock-short">Full information on the used extended public key: fingerprint of the
derivation path</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.ExtendedPrivKey.html" title="type bdk_chain::bitcoin::bip32::ExtendedPrivKey">ExtendedPrivKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">The old name for xpriv, extended public key.</div></li><li><div class="item-name"><a class="type" href="type.ExtendedPubKey.html" title="type bdk_chain::bitcoin::bip32::ExtendedPubKey">ExtendedPubKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">The old name for xpub, extended public key.</div></li><li><div class="item-name"><a class="type" href="type.ExtendendPrivKey.html" title="type bdk_chain::bitcoin::bip32::ExtendendPrivKey">ExtendendPrivKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">The old name for xpriv, extended public key (with a released typo in it).</div></li><li><div class="item-name"><a class="type" href="type.ExtendendPubKey.html" title="type bdk_chain::bitcoin::bip32::ExtendendPubKey">ExtendendPubKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">The old name for xpub, extended public key (with a released typo in it).</div></li><li><div class="item-name"><a class="type" href="type.KeySource.html" title="type bdk_chain::bitcoin::bip32::KeySource">KeySource</a></div><div class="desc docblock-short">Full information on the used extended public key: fingerprint of the
master extended public key and a derivation path from it.</div></li></ul></section></div></main></body></html>

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

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!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="The old name for xpriv, extended public key."><title>ExtendedPrivKey in bdk_chain::bitcoin::bip32 - 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 type"><!--[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><a class="logo-container" href="../../../bdk_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../bdk_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../bdk_chain/index.html">bdk_chain</a><span class="version">0.19.0</span></h2></div><h2 class="location"><a href="#">ExtendedPrivKey</a></h2><div class="sidebar-elems"><section><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#fields">Fields</a></h3><ul class="block field"><li><a href="#structfield.chain_code">chain_code</a></li><li><a href="#structfield.child_number">child_number</a></li><li><a href="#structfield.depth">depth</a></li><li><a href="#structfield.network">network</a></li><li><a href="#structfield.parent_fingerprint">parent_fingerprint</a></li><li><a href="#structfield.private_key">private_key</a></li></ul></section><h2><a href="index.html">In bdk_chain::bitcoin::bip32</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>Type Alias <a href="../../index.html">bdk_chain</a>::<wbr><a href="../index.html">bitcoin</a>::<wbr><a href="index.html">bip32</a>::<wbr><a class="type" href="#">ExtendedPrivKey</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub type ExtendedPrivKey = <a class="struct" href="struct.Xpriv.html" title="struct bdk_chain::bitcoin::bip32::Xpriv">Xpriv</a>;</code></pre><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.31.0: use xpriv instead</span></div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The old name for xpriv, extended public key.</p>
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct ExtendedPrivKey {
pub network: <a class="enum" href="../enum.NetworkKind.html" title="enum bdk_chain::bitcoin::NetworkKind">NetworkKind</a>,
pub depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>,
pub parent_fingerprint: <a class="struct" href="struct.Fingerprint.html" title="struct bdk_chain::bitcoin::bip32::Fingerprint">Fingerprint</a>,
pub child_number: <a class="enum" href="enum.ChildNumber.html" title="enum bdk_chain::bitcoin::bip32::ChildNumber">ChildNumber</a>,
pub private_key: <a class="struct" href="../secp256k1/struct.SecretKey.html" title="struct bdk_chain::bitcoin::secp256k1::SecretKey">SecretKey</a>,
pub chain_code: <a class="struct" href="struct.ChainCode.html" title="struct bdk_chain::bitcoin::bip32::ChainCode">ChainCode</a>,
}</code></pre><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.network" class="structfield section-header"><a href="#structfield.network" class="anchor field">§</a><code>network: <a class="enum" href="../enum.NetworkKind.html" title="enum bdk_chain::bitcoin::NetworkKind">NetworkKind</a></code></span><div class="docblock"><p>The network this key is to be used on</p>
</div><span id="structfield.depth" class="structfield section-header"><a href="#structfield.depth" class="anchor field">§</a><code>depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span><div class="docblock"><p>How many derivations this key is from the master (which is 0)</p>
</div><span id="structfield.parent_fingerprint" class="structfield section-header"><a href="#structfield.parent_fingerprint" class="anchor field">§</a><code>parent_fingerprint: <a class="struct" href="struct.Fingerprint.html" title="struct bdk_chain::bitcoin::bip32::Fingerprint">Fingerprint</a></code></span><div class="docblock"><p>Fingerprint of the parent key (0 for master)</p>
</div><span id="structfield.child_number" class="structfield section-header"><a href="#structfield.child_number" class="anchor field">§</a><code>child_number: <a class="enum" href="enum.ChildNumber.html" title="enum bdk_chain::bitcoin::bip32::ChildNumber">ChildNumber</a></code></span><div class="docblock"><p>Child number of the key used to derive from parent (0 for master)</p>
</div><span id="structfield.private_key" class="structfield section-header"><a href="#structfield.private_key" class="anchor field">§</a><code>private_key: <a class="struct" href="../secp256k1/struct.SecretKey.html" title="struct bdk_chain::bitcoin::secp256k1::SecretKey">SecretKey</a></code></span><div class="docblock"><p>Private key</p>
</div><span id="structfield.chain_code" class="structfield section-header"><a href="#structfield.chain_code" class="anchor field">§</a><code>chain_code: <a class="struct" href="struct.ChainCode.html" title="struct bdk_chain::bitcoin::bip32::ChainCode">ChainCode</a></code></span><div class="docblock"><p>Chain code</p>
</div><script src="../../../type.impl/bdk_chain/bitcoin/bip32/struct.Xpriv.js" data-self-path="bdk_chain::bitcoin::bip32::ExtendedPrivKey" async></script></section></div></main></body></html>
Loading

0 comments on commit dd73b7d

Please sign in to comment.