From e04e8a0b686520b554a180f4aa85de25742c3649 Mon Sep 17 00:00:00 2001 From: Stephen van Egmond Date: Fri, 21 Mar 2025 09:56:43 -0400 Subject: [PATCH 1/4] add common commands and important options --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4c41eee307..8993bf3a9c 100644 --- a/README.md +++ b/README.md @@ -74,3 +74,17 @@ preloaded with the native EVM token. ## Multinode Local Devnet Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/blob/main/kurtosis/README.md) for more information on how to run a multinode local devnet. + +## Important Commands and Options + +`beacond help` lists available commands. Some commands have sub-commands. + +`beacond init` creates a folder structure for beacond to operate in, along with initial configuration files, the important ones being `app.toml` and `config.toml`. + +`beacond start` starts the chain client and begins the syncing process. + +The key environment variable is `CHAIN_SPEC`, which can be set to `mainnet`, `testnet`, or `devnet`. This should be set any time when using beacond. It will influence which configuration files you get during `init` and which chain ID beacond will communicate with while running. + +You can override the default operating directories for beacond with the `--home option. + +The [Berachain Node Quickstart](https://docs.berachain.com/nodes/quickstart) provides a complete example of a functioning setup, suitable for a development system or for experiments. From 61aa756e5db8da702f8f9722c6a10d5587fdc9dd Mon Sep 17 00:00:00 2001 From: Stephen van Egmond Date: Fri, 21 Mar 2025 09:57:51 -0400 Subject: [PATCH 2/4] close ` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8993bf3a9c..ecc3bddd3c 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,6 @@ Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/bl The key environment variable is `CHAIN_SPEC`, which can be set to `mainnet`, `testnet`, or `devnet`. This should be set any time when using beacond. It will influence which configuration files you get during `init` and which chain ID beacond will communicate with while running. -You can override the default operating directories for beacond with the `--home option. +You can override the default operating directories for beacond with the `--home ` option. The [Berachain Node Quickstart](https://docs.berachain.com/nodes/quickstart) provides a complete example of a functioning setup, suitable for a development system or for experiments. From 5105257468bd20d0f0a50a25a454cb3acd098606 Mon Sep 17 00:00:00 2001 From: Camembera Date: Wed, 30 Apr 2025 16:42:53 -0400 Subject: [PATCH 3/4] Update README.md Signed-off-by: Camembera --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ecc3bddd3c..ec66d35727 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,9 @@ Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/bl `beacond start` starts the chain client and begins the syncing process. -The key environment variable is `CHAIN_SPEC`, which can be set to `mainnet`, `testnet`, or `devnet`. This should be set any time when using beacond. It will influence which configuration files you get during `init` and which chain ID beacond will communicate with while running. +The key configuration value is the Beacon chain specification ("chainspec") - analogous to an Eth genesis - is held in a spec.toml file. There are three well-known chainspecs (`mainnet|testnet|devnet`). Or, a custom file can be provided to provide your own scenario's settings - see this [example using Docker](https://docs.berachain.com/nodes/guides/docker-devnet). + +The chainspec is set with the `--beacon-kit.chain-spec` command line option, and if necessary for a custom chainspec, use `--beacon-kit.chain-spec-file`. If used during `beacond init`, this value is written into app.toml and does not need to be specified anymore. You can override the default operating directories for beacond with the `--home ` option. From 2ca015560308e8148bbc2457a7aa602fd11ff28f Mon Sep 17 00:00:00 2001 From: Camembera Date: Wed, 30 Apr 2025 16:58:24 -0400 Subject: [PATCH 4/4] Update README.md Signed-off-by: Camembera --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec66d35727..fe45be12fd 100644 --- a/README.md +++ b/README.md @@ -89,4 +89,10 @@ The chainspec is set with the `--beacon-kit.chain-spec` command line option, and You can override the default operating directories for beacond with the `--home ` option. -The [Berachain Node Quickstart](https://docs.berachain.com/nodes/quickstart) provides a complete example of a functioning setup, suitable for a development system or for experiments. +The [Berachain Node Quickstart](https://docs.berachain.com/nodes/quickstart) provides a quick deployment of mainnet or testnet on your desk. + +For developing with beacon-kit, you have options: +1. see the Makefile for targets to start stand-alone processes +2. see [an example deploying a team with Docker on a custom chainspec](https://docs.berachain.com/nodes/guides/docker-devnet) +3. see [a deployment with Kurtosis](https://docs.berachain.com/nodes/guides/kurtosis) +4. see [an expect script that does a complete cycle of deposits, withdrawal, eviction, voluntary exit](https://github.com/berachain/guides/blob/main/apps/local-docker-devnet/devnet-automation.exp)