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/descriptor/checksum.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>checksum.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 </pre><div class="example-wrap"><pre class="rust ">
131 <span class="comment">// Magical Bitcoin Library</span>
132 <span class="comment">// Written in 2020 by</span>
133 <span class="comment">// Alekos Filini <alekos.filini@gmail.com></span>
134 <span class="comment">//</span>
135 <span class="comment">// Copyright (c) 2020 Magical Bitcoin</span>
136 <span class="comment">//</span>
137 <span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span>
138 <span class="comment">// of this software and associated documentation files (the "Software"), to deal</span>
139 <span class="comment">// in the Software without restriction, including without limitation the rights</span>
140 <span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
141 <span class="comment">// copies of the Software, and to permit persons to whom the Software is</span>
142 <span class="comment">// furnished to do so, subject to the following conditions:</span>
143 <span class="comment">//</span>
144 <span class="comment">// The above copyright notice and this permission notice shall be included in all</span>
145 <span class="comment">// copies or substantial portions of the Software.</span>
146 <span class="comment">//</span>
147 <span class="comment">// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
148 <span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
149 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
150 <span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
151 <span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
152 <span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
153 <span class="comment">// SOFTWARE.</span>
155 <span class="doccomment">//! Descriptor checksum</span>
156 <span class="doccomment">//!</span>
157 <span class="doccomment">//! This module contains a re-implementation of the function used by Bitcoin Core to calculate the</span>
158 <span class="doccomment">//! checksum of a descriptor</span>
160 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">iter</span>::<span class="ident">FromIterator</span>;
162 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">descriptor</span>::<span class="ident">Error</span>;
164 <span class="kw">const</span> <span class="ident">INPUT_CHARSET</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"0123456789()[],'/*abcdefgh@:$%{}IJKLMNOPQRSTUVWXYZ&+-.;<=>?!^_|~ijklmnopqrstuvwxyzABCDEFGH`#\"\\ "</span>;
165 <span class="kw">const</span> <span class="ident">CHECKSUM_CHARSET</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"qpzry9x8gf2tvdw0s3jn54khce6mua7l"</span>;
167 <span class="kw">fn</span> <span class="ident">poly_mod</span>(<span class="kw-2">mut</span> <span class="ident">c</span>: <span class="ident">u64</span>, <span class="ident">val</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> {
168 <span class="kw">let</span> <span class="ident">c0</span> <span class="op">=</span> <span class="ident">c</span> <span class="op">></span><span class="op">></span> <span class="number">35</span>;
169 <span class="ident">c</span> <span class="op">=</span> ((<span class="ident">c</span> <span class="op">&</span> <span class="number">0x7ffffffff</span>) <span class="op"><</span><span class="op"><</span> <span class="number">5</span>) <span class="op">^</span> <span class="ident">val</span>;
170 <span class="kw">if</span> <span class="ident">c0</span> <span class="op">&</span> <span class="number">1</span> <span class="op">></span> <span class="number">0</span> {
171 <span class="ident">c</span> <span class="op">^</span><span class="op">=</span> <span class="number">0xf5dee51989</span>
173 <span class="kw">if</span> <span class="ident">c0</span> <span class="op">&</span> <span class="number">2</span> <span class="op">></span> <span class="number">0</span> {
174 <span class="ident">c</span> <span class="op">^</span><span class="op">=</span> <span class="number">0xa9fdca3312</span>
176 <span class="kw">if</span> <span class="ident">c0</span> <span class="op">&</span> <span class="number">4</span> <span class="op">></span> <span class="number">0</span> {
177 <span class="ident">c</span> <span class="op">^</span><span class="op">=</span> <span class="number">0x1bab10e32d</span>
179 <span class="kw">if</span> <span class="ident">c0</span> <span class="op">&</span> <span class="number">8</span> <span class="op">></span> <span class="number">0</span> {
180 <span class="ident">c</span> <span class="op">^</span><span class="op">=</span> <span class="number">0x3706b1677a</span>
182 <span class="kw">if</span> <span class="ident">c0</span> <span class="op">&</span> <span class="number">16</span> <span class="op">></span> <span class="number">0</span> {
183 <span class="ident">c</span> <span class="op">^</span><span class="op">=</span> <span class="number">0x644d626ffd</span>
186 <span class="ident">c</span>
189 <span class="doccomment">/// Compute the checksum of a descriptor</span>
190 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_checksum</span>(<span class="ident">desc</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">Error</span><span class="op">></span> {
191 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="number">1</span>;
192 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cls</span> <span class="op">=</span> <span class="number">0</span>;
193 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">clscount</span> <span class="op">=</span> <span class="number">0</span>;
194 <span class="kw">for</span> <span class="ident">ch</span> <span class="kw">in</span> <span class="ident">desc</span>.<span class="ident">chars</span>() {
195 <span class="kw">let</span> <span class="ident">pos</span> <span class="op">=</span> <span class="ident">INPUT_CHARSET</span>
196 .<span class="ident">find</span>(<span class="ident">ch</span>)
197 .<span class="ident">ok_or</span>(<span class="ident">Error</span>::<span class="ident">InvalidDescriptorCharacter</span>(<span class="ident">ch</span>))<span class="question-mark">?</span> <span class="kw">as</span> <span class="ident">u64</span>;
198 <span class="ident">c</span> <span class="op">=</span> <span class="ident">poly_mod</span>(<span class="ident">c</span>, <span class="ident">pos</span> <span class="op">&</span> <span class="number">31</span>);
199 <span class="ident">cls</span> <span class="op">=</span> <span class="ident">cls</span> <span class="op">*</span> <span class="number">3</span> <span class="op">+</span> (<span class="ident">pos</span> <span class="op">></span><span class="op">></span> <span class="number">5</span>);
200 <span class="ident">clscount</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
201 <span class="kw">if</span> <span class="ident">clscount</span> <span class="op">=</span><span class="op">=</span> <span class="number">3</span> {
202 <span class="ident">c</span> <span class="op">=</span> <span class="ident">poly_mod</span>(<span class="ident">c</span>, <span class="ident">cls</span>);
203 <span class="ident">cls</span> <span class="op">=</span> <span class="number">0</span>;
204 <span class="ident">clscount</span> <span class="op">=</span> <span class="number">0</span>;
207 <span class="kw">if</span> <span class="ident">clscount</span> <span class="op">></span> <span class="number">0</span> {
208 <span class="ident">c</span> <span class="op">=</span> <span class="ident">poly_mod</span>(<span class="ident">c</span>, <span class="ident">cls</span>);
210 (<span class="number">0</span>..<span class="number">8</span>).<span class="ident">for_each</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">poly_mod</span>(<span class="ident">c</span>, <span class="number">0</span>));
211 <span class="ident">c</span> <span class="op">^</span><span class="op">=</span> <span class="number">1</span>;
213 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">chars</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">8</span>);
214 <span class="kw">for</span> <span class="ident">j</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">8</span> {
215 <span class="ident">chars</span>.<span class="ident">push</span>(
216 <span class="ident">CHECKSUM_CHARSET</span>
217 .<span class="ident">chars</span>()
218 .<span class="ident">nth</span>(((<span class="ident">c</span> <span class="op">></span><span class="op">></span> (<span class="number">5</span> <span class="op">*</span> (<span class="number">7</span> <span class="op">-</span> <span class="ident">j</span>))) <span class="op">&</span> <span class="number">31</span>) <span class="kw">as</span> <span class="ident">usize</span>)
219 .<span class="ident">unwrap</span>(),
223 <span class="prelude-val">Ok</span>(<span class="ident">String</span>::<span class="ident">from_iter</span>(<span class="ident">chars</span>))
226 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
227 <span class="kw">mod</span> <span class="ident">test</span> {
228 <span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
229 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">descriptor</span>::<span class="ident">get_checksum</span>;
231 <span class="comment">// test get_checksum() function; it should return the same value as Bitcoin Core</span>
232 <span class="attribute">#[<span class="ident">test</span>]</span>
233 <span class="kw">fn</span> <span class="ident">test_get_checksum</span>() {
234 <span class="kw">let</span> <span class="ident">desc</span> <span class="op">=</span> <span class="string">"wpkh(tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcLNfjdi5qUvw3VDfgYiH5mNsj5izuiu2N/1/2/*)"</span>;
235 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">get_checksum</span>(<span class="ident">desc</span>).<span class="ident">unwrap</span>(), <span class="string">"tqz0nc62"</span>);
237 <span class="kw">let</span> <span class="ident">desc</span> <span class="op">=</span> <span class="string">"pkh(tpubD6NzVbkrYhZ4XHndKkuB8FifXm8r5FQHwrN6oZuWCz13qb93rtgKvD4PQsqC4HP4yhV3tA2fqr2RbY5mNXfM7RxXUoeABoDtsFUq2zJq6YK/44'/1'/0'/0/*)"</span>;
238 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">get_checksum</span>(<span class="ident">desc</span>).<span class="ident">unwrap</span>(), <span class="string">"lasegmfs"</span>);
241 <span class="attribute">#[<span class="ident">test</span>]</span>
242 <span class="kw">fn</span> <span class="ident">test_get_checksum_invalid_character</span>() {
243 <span class="kw">let</span> <span class="ident">sparkle_heart</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">240</span>, <span class="number">159</span>, <span class="number">146</span>, <span class="number">150</span>];
244 <span class="kw">let</span> <span class="ident">sparkle_heart</span> <span class="op">=</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="kw-2">&</span><span class="ident">sparkle_heart</span>)
245 .<span class="ident">unwrap</span>()
246 .<span class="ident">chars</span>()
247 .<span class="ident">next</span>()
248 .<span class="ident">unwrap</span>();
249 <span class="kw">let</span> <span class="ident">invalid_desc</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">"wpkh(tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcL{}fjdi5qUvw3VDfgYiH5mNsj5izuiu2N/1/2/*)"</span>, <span class="ident">sparkle_heart</span>);
251 <span class="macro">assert</span><span class="macro">!</span>(<span class="macro">matches</span><span class="macro">!</span>(
252 <span class="ident">get_checksum</span>(<span class="kw-2">&</span><span class="ident">invalid_desc</span>).<span class="ident">err</span>(),
253 <span class="prelude-val">Some</span>(<span class="ident">Error</span>::<span class="ident">InvalidDescriptorCharacter</span>(<span class="ident">invalid_char</span>)) <span class="kw">if</span> <span class="ident">invalid_char</span> <span class="op">=</span><span class="op">=</span> <span class="ident">sparkle_heart</span>
258 </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