librustzcash/rustdoc/latest/zcash_client_backend/proto/proposal/index.html

8 lines
6.6 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="API documentation for the Rust `proposal` mod in crate `zcash_client_backend`."><title>zcash_client_backend::proto::proposal - 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_client_backend" 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="../sidebar-items.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"><!--[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_client_backend/index.html">zcash_<wbr>client_<wbr>backend</a><span class="version">0.18.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module proposal</a></h2><h3><a href="#modules">Module 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"><h2><a href="../index.html">In zcash_<wbr>client_<wbr>backend::<wbr>proto</a></h2></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"><div class="rustdoc-breadcrumbs"><a href="../../index.html">zcash_client_backend</a>::<wbr><a href="../index.html">proto</a></div><h1>Module <span>proposal</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_client_backend/proto/proposal.rs.html#2-225">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="proposed_input/index.html" title="mod zcash_client_backend::proto::proposal::proposed_input">proposed_<wbr>input</a></dt><dd>Nested message and enum types in <code>ProposedInput</code>.</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.ChangeValue.html" title="struct zcash_client_backend::proto::proposal::ChangeValue">Change<wbr>Value</a></dt><dd>A proposed change or ephemeral output. If the transparent value pool is
selected, the <code>memo</code> field must be null.</dd><dt><a class="struct" href="struct.MemoBytes.html" title="struct zcash_client_backend::proto::proposal::MemoBytes">Memo<wbr>Bytes</a></dt><dd>An object wrapper for memo bytes, to facilitate representing the
<code>change_memo == None</code> case.</dd><dt><a class="struct" href="struct.PaymentOutputPool.html" title="struct zcash_client_backend::proto::proposal::PaymentOutputPool">Payment<wbr>Output<wbr>Pool</a></dt><dd>A mapping from ZIP 321 payment index to the output pool that has been chosen
for that payment, based upon the payment address and the selected inputs to
the transaction.</dd><dt><a class="struct" href="struct.PriorStepChange.html" title="struct zcash_client_backend::proto::proposal::PriorStepChange">Prior<wbr>Step<wbr>Change</a></dt><dd>A reference to a change or ephemeral output from a prior step of the proposal.</dd><dt><a class="struct" href="struct.PriorStepOutput.html" title="struct zcash_client_backend::proto::proposal::PriorStepOutput">Prior<wbr>Step<wbr>Output</a></dt><dd>A reference to a payment in a prior step of the proposal. This payment must
belong to the wallet.</dd><dt><a class="struct" href="struct.Proposal.html" title="struct zcash_client_backend::proto::proposal::Proposal">Proposal</a></dt><dd>A data structure that describes a series of transactions to be created.</dd><dt><a class="struct" href="struct.ProposalStep.html" title="struct zcash_client_backend::proto::proposal::ProposalStep">Proposal<wbr>Step</a></dt><dd>A data structure that describes the inputs to be consumed and outputs to
be produced in a proposed transaction.</dd><dt><a class="struct" href="struct.ProposedInput.html" title="struct zcash_client_backend::proto::proposal::ProposedInput">Proposed<wbr>Input</a></dt><dd>The unique identifier and value for an input to be used in the transaction.</dd><dt><a class="struct" href="struct.ReceivedOutput.html" title="struct zcash_client_backend::proto::proposal::ReceivedOutput">Received<wbr>Output</a></dt><dd>The unique identifier and value for each proposed input that does not
require a back-reference to a prior step of the proposal.</dd><dt><a class="struct" href="struct.TransactionBalance.html" title="struct zcash_client_backend::proto::proposal::TransactionBalance">Transaction<wbr>Balance</a></dt><dd>The proposed change outputs and fee value.</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.FeeRule.html" title="enum zcash_client_backend::proto::proposal::FeeRule">FeeRule</a></dt><dd>The fee rule used in constructing a Proposal</dd><dt><a class="enum" href="enum.ValuePool.html" title="enum zcash_client_backend::proto::proposal::ValuePool">Value<wbr>Pool</a></dt></dl></section></div></main></body></html>