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 `DerivableKey` trait in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, DerivableKey"><title>bdk::keys::DerivableKey - 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 DerivableKey</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.add_metadata">add_metadata</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-DerivableKey%3CCtx%3E-for-ExtendedPrivKey">ExtendedPrivKey</a><a href="#impl-DerivableKey%3CCtx%3E-for-ExtendedPubKey">ExtendedPubKey</a><a href="#impl-DerivableKey%3CCtx%3E-for-Mnemonic">Mnemonic</a><a href="#impl-DerivableKey%3CCtx%3E-for-Seed">Seed</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">keys</a></p><script>window.sidebarCurrent = {name: "DerivableKey", 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/keys/mod.rs.html#312-319" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">bdk</a>::<wbr><a href="index.html">keys</a>::<wbr><a class="trait" href="">DerivableKey</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait DerivableKey<Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>> {
5 pub fn <a href="#tymethod.add_metadata" class="fnname">add_metadata</a>(<br> self, <br> origin: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <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 keys that can be derived.</p>
7 <p>When extra metadata are provided, a <a href="../../bdk/keys/trait.DerivableKey.html" title="DerivableKey"><code>DerivableKey</code></a> can be transofrmed into a
8 <a href="../../bdk/keys/enum.DescriptorKey.html" title="DescriptorKey"><code>DescriptorKey</code></a>: the trait <a href="../../bdk/keys/trait.ToDescriptorKey.html" title="ToDescriptorKey"><code>ToDescriptorKey</code></a> is automatically implemented
9 for <code>(DerivableKey, DerivationPath)</code> and
10 <code>(DerivableKey, KeySource, DerivationPath)</code> tuples.</p>
11 <p>For key types that don't encode any indication about the path to use (like bip39), it's
12 generally recommended to implemented this trait instead of <a href="../../bdk/keys/trait.ToDescriptorKey.html" title="ToDescriptorKey"><code>ToDescriptorKey</code></a>. The same
13 rules regarding script context and valid networks apply.</p>
14 </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.add_metadata" class="method"><code>pub fn <a href="#tymethod.add_metadata" class="fnname">add_metadata</a>(<br> self, <br> origin: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/mod.rs.html#314-318" title="goto source code">[src]</a></h3><div class="docblock"><p>Add a extra metadata, consume <code>self</code> and turn it into a <a href="../../bdk/keys/enum.DescriptorKey.html" title="DescriptorKey"><code>DescriptorKey</code></a></p>
15 </div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-DerivableKey%3CCtx%3E-for-Seed" class="impl"><code class="in-band">impl<Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>> <a class="trait" href="../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><Ctx> for Seed</code><a href="#impl-DerivableKey%3CCtx%3E-for-Seed" class="anchor"></a><a class="srclink" href="../../src/bdk/keys/bip39.rs.html#43-57" title="goto source code">[src]</a></h3><div class="item-info"><div class="stab portability">This is supported on <strong>crate feature <code>keys-bip39</code></strong> only.</div></div><div class="impl-items"><h4 id="method.add_metadata" class="method hidden"><code>pub fn <a href="#method.add_metadata" class="fnname">add_metadata</a>(<br> self, <br> source: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/bip39.rs.html#44-56" title="goto source code">[src]</a></h4></div><h3 id="impl-DerivableKey%3CCtx%3E-for-Mnemonic" class="impl"><code class="in-band">impl<Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>> <a class="trait" href="../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><Ctx> for Mnemonic</code><a href="#impl-DerivableKey%3CCtx%3E-for-Mnemonic" class="anchor"></a><a class="srclink" href="../../src/bdk/keys/bip39.rs.html#73-81" title="goto source code">[src]</a></h3><div class="item-info"><div class="stab portability">This is supported on <strong>crate feature <code>keys-bip39</code></strong> only.</div></div><div class="impl-items"><h4 id="method.add_metadata-1" class="method hidden"><code>pub fn <a href="#method.add_metadata" class="fnname">add_metadata</a>(<br> self, <br> source: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/bip39.rs.html#74-80" title="goto source code">[src]</a></h4></div><h3 id="impl-DerivableKey%3CCtx%3E-for-ExtendedPubKey" class="impl"><code class="in-band">impl<Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>> <a class="trait" href="../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><Ctx> for ExtendedPubKey</code><a href="#impl-DerivableKey%3CCtx%3E-for-ExtendedPubKey" class="anchor"></a><a class="srclink" href="../../src/bdk/keys/mod.rs.html#321-335" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.add_metadata-2" class="method hidden"><code>pub fn <a href="#method.add_metadata" class="fnname">add_metadata</a>(<br> self, <br> origin: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/mod.rs.html#322-334" title="goto source code">[src]</a></h4></div><h3 id="impl-DerivableKey%3CCtx%3E-for-ExtendedPrivKey" class="impl"><code class="in-band">impl<Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>> <a class="trait" href="../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><Ctx> for ExtendedPrivKey</code><a href="#impl-DerivableKey%3CCtx%3E-for-ExtendedPrivKey" class="anchor"></a><a class="srclink" href="../../src/bdk/keys/mod.rs.html#337-351" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.add_metadata-3" class="method hidden"><code>pub fn <a href="#method.add_metadata" class="fnname">add_metadata</a>(<br> self, <br> origin: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/mod.rs.html#338-350" title="goto source code">[src]</a></h4></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-DerivableKey%3CCtx%3E" class="impl"><code class="in-band">impl<Ctx, K> DerivableKey<Ctx> for <a class="struct" href="../../bdk/keys/struct.GeneratedKey.html" title="struct bdk::keys::GeneratedKey">GeneratedKey</a><K, Ctx> <span class="where fmt-newline">where<br> Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>,<br> K: <a class="trait" href="../../bdk/keys/trait.DerivableKey.html" title="trait bdk::keys::DerivableKey">DerivableKey</a><Ctx>, </span></code><a href="#impl-DerivableKey%3CCtx%3E" class="anchor"></a><a class="srclink" href="../../src/bdk/keys/mod.rs.html#385-398" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.add_metadata-4" class="method hidden"><code>pub fn <a href="#method.add_metadata-4" class="fnname">add_metadata</a>(<br> self, <br> origin: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/mod.rs.html#390-397" title="goto source code">[src]</a></h4></div><h3 id="impl-DerivableKey%3CCtx%3E-1" class="impl"><code class="in-band">impl<Ctx: <a class="trait" href="../../bdk/keys/trait.ScriptContext.html" title="trait bdk::keys::ScriptContext">ScriptContext</a>> DerivableKey<Ctx> for <a class="type" href="../../bdk/keys/bip39/type.MnemonicWithPassphrase.html" title="type bdk::keys::bip39::MnemonicWithPassphrase">MnemonicWithPassphrase</a></code><a href="#impl-DerivableKey%3CCtx%3E-1" class="anchor"></a><a class="srclink" href="../../src/bdk/keys/bip39.rs.html#60-70" title="goto source code">[src]</a></h3><div class="item-info"><div class="stab portability">This is supported on <strong>crate feature <code>keys-bip39</code></strong> only.</div></div><div class="impl-items"><h4 id="method.add_metadata-5" class="method hidden"><code>pub fn <a href="#method.add_metadata-5" class="fnname">add_metadata</a>(<br> self, <br> source: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><KeySource>, <br> derivation_path: DerivationPath<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../bdk/keys/enum.DescriptorKey.html" title="enum bdk::keys::DescriptorKey">DescriptorKey</a><Ctx>, <a class="enum" href="../../bdk/keys/enum.KeyError.html" title="enum bdk::keys::KeyError">KeyError</a>></code><a class="srclink" href="../../src/bdk/keys/bip39.rs.html#61-69" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/bdk/keys/trait.DerivableKey.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