Neptune-Crypto / twenty-first / 15120928877

98%

push

github

feat!: MerkleTree-specific Type Aliases (#251)

This PR introduces type aliases:
 - `MerkleTreeNodeIndex` for `usize`
 - `MerkleTreeLeafIndex` for `usize`
 - `MerkleTreeHeight` for `u32`
with the objective of documenting the conventions for
arithmetic with these index types.

Also:
 - Public function `nodes()` dropped in favor of `node(i)`.
 - Public function `leafs()` now returns an iterator instead
   of a slice.
 - Private function `authentication_structure_node_indices` is
   marked `pub` as it is needed downstream.

Displaces #250.

---------

Co-authored-by: Jan Ferdinand Sauer <ferdinand@neptune.cash>

74 of 75 new or added lines in 4 files covered. (98.67%)

12687 of 12958 relevant lines covered (97.91%)

42714280.71 hits per line