22 lines
5.8 KiB
HTML
22 lines
5.8 KiB
HTML
<!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="Equihash is a Proof-of-Work algorithm, based on a generalization of the Birthday problem which finds colliding hash values. It was designed to be memory-hard; more specifically, the bottle-neck for parallel implementations of Equihash solvers would be memory bandwidth."><meta name="keywords" content="rust, rustlang, rust-lang, equihash"><title>equihash - 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><script src="../crates.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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../equihash/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Crate equihash</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.1.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all equihash's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="equihash" data-ty="mod" data-relpath=""></div><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" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">equihash</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><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/equihash/lib.rs.html#1-28" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Equihash is a Proof-of-Work algorithm, based on a generalization of the Birthday
|
||
problem which finds colliding hash values. It was designed to be memory-hard; more
|
||
specifically, the bottle-neck for parallel implementations of Equihash solvers would
|
||
be memory bandwidth.</p>
|
||
<p>This crate implements Equihash as specified for the Zcash consensus rules. It can
|
||
verify solutions for any valid <code>(n, k)</code> parameters, as long as the row indices are no
|
||
larger than 32 bits (that is, <code>ceiling(((n / (k + 1)) + 1) / 8) <= 4</code>).</p>
|
||
<h1 id="references" class="section-header"><a href="#references">References</a></h1>
|
||
<ul>
|
||
<li><a href="https://zips.z.cash/protocol/protocol.pdf#equihash">Section 7.6.1: Equihash.</a> Zcash Protocol Specification, version 2020.1.10 or later.</li>
|
||
<li>Alex Biryukov and Dmitry Khovratovich.
|
||
<a href="https://www.internetsociety.org/sites/default/files/blogs-media/equihash-asymmetric-proof-of-work-based-generalized-birthday-problem.pdf"><em>Equihash: Asymmetric Proof-of-Work Based on the Generalized Birthday Problem.</em></a>
|
||
NDSS ’16.</li>
|
||
</ul>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="equihash::Error struct">Error</a></div><div class="item-right docblock-short"><p>An Equihash solution failed to verify.</p>
|
||
</div></div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
|
||
<div class="item-table"><div class="item-left module-item"><a class="fn" href="fn.is_valid_solution.html" title="equihash::is_valid_solution fn">is_valid_solution</a></div><div class="item-right docblock-short"><p>Checks whether <code>soln</code> is a valid solution for <code>(input, nonce)</code> with the
|
||
parameters <code>(n, k)</code>.</p>
|
||
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="equihash" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |