librustzcash/rustdoc/latest/zcash_client_backend/wallet/index.html

6 lines
7.6 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="Structs representing transaction data scanned from the block chain by a wallet or light client."><title>zcash_client_backend::wallet - 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 wallet</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate zcash_<wbr>client_<wbr>backend</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></div><h1>Module <span>wallet</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/wallet.rs.html#1-584">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Structs representing transaction data scanned from the block chain by a wallet or
light client.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.NoteId.html" title="struct zcash_client_backend::wallet::NoteId">NoteId</a></dt><dd>A unique identifier for a shielded transaction output</dd><dt><a class="struct" href="struct.ReceivedNote.html" title="struct zcash_client_backend::wallet::ReceivedNote">Received<wbr>Note</a></dt><dd>Information about a note that is tracked by the wallet that is available for spending,
with sufficient information for use in note selection.</dd><dt><a class="struct" href="struct.TransparentAddressMetadata.html" title="struct zcash_client_backend::wallet::TransparentAddressMetadata">Transparent<wbr>Address<wbr>Metadata</a><wbr><span class="stab portability" title="Available on crate feature `transparent-inputs` only"><code>transparent-inputs</code></span></dt><dd>Metadata related to the ZIP 32 derivation of a transparent address.
This is implicitly scoped to an account.</dd><dt><a class="struct" href="struct.WalletOutput.html" title="struct zcash_client_backend::wallet::WalletOutput">Wallet<wbr>Output</a></dt><dd>An output that was successfully decrypted in the process of wallet scanning.</dd><dt><a class="struct" href="struct.WalletSpend.html" title="struct zcash_client_backend::wallet::WalletSpend">Wallet<wbr>Spend</a></dt><dd>A reference to a spent note belonging to the wallet within a transaction.</dd><dt><a class="struct" href="struct.WalletTransparentOutput.html" title="struct zcash_client_backend::wallet::WalletTransparentOutput">Wallet<wbr>Transparent<wbr>Output</a></dt><dt><a class="struct" href="struct.WalletTx.html" title="struct zcash_client_backend::wallet::WalletTx">Wallet<wbr>Tx</a></dt><dd>The shielded subset of a <a href="zcash_primitives::transaction::Transaction"><code>Transaction</code></a>s data that is relevant to a particular wallet.</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.Note.html" title="enum zcash_client_backend::wallet::Note">Note</a></dt><dd>An enumeration of supported shielded note types for use in <a href="struct.ReceivedNote.html" title="struct zcash_client_backend::wallet::ReceivedNote"><code>ReceivedNote</code></a></dd><dt><a class="enum" href="enum.OvkPolicy.html" title="enum zcash_client_backend::wallet::OvkPolicy">OvkPolicy</a></dt><dd>Describes a policy for which outgoing viewing key should be able to decrypt
transaction outputs.</dd><dt><a class="enum" href="enum.Recipient.html" title="enum zcash_client_backend::wallet::Recipient">Recipient</a></dt><dd>A type that represents the recipient of a transaction output:</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.WalletOrchardOutput.html" title="type zcash_client_backend::wallet::WalletOrchardOutput">Wallet<wbr>Orchard<wbr>Output</a><wbr><span class="stab portability" title="Available on crate feature `orchard` only"><code>orchard</code></span></dt><dd>The output part of an Orchard <a href="orchard::Action"><code>Action</code></a> that was decrypted in the process of scanning.</dd><dt><a class="type" href="type.WalletOrchardSpend.html" title="type zcash_client_backend::wallet::WalletOrchardSpend">Wallet<wbr>Orchard<wbr>Spend</a><wbr><span class="stab portability" title="Available on crate feature `orchard` only"><code>orchard</code></span></dt><dd>A type alias for Orchard <a href="struct.WalletSpend.html" title="struct zcash_client_backend::wallet::WalletSpend"><code>WalletSpend</code></a>s.</dd><dt><a class="type" href="type.WalletSaplingOutput.html" title="type zcash_client_backend::wallet::WalletSaplingOutput">Wallet<wbr>Sapling<wbr>Output</a></dt><dd>A subset of an <a href="sapling::bundle::OutputDescription"><code>OutputDescription</code></a> relevant to wallets and light clients.</dd><dt><a class="type" href="type.WalletSaplingSpend.html" title="type zcash_client_backend::wallet::WalletSaplingSpend">Wallet<wbr>Sapling<wbr>Spend</a></dt><dd>A type alias for Sapling <a href="struct.WalletSpend.html" title="struct zcash_client_backend::wallet::WalletSpend"><code>WalletSpend</code></a>s.</dd></dl></section></div></main></body></html>