zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(docs): Simplify the docs for nodes in Sapling trees (#7378) 

* fix docs build

* fix docs build errors in sapling trees

* fix docs build in sprout joinsplits

* fix doc build in handshake

* fix docs build in zebra-state

* fix docs build in zebrad

* new line fix

* Fix docs

* Simplify importing `bridgetree`

---------

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
This commit is contained in:
Marek 2023-08-24 17:55:53 +02:00 committed by GitHub
parent 0cc48a322a
commit e86197f6be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
zebra-chain/src/sapling/tree.rs
View File

@ -18,7 +18,7 @@ use std::{
}; };
use bitvec::prelude::*; use bitvec::prelude::*;
use bridgetree::{self}; use bridgetree;
use incrementalmerkletree::{frontier::Frontier, Hashable}; use incrementalmerkletree::{frontier::Frontier, Hashable};
use lazy_static::lazy_static; use lazy_static::lazy_static;
@ -174,12 +174,11 @@ impl fmt::Debug for Node {
/// Required to convert [`NoteCommitmentTree`] into [`SerializedTree`]. /// Required to convert [`NoteCommitmentTree`] into [`SerializedTree`].
/// ///
/// Zebra stores Sapling note commitment trees as [`Frontier`]s while the /// Zebra stores Sapling note commitment trees as [`Frontier`]s while the
/// [`z_gettreestate`][2] RPC requires [`CommitmentTree`][3]s. Implementing /// [`z_gettreestate`][1] RPC requires [`CommitmentTree`][2]s. Implementing
/// [`incrementalmerkletree::Hashable`] for [`Node`]s allows the conversion. /// [`incrementalmerkletree::Hashable`] for [`Node`]s allows the conversion.
/// ///
/// [1]: bridgetree::Frontier /// [1]: https://zcash.github.io/rpc/z_gettreestate.html
/// [2]: https://zcash.github.io/rpc/z_gettreestate.html /// [2]: incrementalmerkletree::frontier::CommitmentTree
/// [3]: incrementalmerkletree::frontier::CommitmentTree
impl HashSer for Node { impl HashSer for Node {
fn read<R: io::Read>(mut reader: R) -> io::Result<Self> { fn read<R: io::Read>(mut reader: R) -> io::Result<Self> {
let mut node = [0u8; 32]; let mut node = [0u8; 32];