From c30d53d87cf280f2d6eaa0b9724c5a96988808a3 Mon Sep 17 00:00:00 2001 From: cordt-sei <165932662+cordt-sei@users.noreply.github.com> Date: Thu, 27 Jun 2024 12:58:47 -0600 Subject: [PATCH] Update quickstart.mdx Minor formatting corrections --- pages/dev-node/quickstart.mdx | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/pages/dev-node/quickstart.mdx b/pages/dev-node/quickstart.mdx index 733a1374..2cef6020 100644 --- a/pages/dev-node/quickstart.mdx +++ b/pages/dev-node/quickstart.mdx @@ -52,21 +52,25 @@ Before running the script, take a moment to understand the configurable paramete - **Default**: `"pynode"` - **Usage**: Any name you prefer for easy identification of your node. + 2. **trust_height_delta**: - **Description**: The negative height offset for state sync. It defines how many blocks before the latest block you trust for syncing. - **Default**: `20000` - - **Usage**: Adjust this, usually lawer if you experience syncing issues. + - **Usage**: If you experience syncing issues, try adjusting this somewhere between 10000-35000 + 3. **enable_unsafe_reset**: - **Description**: Determines whether to wipe the existing configs, database and keys before setting up the node. - **Default**: `True` - - **Usage**: Set to `False` if you want to retain existing data. Use `True` for a clean setup. + - **Usage**: Defaults to `True` for a clean setup. Set `False` to retain existing data. + 4. **version_override**: - **Description**: Overrides automatic version selection in favor of version(s) specified in [`ENV_TO_CONFIG`](https://github.com/sei-protocol/sei-chain/blob/3b8b27c597a93b968f17335f911d35b38e5cf1f6/scripts/run-node.py#L28) - **Default**: `False` - **Usage**: Set `True` to force version specified in the parameters below. + 5. **MAINNET_VERSION, DEVNET_VERSION, TESTNET_VERSION**: - **Description**: Versions of the chain binary for several environments, both testing and production. - **Default**: @@ -75,6 +79,7 @@ Before running the script, take a moment to understand the configurable paramete - TESTNET_VERSION = `"v5.2.2"` - **Usage**: Specify the version to be installed if `version_override` is `True`. + 6. **ENV_TO_CONFIG**: - **Description**: This maps environment names to their chain IDs and version overrides. - **Default**: @@ -88,6 +93,7 @@ Before running the script, take a moment to understand the configurable paramete ``` - **Usage**: Modify this dictionary to run a specific chian version for a given network. + --- ## Running the Script @@ -96,23 +102,28 @@ Before running the script, take a moment to understand the configurable paramete - Ensure you have the required dependencies installed: Go 1.21, make, gcc, and Docker. - Backup any important existing data before proceeding, the script will wipe existing data by default. + 2. **Execute the Script**: - Run the script using Python: `python3 ./scripts/run_node.py` - Follow the prompts to choose the environment (local, devnet, testnet, mainnet) and the database backend (legacy or sei-db). + 3. **Environment Selection**: - The script will fetch the chain ID and version based on your environment selection. If `local` is selected, it will fetch the latest / most current version from GitHub. + 4. **Installation and Configuration**: - The script will download the specified version, extract it, and install it using `make install`. - If `enable_unsafe_reset` is `True`, it will reset the Tendermint state and any existing configs + keys. - The script will initialize the node with the given moniker and chain ID. - For non-local environments, it will fetch state sync parameters, persistent peers, and apropriate genesis file. + 5. **Configuration Files**: - The script will modify `config.toml` and `app.toml` based on your selections and the fetched data. - If `sei-db` is selected as the database backend, additional configurations will be applied to `app.toml`. + 6. **Start the Node**: - The script then starts the node and begins to sync. - At this point you may stop the script [`ctrl+C`] and run the node manually or as a service, or keep running in the terminal as long as needed.