feat(cli): adds `--dump-state` cli cmd #496

dutterbutter · 2024-12-16T18:57:21Z

What 💻

adds --dump-state cli cmd
adds --state-interval cli cmd
Partial implementation of feat: support anvil's state-related CLI options #482
Updates alloy-zksync in e2e

Why ✋

anvil parity

Evidence 📷

Include screenshots, screen recordings, or console output here demonstrating that your changes work as intended

Usage

Run the following command, wait ~60 secs and view state.json file:

./target/release/anvil-zksync --dump-state state.json run

Forking:

./target/release/anvil-zksync --dump-state state.json fork --fork-url sepolia-testnet

crates/cli/src/main.rs

crates/cli/Cargo.toml

crates/core/src/node/mod.rs

crates/cli/src/utils.rs

crates/cli/src/main.rs

itegulov · 2024-12-17T07:17:02Z

Also, would love to see an e2e test for this

dutterbutter · 2024-12-17T18:05:06Z

@itegulov added e2e tests for run and fork modes using --dump_state.

…pdate dev deps

itegulov

Alright looks good to me. Happy to merge this if you want, all my suggestions are small and can come in a separate PR

itegulov · 2024-12-19T01:51:40Z

Cargo.toml

+tempdir = "0.3.7"
+maplit = "1.0.2"
+zksync-web3-rs = "0.1.1"
+ethers = { version = "2.0.4", features = ["rustls"] }


Didn't realize we are still using ethers somewhere, that's interesting...

Yes, its used in unit tests in core.

itegulov · 2024-12-19T01:57:47Z

crates/cli/src/main.rs

+        dump_state,
+        dump_interval,
+        preserve_historical_states,
+    ));


You don't have to spawn it, you can just use it directly in select! as it is a future. This way you will be able to use state_dumper.dump() after the select like you were doing it before my changes.

Also, I have just realized I made the same mistake with block_producer_handle below, if you don't mind removing tokio::task::spawn there too that would be great

itegulov · 2024-12-19T02:02:56Z

e2e-tests-rust/Cargo.toml

@@ -10,7 +10,7 @@ categories = ["cryptography"]
 publish = false

 [dependencies]
-alloy-zksync = { git = "https://github.com/itegulov/alloy-zksync.git", rev = "692c5c2ca5defc88ac542f420d97c6756dadf9df" }
+alloy-zksync = { git = "https://github.com/popzxc/alloy-zksync.git", rev = "6a2e3cfe41cae9f92dc6672dbd0ce56ccc37e9b3" }


itegulov · 2024-12-19T02:05:03Z

e2e-tests-rust/Cargo.toml

@@ -10,7 +10,7 @@ categories = ["cryptography"]
 publish = false

 [dependencies]
-alloy-zksync = { git = "https://github.com/itegulov/alloy-zksync.git", rev = "692c5c2ca5defc88ac542f420d97c6756dadf9df" }
+alloy-zksync = { git = "https://github.com/popzxc/alloy-zksync.git", rev = "6a2e3cfe41cae9f92dc6672dbd0ce56ccc37e9b3" }
 alloy = { version = "0.6", features = ["full", "rlp", "serde", "sol-types", "getrandom", "provider-anvil-api", "json-rpc"] }


Created an issue for upgrading alloy to match alloy-zksync #504

(nothing actionable here just noting)

Will pick #504 once this is merged

itegulov · 2024-12-19T02:07:55Z

e2e-tests-rust/tests/lib.rs


 const SOME_ORIGIN: HeaderValue = HeaderValue::from_static("http://some.origin");
 const OTHER_ORIGIN: HeaderValue = HeaderValue::from_static("http://other.origin");
 const ANY_ORIGIN: HeaderValue = HeaderValue::from_static("*");

+use anvil_zksync_core::node::VersionedState;
+use std::{ fs, convert::identity, thread::sleep, time::Duration };
+use tempdir::TempDir;


Please move these above the constants. Also seems like rustfmt+clippy are not enforced here so I created a separate issue #505

In general I recommend enabling rustfmt-based auto-formatting in your editor (not sure what you use but there should be an option for almost anything)

Opened PR for #505 here: #506

itegulov · 2024-12-19T02:09:28Z

e2e-tests-rust/tests/lib.rs

+    provider.tx().finalize().await?;
+
+    // Allow some time for the state to be dumped
+    sleep(Duration::from_secs(2));


I think this wouldn't be necessary if you added state_dumper.dump() at the end of the program like I suggested in that other thread, right?

itegulov · 2024-12-19T02:10:18Z

e2e-tests-rust/tests/lib.rs

+
+    let dumped_data = fs::read_to_string(&dump_path)?;
+    let state: VersionedState = serde_json::from_str(&dumped_data)
+        .map_err(|e| anyhow::anyhow!("Failed to deserialize state: {}", e))?;


nit: use .with_context for better readability

itegulov · 2024-12-19T02:10:53Z

e2e-tests-rust/tests/lib.rs

+
+    let dumped_data = fs::read_to_string(&dump_path)?;
+    let state: VersionedState = serde_json::from_str(&dumped_data)
+        .map_err(|e| anyhow::anyhow!("Failed to deserialize state: {}", e))?;


nit: same thing here

itegulov · 2024-12-19T02:11:59Z

e2e-tests-rust/tests/lib.rs

+                "state_dump.json should contain at least one block"
+            );
+            assert!(
+                !state.transactions.is_empty(),


I would also assert that it contains that one transaction we executed at the beginning

itegulov · 2024-12-19T02:12:06Z

e2e-tests-rust/tests/lib.rs

+                "state_dump_fork.json should contain at least one block"
+            );
+            assert!(
+                !state.transactions.is_empty(),


dutterbutter · 2024-12-19T02:29:39Z

Will make changes in subsequent PR here: #502

dutterbutter requested a review from a team as a code owner December 16, 2024 18:57

dutterbutter commented Dec 16, 2024

View reviewed changes

crates/cli/src/main.rs Outdated Show resolved Hide resolved

dutterbutter requested a review from itegulov December 16, 2024 21:11

dutterbutter added the needs review 👓 PR requires a review label Dec 16, 2024

itegulov reviewed Dec 17, 2024

View reviewed changes

crates/cli/Cargo.toml Outdated Show resolved Hide resolved

crates/core/src/node/mod.rs Outdated Show resolved Hide resolved

crates/cli/src/utils.rs Outdated Show resolved Hide resolved

crates/cli/src/main.rs Show resolved Hide resolved

crates/cli/src/main.rs Outdated Show resolved Hide resolved

dutterbutter requested a review from itegulov December 17, 2024 18:34

dutterbutter added 7 commits December 18, 2024 08:13

wip

2783f7c

feat: adds dump state option to cli with test

8ea8a38

chore: clean up and cargo fmt

9947980

chore: remove unneeded pub

8e68f36

chore: clean up and cargo fmt

d052069

chore: clean up and cargo fmt

1fd679c

chore: add e2e tst for dump_state, update alloy-zksync to latest

c34aa14

dutterbutter force-pushed the db/add-state-cli-options branch from ae74565 to dd53c60 Compare December 18, 2024 15:52

chore: clean up, lint, move write_json to utils, resolve conflicts, u…

127327e

…pdate dev deps

dutterbutter force-pushed the db/add-state-cli-options branch from dd53c60 to 127327e Compare December 18, 2024 16:20

dutterbutter mentioned this pull request Dec 18, 2024

feat(cli): adds load and state cli options #502

Merged

itegulov approved these changes Dec 19, 2024

View reviewed changes

dutterbutter merged commit 1f0a4b6 into main Dec 19, 2024
14 checks passed

dutterbutter deleted the db/add-state-cli-options branch December 19, 2024 02:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): adds `--dump-state` cli cmd #496

feat(cli): adds `--dump-state` cli cmd #496

dutterbutter commented Dec 16, 2024 •

edited

Loading

itegulov commented Dec 17, 2024

dutterbutter commented Dec 17, 2024 •

edited

Loading

itegulov left a comment

itegulov Dec 19, 2024

dutterbutter Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

dutterbutter Dec 19, 2024

itegulov Dec 19, 2024

dutterbutter Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

itegulov Dec 19, 2024

dutterbutter commented Dec 19, 2024 •

edited

Loading

feat(cli): adds --dump-state cli cmd #496

feat(cli): adds --dump-state cli cmd #496

Conversation

dutterbutter commented Dec 16, 2024 • edited Loading

What 💻

Why ✋

Evidence 📷

Usage

itegulov commented Dec 17, 2024

dutterbutter commented Dec 17, 2024 • edited Loading

itegulov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dutterbutter commented Dec 19, 2024 • edited Loading

feat(cli): adds `--dump-state` cli cmd #496

feat(cli): adds `--dump-state` cli cmd #496

dutterbutter commented Dec 16, 2024 •

edited

Loading

dutterbutter commented Dec 17, 2024 •

edited

Loading

dutterbutter commented Dec 19, 2024 •

edited

Loading