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 `address_validator` mod in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, address_validator"><title>bdk::wallet::address_validator - 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 address_validator</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../../index.html">bdk</a>::<wbr><a href="../index.html">wallet</a></p><script>window.sidebarCurrent = {name: "address_validator", 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/wallet/address_validator.rs.html#25-167" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../../index.html">bdk</a>::<wbr><a href="../index.html">wallet</a>::<wbr><a class="mod" href="">address_validator</a></span></h1><div class="docblock"><p>Address validation callbacks</p>
5 <p>The typical usage of those callbacks is for displaying the newly-generated address on a
6 hardware wallet, so that the user can cross-check its correctness.</p>
7 <p>More generally speaking though, these callbacks can also be used to "do something" every time
8 an address is generated, without necessarily checking or validating it.</p>
9 <p>An address validator can be attached to a <a href="../../../bdk/wallet/struct.Wallet.html"><code>Wallet</code></a> by using the
10 <a href="../../../bdk/wallet/struct.Wallet.html#method.add_address_validator"><code>Wallet::add_address_validator</code></a> method, and
11 whenever a new address is generated (either explicitly by the user with
12 <a href="../../../bdk/wallet/struct.Wallet.html#method.get_new_address"><code>Wallet::get_new_address</code></a> or internally to create a change
13 address) all the attached validators will be polled, in sequence. All of them must complete
14 successfully to continue.</p>
15 <h2 id="example" class="section-header"><a href="#example">Example</a></h2>
16 <div class="example-wrap"><pre class="rust rust-example-rendered">
17 <span class="kw">struct</span> <span class="ident">PrintAddressAndContinue</span>;
19 <span class="kw">impl</span> <span class="ident">AddressValidator</span> <span class="kw">for</span> <span class="ident">PrintAddressAndContinue</span> {
20 <span class="kw">fn</span> <span class="ident">validate</span>(
21 <span class="kw-2">&</span><span class="self">self</span>,
22 <span class="ident">keychain</span>: <span class="ident">KeychainKind</span>,
23 <span class="ident">hd_keypaths</span>: <span class="kw-2">&</span><span class="ident">HDKeyPaths</span>,
24 <span class="ident">script</span>: <span class="kw-2">&</span><span class="ident">Script</span>
25 ) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">AddressValidatorError</span><span class="op">></span> {
26 <span class="kw">let</span> <span class="ident">address</span> <span class="op">=</span> <span class="ident">Address</span>::<span class="ident">from_script</span>(<span class="ident">script</span>, <span class="ident">Network</span>::<span class="ident">Testnet</span>)
27 .<span class="ident">as_ref</span>()
28 .<span class="ident">map</span>(<span class="ident">Address</span>::<span class="ident">to_string</span>)
29 .<span class="ident">unwrap_or</span>(<span class="ident">script</span>.<span class="ident">to_string</span>());
30 <span class="macro">println</span><span class="macro">!</span>(<span class="string">"New address of type {:?}: {}"</span>, <span class="ident">keychain</span>, <span class="ident">address</span>);
31 <span class="macro">println</span><span class="macro">!</span>(<span class="string">"HD keypaths: {:#?}"</span>, <span class="ident">hd_keypaths</span>);
33 <span class="prelude-val">Ok</span>(())
37 <span class="kw">let</span> <span class="ident">descriptor</span> <span class="op">=</span> <span class="string">"wpkh(tpubD6NzVbkrYhZ4Xferm7Pz4VnjdcDPFyjVu5K4iZXQ4pVN8Cks4pHVowTBXBKRhX64pkRyJZJN5xAKj4UDNnLPb5p2sSKXhewoYx5GbTdUFWq/*)"</span>;
38 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wallet</span>: <span class="ident">OfflineWallet</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">Wallet</span>::<span class="ident">new_offline</span>(<span class="ident">descriptor</span>, <span class="prelude-val">None</span>, <span class="ident">Network</span>::<span class="ident">Testnet</span>, <span class="ident">MemoryDatabase</span>::<span class="ident">default</span>())<span class="question-mark">?</span>;
39 <span class="ident">wallet</span>.<span class="ident">add_address_validator</span>(<span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">PrintAddressAndContinue</span>));
41 <span class="kw">let</span> <span class="ident">address</span> <span class="op">=</span> <span class="ident">wallet</span>.<span class="ident">get_new_address</span>()<span class="question-mark">?</span>;
42 <span class="macro">println</span><span class="macro">!</span>(<span class="string">"Address: {}"</span>, <span class="ident">address</span>);</pre></div>
43 </div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
44 <table><tr class="module-item"><td><a class="enum" href="enum.AddressValidatorError.html" title="bdk::wallet::address_validator::AddressValidatorError enum">AddressValidatorError</a></td><td class="docblock-short"><p>Errors that can be returned to fail the validation of an address</p>
45 </td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
46 <table><tr class="module-item"><td><a class="trait" href="trait.AddressValidator.html" title="bdk::wallet::address_validator::AddressValidator trait">AddressValidator</a></td><td class="docblock-short"><p>Trait to build address validators</p>
47 </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