48 lines
21 KiB
HTML
48 lines
21 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="This trait describes a capability for manipulating wallet note commitment trees."><title>WalletCommitmentTrees in zcash_client_backend::data_api - 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 trait"><!--[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="#">Wallet<wbr>Commitment<wbr>Trees</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li><li><a href="#associatedtype.OrchardShardStore" title="OrchardShardStore">OrchardShardStore</a></li><li><a href="#associatedtype.SaplingShardStore" title="SaplingShardStore">SaplingShardStore</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.put_orchard_subtree_roots" title="put_orchard_subtree_roots">put_orchard_subtree_roots</a></li><li><a href="#tymethod.put_sapling_subtree_roots" title="put_sapling_subtree_roots">put_sapling_subtree_roots</a></li><li><a href="#tymethod.with_orchard_tree_mut" title="with_orchard_tree_mut">with_orchard_tree_mut</a></li><li><a href="#tymethod.with_sapling_tree_mut" title="with_sapling_tree_mut">with_sapling_tree_mut</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In zcash_<wbr>client_<wbr>backend::<wbr>data_<wbr>api</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">data_api</a></div><h1>Trait <span class="trait">WalletCommitmentTrees</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/data_api.rs.html#2625-2690">Source</a> </span></div><pre class="rust item-decl"><code>pub trait WalletCommitmentTrees {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>;
|
|
type <a href="#associatedtype.SaplingShardStore" class="associatedtype">SaplingShardStore</a><'a>: ShardStore<H = Node, CheckpointId = BlockHeight, Error = Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>;
|
|
type <a href="#associatedtype.OrchardShardStore" class="associatedtype">OrchardShardStore</a><'a>: ShardStore<H = MerkleHashOrchard, CheckpointId = BlockHeight, Error = Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.with_sapling_tree_mut" class="fn">with_sapling_tree_mut</a><F, A, E>(&mut self, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E>
|
|
<span class="where">where for<'a> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&'a mut ShardTree<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.SaplingShardStore" title="type zcash_client_backend::data_api::WalletCommitmentTrees::SaplingShardStore">SaplingShardStore</a><'a>, { sapling::NOTE_COMMITMENT_TREE_DEPTH }, SAPLING_SHARD_HEIGHT>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E>,
|
|
E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>></span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.put_sapling_subtree_roots" class="fn">put_sapling_subtree_roots</a>(
|
|
&mut self,
|
|
start_index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
roots: &[<a class="struct" href="chain/struct.CommitmentTreeRoot.html" title="struct zcash_client_backend::data_api::chain::CommitmentTreeRoot">CommitmentTreeRoot</a><Node>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.with_orchard_tree_mut" class="fn">with_orchard_tree_mut</a><F, A, E>(&mut self, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E>
|
|
<span class="where">where for<'a> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&'a mut ShardTree<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.OrchardShardStore" title="type zcash_client_backend::data_api::WalletCommitmentTrees::OrchardShardStore">OrchardShardStore</a><'a>, { _ }, ORCHARD_SHARD_HEIGHT>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E>,
|
|
E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>></span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.put_orchard_subtree_roots" class="fn">put_orchard_subtree_roots</a>(
|
|
&mut self,
|
|
start_index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
roots: &[<a class="struct" href="chain/struct.CommitmentTreeRoot.html" title="struct zcash_client_backend::data_api::chain::CommitmentTreeRoot">CommitmentTreeRoot</a><MerkleHashOrchard>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait describes a capability for manipulating wallet note commitment trees.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2626">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></h4></section><details class="toggle" open><summary><section id="associatedtype.SaplingShardStore" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2629-2633">Source</a><h4 class="code-header">type <a href="#associatedtype.SaplingShardStore" class="associatedtype">SaplingShardStore</a><'a>: ShardStore<H = Node, CheckpointId = BlockHeight, Error = Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>></h4></section></summary><div class="docblock"><p>The type of the backing [<code>ShardStore</code>] for the Sapling note commitment tree.</p>
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.OrchardShardStore" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2660-2664">Source</a><h4 class="code-header">type <a href="#associatedtype.OrchardShardStore" class="associatedtype">OrchardShardStore</a><'a>: ShardStore<H = MerkleHashOrchard, CheckpointId = BlockHeight, Error = Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>></h4></section><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>orchard</code></strong> only.</div></span></summary><div class="docblock"><p>The type of the backing [<code>ShardStore</code>] for the Orchard note commitment tree.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.with_sapling_tree_mut" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2637-2646">Source</a><h4 class="code-header">fn <a href="#tymethod.with_sapling_tree_mut" class="fn">with_sapling_tree_mut</a><F, A, E>(&mut self, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E><div class="where">where
|
|
for<'a> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&'a mut ShardTree<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.SaplingShardStore" title="type zcash_client_backend::data_api::WalletCommitmentTrees::SaplingShardStore">SaplingShardStore</a><'a>, { sapling::NOTE_COMMITMENT_TREE_DEPTH }, SAPLING_SHARD_HEIGHT>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E>,
|
|
E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>>,</div></h4></section></summary><div class="docblock"><p>Evaluates the given callback function with a reference to the Sapling
|
|
note commitment tree maintained by the wallet.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.put_sapling_subtree_roots" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2652-2656">Source</a><h4 class="code-header">fn <a href="#tymethod.put_sapling_subtree_roots" class="fn">put_sapling_subtree_roots</a>(
|
|
&mut self,
|
|
start_index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
roots: &[<a class="struct" href="chain/struct.CommitmentTreeRoot.html" title="struct zcash_client_backend::data_api::chain::CommitmentTreeRoot">CommitmentTreeRoot</a><Node>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>></h4></section></summary><div class="docblock"><p>Adds a sequence of Sapling note commitment tree subtree roots to the data store.</p>
|
|
<p>Each such value should be the Merkle root of a subtree of the Sapling note commitment tree
|
|
containing 2^<a href="constant.SAPLING_SHARD_HEIGHT.html" title="constant zcash_client_backend::data_api::SAPLING_SHARD_HEIGHT"><code>SAPLING_SHARD_HEIGHT</code></a> note commitments.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_orchard_tree_mut" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2669-2678">Source</a><h4 class="code-header">fn <a href="#tymethod.with_orchard_tree_mut" class="fn">with_orchard_tree_mut</a><F, A, E>(&mut self, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E><div class="where">where
|
|
for<'a> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&'a mut ShardTree<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.OrchardShardStore" title="type zcash_client_backend::data_api::WalletCommitmentTrees::OrchardShardStore">OrchardShardStore</a><'a>, { _ }, ORCHARD_SHARD_HEIGHT>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, E>,
|
|
E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>>,</div></h4></section><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>orchard</code></strong> only.</div></span></summary><div class="docblock"><p>Evaluates the given callback function with a reference to the Orchard
|
|
note commitment tree maintained by the wallet.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.put_orchard_subtree_roots" class="method"><a class="src rightside" href="../../src/zcash_client_backend/data_api.rs.html#2685-2689">Source</a><h4 class="code-header">fn <a href="#tymethod.put_orchard_subtree_roots" class="fn">put_orchard_subtree_roots</a>(
|
|
&mut self,
|
|
start_index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
roots: &[<a class="struct" href="chain/struct.CommitmentTreeRoot.html" title="struct zcash_client_backend::data_api::chain::CommitmentTreeRoot">CommitmentTreeRoot</a><MerkleHashOrchard>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, ShardTreeError<Self::<a class="associatedtype" href="trait.WalletCommitmentTrees.html#associatedtype.Error" title="type zcash_client_backend::data_api::WalletCommitmentTrees::Error">Error</a>>></h4></section><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>orchard</code></strong> only.</div></span></summary><div class="docblock"><p>Adds a sequence of Orchard note commitment tree subtree roots to the data store.</p>
|
|
<p>Each such value should be the Merkle root of a subtree of the Orchard note commitment tree
|
|
containing 2^<a href="constant.ORCHARD_SHARD_HEIGHT.html" title="constant zcash_client_backend::data_api::ORCHARD_SHARD_HEIGHT"><code>ORCHARD_SHARD_HEIGHT</code></a> note commitments.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-WalletCommitmentTrees-for-MockWalletDb" class="impl"><a class="src rightside" href="../../src/zcash_client_backend/data_api/testing.rs.html#2826-2901">Source</a><a href="#impl-WalletCommitmentTrees-for-MockWalletDb" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.WalletCommitmentTrees.html" title="trait zcash_client_backend::data_api::WalletCommitmentTrees">WalletCommitmentTrees</a> for <a class="struct" href="testing/struct.MockWalletDb.html" title="struct zcash_client_backend::data_api::testing::MockWalletDb">MockWalletDb</a></h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>test-dependencies</code></strong> only.</div></span></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/zcash_client_backend/data_api/testing.rs.html#2827">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section><section id="associatedtype.SaplingShardStore-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/zcash_client_backend/data_api/testing.rs.html#2828">Source</a><a href="#associatedtype.SaplingShardStore-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SaplingShardStore" class="associatedtype">SaplingShardStore</a><'a> = MemoryShardStore<Node, BlockHeight></h4></section><section id="associatedtype.OrchardShardStore-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/zcash_client_backend/data_api/testing.rs.html#2864">Source</a><a href="#associatedtype.OrchardShardStore-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.OrchardShardStore" class="associatedtype">OrchardShardStore</a><'a> = MemoryShardStore<MerkleHashOrchard, BlockHeight></h4></section></div></details></div><script src="../../trait.impl/zcash_client_backend/data_api/trait.WalletCommitmentTrees.js" async></script></section></div></main></body></html> |