Updated Readme for Capella

grandinetech · Feb 20, 2023 · e960cd2 · e960cd2
1 parent d5673f3
commit e960cd2
Showing 1 changed file with 26 additions and 5 deletions.
diff --git a/readme.md b/readme.md
@@ -13,15 +13,15 @@ The tests above were conducted by independent [Miga Labs](https://migalabs.es/et
 ## Beacon Node
 
 The Beacon Node is the main component of Grandine.
-Let's try it out by syncing the Prater network on Linux:
+Let's try it out by syncing the Goerli network on Linux:
 
 ```
 docker run                              \
   -p 9000:9000/tcp                      \
   -p 9000:9000/udp                      \
   -v $HOME/.grandine:/root/.grandine    \
   sifrai/grandine:latest grandine       \
-  --network prater
+  --network goerli
 ```
 
 For ARM64 (Raspberry Pi) simply use dedicated docker image:
@@ -32,13 +32,13 @@ docker run                              \
   -p 9000:9000/udp                      \
   -v $HOME/.grandine:/root/.grandine    \
   sifrai/grandine:latest-arm64 grandine \
-  --network prater
+  --network goerli
 ```
 
 ## Validator
 
 The Validator is a built-in component that is activated if validator keys are passed to Grandine.
-Let's try running Grandine with a new validator enabled on the Prater network (assuming you already have keys, secrets etc.):
+Let's try running Grandine with a new validator enabled on the Goerli network (assuming you already have keys, secrets etc.):
 
 ```
 docker run                                                          \ 
@@ -49,7 +49,7 @@ docker run                                                          \
   -v $HOME/.grandine/secrets:/root/.grandine/secrets                \
   sifrai/grandine:latest grandine                                   \
   --eth1-rpc-urls ETH1-RPC-URL                                      \
-  --network prater                                                  \
+  --network goerli                                                  \
   --keystore-dir /root/.grandine/validator_keys                     \
   --keystore-password-file /root/.grandine/secrets
 ```
@@ -59,6 +59,27 @@ Otherwise, for every keystore file in `$HOME/.grandine/validator_keys` there sho
 
 For any sensitive keys it's a must to use a [remote signer](#remote-signer).
 
+## Capella
+
+Capella support is shipped via the [unstable](https://hub.docker.com/r/sifrai/grandine/tags) docker images. The easiest way to test Cappela hardfork is to join one of the devnets by providing `custom_config_data` configs.
+
+```
+docker run                                                                 \
+  -p 9000:9000/tcp                                                         \
+  -p 9000:9000/udp                                                         \
+  -v $HOME/.grandine:/root/.grandine                                       \
+  -v $HOME/.grandine/validator_keys:/root/.grandine/validator_keys         \
+  -v $HOME/.grandine/secrets:/root/.grandine/secrets                       \
+  -v $HOME/.grandine/jwt:/root/.grandine/jwt                               \
+  -v $HOME/.grandine/custom_config_data:/root/.grandine/custom_config_data \
+  sifrai/grandine:unstable grandine                                        \
+  --configuration-directory /root/.grandine/custom_config_data             \
+  --eth1-rpc-urls ETH1-RPC-URL                                             \
+  --jwt-secret /root/.grandine/jwt                                         \
+  --keystore-dir /root/.grandine/validator_keys                            \
+  --keystore-password-file /root/.grandine/secrets
+```
+
 ## Remote Signer
 
 Grandine supports [Web3Signer](https://github.com/ConsenSys/web3signer) remote signer. Multiple remote signer URLs can be passed via `--web3signer-api-urls` parameter. Grandine first loads keys it finds in the directory specified by `--keystore-dir` parameter and then from the remote signers specified via the `--web3signer-api-urls` parameter. Only the first unique validator key will be loaded so the order is important if the same key appears in multiple sources. Keys from the remote signers are refreshed every epoch. Grandine runs internal slashing protection for validators specified via `--web3signer-api-urls` too.