zec
/
incrementalmerkletree
mirror of https://github.com/zcash/incrementalmerkletree.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Clarify the witnees->mark renaming in the `Tree` interface.

This commit is contained in:
Kris Nuttycombe 2022-12-20 17:05:01 -07:00
parent e78fb14a43
commit 61a34e5ec5
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CHANGELOG-bridgetree.md
View File

@ -35,11 +35,11 @@ referred to by their new location.
- `witness` is now used as the name of the operation to construct the witness for a leaf.
We now use `mark` to refer to the process of marking a node for which we may later wish
to construct a witness.
- `Tree::witness` has been renamed to `Tree::mark`
- `Tree::witnessed_positions` has been renamed to `Tree::marked_positions`
- `Tree::get_witnessed_leaf` has been renamed to `Tree::get_marked_leaf`
- `Tree::remove_witness` has been renamed to `Tree::remove_mark`
- `Tree::authentication_path` has been renamed to `Tree::witness`
- `BridgeTree::witness` has been renamed to `BridgeTree::mark`
- `BridgeTree::witnessed_positions` has been renamed to `BridgeTree::marked_positions`
- `BridgeTree::get_witnessed_leaf` has been renamed to `BridgeTree::get_marked_leaf`
- `BridgeTree::remove_witness` has been renamed to `BridgeTree::remove_mark`
- `BridgeTree::authentication_path` has been renamed to `BridgeTree::witness`
- `BridgeTree::witnessed` has been renamed to `BridgeTree::marked`
- `BridgeTree::witnessed_indices` has been renamed to `BridgeTree::marked_indices`
@ -75,6 +75,13 @@ the `testing` module, as there is not another good use case for polymorphism
over tree implementations; the API of `Tree` is excessively specialized to the
`BridgeTree` use patterns case.
The `Tree` interface reflects the renaming of `witness` to `mark` described above:
- `Tree::witness` has been renamed to `Tree::mark`
- `Tree::witnessed_positions` has been renamed to `Tree::marked_positions`
- `Tree::get_witnessed_leaf` has been renamed to `Tree::get_marked_leaf`
- `Tree::remove_witness` has been renamed to `Tree::remove_mark`
- `Tree::authentication_path` has been renamed to `Tree::witness`
### Removed relative to `incrementalmerkletree-0.3.0`
- `bridgetree::Leaf`