Organize STM code - Merkle Tree Module

[curiecrypt]

Content

This PR includes the version of mithril-stm where the merkle_tree is a module containing:

• leaf
• tree
• path: Path, BatchPath,
• commitment: MerkleTreeCommitment, MerkleTreeCommitmentBatchCompat.
• Heap helpers are moved to merkle_tree/mod.rs from merkle_tree/tree.rs.

Pre-submit checklist

• Branch
  • Tests are provided (if possible)
  • Crates versions are updated (if relevant)
  • CHANGELOG file is updated (if relevant)
  • Commit sequence broadly makes sense
  • Key commits have useful messages
• PR
  • All check jobs of the CI have succeeded
  • Self-reviewed the diff
  • Useful pull request description
  • Reviewer requested
• Documentation
  • Update README file (if relevant)
  • Update documentation website (if relevant)
  • Add dev blog post (if relevant)
  • Add ADR blog post or Dev ADR entry (if relevant)
  • No new TODOs introduced

Comments

Issue(s)

Relates to #2369

[github-actions]

Test Results

    3 files  ±0     57 suites  ±0   11m 32s ⏱️ +12s
1 772 tests ±0  1 772 ✅ ±0  0 💤 ±0  0 ❌ ±0 
2 170 runs  ±0  2 170 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit d266e8d. ± Comparison against base commit ba14422.

This pull request removes 9 and adds 9 tests. Note that renamed tests count towards both.

mithril-stm ‑ merkle_tree::tests::test_bytes_batch_path
mithril-stm ‑ merkle_tree::tests::test_bytes_path
mithril-stm ‑ merkle_tree::tests::test_bytes_tree
mithril-stm ‑ merkle_tree::tests::test_bytes_tree_commitment
mithril-stm ‑ merkle_tree::tests::test_bytes_tree_commitment_batch_compat
mithril-stm ‑ merkle_tree::tests::test_create_batch_proof
mithril-stm ‑ merkle_tree::tests::test_create_invalid_batch_proof
mithril-stm ‑ merkle_tree::tests::test_create_invalid_proof
mithril-stm ‑ merkle_tree::tests::test_create_proof

mithril-stm ‑ merkle_tree::tree::tests::test_bytes_batch_path
mithril-stm ‑ merkle_tree::tree::tests::test_bytes_path
mithril-stm ‑ merkle_tree::tree::tests::test_bytes_tree
mithril-stm ‑ merkle_tree::tree::tests::test_bytes_tree_commitment
mithril-stm ‑ merkle_tree::tree::tests::test_bytes_tree_commitment_batch_compat
mithril-stm ‑ merkle_tree::tree::tests::test_create_batch_proof
mithril-stm ‑ merkle_tree::tree::tests::test_create_invalid_batch_proof
mithril-stm ‑ merkle_tree::tree::tests::test_create_invalid_proof
mithril-stm ‑ merkle_tree::tree::tests::test_create_proof

♻️ This comment has been updated with latest results.

[jpraynaud]

Maybe a more natural structure would be:

• a path sub module with Path and BatchPath
• a commitment sub module with MerkleTreeCommitment and MerkleTreeCommitmentBatchCompat

WDYT?

[jpraynaud]

Few comments seen together 👍