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 `template` mod in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, template"><title>bdk::descriptor::template - 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 mod"><!--[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">Module template</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class="location"><a href="../../index.html">bdk</a>::<wbr><a href="../index.html">descriptor</a></p><script>window.sidebarCurrent = {name: "template", ty: "mod", 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#25-727" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../../index.html">bdk</a>::<wbr><a href="../index.html">descriptor</a>::<wbr><a class="mod" href="">template</a></span></h1><div class="docblock"><p>Descriptor templates</p>
5 <p>This module contains the definition of various common script templates that are ready to be
6 used. See the documentation of each template for an example.</p>
7 </div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
8 <table><tr class="module-item"><td><a class="struct" href="struct.BIP44.html" title="bdk::descriptor::template::BIP44 struct">BIP44</a></td><td class="docblock-short"><p>BIP44 template. Expands to <code>pkh(key/44'/0'/0'/{0,1}/*)</code></p>
9 </td></tr><tr class="module-item"><td><a class="struct" href="struct.BIP44Public.html" title="bdk::descriptor::template::BIP44Public struct">BIP44Public</a></td><td class="docblock-short"><p>BIP44 public template. Expands to <code>pkh(key/{0,1}/*)</code></p>
10 </td></tr><tr class="module-item"><td><a class="struct" href="struct.BIP49.html" title="bdk::descriptor::template::BIP49 struct">BIP49</a></td><td class="docblock-short"><p>BIP49 template. Expands to <code>sh(wpkh(key/49'/0'/0'/{0,1}/*))</code></p>
11 </td></tr><tr class="module-item"><td><a class="struct" href="struct.BIP49Public.html" title="bdk::descriptor::template::BIP49Public struct">BIP49Public</a></td><td class="docblock-short"><p>BIP49 public template. Expands to <code>sh(wpkh(key/{0,1}/*))</code></p>
12 </td></tr><tr class="module-item"><td><a class="struct" href="struct.BIP84.html" title="bdk::descriptor::template::BIP84 struct">BIP84</a></td><td class="docblock-short"><p>BIP84 template. Expands to <code>wpkh(key/84'/0'/0'/{0,1}/*)</code></p>
13 </td></tr><tr class="module-item"><td><a class="struct" href="struct.BIP84Public.html" title="bdk::descriptor::template::BIP84Public struct">BIP84Public</a></td><td class="docblock-short"><p>BIP84 public template. Expands to <code>wpkh(key/{0,1}/*)</code></p>
14 </td></tr><tr class="module-item"><td><a class="struct" href="struct.P2PKH.html" title="bdk::descriptor::template::P2PKH struct">P2PKH</a></td><td class="docblock-short"><p>P2PKH template. Expands to a descriptor <code>pkh(key)</code></p>
15 </td></tr><tr class="module-item"><td><a class="struct" href="struct.P2WPKH.html" title="bdk::descriptor::template::P2WPKH struct">P2WPKH</a></td><td class="docblock-short"><p>P2WPKH template. Expands to a descriptor <code>wpkh(key)</code></p>
16 </td></tr><tr class="module-item"><td><a class="struct" href="struct.P2WPKH_P2SH.html" title="bdk::descriptor::template::P2WPKH_P2SH struct">P2WPKH_P2SH</a></td><td class="docblock-short"><p>P2WPKH-P2SH template. Expands to a descriptor <code>sh(wpkh(key))</code></p>
17 </td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
18 <table><tr class="module-item"><td><a class="trait" href="trait.DescriptorTemplate.html" title="bdk::descriptor::template::DescriptorTemplate trait">DescriptorTemplate</a></td><td class="docblock-short"><p>Trait for descriptor templates that can be built into a full descriptor</p>
19 </td></tr></table><h2 id="types" class="section-header"><a href="#types">Type Definitions</a></h2>
20 <table><tr class="module-item"><td><a class="type" href="type.DescriptorTemplateOut.html" title="bdk::descriptor::template::DescriptorTemplateOut type">DescriptorTemplateOut</a></td><td class="docblock-short"><p>Type alias for the return type of <a href="../../../bdk/descriptor/template/trait.DescriptorTemplate.html" title="DescriptorTemplate"><code>DescriptorTemplate</code></a>, <a href="../../../bdk/macro.descriptor.html"><code>descriptor!</code></a> and others</p>
21 </td></tr></table></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