website/static/api-docs/pow_sha256/0.2.1/src/pow_sha256/lib.rs.html

465 lines
35 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<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">&#9776;</div><a href='../../pow_sha256/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>
<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>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! MCaptch&#39;s SHA256 based Proof of Work library</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Example:</span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! use pow_sha256::{ConfigBuilder, PoW};</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! fn main() {</span>
<span class="doccomment">//! let config = ConfigBuilder::default()</span>
<span class="doccomment">//! .salt(&quot;myrandomsaltisnotlongenoug&quot;.into())</span>
<span class="doccomment">//! .build()</span>
<span class="doccomment">//! .unwrap();</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let phrase = &quot;ironmansucks&quot;;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! const DIFFICULTY: u32 = 1000;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let work = config.prove_work(&amp;phrase, DIFFICULTY).unwrap();</span>
<span class="doccomment">//! assert!(config.is_valid_proof(&amp;work, &amp;phrase));</span>
<span class="doccomment">//! assert!(config.is_sufficient_difficulty(&amp;work, DIFFICULTY));</span>
<span class="doccomment">//! } </span>
<span class="doccomment">//! ```</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">marker</span>::<span class="ident">PhantomData</span>;
<span class="kw">use</span> <span class="ident">derive_builder</span>::<span class="ident">Builder</span>;
<span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
<span class="kw">use</span> <span class="ident">sha2</span>::{<span class="ident">Digest</span>, <span class="ident">Sha256</span>};
<span class="doccomment">/// Proof of Work over concrete type T. T can be any type that implements serde::Serialize.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>, <span class="ident">Builder</span>, <span class="ident">Deserialize</span>, <span class="ident">PartialEq</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> {
<span class="kw">pub</span> <span class="ident">nonce</span>: <span class="ident">u64</span>,
<span class="kw">pub</span> <span class="ident">result</span>: <span class="ident">String</span>,
<span class="attribute">#[<span class="ident">builder</span>(<span class="ident">default</span> <span class="op">=</span> <span class="string">&quot;PhantomData&quot;</span>, <span class="ident">setter</span>(<span class="ident">skip</span>))]</span>
<span class="ident">_spook</span>: <span class="ident">PhantomData</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>,
}
<span class="doccomment">/// Configuration for generting proof of work</span>
<span class="doccomment">/// Please choose a long, unique value for salt</span>
<span class="doccomment">/// Resistance to dictionary/rainbow attacks depend on uniqueness</span>
<span class="doccomment">/// of the salt</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>, <span class="ident">Deserialize</span>, <span class="ident">Builder</span>, <span class="ident">PartialEq</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Config</span> {
<span class="kw">pub</span> <span class="ident">salt</span>: <span class="ident">String</span>,
}
<span class="kw">impl</span> <span class="ident">Config</span> {
<span class="doccomment">/// Create Proof of Work over item of type T.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Make sure difficulty is not too high. A 64 bit difficulty,</span>
<span class="doccomment">/// for example, takes a long time on a general purpose processor.</span>
<span class="doccomment">/// Returns bincode::Error if serialization fails.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">prove_work</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">t</span>: <span class="kw-2">&amp;</span><span class="ident">T</span>, <span class="ident">difficulty</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bincode</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span><span class="op">&gt;</span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Serialize</span>,
{
<span class="ident">bincode</span>::<span class="ident">serialize</span>(<span class="ident">t</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">prove_work_serialized</span>(<span class="kw-2">&amp;</span><span class="ident">v</span>, <span class="ident">difficulty</span>))
}
<span class="doccomment">/// Create Proof of Work on an already serialized item of type T.</span>
<span class="doccomment">/// The input is assumed to be serialized using network byte order.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Make sure difficulty is not too high. A 64 bit difficulty,</span>
<span class="doccomment">/// for example, takes a long time on a general purpose processor.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">prove_work_serialized</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">prefix</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>], <span class="ident">difficulty</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Serialize</span>,
{
<span class="kw">let</span> <span class="ident">prefix_sha</span> <span class="op">=</span> <span class="ident">Sha256</span>::<span class="ident">new</span>().<span class="ident">chain</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">salt</span>).<span class="ident">chain</span>(<span class="ident">prefix</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">n</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="ident">difficulty</span> <span class="op">=</span> <span class="ident">get_difficulty</span>(<span class="ident">difficulty</span>);
<span class="kw">while</span> <span class="ident">result</span> <span class="op">&lt;</span> <span class="ident">difficulty</span> {
<span class="ident">n</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
<span class="ident">result</span> <span class="op">=</span> <span class="ident">score</span>(<span class="ident">prefix_sha</span>.<span class="ident">clone</span>(), <span class="ident">n</span>);
}
<span class="ident">PoW</span> {
<span class="ident">nonce</span>: <span class="ident">n</span>,
<span class="ident">result</span>: <span class="ident">result</span>.<span class="ident">to_string</span>(),
<span class="ident">_spook</span>: <span class="ident">PhantomData</span>,
}
}
<span class="doccomment">/// Calculate the PoW score with the provided input T.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">calculate</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">pow</span>: <span class="kw-2">&amp;</span><span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>, <span class="ident">t</span>: <span class="kw-2">&amp;</span><span class="ident">T</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bincode</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">u128</span><span class="op">&gt;</span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Serialize</span>,
{
<span class="ident">bincode</span>::<span class="ident">serialize</span>(<span class="ident">t</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">calculate_serialized</span>(<span class="ident">pow</span>, <span class="kw-2">&amp;</span><span class="ident">v</span>))
}
<span class="doccomment">/// Calculate the PoW score of an already serialized T and self.</span>
<span class="doccomment">/// The input is assumed to be serialized using network byte order.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">calculate_serialized</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">pow</span>: <span class="kw-2">&amp;</span><span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>, <span class="ident">target</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">u128</span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Serialize</span>,
{
<span class="ident">score</span>(<span class="ident">Sha256</span>::<span class="ident">new</span>().<span class="ident">chain</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">salt</span>).<span class="ident">chain</span>(<span class="ident">target</span>), <span class="ident">pow</span>.<span class="ident">nonce</span>)
}
<span class="doccomment">/// Verifies that the PoW is indeed generated out of the phrase provided.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_valid_proof</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">pow</span>: <span class="kw-2">&amp;</span><span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>, <span class="ident">t</span>: <span class="kw-2">&amp;</span><span class="ident">T</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bool</span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Serialize</span>,
{
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">calculate</span>(<span class="ident">pow</span>, <span class="ident">t</span>) {
<span class="prelude-val">Ok</span>(<span class="ident">res</span>) <span class="op">=</span><span class="op">&gt;</span> {
<span class="kw">return</span> <span class="kw">if</span> <span class="ident">pow</span>.<span class="ident">result</span> <span class="op">=</span><span class="op">=</span> <span class="ident">res</span>.<span class="ident">to_string</span>() {
<span class="bool-val">true</span>
} <span class="kw">else</span> {
<span class="bool-val">false</span>
}
}
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="kw">return</span> <span class="bool-val">false</span>,
}
}
<span class="doccomment">/// Checks if the PoW result is of sufficient difficulty</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_sufficient_difficulty</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">pow</span>: <span class="kw-2">&amp;</span><span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>, <span class="ident">target_diff</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bool</span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Serialize</span>,
{
<span class="kw">match</span> <span class="ident">pow</span>.<span class="ident">result</span>.<span class="ident">parse</span>::<span class="op">&lt;</span><span class="ident">u128</span><span class="op">&gt;</span>() {
<span class="prelude-val">Ok</span>(<span class="ident">res</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="kw">return</span> <span class="ident">res</span> <span class="op">&gt;</span><span class="op">=</span> <span class="ident">get_difficulty</span>(<span class="ident">target_diff</span>),
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="kw">return</span> <span class="bool-val">false</span>,
}
}
}
<span class="kw">fn</span> <span class="ident">score</span>(<span class="ident">prefix_sha</span>: <span class="ident">Sha256</span>, <span class="ident">nonce</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">u128</span> {
<span class="ident">first_bytes_as_u128</span>(
<span class="ident">prefix_sha</span>
.<span class="ident">chain</span>(<span class="kw-2">&amp;</span><span class="ident">nonce</span>.<span class="ident">to_be_bytes</span>()) <span class="comment">// to_be_bytes() converts to network endian</span>
.<span class="ident">finalize</span>()
.<span class="ident">as_slice</span>(),
)
}
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// panics if inp.len() &lt; 16</span>
<span class="kw">fn</span> <span class="ident">first_bytes_as_u128</span>(<span class="ident">inp</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">u128</span> {
<span class="kw">use</span> <span class="ident">bincode</span>::<span class="ident">config</span>::<span class="kw-2">*</span>;
<span class="ident">DefaultOptions</span>::<span class="ident">new</span>()
.<span class="ident">with_fixint_encoding</span>()
.<span class="ident">allow_trailing_bytes</span>()
.<span class="ident">with_no_limit</span>()
.<span class="ident">with_big_endian</span>()
.<span class="ident">deserialize</span>(<span class="kw-2">&amp;</span><span class="ident">inp</span>)
.<span class="ident">unwrap</span>()
}
<span class="comment">// utility function to get u128 difficulty factor from u32</span>
<span class="comment">// javacript isn&#39;t capable of represnting u128 so</span>
<span class="kw">fn</span> <span class="ident">get_difficulty</span>(<span class="ident">difficulty_factor</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">u128</span> {
<span class="ident">u128</span>::<span class="ident">max_value</span>() <span class="op">-</span> <span class="ident">u128</span>::<span class="ident">max_value</span>() <span class="op">/</span> <span class="ident">difficulty_factor</span> <span class="kw">as</span> <span class="ident">u128</span>
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">test</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">const</span> <span class="ident">DIFFICULTY</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">1000</span>;
<span class="kw">fn</span> <span class="ident">get_config</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Config</span> {
<span class="ident">ConfigBuilder</span>::<span class="ident">default</span>()
.<span class="ident">salt</span>(
<span class="string">&quot;79ziepia7vhjgviiwjhnend3ofjqocsi2winc4ptqhmkvcajihywxcizewvckg9h6gs4j83v9&quot;</span>.<span class="ident">into</span>(),
)
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>()
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">base_functionality</span>() {
<span class="comment">// Let&#39;s prove we did work targeting a phrase.</span>
<span class="kw">let</span> <span class="ident">phrase</span> <span class="op">=</span> <span class="string">b&quot;Ex nihilo nihil fit.&quot;</span>.<span class="ident">to_vec</span>();
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">get_config</span>();
<span class="kw">let</span> <span class="ident">pw</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&amp;</span><span class="ident">phrase</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">calculate</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="kw-2">&amp;</span><span class="ident">phrase</span>).<span class="ident">unwrap</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">get_difficulty</span>(<span class="ident">DIFFICULTY</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="kw-2">&amp;</span><span class="ident">phrase</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_sufficient_difficulty</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="ident">DIFFICULTY</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">double_pow</span>() {
<span class="kw">let</span> <span class="ident">phrase</span> <span class="op">=</span> <span class="string">&quot;Ex nihilo nihil fit.&quot;</span>.<span class="ident">to_owned</span>();
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">get_config</span>();
<span class="kw">let</span> <span class="ident">pw</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&amp;</span><span class="ident">phrase</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">pwpw</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">calculate</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="kw-2">&amp;</span><span class="ident">phrase</span>).<span class="ident">unwrap</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">get_difficulty</span>(<span class="ident">DIFFICULTY</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="kw-2">&amp;</span><span class="ident">phrase</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_sufficient_difficulty</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="ident">DIFFICULTY</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">calculate</span>(<span class="kw-2">&amp;</span><span class="ident">pwpw</span>, <span class="kw-2">&amp;</span><span class="ident">pw</span>).<span class="ident">unwrap</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">get_difficulty</span>(<span class="ident">DIFFICULTY</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&amp;</span><span class="ident">pwpw</span>, <span class="kw-2">&amp;</span><span class="ident">pw</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_sufficient_difficulty</span>(<span class="kw-2">&amp;</span><span class="ident">pwpw</span>, <span class="ident">DIFFICULTY</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">is_not_valid_proof</span>() {
<span class="kw">let</span> <span class="ident">phrase</span> <span class="op">=</span> <span class="string">&quot;Ex nihilo nihil fit.&quot;</span>.<span class="ident">to_owned</span>();
<span class="kw">let</span> <span class="ident">phrase2</span> <span class="op">=</span> <span class="string">&quot;Omne quod movetur ab alio movetur.&quot;</span>.<span class="ident">to_owned</span>();
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">get_config</span>();
<span class="kw">let</span> <span class="ident">pw</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&amp;</span><span class="ident">phrase</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">pw2</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&amp;</span><span class="ident">phrase2</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&amp;</span><span class="ident">pw</span>, <span class="kw-2">&amp;</span><span class="ident">phrase2</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&amp;</span><span class="ident">pw2</span>, <span class="kw-2">&amp;</span><span class="ident">phrase</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">serialization_test</span>() {
<span class="kw">let</span> <span class="ident">target</span>: <span class="ident">u8</span> <span class="op">=</span> <span class="number">1</span>;
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">get_config</span>();
<span class="kw">let</span> <span class="ident">pw</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&amp;</span><span class="ident">target</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">message</span>: (<span class="ident">u8</span>, <span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>) <span class="op">=</span> (<span class="ident">target</span>, <span class="ident">pw</span>);
<span class="kw">let</span> <span class="ident">message_ser</span> <span class="op">=</span> <span class="ident">bincode</span>::<span class="ident">serialize</span>(<span class="kw-2">&amp;</span><span class="ident">message</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">recieved_message</span>: (<span class="ident">u8</span>, <span class="ident">PoW</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>) <span class="op">=</span> <span class="ident">bincode</span>::<span class="ident">deserialize</span>(<span class="kw-2">&amp;</span><span class="ident">message_ser</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">recieved_message</span>, <span class="ident">message</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_sufficient_difficulty</span>(<span class="kw-2">&amp;</span><span class="ident">message</span>.<span class="number">1</span>, <span class="ident">DIFFICULTY</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&amp;</span><span class="ident">message</span>.<span class="number">1</span>, <span class="kw-2">&amp;</span><span class="ident">target</span>));
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pow_sha256"></div>
<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>