@@ -42,27 +42,25 @@ const MAX_NUM_NODES: MerkleTreeNodeIndex =
4242const MAX_NUM_LEAFS : MerkleTreeLeafIndex = MAX_NUM_NODES / 2 ;
4343
4444/// The maximum height of Merkle trees that functions in this module support.
45- ///
46- /// See also: [`MAX_NUM_NODES`], [`MAX_NUM_LEAFS`].
4745pub const MAX_TREE_HEIGHT : MerkleTreeHeight = MAX_NUM_LEAFS . ilog2 ( ) as MerkleTreeHeight ;
4846
4947/// The index of the root node.
5048pub ( crate ) const ROOT_INDEX : MerkleTreeNodeIndex = 1 ;
5149
5250type Result < T > = result:: Result < T , MerkleTreeError > ;
5351
54- /// A [Merkle tree][merkle_tree ] is a binary tree of [digests](Digest) that is
52+ /// A [Merkle tree][1 ] is a binary tree of [digests](Digest) that is
5553/// used to efficiently prove the inclusion of items in a set. Set inclusion can
5654/// be verified through an [inclusion proof](MerkleTreeInclusionProof). This
57- /// struct can hold at most 2^25 digests[^1 ], limiting the height of the tree to
55+ /// struct can hold at most 2^25 digests[^2 ], limiting the height of the tree to
5856/// 2^24. However, the associated functions (*i.e.*, the ones that don't take
5957/// `self`) make abstraction of this limitation and work for Merkle trees of up
6058/// to 2^63 nodes, 2^62 leafs, or height up to 62.
6159///
6260/// The used hash function is [`Tip5`].
6361///
64- /// [^ 1]: https://github.com/Neptune-Crypto/twenty-first/pull/250#issuecomment-2782490889
65- /// [merkle_tree ]: https://en.wikipedia.org/wiki/Merkle_tree
62+ /// [1]: < https://en.wikipedia.org/wiki/Merkle_tree>
63+ /// [^2 ]: < https://github.com/Neptune-Crypto/twenty-first/pull/250#issuecomment-2782490889>
6664#[ derive( Debug , Clone , PartialEq , Eq ) ]
6765pub struct MerkleTree {
6866 nodes : Vec < Digest > ,
0 commit comments