-
Notifications
You must be signed in to change notification settings - Fork 6
docs: align Go requirements with source modules #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -19,13 +19,13 @@ | |||||||||||||||
| <Card horizontal title="Archive Nodes" icon="database" /> | ||||||||||||||||
| </CardGroup> | ||||||||||||||||
|
|
||||||||||||||||
| ## Network Versions | ||||||||||||||||
|
|
||||||||||||||||
| <VersionTable /> | ||||||||||||||||
|
|
||||||||||||||||
| _Live binary versions, genesis, and seed peers — see the [technical reference](/node/technical-reference)._ | ||||||||||||||||
|
|
||||||||||||||||
| ## Hardware Requirements | ||||||||||||||||
|
|
||||||||||||||||
| | Component | Required | | ||||||||||||||||
| | --------- | ------------------------------------------------------ | | ||||||||||||||||
|
|
@@ -34,7 +34,7 @@ | |||||||||||||||
| | Storage | 2 TB NVMe SSD (high IOPS required) | | ||||||||||||||||
| | Network | 2 Gbps with low latency | | ||||||||||||||||
|
|
||||||||||||||||
| ## Installation & Setup Steps | ||||||||||||||||
|
|
||||||||||||||||
| <Steps> | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -47,13 +47,13 @@ | |||||||||||||||
| sudo apt update && sudo apt upgrade -y | ||||||||||||||||
| ``` | ||||||||||||||||
|
|
||||||||||||||||
| ###### 2. Install Essential Packages | ||||||||||||||||
|
|
||||||||||||||||
| ```bash | ||||||||||||||||
| sudo apt install make gcc git jq chrony curl lz4 wget tar build-essential -y | ||||||||||||||||
| ``` | ||||||||||||||||
|
|
||||||||||||||||
| ###### 3. Synchronize System Time | ||||||||||||||||
|
|
||||||||||||||||
| ```bash | ||||||||||||||||
| sudo timedatectl set-timezone UTC | ||||||||||||||||
|
|
@@ -61,22 +61,24 @@ | |||||||||||||||
| timedatectl | ||||||||||||||||
| ``` | ||||||||||||||||
|
|
||||||||||||||||
| ##### Install Go | ||||||||||||||||
|
|
||||||||||||||||
| Only needed if you build `seid` from source — the prebuilt binary and Docker | ||||||||||||||||
| install paths in the next step don't require Go. | ||||||||||||||||
| You need Go only if you build `seid` from source. The prebuilt binary and Docker | ||||||||||||||||
| install paths in the next step do not require it. | ||||||||||||||||
|
|
||||||||||||||||
| Suggested Version: Go 1.24.x (required for seid v6.3+) | ||||||||||||||||
| Current releases require Go 1.25.6 or later. Check the selected release's | ||||||||||||||||
| [`go.mod`](https://github.com/sei-protocol/sei-chain/blob/main/go.mod) for its exact | ||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [suggestion] Same |
||||||||||||||||
| requirement. | ||||||||||||||||
|
|
||||||||||||||||
| ###### Installation Steps | ||||||||||||||||
|
|
||||||||||||||||
| ```bash | ||||||||||||||||
| # Check for existing Go installation | ||||||||||||||||
| go version | ||||||||||||||||
|
|
||||||||||||||||
| # Download and install Go 1.24.x | ||||||||||||||||
| wget https://go.dev/dl/go1.24.5.linux-amd64.tar.gz | ||||||||||||||||
| sudo tar -C /usr/local -xzf go1.24.5.linux-amd64.tar.gz | ||||||||||||||||
| # Download and install Go 1.25.6 | ||||||||||||||||
| wget https://go.dev/dl/go1.25.6.linux-amd64.tar.gz | ||||||||||||||||
| sudo tar -C /usr/local -xzf go1.25.6.linux-amd64.tar.gz | ||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [suggestion] Extracting into The block already opens with
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| # Add Go to your environment variables | ||||||||||||||||
| echo 'export PATH=$PATH:/usr/local/go/bin' >> $HOME/.bashrc | ||||||||||||||||
|
|
@@ -174,7 +176,7 @@ | |||||||||||||||
| </Tab> | ||||||||||||||||
| </Tabs> | ||||||||||||||||
|
|
||||||||||||||||
| ##### Initialize Chain Files | ||||||||||||||||
|
|
||||||||||||||||
| <Info>Default init mode is **full** (RPC/P2P bind to all interfaces). For **validator** or **seed** nodes, use `--mode validator` or `--mode seed` so RPC and P2P bind to localhost only. See the [Validator Operations Guide](/node/validators) for the full validator init example.</Info> | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -202,7 +204,7 @@ | |||||||||||||||
| sed -i 's/persistent-peers = .*/persistent-peers = "'$PEERS'"/' ~/.sei/config/config.toml | ||||||||||||||||
| ``` | ||||||||||||||||
|
|
||||||||||||||||
| ##### Configure App Settings | ||||||||||||||||
|
|
||||||||||||||||
| ```bash | ||||||||||||||||
| # Set minimum gas price (recommended; helps prevent spam transactions) | ||||||||||||||||
|
|
@@ -232,7 +234,7 @@ | |||||||||||||||
|
|
||||||||||||||||
| <Accordion title="Advanced Configuration"> | ||||||||||||||||
|
|
||||||||||||||||
| #### Archive Node Setup | ||||||||||||||||
|
|
||||||||||||||||
| An archive node maintains the complete historical record of the chain. This requires disabling state sync and starting with a pre-existing database using a "snapshot". | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -246,7 +248,7 @@ | |||||||||||||||
|
|
||||||||||||||||
| **2. Configure Archive Node Peers** — To sync from the height your snapshot was created at, you need peers retaining a large amount of historical blocks. The node will require specific peers during initial sync, which can be changed at a later time. | ||||||||||||||||
|
|
||||||||||||||||
| #### Mempool Configuration | ||||||||||||||||
|
|
||||||||||||||||
| For optimal transaction handling and resource management, it is recommended to update the mempool settings in your `config.toml` file. | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -334,7 +336,7 @@ | |||||||||||||||
| sudo systemctl start seid | ||||||||||||||||
| ``` | ||||||||||||||||
|
|
||||||||||||||||
| ##### Monitoring & Troubleshooting | ||||||||||||||||
|
|
||||||||||||||||
| Check your node's status with these commands: | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -370,9 +372,9 @@ | |||||||||||||||
|
|
||||||||||||||||
| [View Complete Node Setup Guide](/node/node-operators) | ||||||||||||||||
|
|
||||||||||||||||
| ## Node Resources | ||||||||||||||||
|
|
||||||||||||||||
| ### Node Setup | ||||||||||||||||
|
|
||||||||||||||||
| <CardGroup cols={3}> | ||||||||||||||||
| <Card horizontal title="Node Operations Guide" icon="server" href="/node/node-operators"> | ||||||||||||||||
|
|
@@ -386,7 +388,7 @@ | |||||||||||||||
| </Card> | ||||||||||||||||
| </CardGroup> | ||||||||||||||||
|
|
||||||||||||||||
| ### Advanced Operations | ||||||||||||||||
|
|
||||||||||||||||
| <CardGroup cols={3}> | ||||||||||||||||
| <Card horizontal title="Configuration & Monitoring" icon="gauge-simple-high" href="/node/advanced-config-monitoring"> | ||||||||||||||||
|
|
||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ | |
|
|
||
| ## Installation | ||
|
|
||
| ### Pre-built Binaries (Recommended) | ||
|
|
||
| Pre-built binaries are available for Linux, macOS, and Windows. Download the latest release from | ||
| the [releases page](https://github.com/sei-protocol/seictl/releases). | ||
|
|
@@ -87,7 +87,7 @@ | |
| seictl --version | ||
| ``` | ||
|
|
||
| #### Verify Download (Optional) | ||
|
|
||
| All releases include a `checksums.txt` file for verification, e.g.: | ||
|
|
||
|
|
@@ -99,13 +99,13 @@ | |
| sha256sum -c checksums.txt 2>&1 | grep seictl_Linux_x86_64.tar.gz | ||
| ``` | ||
|
|
||
| ### Build from Source | ||
|
|
||
| If you prefer to build from source or need a specific configuration: | ||
|
|
||
| #### Prerequisites | ||
|
|
||
| - Go 1.24.5 or higher | ||
| - [Go 1.26.0 or later](https://go.dev/doc/install). Check [`go.mod`](https://github.com/sei-protocol/seictl/blob/main/go.mod) for the exact requirement. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [suggestion] Two things here:
|
||
|
|
||
| #### Build | ||
|
|
||
|
|
@@ -115,7 +115,7 @@ | |
| go build -o seictl | ||
| ``` | ||
|
|
||
| ### Install via Go | ||
|
|
||
| ```bash | ||
| go install github.com/sei-protocol/seictl@latest | ||
|
|
@@ -127,13 +127,13 @@ | |
| seictl [global options] command [command options] [arguments...] | ||
| ``` | ||
|
|
||
| ### Global Options | ||
|
|
||
| - `--home <path>`: Sei home directory (default: `~/.sei`, can be set via `SEI_HOME` environment variable) | ||
|
|
||
| ## Commands | ||
|
|
||
| ### Patch Command | ||
|
|
||
| #### `patch` | ||
|
|
||
|
|
@@ -168,7 +168,7 @@ | |
|
|
||
| **Note:** The file extension (`.toml` or `.json`) is used to determine the format automatically. | ||
|
|
||
| ### Genesis Commands | ||
|
|
||
| #### `genesis patch` | ||
|
|
||
|
|
@@ -199,7 +199,7 @@ | |
| seictl genesis patch patch.json -i | ||
| ``` | ||
|
|
||
| ### Config Commands | ||
|
|
||
| #### `config patch` | ||
|
|
||
|
|
@@ -235,7 +235,7 @@ | |
| seictl config patch patch.toml -o /path/to/output.toml | ||
| ``` | ||
|
|
||
| ## Configuration Targets | ||
|
|
||
| The `config` command can work with three different configuration files: | ||
|
|
||
|
|
@@ -271,7 +271,7 @@ | |
| - State sync and block sync | ||
| - Transaction indexing | ||
|
|
||
| ## Merge Patch Behavior | ||
|
|
||
| The merge patch algorithm works as follows: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[suggestion] The prose and the link disagree: it says to check the selected release's
go.mod, but the URL isblob/main/go.mod.This matters here specifically because the "Build from source" tab directly below instructs
git checkout <version-tag>— so the reader is building a tagged release while the link shows themmain's requirement. Ifmainhas since bumped itsgodirective, they'll install a newer Go than needed; if they're on an older tag, the link actively misinforms them.Either point at a tag and let the version table drive it, or reword to match what's linked: