]> Untitled Git - bitcoindevkit.org/blob
c5c58b8bedf6f98f19e45f3a7a1f6de74c2df0b8
[bitcoindevkit.org] /
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="Trait for types which can be converted into an `ExtendedDescriptor` and a `KeyMap` usable by a wallet in a specific `Network`"><title>IntoWalletDescriptor in bdk_wallet::descriptor - 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_wallet" 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 trait"><!--[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_wallet/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_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../bdk_wallet/index.html">bdk_wallet</a><span class="version">1.0.0-beta.1</span></h2></div><h2 class="location"><a href="#">IntoWalletDescriptor</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_wallet_descriptor">into_wallet_descriptor</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IntoWalletDescriptor-for-%26String">&amp;String</a></li><li><a href="#impl-IntoWalletDescriptor-for-%26str">&amp;str</a></li><li><a href="#impl-IntoWalletDescriptor-for-(Descriptor%3CDescriptorPublicKey%3E,+BTreeMap%3CDescriptorPublicKey,+DescriptorSecretKey%3E)">(ExtendedDescriptor, KeyMap)</a></li><li><a href="#impl-IntoWalletDescriptor-for-String">String</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bdk_wallet::descriptor</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>Trait <a href="../index.html">bdk_wallet</a>::<wbr><a href="index.html">descriptor</a>::<wbr><a class="trait" href="#">IntoWalletDescriptor</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_wallet/descriptor/mod.rs.html#74-81">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait IntoWalletDescriptor {
2 // Required method
3 fn <a href="#tymethod.into_wallet_descriptor" class="fn">into_wallet_descriptor</a>(
4 self,
5 secp: &amp;Secp256k1&lt;All&gt;,
6 network: Network
7 ) -&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="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>), <a class="enum" href="error/enum.Error.html" title="enum bdk_wallet::descriptor::error::Error">DescriptorError</a>&gt;;
8 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for types which can be converted into an <a href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor"><code>ExtendedDescriptor</code></a> and a <a href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap"><code>KeyMap</code></a> usable by a wallet in a specific [<code>Network</code>]</p>
9 </div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.into_wallet_descriptor" class="method"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#76-80">source</a><h4 class="code-header">fn <a href="#tymethod.into_wallet_descriptor" class="fn">into_wallet_descriptor</a>(
10 self,
11 secp: &amp;Secp256k1&lt;All&gt;,
12 network: Network
13 ) -&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="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>), <a class="enum" href="error/enum.Error.html" title="enum bdk_wallet::descriptor::error::Error">DescriptorError</a>&gt;</h4></section></summary><div class="docblock"><p>Convert to wallet descriptor</p>
14 </div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IntoWalletDescriptor-for-%26str" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#83-103">source</a><a href="#impl-IntoWalletDescriptor-for-%26str" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><section id="method.into_wallet_descriptor" class="method trait-impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#84-102">source</a><a href="#method.into_wallet_descriptor" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_wallet_descriptor" class="fn">into_wallet_descriptor</a>(
15 self,
16 secp: &amp;Secp256k1&lt;All&gt;,
17 network: Network
18 ) -&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="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>), <a class="enum" href="error/enum.Error.html" title="enum bdk_wallet::descriptor::error::Error">DescriptorError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoWalletDescriptor-for-%26String" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#105-113">source</a><a href="#impl-IntoWalletDescriptor-for-%26String" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></section></summary><div class="impl-items"><section id="method.into_wallet_descriptor-1" class="method trait-impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#106-112">source</a><a href="#method.into_wallet_descriptor-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_wallet_descriptor" class="fn">into_wallet_descriptor</a>(
19 self,
20 secp: &amp;Secp256k1&lt;All&gt;,
21 network: Network
22 ) -&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="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>), <a class="enum" href="error/enum.Error.html" title="enum bdk_wallet::descriptor::error::Error">DescriptorError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoWalletDescriptor-for-(Descriptor%3CDescriptorPublicKey%3E,+BTreeMap%3CDescriptorPublicKey,+DescriptorSecretKey%3E)" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#135-215">source</a><a href="#impl-IntoWalletDescriptor-for-(Descriptor%3CDescriptorPublicKey%3E,+BTreeMap%3CDescriptorPublicKey,+DescriptorSecretKey%3E)" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for (<a class="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>)</h3></section></summary><div class="impl-items"><section id="method.into_wallet_descriptor-2" class="method trait-impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#136-214">source</a><a href="#method.into_wallet_descriptor-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_wallet_descriptor" class="fn">into_wallet_descriptor</a>(
23 self,
24 secp: &amp;Secp256k1&lt;All&gt;,
25 network: Network
26 ) -&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="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>), <a class="enum" href="error/enum.Error.html" title="enum bdk_wallet::descriptor::error::Error">DescriptorError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoWalletDescriptor-for-String" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#115-123">source</a><a href="#impl-IntoWalletDescriptor-for-String" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></section></summary><div class="impl-items"><section id="method.into_wallet_descriptor-3" class="method trait-impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#116-122">source</a><a href="#method.into_wallet_descriptor-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_wallet_descriptor" class="fn">into_wallet_descriptor</a>(
27 self,
28 secp: &amp;Secp256k1&lt;All&gt;,
29 network: Network
30 ) -&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="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a>, <a class="type" href="../keys/type.KeyMap.html" title="type bdk_wallet::keys::KeyMap">KeyMap</a>), <a class="enum" href="error/enum.Error.html" title="enum bdk_wallet::descriptor::error::Error">DescriptorError</a>&gt;</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-IntoWalletDescriptor-for-(Descriptor%3CDescriptorPublicKey%3E,+BTreeMap%3CDescriptorPublicKey,+DescriptorSecretKey%3E,+HashSet%3CNetwork%3E)" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#217-292">source</a><a href="#impl-IntoWalletDescriptor-for-(Descriptor%3CDescriptorPublicKey%3E,+BTreeMap%3CDescriptorPublicKey,+DescriptorSecretKey%3E,+HashSet%3CNetwork%3E)" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for <a class="type" href="template/type.DescriptorTemplateOut.html" title="type bdk_wallet::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a></h3></section><section id="impl-IntoWalletDescriptor-for-Descriptor%3CDescriptorPublicKey%3E" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/mod.rs.html#125-133">source</a><a href="#impl-IntoWalletDescriptor-for-Descriptor%3CDescriptorPublicKey%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for <a class="type" href="type.ExtendedDescriptor.html" title="type bdk_wallet::descriptor::ExtendedDescriptor">ExtendedDescriptor</a></h3></section><section id="impl-IntoWalletDescriptor-for-T" class="impl"><a class="src rightside" href="../../src/bdk_wallet/descriptor/template.rs.html#60-68">source</a><a href="#impl-IntoWalletDescriptor-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="template/trait.DescriptorTemplate.html" title="trait bdk_wallet::descriptor::template::DescriptorTemplate">DescriptorTemplate</a>&gt; <a class="trait" href="trait.IntoWalletDescriptor.html" title="trait bdk_wallet::descriptor::IntoWalletDescriptor">IntoWalletDescriptor</a> for T</h3></section><div class="docblock"><p>Turns a <a href="template/trait.DescriptorTemplate.html" title="trait bdk_wallet::descriptor::template::DescriptorTemplate"><code>DescriptorTemplate</code></a> into a valid wallet descriptor by calling its
31 <a href="template/trait.DescriptorTemplate.html#tymethod.build" title="method bdk_wallet::descriptor::template::DescriptorTemplate::build"><code>build</code></a> method</p>
32 </div></div><script src="../../trait.impl/bdk_wallet/descriptor/trait.IntoWalletDescriptor.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main></body></html>