23 lines
6.3 KiB
HTML
23 lines
6.3 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="The Partially Created Zcash Transaction (PCZT) format."><title>pczt - 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="pczt" 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="../pczt/index.html">pczt</a><span class="version">0.2.1</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><ul><li><a href="#pczt-roles-behind-feature-flags" title="PCZT roles behind feature flags">PCZT roles behind feature flags</a></li></ul></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="#enums" title="Enums">Enums</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>pczt</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/pczt/lib.rs.html#1-120">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The Partially Created Zcash Transaction (PCZT) format.</p>
|
||
<p>This format enables splitting up the logical steps of creating a Zcash transaction
|
||
across distinct entities. The entity roles roughly match those specified in
|
||
<a href="https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki">BIP 174: Partially Signed Bitcoin Transaction Format</a> and <a href="https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki">BIP 370: PSBT Version 2</a>,
|
||
with additional Zcash-specific roles.</p>
|
||
<h3 id="feature-flags"><a class="doc-anchor" href="#feature-flags">§</a>Feature flags</h3>
|
||
<ul>
|
||
<li><strong><code>orchard</code></strong> — Enables functionality that requires Orchard protocol types.</li>
|
||
<li><strong><code>sapling</code></strong> — Enables functionality that requires Sapling protocol types.</li>
|
||
<li><strong><code>transparent</code></strong> — Enables functionality that requires Zcash transparent protocol types.</li>
|
||
<li><strong><code>zcp-builder</code></strong> — Enables building a PCZT from the output of <code>zcash_primitives</code>’s <code>Builder::build_for_pczt</code>.</li>
|
||
</ul>
|
||
<h4 id="pczt-roles-behind-feature-flags"><a class="doc-anchor" href="#pczt-roles-behind-feature-flags">§</a>PCZT roles behind feature flags</h4>
|
||
<p>These roles require awareness of at least one payment protocol’s types in order to
|
||
function.</p>
|
||
<ul>
|
||
<li><strong><code>io-finalizer</code></strong> — Enables the I/O Finalizer role.</li>
|
||
<li><strong><code>prover</code></strong> — Enables the Prover role.</li>
|
||
<li><strong><code>signer</code></strong> — Enables the Signer role.</li>
|
||
<li><strong><code>spend-finalizer</code></strong> — Enables the Spend Finalizer role.</li>
|
||
<li><strong><code>tx-extractor</code></strong> — Enables the Transaction Extractor role.</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="common/index.html" title="mod pczt::common">common</a></dt><dd>The common fields of a PCZT.</dd><dt><a class="mod" href="orchard/index.html" title="mod pczt::orchard">orchard</a></dt><dd>The Orchard fields of a PCZT.</dd><dt><a class="mod" href="roles/index.html" title="mod pczt::roles">roles</a></dt><dd>Implementations of the PCZT roles.</dd><dt><a class="mod" href="sapling/index.html" title="mod pczt::sapling">sapling</a></dt><dd>The Sapling fields of a PCZT.</dd><dt><a class="mod" href="transparent/index.html" title="mod pczt::transparent">transparent</a></dt><dd>The transparent fields of a PCZT.</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.Pczt.html" title="struct pczt::Pczt">Pczt</a></dt><dd>A partially-created Zcash transaction.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ParseError.html" title="enum pczt::ParseError">Parse<wbr>Error</a></dt><dd>Errors that can occur while parsing a PCZT.</dd></dl></section></div></main></body></html> |