zec
/
librustzcash
mirror of https://github.com/zcash/librustzcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
librustzcash/rustdoc/latest/zcash_proofs/index.html

20 lines
8.9 KiB
HTML
Raw Permalink 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="Zcash circuits and proofs."><title>zcash_proofs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-20739d33.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="zcash_proofs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.88.0-nightly (74509131e 2025-04-29)" data-channel="nightly" data-search-js="search-f7877310.js" data-settings-js="settings-5514c975.js" ><script src="../static.files/storage-4e99c027.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-7ef8a74a.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../zcash_proofs/index.html">zcash_<wbr>proofs</a><span class="version">0.22.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#feature-flags" title="Feature flags">Feature flags</a></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>zcash_proofs</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/zcash_proofs/lib.rs.html#1-513">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><em>Zcash circuits and proofs.</em></p>
<p><code>zcash_proofs</code> contains the zk-SNARK circuits used by Zcash, and the APIs for creating
and verifying proofs.</p>
<h3 id="feature-flags"><a class="doc-anchor" href="#feature-flags">§</a>Feature flags</h3>
<ul>
<li><strong><code>bundled-prover</code></strong> — Bundles the Sapling proving parameters inside the binary, which will increase its size
by around 50 MiB.</li>
<li><strong><code>directories</code></strong> — Enables APIs for determining the default location on the local filesystem for storing
the Sprout and Sapling proving parameters.</li>
<li><strong><code>download-params</code></strong> — Enables APIs for downloading the Sprout and Sapling proving parameters to the default
location on the local filesystem.</li>
<li><strong><code>local-prover</code></strong> <em>(enabled by default)</em> — Enables APIs for loading the Sapling proving parameters from the default location on
the local filesystem.</li>
<li><strong><code>multicore</code></strong> <em>(enabled by default)</em> — Enables multithreading support for creating proofs.</li>
<li><strong><code>expensive-tests</code></strong> — A feature used to isolate tests that are expensive to run. Test-only.</li>
</ul>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="circuit/index.html" title="mod zcash_proofs::circuit">circuit</a></dt><dd>Implementations of the Zcash circuits and Zcash-specific gadgets.</dd><dt><a class="mod" href="prover/index.html" title="mod zcash_proofs::prover">prover</a><wbr><span class="stab portability" title="Available on crate features `local-prover` or `bundled-prover` only"><code>local-prover</code> or <code>bundled-prover</code></span></dt><dd>Abstractions over the proving system and parameters for ease of use.</dd><dt><a class="mod" href="sprout/index.html" title="mod zcash_proofs::sprout">sprout</a></dt><dd>APIs for creating and verifying Sprout proofs.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.SaplingParameterPaths.html" title="struct zcash_proofs::SaplingParameterPaths">Sapling<wbr>Parameter<wbr>Paths</a><wbr><span class="stab portability" title="Available on crate feature `download-params` only"><code>download-params</code></span></dt><dd>The paths to the Sapling parameter files.</dd><dt><a class="struct" href="struct.ZcashParameters.html" title="struct zcash_proofs::ZcashParameters">Zcash<wbr>Parameters</a></dt><dd>Zcash Sprout and Sapling groth16 circuit parameters.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.SAPLING_OUTPUT_NAME.html" title="constant zcash_proofs::SAPLING_OUTPUT_NAME">SAPLING_<wbr>OUTPUT_<wbr>NAME</a></dt><dd>The sapling output parameters file name.</dd><dt><a class="constant" href="constant.SAPLING_SPEND_NAME.html" title="constant zcash_proofs::SAPLING_SPEND_NAME">SAPLING_<wbr>SPEND_<wbr>NAME</a></dt><dd>The sapling spend parameters file name.</dd><dt><a class="constant" href="constant.SPROUT_NAME.html" title="constant zcash_proofs::SPROUT_NAME">SPROUT_<wbr>NAME</a></dt><dd>The sprout parameters file name.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.default_params_folder.html" title="fn zcash_proofs::default_params_folder">default_<wbr>params_<wbr>folder</a><wbr><span class="stab portability" title="Available on crate feature `directories` only"><code>directories</code></span></dt><dd>Returns the default folder that the Zcash proving parameters are located in.</dd><dt><a class="fn" href="fn.download_parameters.html" title="fn zcash_proofs::download_parameters">download_<wbr>parameters</a><wbr><span class="stab deprecated" title="">Deprecated</span><wbr><span class="stab portability" title="Available on crate feature `download-params` only"><code>download-params</code></span></dt><dd>Download the Zcash Sapling parameters if needed, and store them in the default location.
Always checks the sizes and hashes of the files, even if they didn’t need to be downloaded.</dd><dt><a class="fn" href="fn.download_sapling_parameters.html" title="fn zcash_proofs::download_sapling_parameters">download_<wbr>sapling_<wbr>parameters</a><wbr><span class="stab portability" title="Available on crate feature `download-params` only"><code>download-params</code></span></dt><dd>Download the Zcash Sapling parameters if needed, and store them in the default location.
Always checks the sizes and hashes of the files, even if they didn’t need to be downloaded.</dd><dt><a class="fn" href="fn.download_sprout_parameters.html" title="fn zcash_proofs::download_sprout_parameters">download_<wbr>sprout_<wbr>parameters</a><wbr><span class="stab portability" title="Available on crate feature `download-params` only"><code>download-params</code></span></dt><dd>Download the Zcash Sprout parameters if needed, and store them in the default location.
Always checks the size and hash of the file, even if it didn’t need to be downloaded.</dd><dt><a class="fn" href="fn.load_parameters.html" title="fn zcash_proofs::load_parameters">load_<wbr>parameters</a></dt><dd>Load the specified parameters, checking the sizes and hashes of the files.</dd><dt><a class="fn" href="fn.parse_parameters.html" title="fn zcash_proofs::parse_parameters">parse_<wbr>parameters</a></dt><dd>Parse Bls12 keys from bytes as serialized by <a href="bellman::groth16::Parameters::write"><code>groth16::Parameters::write</code></a>.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink