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="API documentation for the Rust `DescriptorTemplate` trait in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, DescriptorTemplate"><title>bdk::descriptor::template::DescriptorTemplate - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
2 <link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
3 <link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../bdk/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Trait DescriptorTemplate</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.build">build</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../../index.html">bdk</a>::<wbr><a href="../index.html">descriptor</a>::<wbr><a href="index.html">template</a></p><script>window.sidebarCurrent = {name: "DescriptorTemplate", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
4 <a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#62-65" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../../index.html">bdk</a>::<wbr><a href="../index.html">descriptor</a>::<wbr><a href="index.html">template</a>::<wbr><a class="trait" href="">DescriptorTemplate</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait DescriptorTemplate {
5 pub fn <a href="#tymethod.build" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>>;
6 }</pre></div><div class="docblock"><p>Trait for descriptor templates that can be built into a full descriptor</p>
7 <p>Since <a href="../../../bdk/descriptor/trait.ToWalletDescriptor.html" title="ToWalletDescriptor"><code>ToWalletDescriptor</code></a> is implemented for any <a href="../../../bdk/descriptor/template/trait.DescriptorTemplate.html" title="DescriptorTemplate"><code>DescriptorTemplate</code></a>, they can also be
8 passed directly to the <a href="../../../bdk/wallet/struct.Wallet.html"><code>Wallet</code></a> constructor.</p>
9 <h2 id="example" class="section-header"><a href="#example">Example</a></h2>
10 <div class="example-wrap"><pre class="rust rust-example-rendered">
11 <span class="kw">use</span> <span class="ident">bdk</span>::<span class="ident">keys</span>::{<span class="ident">KeyError</span>, <span class="ident">ToDescriptorKey</span>};
12 <span class="kw">use</span> <span class="ident">bdk</span>::<span class="ident">miniscript</span>::<span class="ident">Legacy</span>;
13 <span class="kw">use</span> <span class="ident">bdk</span>::<span class="ident">template</span>::{<span class="ident">DescriptorTemplate</span>, <span class="ident">DescriptorTemplateOut</span>};
15 <span class="kw">struct</span> <span class="ident">MyP2PKH</span><span class="op"><</span><span class="ident">K</span>: <span class="ident">ToDescriptorKey</span><span class="op"><</span><span class="ident">Legacy</span><span class="op">></span><span class="op">></span>(<span class="ident">K</span>);
17 <span class="kw">impl</span><span class="op"><</span><span class="ident">K</span>: <span class="ident">ToDescriptorKey</span><span class="op"><</span><span class="ident">Legacy</span><span class="op">></span><span class="op">></span> <span class="ident">DescriptorTemplate</span> <span class="kw">for</span> <span class="ident">MyP2PKH</span><span class="op"><</span><span class="ident">K</span><span class="op">></span> {
18 <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">DescriptorTemplateOut</span>, <span class="ident">KeyError</span><span class="op">></span> {
19 <span class="prelude-val">Ok</span>(<span class="ident">bdk</span>::<span class="macro">descriptor</span><span class="macro">!</span>(<span class="ident">pkh</span>(<span class="self">self</span>.<span class="number">0</span>))<span class="question-mark">?</span>)
22 </div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.build" class="method"><code>pub fn <a href="#tymethod.build" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#64" title="goto source code">[src]</a></h3><div class="docblock"><p>Build the complete descriptor</p>
23 </div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-DescriptorTemplate" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.BIP44.html" title="struct bdk::descriptor::template::BIP44">BIP44</a><K></code><a href="#impl-DescriptorTemplate" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build" class="method hidden"><code>pub fn <a href="#method.build" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#208-210" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-1" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.BIP44Public.html" title="struct bdk::descriptor::template::BIP44Public">BIP44Public</a><K></code><a href="#impl-DescriptorTemplate-1" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#246-250" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-1" class="method hidden"><code>pub fn <a href="#method.build-1" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#247-249" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-2" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.BIP49.html" title="struct bdk::descriptor::template::BIP49">BIP49</a><K></code><a href="#impl-DescriptorTemplate-2" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#281-285" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-2" class="method hidden"><code>pub fn <a href="#method.build-2" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#282-284" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-3" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.BIP49Public.html" title="struct bdk::descriptor::template::BIP49Public">BIP49Public</a><K></code><a href="#impl-DescriptorTemplate-3" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#320-324" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-3" class="method hidden"><code>pub fn <a href="#method.build-3" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#321-323" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-4" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.BIP84.html" title="struct bdk::descriptor::template::BIP84">BIP84</a><K></code><a href="#impl-DescriptorTemplate-4" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#355-359" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-4" class="method hidden"><code>pub fn <a href="#method.build-4" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#356-358" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-5" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.BIP84Public.html" title="struct bdk::descriptor::template::BIP84Public">BIP84Public</a><K></code><a href="#impl-DescriptorTemplate-5" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#394-398" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-5" class="method hidden"><code>pub fn <a href="#method.build-5" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#395-397" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-6" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.ToDescriptorKey.html" title="trait bdk::keys::ToDescriptorKey">ToDescriptorKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.P2PKH.html" title="struct bdk::descriptor::template::P2PKH">P2PKH</a><K></code><a href="#impl-DescriptorTemplate-6" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#105-109" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-6" class="method hidden"><code>pub fn <a href="#method.build-6" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#106-108" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-7" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.ToDescriptorKey.html" title="trait bdk::keys::ToDescriptorKey">ToDescriptorKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.P2WPKH.html" title="struct bdk::descriptor::template::P2WPKH">P2WPKH</a><K></code><a href="#impl-DescriptorTemplate-7" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#172-176" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-7" class="method hidden"><code>pub fn <a href="#method.build-7" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#173-175" title="goto source code">[src]</a></h4></div><h3 id="impl-DescriptorTemplate-8" class="impl"><code class="in-band">impl<K: <a class="trait" href="../../../bdk/keys/trait.ToDescriptorKey.html" title="trait bdk::keys::ToDescriptorKey">ToDescriptorKey</a><<a class="enum" href="../../../bdk/descriptor/enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> DescriptorTemplate for <a class="struct" href="../../../bdk/descriptor/template/struct.P2WPKH_P2SH.html" title="struct bdk::descriptor::template::P2WPKH_P2SH">P2WPKH_P2SH</a><K></code><a href="#impl-DescriptorTemplate-8" class="anchor"></a><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#139-143" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.build-8" class="method hidden"><code>pub fn <a href="#method.build-8" class="fnname">build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="../../../bdk/descriptor/template/type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#140-142" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/bdk/descriptor/template/trait.DescriptorTemplate.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../";window.currentCrate = "bdk";</script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
projects / bitcoindevkit.org / blob