docs: verkle stateful docs (#3805)

* docs: verkle stateful docs * Update packages/client/README.md * spelling config fix --------- Co-authored-by: acolytec3 <[email protected]>
ethereumjs · Nov 20, 2024 · 84700fb · 84700fb
1 parent 723005a
commit 84700fb
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 12 deletions.
diff --git a/config/cspell-md.json b/config/cspell-md.json
@@ -1,6 +1,8 @@
 {
   "language": "en-US",
-  "ignoreRegExpList": ["/0x[0-9A-Fa-f]+/"],
+  "ignoreRegExpList": [
+    "/0x[0-9A-Fa-f]+/"
+  ],
   "words": [
     "trienode",
     "t8ntool",
@@ -318,6 +320,7 @@
     "heartedly",
     "beaconroot",
     "Grandine",
-    "EVMBN"
+    "EVMBN",
+    "kaust"
   ]
-}
+}
diff --git a/config/cspell-ts.json b/config/cspell-ts.json
@@ -1,17 +1,30 @@
 {
   "language": "en-US",
-  "ignoreRegExpList": ["/0x[0-9A-Fa-f]+/", "@scure"],
+  "ignoreRegExpList": [
+    "/0x[0-9A-Fa-f]+/",
+    "@scure"
+  ],
   "overrides": [
     {
       "filename": "**/packages/devp2p/**",
-      "ignoreWords": ["pirl", "ubiq", "gwhale", "prichain", "zfill"]
+      "ignoreWords": [
+        "pirl",
+        "ubiq",
+        "gwhale",
+        "prichain",
+        "zfill"
+      ]
     },
     {
       "filename": "**/packages/ethash/**",
-      "ignoreWords": ["epoc", "cmix"]
+      "ignoreWords": [
+        "epoc",
+        "cmix"
+      ]
     }
   ],
   "words": [
+    "kaust",
     "EEST",
     "paulmillr",
     "t8ntool",
@@ -610,4 +623,4 @@
     "PUSHDATA",
     "chunkified"
   ]
-}
+}
diff --git a/packages/client/README.md b/packages/client/README.md
@@ -220,19 +220,25 @@ Then start the Lodestar client with:
 
 The EthereumJS client supports ongoing protocol development efforts, allowing developers and testers to participate in various testnets using the EthereumJS client.
 
-### Stateless Verkle
+### Verkle testnet
 
-We currently support the Verkle Kaustinen6 testnet, and will be proactively supporting upcoming testnets (e.g. Kaustinen7) as they launch. To start the EthereumJS client alongside the Lodestar consensus client, use the following commands:
+We currently support the Kaustinen7 testnet, both with stateless and stateful execution. We will be proactively supporting upcoming testnets as they launch. 
 
 Step 1 - Running the EthereumJS client (from the cloned @ethereumjs/client package)
 
-`npm run client:start:ts -- --dataDir /data/k6data --network kaustinen6 --rpcEngine --rpcEngineAuth false --logLevel warn`
+For stateless execution: 
+
+`npm run client:start:ts -- --rpc --gethGenesis=./devnets/kaustinen7/genesis.json --dataDir=datadir/kaust7 --rpcEngine --rpcEngineAuth=false --statelessVerkle=true`
+
+For stateful execution:
+
+`npm run client:start:ts -- --rpc --gethGenesis=./devnets/kaustinen7/genesis.json --dataDir=datadir/kaust7 --rpcEngine --rpcEngineAuth=false --statefulVerkle=true`
 
 Step 2 - Running the Lodestar client (from the cloned Lodestar quick-start repository)
 
-`setup.sh --dataDir k6data --network kaustinen6 --justCL`
+`./setup.sh --network kaustinen7 --dataDir kaust --justCL`
 
-Additional information on the Kaustinen6 testnet can be retrieve from this page: https://verkle-gen-devnet-6.ethpandaops.io/
+Additional information on the Kaustinen7 testnet can be retrieve from this page: https://verkle-gen-devnet-7.ethpandaops.io/
 
 The process should be similar for other testnets, and the quick-start repository should provide testnet-specific configuration instructions for the Lodestar consensus layer client.