Skip to content

Commit 82e41de

Browse files
author
github-actions
committed
Publish autogenerated nightly docs
1 parent 2f13a17 commit 82e41de

File tree

188 files changed

+1315
-956
lines changed

Some content is hidden

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

188 files changed

+1315
-956
lines changed

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/all.html

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

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/enum.Descriptor.html

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

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/enum.DescriptorPublicKey.html

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

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/enum.Legacy.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414
compilations.
1515
This does NOT recursively check if the children of the fragment are
1616
valid or not. Since the compilation proceeds in a leaf to root fashion,
17-
a recursive check is unnecessary. <a href="../keys/trait.ScriptContext.html#tymethod.check_terminal_non_malleable">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_witness" class="method trait-impl has-srclink"><a href="#method.check_witness" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#method.check_witness" class="fn">check_witness</a>&lt;Pk&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;witness: &amp;[<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>&gt;]<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Check whether the given satisfaction is valid under the ScriptContext
17+
a recursive check is unnecessary. <a href="../keys/trait.ScriptContext.html#tymethod.check_terminal_non_malleable">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_pk" class="method trait-impl has-srclink"><a href="#method.check_pk" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#tymethod.check_pk" class="fn">check_pk</a>&lt;Pk&gt;(pk: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Pk) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Each context has slightly different rules on what Pks are allowed in descriptors
18+
Legacy/Bare does not allow x_only keys
19+
Segwit does not allow uncompressed keys and x_only keys
20+
Tapscript does not allow uncompressed keys <a href="../keys/trait.ScriptContext.html#tymethod.check_pk">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_witness" class="method trait-impl has-srclink"><a href="#method.check_witness" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#method.check_witness" class="fn">check_witness</a>&lt;Pk&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;witness: &amp;[<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>&gt;]<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Check whether the given satisfaction is valid under the ScriptContext
1821
For example, segwit satisfactions may fail if the witness len is more
1922
3600 or number of stack elements are more than 100. <a href="../keys/trait.ScriptContext.html#method.check_witness">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_global_consensus_validity" class="method trait-impl has-srclink"><a href="#method.check_global_consensus_validity" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#method.check_global_consensus_validity" class="fn">check_global_consensus_validity</a>&lt;Pk&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;ms: &amp;<a class="struct" href="struct.Miniscript.html" title="struct bdk::descriptor::Miniscript">Miniscript</a>&lt;Pk, <a class="enum" href="enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Depending on script Context, some of the Terminals might not
2023
be valid under the current consensus rules.

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/enum.Segwitv0.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@
1111
compilations.
1212
This does NOT recursively check if the children of the fragment are
1313
valid or not. Since the compilation proceeds in a leaf to root fashion,
14-
a recursive check is unnecessary. <a href="../keys/trait.ScriptContext.html#tymethod.check_terminal_non_malleable">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_witness" class="method trait-impl has-srclink"><a href="#method.check_witness" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#method.check_witness" class="fn">check_witness</a>&lt;Pk&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;witness: &amp;[<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>&gt;]<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Check whether the given satisfaction is valid under the ScriptContext
14+
a recursive check is unnecessary. <a href="../keys/trait.ScriptContext.html#tymethod.check_terminal_non_malleable">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_pk" class="method trait-impl has-srclink"><a href="#method.check_pk" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#tymethod.check_pk" class="fn">check_pk</a>&lt;Pk&gt;(pk: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Pk) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Each context has slightly different rules on what Pks are allowed in descriptors
15+
Legacy/Bare does not allow x_only keys
16+
Segwit does not allow uncompressed keys and x_only keys
17+
Tapscript does not allow uncompressed keys <a href="../keys/trait.ScriptContext.html#tymethod.check_pk">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_witness" class="method trait-impl has-srclink"><a href="#method.check_witness" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#method.check_witness" class="fn">check_witness</a>&lt;Pk&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;witness: &amp;[<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>&gt;]<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Check whether the given satisfaction is valid under the ScriptContext
1518
For example, segwit satisfactions may fail if the witness len is more
1619
3600 or number of stack elements are more than 100. <a href="../keys/trait.ScriptContext.html#method.check_witness">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.check_global_consensus_validity" class="method trait-impl has-srclink"><a href="#method.check_global_consensus_validity" class="anchor">§</a><h4 class="code-header">fn <a href="../keys/trait.ScriptContext.html#method.check_global_consensus_validity" class="fn">check_global_consensus_validity</a>&lt;Pk&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;ms: &amp;<a class="struct" href="struct.Miniscript.html" title="struct bdk::descriptor::Miniscript">Miniscript</a>&lt;Pk, <a class="enum" href="enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ScriptContextError&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Pk: MiniscriptKey,</span></h4></section></summary><div class='docblock'>Depending on script Context, some of the Terminals might not
1720
be valid under the current consensus rules.

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/enum.Wildcard.html

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)