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 `AddressValidator` trait in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, AddressValidator"><title>bdk::wallet::address_validator::AddressValidator - 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 AddressValidator</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.validate">validate</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">wallet</a>::<wbr><a href="index.html">address_validator</a></p><script>window.sidebarCurrent = {name: "AddressValidator", 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/wallet/address_validator.rs.html#114-122" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../../index.html">bdk</a>::<wbr><a href="../index.html">wallet</a>::<wbr><a href="index.html">address_validator</a>::<wbr><a class="trait" href="">AddressValidator</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait AddressValidator: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
5 pub fn <a href="#tymethod.validate" class="fnname">validate</a>(<br> &self, <br> keychain: <a class="enum" href="../../../bdk/enum.KeychainKind.html" title="enum bdk::KeychainKind">KeychainKind</a>, <br> hd_keypaths: &<a class="type" href="../../../bdk/descriptor/type.HDKeyPaths.html" title="type bdk::descriptor::HDKeyPaths">HDKeyPaths</a>, <br> script: &Script<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../../bdk/wallet/address_validator/enum.AddressValidatorError.html" title="enum bdk::wallet::address_validator::AddressValidatorError">AddressValidatorError</a>>;
6 }</pre></div><div class="docblock"><p>Trait to build address validators</p>
7 <p>All the address validators attached to a wallet with <a href="../../../bdk/wallet/struct.Wallet.html#method.add_address_validator"><code>Wallet::add_address_validator</code></a> will be polled
8 every time an address (external or internal) is generated by the wallet. Errors returned in the
9 validator will be propagated up to the original caller that triggered the address generation.</p>
10 <p>For a usage example see <a href="../../../bdk/wallet/address_validator/index.html">this module</a>'s documentation.</p>
11 </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.validate" class="method"><code>pub fn <a href="#tymethod.validate" class="fnname">validate</a>(<br> &self, <br> keychain: <a class="enum" href="../../../bdk/enum.KeychainKind.html" title="enum bdk::KeychainKind">KeychainKind</a>, <br> hd_keypaths: &<a class="type" href="../../../bdk/descriptor/type.HDKeyPaths.html" title="type bdk::descriptor::HDKeyPaths">HDKeyPaths</a>, <br> script: &Script<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../../bdk/wallet/address_validator/enum.AddressValidatorError.html" title="enum bdk::wallet::address_validator::AddressValidatorError">AddressValidatorError</a>></code><a class="srclink" href="../../../src/bdk/wallet/address_validator.rs.html#116-121" title="goto source code">[src]</a></h3><div class="docblock"><p>Validate or inspect an address</p>
12 </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"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/bdk/wallet/address_validator/trait.AddressValidator.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