librustzcash/rustdoc/latest/zcash_primitives/sapling/index.html

22 lines
9.6 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="Structs and constants specific to the Sapling shielded pool."><meta name="keywords" content="rust, rustlang, rust-lang, sapling"><title>zcash_primitives::sapling - 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"><!--[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">&#9776;</div><a href='../../zcash_primitives/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module sapling</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="sapling" 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">Module <a href="../index.html">zcash_primitives</a>::<wbr><a class="mod" href="#">sapling</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/zcash_primitives/sapling.rs.html#1-569" 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>Structs and constants specific to the Sapling shielded pool.</p>
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="mod" href="group_hash/index.html" title="zcash_primitives::sapling::group_hash mod">group_hash</a></div><div class="item-right docblock-short"><p>Implementation of <a href="https://zips.z.cash/protocol/protocol.pdf#concretegrouphashjubjub">group hashing into Jubjub</a>.</p>
</div><div class="item-left module-item"><a class="mod" href="keys/index.html" title="zcash_primitives::sapling::keys mod">keys</a></div><div class="item-right docblock-short"><p>Sapling key components.</p>
</div><div class="item-left module-item"><a class="mod" href="note_encryption/index.html" title="zcash_primitives::sapling::note_encryption mod">note_encryption</a></div><div class="item-right docblock-short"><p>Implementation of in-band secret distribution for Zcash transactions.</p>
</div><div class="item-left module-item"><a class="mod" href="pedersen_hash/index.html" title="zcash_primitives::sapling::pedersen_hash mod">pedersen_hash</a></div><div class="item-right docblock-short"><p>Implementation of the Pedersen hash function used in Sapling.</p>
</div><div class="item-left module-item"><a class="mod" href="prover/index.html" title="zcash_primitives::sapling::prover mod">prover</a></div><div class="item-right docblock-short"><p>Abstractions over the proving system and parameters.</p>
</div><div class="item-left module-item"><a class="mod" href="redjubjub/index.html" title="zcash_primitives::sapling::redjubjub mod">redjubjub</a></div><div class="item-right docblock-short"><p>Implementation of <a href="https://zips.z.cash/protocol/protocol.pdf#concretereddsa">RedJubjub</a>, a specialization of RedDSA to the Jubjub
curve.</p>
</div><div class="item-left module-item"><a class="mod" href="testing/index.html" title="zcash_primitives::sapling::testing mod">testing</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="mod" href="util/index.html" title="zcash_primitives::sapling::util mod">util</a></div><div class="item-right docblock-short"></div></div><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.Diversifier.html" title="zcash_primitives::sapling::Diversifier struct">Diversifier</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.Node.html" title="zcash_primitives::sapling::Node struct">Node</a></div><div class="item-right docblock-short"><p>A node within the Sapling commitment tree.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Note.html" title="zcash_primitives::sapling::Note struct">Note</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.NoteValue.html" title="zcash_primitives::sapling::NoteValue struct">NoteValue</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.Nullifier.html" title="zcash_primitives::sapling::Nullifier struct">Nullifier</a></div><div class="item-right docblock-short"><p>Typesafe wrapper for nullifier values.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.PaymentAddress.html" title="zcash_primitives::sapling::PaymentAddress struct">PaymentAddress</a></div><div class="item-right docblock-short"><p>A Sapling payment address.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.ProofGenerationKey.html" title="zcash_primitives::sapling::ProofGenerationKey struct">ProofGenerationKey</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.SaplingIvk.html" title="zcash_primitives::sapling::SaplingIvk struct">SaplingIvk</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.ValueCommitment.html" title="zcash_primitives::sapling::ValueCommitment struct">ValueCommitment</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.ViewingKey.html" title="zcash_primitives::sapling::ViewingKey struct">ViewingKey</a></div><div class="item-right docblock-short"></div></div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="enum" href="enum.Rseed.html" title="zcash_primitives::sapling::Rseed enum">Rseed</a></div><div class="item-right docblock-short"><p>Enum for note randomness before and after <a href="https://zips.z.cash/zip-0212">ZIP 212</a>.</p>
</div></div><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="constant" href="constant.SAPLING_COMMITMENT_TREE_DEPTH.html" title="zcash_primitives::sapling::SAPLING_COMMITMENT_TREE_DEPTH constant">SAPLING_COMMITMENT_TREE_DEPTH</a></div><div class="item-right docblock-short"></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.merkle_hash.html" title="zcash_primitives::sapling::merkle_hash fn">merkle_hash</a></div><div class="item-right docblock-short"><p>Compute a parent node in the Sapling commitment tree given its two children.</p>
</div><div class="item-left module-item"><a class="fn" href="fn.spend_sig.html" title="zcash_primitives::sapling::spend_sig fn">spend_sig</a></div><div class="item-right docblock-short"><p>Create the spendAuthSig for a Sapling SpendDescription.</p>
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="zcash_primitives" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script>
</body></html>