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

feat(merkle tree): Expose Merkle tree API #209

Merged
merged 16 commits into from
Oct 17, 2023

Conversation

slowli
Copy link
Contributor

@slowli slowli commented Oct 12, 2023

What ❔

Expose API allowing to query Merkle proofs for a list of hashed keys at a specific tree version (= L1 batch number).

Why ❔

  • This is one of components for recovering a node from a snapshot; it will be used to authenticate snapshot chunks.
  • In the future, it could be used for eth_getProof.

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.
  • Code has been formatted via zk fmt and zk lint.

@codecov
Copy link

codecov bot commented Oct 12, 2023

Codecov Report

Attention: 39 lines in your changes are missing coverage. Please review.

Comparison is base (0fac66f) 32.82% compared to head (c6598ad) 32.99%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #209      +/-   ##
==========================================
+ Coverage   32.82%   32.99%   +0.16%     
==========================================
  Files         536      537       +1     
  Lines       27908    28041     +133     
==========================================
+ Hits         9161     9251      +90     
- Misses      18747    18790      +43     
Files Coverage Δ
core/lib/merkle_tree/src/domain.rs 93.93% <100.00%> (-0.38%) ⬇️
...lib/zksync_core/src/metadata_calculator/updater.rs 94.18% <100.00%> (ø)
core/lib/config/src/configs/api.rs 54.16% <50.00%> (-0.38%) ⬇️
...ore/lib/zksync_core/src/metadata_calculator/mod.rs 87.75% <0.00%> (-1.83%) ⬇️
core/lib/merkle_tree/src/storage/database.rs 64.70% <0.00%> (-0.65%) ⬇️
...lib/zksync_core/src/metadata_calculator/helpers.rs 86.81% <83.33%> (-2.67%) ⬇️
core/lib/zksync_core/src/lib.rs 25.00% <18.18%> (+0.25%) ⬆️
core/lib/zksync_core/src/api_server/tree/mod.rs 72.50% <72.50%> (ø)

... and 32 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

core/lib/config/src/configs/database.rs Outdated Show resolved Hide resolved
core/lib/zksync_core/src/metadata_calculator/api.rs Outdated Show resolved Hide resolved
core/lib/zksync_core/src/metadata_calculator/api.rs Outdated Show resolved Hide resolved
core/lib/zksync_core/src/metadata_calculator/api.rs Outdated Show resolved Hide resolved
@slowli slowli marked this pull request as ready for review October 13, 2023 10:34
@slowli slowli requested a review from a team as a code owner October 13, 2023 10:34
popzxc
popzxc previously approved these changes Oct 13, 2023
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good, though I'm not in context regarding the use cases of specialized server for merkle proofs. Trusting you on this one :)

core/lib/config/src/configs/database.rs Outdated Show resolved Hide resolved
core/lib/zksync_core/src/metadata_calculator/api.rs Outdated Show resolved Hide resolved
core/lib/zksync_core/src/metadata_calculator/mod.rs Outdated Show resolved Hide resolved
@slowli slowli added this pull request to the merge queue Oct 17, 2023
Merged via the queue into main with commit 4010c7e Oct 17, 2023
33 checks passed
@slowli slowli deleted the aov-pla-619-expose-merkle-tree-api branch October 17, 2023 12:04
github-merge-queue bot pushed a commit that referenced this pull request Oct 24, 2023
🤖 I have created a release *beep* *boop*
---


##
[16.1.0](core-v16.0.2...core-v16.1.0)
(2023-10-24)


### Features

* Add new commitments
([#219](#219))
([a19256e](a19256e))
* arm64 zk-environment rust Docker images and other
([#296](#296))
([33174aa](33174aa))
* **config:** Extract everything not related to the env config from
zksync_config crate
([#245](#245))
([42c64e9](42c64e9))
* **eth-watch:** process governor upgrades
([#247](#247))
([d250294](d250294))
* **merkle tree:** Expose Merkle tree API
([#209](#209))
([4010c7e](4010c7e))
* **merkle tree:** Snapshot recovery for Merkle tree
([#163](#163))
([9e20703](9e20703))
* **multivm:** Remove lifetime from multivm
([#218](#218))
([7eda27c](7eda27c))
* Remove fee_ticker and token_trading_volume fetcher modules
([#262](#262))
([44f7179](44f7179))
* **reorg_detector:** compare miniblock hashes for reorg detection
([#236](#236))
([2c930b2](2c930b2))
* Rewrite server binary to use `vise` metrics
([#120](#120))
([26ee1fb](26ee1fb))
* **types:** introduce state diff record type and compression
([#194](#194))
([ccf753c](ccf753c))
* **vm:** Improve tracer trait
([#121](#121))
([ff60138](ff60138))
* **vm:** Move all vm versions to the one crate
([#249](#249))
([e3fb489](e3fb489))


### Bug Fixes

* **crypto:** update snark-vk to be used in server and update args for
proof wrapping
([#240](#240))
([4a5c54c](4a5c54c))
* **db:** Fix write stalls in RocksDB
([#250](#250))
([650124c](650124c))
* **db:** Fix write stalls in RocksDB (again)
([#265](#265))
([7b23ab0](7b23ab0))
* **db:** Fix write stalls in RocksDB (for real this time)
([#292](#292))
([0f15919](0f15919))
* Fix `TxStage` string representation
([#255](#255))
([246b5a0](246b5a0))
* fix typos
([#226](#226))
([feb8a6c](feb8a6c))
* **witness-generator:** Witness generator oracle with cached storage
refunds ([#274](#274))
([8928a41](8928a41))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants