Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: replace instances of tree with trie #31

Merged
merged 2 commits into from
Dec 6, 2023
Merged

chore: replace instances of tree with trie #31

merged 2 commits into from
Dec 6, 2023

Conversation

h5law
Copy link
Collaborator

@h5law h5law commented Dec 6, 2023

Summary

Human Summary

This PR replaces references to tree with trie as this is technically a trie and not a tree

AI Summary

Summary generated by Reviewpad on 06 Dec 23 17:02 UTC

This pull request includes multiple file diffs. Here is a summary of the changes:

  1. The smst_proofs_test.go file has changes related to replacing smst variables from NewSparseMerkleSumTree to NewSparseMerkleSumTrie in multiple line ranges. Comments referring to the tree have also been updated to refer to the trie.

  2. The smt_proofs_test.go file has changes related to replacing smt variables from NewSparseMerkleTree to NewSparseMerkleTrie in multiple line ranges. Comments referring to the tree have also been updated to refer to the trie.

  3. The utils.go file has changes related to importing the "encoding/binary" package, updating struct field names, function names, and parameter types related to the trie, renaming variables, and updating logic and function calls related to the trie.

  4. The README.md file has changes related to updating terminology from "Merkle tree" to "Merkle Trie", updating references to whitepapers, clarifying definitions, fixing typos, and correcting links.

  5. The proof_sizes_test.go file has changes related to organizing import statements, renaming variables, and updating logging statements to use correct variable names.

  6. The smt_utils_test.go file has changes related to updating comments to reflect the use of trie instead of tree and updating parameter types for consistency.

  7. The smst.go file has changes related to replacing the usage of the SparseMerkleSumTree with SparseMerkleSumTrie, updating comments and function names from Tree to Trie, renaming struct and function names, and updating logic related to the trie.

  8. The fuzz_test.go file has changes related to replacing the word "tree" with "trie" for more descriptive naming.

  9. The utils.go file has changes related to function and variable renaming for the data structure used, updating comments, and changing the type of a function parameter to match the updated data structure.

  10. The Makefile file has changes related to adding targets for documentation generation, testing, and benchmarking, renaming targets and benchmark commands, and updating some occurrences of "Tree" and "SumTree" to "Trie" and "SumTrie".

  11. The bench_leaf_test.go file has changes related to reorganizing package imports, renaming variables, and updating function names and calls to match the changes in the package.

  12. The bench_utils_test.go file has changes related to importing and renaming packages, updating variable and function names, and updating function calls.

These changes involve various updates such as replacing variables and functions related to the tree with those related to the trie, updating comments, renaming variables, updating import statements, and reordering code.

Issue

Fixes N/A

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Run all unit tests: make test_all
  • Run all/relevant benchmarks (if optimising): make benchmark_{all | suite name}

Required Checklist

If Applicable Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • I have updated any relevant README(s)/documentation and left TODOs throughout the codebase
  • Add or update any relevant or supporting mermaid diagrams

@h5law h5law added documentation Improvements or additions to documentation code health Related to code cleanup and health of the repo labels Dec 6, 2023
@h5law h5law self-assigned this Dec 6, 2023
@reviewpad reviewpad bot added large Pull request is large waiting-for-review This PR is currently waiting to be reviewed and removed documentation Improvements or additions to documentation labels Dec 6, 2023
@h5law h5law merged commit ab6942c into main Dec 6, 2023
5 checks passed
@h5law h5law deleted the chore/tree-trie branch December 6, 2023 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Related to code cleanup and health of the repo large Pull request is large waiting-for-review This PR is currently waiting to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant