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 descriptor templates that can be built into a full descriptor"><meta name="keywords" content="rust, rustlang, rust-lang, DescriptorTemplate"><title>DescriptorTemplate in bdk::descriptor::template - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><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="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script>
2 <noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../../bdk/index.html"><div class="logo-container"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div>
3 </a><h2 class="location">Trait DescriptorTemplate</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.build">build</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">bdk</a>::<wbr><a href="../index.html">descriptor</a>::<wbr><a href="index.html">template</a></h2><div id="sidebar-vars" data-name="DescriptorTemplate" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../bdk/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><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><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><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#52-55" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait DescriptorTemplate {
4 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="type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../error/enum.Error.html" title="enum bdk::descriptor::error::Error">DescriptorError</a>>;
5 }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for descriptor templates that can be built into a full descriptor</p>
6 <p>Since <a href="../trait.IntoWalletDescriptor.html" title="IntoWalletDescriptor"><code>IntoWalletDescriptor</code></a> is implemented for any <a href="trait.DescriptorTemplate.html" title="DescriptorTemplate"><code>DescriptorTemplate</code></a>, they can also be
7 passed directly to the <a href="../../wallet/struct.Wallet.html"><code>Wallet</code></a> constructor.</p>
8 <h3 id="example" class="section-header"><a href="#example">Example</a></h3>
9 <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">bdk::descriptor::error::Error</span> <span class="kw">as</span> <span class="ident">DescriptorError</span>;
10 <span class="kw">use</span> <span class="ident">bdk::keys</span>::{<span class="ident">IntoDescriptorKey</span>, <span class="ident">KeyError</span>};
11 <span class="kw">use</span> <span class="ident">bdk::miniscript::Legacy</span>;
12 <span class="kw">use</span> <span class="ident">bdk::template</span>::{<span class="ident">DescriptorTemplate</span>, <span class="ident">DescriptorTemplateOut</span>};
14 <span class="kw">struct</span> <span class="ident">MyP2PKH</span><span class="op"><</span><span class="ident">K</span>: <span class="ident">IntoDescriptorKey</span><span class="op"><</span><span class="ident">Legacy</span><span class="op">></span><span class="op">></span>(<span class="ident">K</span>);
16 <span class="kw">impl</span><span class="op"><</span><span class="ident">K</span>: <span class="ident">IntoDescriptorKey</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> {
17 <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">DescriptorTemplateOut</span>, <span class="ident">DescriptorError</span><span class="op">></span> {
18 <span class="prelude-val">Ok</span>(<span class="macro">bdk::descriptor!</span>(<span class="ident">pkh</span>(<span class="self">self</span>.<span class="number">0</span>))<span class="question-mark">?</span>)
21 </div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.build" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#54" title="goto source code">[src]</a></div><h4 class="code-header">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="type.DescriptorTemplateOut.html" title="type bdk::descriptor::template::DescriptorTemplateOut">DescriptorTemplateOut</a>, <a class="enum" href="../error/enum.Error.html" title="enum bdk::descriptor::error::Error">DescriptorError</a>></h4></div></summary><div class="docblock"><p>Build the complete descriptor</p>
22 </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-DescriptorTemplate" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#202-206" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.Bip44.html" title="struct bdk::descriptor::template::Bip44">Bip44</a><K></h3></div><div id="impl-DescriptorTemplate-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#242-246" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-1" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.Bip44Public.html" title="struct bdk::descriptor::template::Bip44Public">Bip44Public</a><K></h3></div><div id="impl-DescriptorTemplate-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#278-282" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-2" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.Bip49.html" title="struct bdk::descriptor::template::Bip49">Bip49</a><K></h3></div><div id="impl-DescriptorTemplate-3" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#318-322" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-3" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.Bip49Public.html" title="struct bdk::descriptor::template::Bip49Public">Bip49Public</a><K></h3></div><div id="impl-DescriptorTemplate-4" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#354-358" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-4" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.Bip84.html" title="struct bdk::descriptor::template::Bip84">Bip84</a><K></h3></div><div id="impl-DescriptorTemplate-5" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#394-398" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-5" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><<a class="enum" href="../enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.Bip84Public.html" title="struct bdk::descriptor::template::Bip84Public">Bip84Public</a><K></h3></div><div id="impl-DescriptorTemplate-6" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#97-101" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-6" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.IntoDescriptorKey.html" title="trait bdk::keys::IntoDescriptorKey">IntoDescriptorKey</a><<a class="enum" href="../enum.Legacy.html" title="enum bdk::descriptor::Legacy">Legacy</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.P2Pkh.html" title="struct bdk::descriptor::template::P2Pkh">P2Pkh</a><K></h3></div><div id="impl-DescriptorTemplate-7" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#166-170" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-7" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.IntoDescriptorKey.html" title="trait bdk::keys::IntoDescriptorKey">IntoDescriptorKey</a><<a class="enum" href="../enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.P2Wpkh.html" title="struct bdk::descriptor::template::P2Wpkh">P2Wpkh</a><K></h3></div><div id="impl-DescriptorTemplate-8" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bdk/descriptor/template.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-DescriptorTemplate-8" class="anchor"></a><h3 class="code-header in-band">impl<K: <a class="trait" href="../../keys/trait.IntoDescriptorKey.html" title="trait bdk::keys::IntoDescriptorKey">IntoDescriptorKey</a><<a class="enum" href="../enum.Segwitv0.html" title="enum bdk::descriptor::Segwitv0">Segwitv0</a>>> <a class="trait" href="trait.DescriptorTemplate.html" title="trait bdk::descriptor::template::DescriptorTemplate">DescriptorTemplate</a> for <a class="struct" href="struct.P2Wpkh_P2Sh.html" title="struct bdk::descriptor::template::P2Wpkh_P2Sh">P2Wpkh_P2Sh</a><K></h3></div></div><script type="text/javascript" src="../../../implementors/bdk/descriptor/template/trait.DescriptorTemplate.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="bdk" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0-nightly (83b15bfe1 2021-12-28)" ></div>
projects / bitcoindevkit.org / blob