feat: Add caching to HttpForkSource (#114)

matter-labs · Sep 18, 2023 · f3e1528 · f3e1528
1 parent be53aec
commit f3e1528
Show file tree

Hide file tree

Showing 13 changed files with 1,141 additions and 46 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,4 +13,5 @@ etc/**/*.zbin
 !.vscode/launch.json
 !.vscode/tasks.json
 
-*.log
+*.log
+.cache
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -47,6 +47,8 @@ ethabi = "16.0.0"
 itertools = "0.10.5"
 log = "0.4.20"
 simplelog = "0.12.1"
+rustc-hash = "1.1.0"
 
 [dev-dependencies]
 httptest = "0.15.4"
+tempdir = "0.3.7"
diff --git a/README.md b/README.md
@@ -67,6 +67,25 @@ Additionally, the file path can be provided via the `--log-file-path` option (de
 era_test_node --log=error --log-file-path=run.log run
 ```
 
+## 📃 Caching
+
+The node will cache certain network request by default to disk in the `.cache` directory. Alternatively the caching can be disabled or set to in-memory only
+via the `--cache=none|memory|disk` parameter. 
+
+```bash
+era_test_node --cache=none run
+```
+
+```bash
+era_test_node --cache=memory run
+```
+
+Additionally when using `--cache=disk`, the cache directory may be specified via `--cache-dir` and the cache may
+be reset on startup via `--reset-cache` parameters.
+```bash
+era_test_node --cache=disk --cache-dir=/tmp/foo --reset-cache run
+```
+
 ## 🌐 Network Details
 
 - L2 RPC: http://localhost:8011