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="Source of the Rust file `src/wallet/address_validator.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>address_validator.rs - source</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 source"><!--[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></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"><pre class="line-numbers"><span id="1"> 1</span>
10 <span id="7"> 7</span>
11 <span id="8"> 8</span>
12 <span id="9"> 9</span>
13 <span id="10"> 10</span>
14 <span id="11"> 11</span>
15 <span id="12"> 12</span>
16 <span id="13"> 13</span>
17 <span id="14"> 14</span>
18 <span id="15"> 15</span>
19 <span id="16"> 16</span>
20 <span id="17"> 17</span>
21 <span id="18"> 18</span>
22 <span id="19"> 19</span>
23 <span id="20"> 20</span>
24 <span id="21"> 21</span>
25 <span id="22"> 22</span>
26 <span id="23"> 23</span>
27 <span id="24"> 24</span>
28 <span id="25"> 25</span>
29 <span id="26"> 26</span>
30 <span id="27"> 27</span>
31 <span id="28"> 28</span>
32 <span id="29"> 29</span>
33 <span id="30"> 30</span>
34 <span id="31"> 31</span>
35 <span id="32"> 32</span>
36 <span id="33"> 33</span>
37 <span id="34"> 34</span>
38 <span id="35"> 35</span>
39 <span id="36"> 36</span>
40 <span id="37"> 37</span>
41 <span id="38"> 38</span>
42 <span id="39"> 39</span>
43 <span id="40"> 40</span>
44 <span id="41"> 41</span>
45 <span id="42"> 42</span>
46 <span id="43"> 43</span>
47 <span id="44"> 44</span>
48 <span id="45"> 45</span>
49 <span id="46"> 46</span>
50 <span id="47"> 47</span>
51 <span id="48"> 48</span>
52 <span id="49"> 49</span>
53 <span id="50"> 50</span>
54 <span id="51"> 51</span>
55 <span id="52"> 52</span>
56 <span id="53"> 53</span>
57 <span id="54"> 54</span>
58 <span id="55"> 55</span>
59 <span id="56"> 56</span>
60 <span id="57"> 57</span>
61 <span id="58"> 58</span>
62 <span id="59"> 59</span>
63 <span id="60"> 60</span>
64 <span id="61"> 61</span>
65 <span id="62"> 62</span>
66 <span id="63"> 63</span>
67 <span id="64"> 64</span>
68 <span id="65"> 65</span>
69 <span id="66"> 66</span>
70 <span id="67"> 67</span>
71 <span id="68"> 68</span>
72 <span id="69"> 69</span>
73 <span id="70"> 70</span>
74 <span id="71"> 71</span>
75 <span id="72"> 72</span>
76 <span id="73"> 73</span>
77 <span id="74"> 74</span>
78 <span id="75"> 75</span>
79 <span id="76"> 76</span>
80 <span id="77"> 77</span>
81 <span id="78"> 78</span>
82 <span id="79"> 79</span>
83 <span id="80"> 80</span>
84 <span id="81"> 81</span>
85 <span id="82"> 82</span>
86 <span id="83"> 83</span>
87 <span id="84"> 84</span>
88 <span id="85"> 85</span>
89 <span id="86"> 86</span>
90 <span id="87"> 87</span>
91 <span id="88"> 88</span>
92 <span id="89"> 89</span>
93 <span id="90"> 90</span>
94 <span id="91"> 91</span>
95 <span id="92"> 92</span>
96 <span id="93"> 93</span>
97 <span id="94"> 94</span>
98 <span id="95"> 95</span>
99 <span id="96"> 96</span>
100 <span id="97"> 97</span>
101 <span id="98"> 98</span>
102 <span id="99"> 99</span>
103 <span id="100">100</span>
104 <span id="101">101</span>
105 <span id="102">102</span>
106 <span id="103">103</span>
107 <span id="104">104</span>
108 <span id="105">105</span>
109 <span id="106">106</span>
110 <span id="107">107</span>
111 <span id="108">108</span>
112 <span id="109">109</span>
113 <span id="110">110</span>
114 <span id="111">111</span>
115 <span id="112">112</span>
116 <span id="113">113</span>
117 <span id="114">114</span>
118 <span id="115">115</span>
119 <span id="116">116</span>
120 <span id="117">117</span>
121 <span id="118">118</span>
122 <span id="119">119</span>
123 <span id="120">120</span>
124 <span id="121">121</span>
125 <span id="122">122</span>
126 <span id="123">123</span>
127 <span id="124">124</span>
128 <span id="125">125</span>
129 <span id="126">126</span>
130 <span id="127">127</span>
131 <span id="128">128</span>
132 <span id="129">129</span>
133 <span id="130">130</span>
134 <span id="131">131</span>
135 <span id="132">132</span>
136 <span id="133">133</span>
137 <span id="134">134</span>
138 <span id="135">135</span>
139 <span id="136">136</span>
140 <span id="137">137</span>
141 <span id="138">138</span>
142 <span id="139">139</span>
143 <span id="140">140</span>
144 <span id="141">141</span>
145 <span id="142">142</span>
146 <span id="143">143</span>
147 <span id="144">144</span>
148 <span id="145">145</span>
149 <span id="146">146</span>
150 <span id="147">147</span>
151 <span id="148">148</span>
152 <span id="149">149</span>
153 <span id="150">150</span>
154 <span id="151">151</span>
155 <span id="152">152</span>
156 <span id="153">153</span>
157 <span id="154">154</span>
158 <span id="155">155</span>
159 <span id="156">156</span>
160 <span id="157">157</span>
161 <span id="158">158</span>
162 <span id="159">159</span>
163 <span id="160">160</span>
164 <span id="161">161</span>
165 <span id="162">162</span>
166 <span id="163">163</span>
167 <span id="164">164</span>
168 <span id="165">165</span>
169 <span id="166">166</span>
170 <span id="167">167</span>
171 </pre><div class="example-wrap"><pre class="rust ">
172 <span class="comment">// Magical Bitcoin Library</span>
173 <span class="comment">// Written in 2020 by</span>
174 <span class="comment">// Alekos Filini <alekos.filini@gmail.com></span>
175 <span class="comment">//</span>
176 <span class="comment">// Copyright (c) 2020 Magical Bitcoin</span>
177 <span class="comment">//</span>
178 <span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span>
179 <span class="comment">// of this software and associated documentation files (the "Software"), to deal</span>
180 <span class="comment">// in the Software without restriction, including without limitation the rights</span>
181 <span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
182 <span class="comment">// copies of the Software, and to permit persons to whom the Software is</span>
183 <span class="comment">// furnished to do so, subject to the following conditions:</span>
184 <span class="comment">//</span>
185 <span class="comment">// The above copyright notice and this permission notice shall be included in all</span>
186 <span class="comment">// copies or substantial portions of the Software.</span>
187 <span class="comment">//</span>
188 <span class="comment">// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
189 <span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
190 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
191 <span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
192 <span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
193 <span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
194 <span class="comment">// SOFTWARE.</span>
196 <span class="doccomment">//! Address validation callbacks</span>
197 <span class="doccomment">//!</span>
198 <span class="doccomment">//! The typical usage of those callbacks is for displaying the newly-generated address on a</span>
199 <span class="doccomment">//! hardware wallet, so that the user can cross-check its correctness.</span>
200 <span class="doccomment">//!</span>
201 <span class="doccomment">//! More generally speaking though, these callbacks can also be used to "do something" every time</span>
202 <span class="doccomment">//! an address is generated, without necessarily checking or validating it.</span>
203 <span class="doccomment">//!</span>
204 <span class="doccomment">//! An address validator can be attached to a [`Wallet`](super::Wallet) by using the</span>
205 <span class="doccomment">//! [`Wallet::add_address_validator`](super::Wallet::add_address_validator) method, and</span>
206 <span class="doccomment">//! whenever a new address is generated (either explicitly by the user with</span>
207 <span class="doccomment">//! [`Wallet::get_new_address`](super::Wallet::get_new_address) or internally to create a change</span>
208 <span class="doccomment">//! address) all the attached validators will be polled, in sequence. All of them must complete</span>
209 <span class="doccomment">//! successfully to continue.</span>
210 <span class="doccomment">//!</span>
211 <span class="doccomment">//! ## Example</span>
212 <span class="doccomment">//!</span>
213 <span class="doccomment">//! ```</span>
214 <span class="doccomment">//! # use std::sync::Arc;</span>
215 <span class="doccomment">//! # use bitcoin::*;</span>
216 <span class="doccomment">//! # use bdk::address_validator::*;</span>
217 <span class="doccomment">//! # use bdk::database::*;</span>
218 <span class="doccomment">//! # use bdk::*;</span>
219 <span class="doccomment">//! struct PrintAddressAndContinue;</span>
220 <span class="doccomment">//!</span>
221 <span class="doccomment">//! impl AddressValidator for PrintAddressAndContinue {</span>
222 <span class="doccomment">//! fn validate(</span>
223 <span class="doccomment">//! &self,</span>
224 <span class="doccomment">//! keychain: KeychainKind,</span>
225 <span class="doccomment">//! hd_keypaths: &HDKeyPaths,</span>
226 <span class="doccomment">//! script: &Script</span>
227 <span class="doccomment">//! ) -> Result<(), AddressValidatorError> {</span>
228 <span class="doccomment">//! let address = Address::from_script(script, Network::Testnet)</span>
229 <span class="doccomment">//! .as_ref()</span>
230 <span class="doccomment">//! .map(Address::to_string)</span>
231 <span class="doccomment">//! .unwrap_or(script.to_string());</span>
232 <span class="doccomment">//! println!("New address of type {:?}: {}", keychain, address);</span>
233 <span class="doccomment">//! println!("HD keypaths: {:#?}", hd_keypaths);</span>
234 <span class="doccomment">//!</span>
235 <span class="doccomment">//! Ok(())</span>
236 <span class="doccomment">//! }</span>
237 <span class="doccomment">//! }</span>
238 <span class="doccomment">//!</span>
239 <span class="doccomment">//! let descriptor = "wpkh(tpubD6NzVbkrYhZ4Xferm7Pz4VnjdcDPFyjVu5K4iZXQ4pVN8Cks4pHVowTBXBKRhX64pkRyJZJN5xAKj4UDNnLPb5p2sSKXhewoYx5GbTdUFWq/*)";</span>
240 <span class="doccomment">//! let mut wallet: OfflineWallet<_> = Wallet::new_offline(descriptor, None, Network::Testnet, MemoryDatabase::default())?;</span>
241 <span class="doccomment">//! wallet.add_address_validator(Arc::new(PrintAddressAndContinue));</span>
242 <span class="doccomment">//!</span>
243 <span class="doccomment">//! let address = wallet.get_new_address()?;</span>
244 <span class="doccomment">//! println!("Address: {}", address);</span>
245 <span class="doccomment">//! # Ok::<(), bdk::Error>(())</span>
246 <span class="doccomment">//! ```</span>
248 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
250 <span class="kw">use</span> <span class="ident">bitcoin</span>::<span class="ident">Script</span>;
252 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">descriptor</span>::<span class="ident">HDKeyPaths</span>;
253 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">types</span>::<span class="ident">KeychainKind</span>;
255 <span class="doccomment">/// Errors that can be returned to fail the validation of an address</span>
256 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
257 <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">AddressValidatorError</span> {
258 <span class="doccomment">/// User rejected the address</span>
259 <span class="ident">UserRejected</span>,
260 <span class="doccomment">/// Network connection error</span>
261 <span class="ident">ConnectionError</span>,
262 <span class="doccomment">/// Network request timeout error</span>
263 <span class="ident">TimeoutError</span>,
264 <span class="doccomment">/// Invalid script</span>
265 <span class="ident">InvalidScript</span>,
266 <span class="doccomment">/// A custom error message</span>
267 <span class="ident">Message</span>(<span class="ident">String</span>),
270 <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">AddressValidatorError</span> {
271 <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
272 <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{:?}"</span>, <span class="self">self</span>)
276 <span class="kw">impl</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">AddressValidatorError</span> {}
278 <span class="doccomment">/// Trait to build address validators</span>
279 <span class="doccomment">///</span>
280 <span class="doccomment">/// All the address validators attached to a wallet with [`Wallet::add_address_validator`](super::Wallet::add_address_validator) will be polled</span>
281 <span class="doccomment">/// every time an address (external or internal) is generated by the wallet. Errors returned in the</span>
282 <span class="doccomment">/// validator will be propagated up to the original caller that triggered the address generation.</span>
283 <span class="doccomment">///</span>
284 <span class="doccomment">/// For a usage example see [this module](crate::address_validator)'s documentation.</span>
285 <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">AddressValidator</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> {
286 <span class="doccomment">/// Validate or inspect an address</span>
287 <span class="kw">fn</span> <span class="ident">validate</span>(
288 <span class="kw-2">&</span><span class="self">self</span>,
289 <span class="ident">keychain</span>: <span class="ident">KeychainKind</span>,
290 <span class="ident">hd_keypaths</span>: <span class="kw-2">&</span><span class="ident">HDKeyPaths</span>,
291 <span class="ident">script</span>: <span class="kw-2">&</span><span class="ident">Script</span>,
292 ) <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>;
295 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
296 <span class="kw">mod</span> <span class="ident">test</span> {
297 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
299 <span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
300 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">wallet</span>::<span class="ident">test</span>::{<span class="ident">get_funded_wallet</span>, <span class="ident">get_test_wpkh</span>};
301 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">wallet</span>::<span class="ident">TxBuilder</span>;
303 <span class="kw">struct</span> <span class="ident">TestValidator</span>;
304 <span class="kw">impl</span> <span class="ident">AddressValidator</span> <span class="kw">for</span> <span class="ident">TestValidator</span> {
305 <span class="kw">fn</span> <span class="ident">validate</span>(
306 <span class="kw-2">&</span><span class="self">self</span>,
307 <span class="ident">_keychain</span>: <span class="ident">KeychainKind</span>,
308 <span class="ident">_hd_keypaths</span>: <span class="kw-2">&</span><span class="ident">HDKeyPaths</span>,
309 <span class="ident">_script</span>: <span class="kw-2">&</span><span class="ident">bitcoin</span>::<span class="ident">Script</span>,
310 ) <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> {
311 <span class="prelude-val">Err</span>(<span class="ident">AddressValidatorError</span>::<span class="ident">InvalidScript</span>)
315 <span class="attribute">#[<span class="ident">test</span>]</span>
316 <span class="attribute">#[<span class="ident">should_panic</span>(<span class="ident">expected</span> <span class="op">=</span> <span class="string">"InvalidScript"</span>)]</span>
317 <span class="kw">fn</span> <span class="ident">test_address_validator_external</span>() {
318 <span class="kw">let</span> (<span class="kw-2">mut</span> <span class="ident">wallet</span>, <span class="kw">_</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">get_funded_wallet</span>(<span class="ident">get_test_wpkh</span>());
319 <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">TestValidator</span>));
321 <span class="ident">wallet</span>.<span class="ident">get_new_address</span>().<span class="ident">unwrap</span>();
324 <span class="attribute">#[<span class="ident">test</span>]</span>
325 <span class="attribute">#[<span class="ident">should_panic</span>(<span class="ident">expected</span> <span class="op">=</span> <span class="string">"InvalidScript"</span>)]</span>
326 <span class="kw">fn</span> <span class="ident">test_address_validator_internal</span>() {
327 <span class="kw">let</span> (<span class="kw-2">mut</span> <span class="ident">wallet</span>, <span class="ident">descriptors</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">get_funded_wallet</span>(<span class="ident">get_test_wpkh</span>());
328 <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">TestValidator</span>));
330 <span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="macro">testutils</span><span class="macro">!</span>(@<span class="ident">external</span> <span class="ident">descriptors</span>, <span class="number">10</span>);
331 <span class="ident">wallet</span>
332 .<span class="ident">create_tx</span>(<span class="ident">TxBuilder</span>::<span class="ident">with_recipients</span>(<span class="macro">vec</span><span class="macro">!</span>[(
333 <span class="ident">addr</span>.<span class="ident">script_pubkey</span>(),
334 <span class="number">25_000</span>,
336 .<span class="ident">unwrap</span>();
340 </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 src="../../../source-script.js"></script><script src="../../../source-files.js"></script><script defer src="../../../search-index.js"></script></body></html>
projects / bitcoindevkit.org / blob