From 305bbc5fac25ba368e77d925d82005f523abd7dd Mon Sep 17 00:00:00 2001 From: Carson <104383295+codebycarson@users.noreply.github.com> Date: Mon, 27 May 2024 06:22:27 -0700 Subject: [PATCH] Fixed bad formatting, moved oracle price feeder over, small typos --- pages/dev-node/node-configuration.mdx | 12 ++++----- pages/dev-node/node-operators.mdx | 2 +- pages/dev-node/quickstart.mdx | 26 ++++++++++--------- pages/dev-node/running-seid.mdx | 21 +++++++++------ ...ice-feeder.mdx => oracle-price-feeder.mdx} | 0 5 files changed, 34 insertions(+), 27 deletions(-) rename pages/dev-validators/{oracle-price-feeder/running-an-oracle-price-feeder.mdx => oracle-price-feeder.mdx} (100%) diff --git a/pages/dev-node/node-configuration.mdx b/pages/dev-node/node-configuration.mdx index ac8d074..5ff1e14 100644 --- a/pages/dev-node/node-configuration.mdx +++ b/pages/dev-node/node-configuration.mdx @@ -2,10 +2,10 @@ There are a few node types that can be run on Sei network which serve a variety of purposes. These include: -- rpc / full nodes: these nodes are generally used for querying data or interacting with the chain. They maintain some state but not since genesis. The default settings will run rpc / full nodes. -- archive nodes: maintain full state of the blockchain from genesis. Generally requires large disks. To enable this type of node, set min-retain-blocks=0 and pruning="nothing" in your app.toml -- state sync nodes: provide snapshot data for other nodes to use to bootstrap onto the chain. To enable this type of node, set enable=true under the [statesync] section in config.toml -- validator nodes: provide security to the chain by proposing and signing blocks. To enable this type of node, set mode=validator in config.toml. Note that because Sei is proof-of-stake, you must have enough delegation to join the active set +- **RPC / full nodes**: these nodes are generally used for querying data or interacting with the chain. They maintain some state but not since genesis. The default settings will run rpc / full nodes. +- **Archive Nodes**: maintain full state of the blockchain from genesis. Generally requires large disks. To enable this type of node, set min-retain-blocks=0 and pruning="nothing" in your app.toml +- **State Sync Nodes**: provide snapshot data for other nodes to use to bootstrap onto the chain. To enable this type of node, set enable=true under the [statesync] section in config.toml +- **Validator Nodes**: provide security to the chain by proposing and signing blocks. To enable this type of node, set mode=validator in config.toml. Note that because Sei is proof-of-stake, you must have enough delegation to join the active set Commonly Used Ports Seid uses the following TCP ports. Toggle their settings to match your environment. @@ -17,6 +17,7 @@ Seid uses the following TCP ports. Toggle their settings to match your environme These ports are all customizable in $HOME/.sei/config/config.toml and $HOME/.sei/config/app/toml discussed in the later sections along with other fields. ### Systemd File Template + ```bash [Unit] Description=Sei Node @@ -38,5 +39,4 @@ LimitNOFILE=65535 [Install] WantedBy=multi-user.target - -``` \ No newline at end of file +``` diff --git a/pages/dev-node/node-operators.mdx b/pages/dev-node/node-operators.mdx index d716920..8544605 100644 --- a/pages/dev-node/node-operators.mdx +++ b/pages/dev-node/node-operators.mdx @@ -6,7 +6,7 @@ import VersionTable from '../../components/VersionFetcher/VersionTable'; ## System Requirements | CPU Cores | RAM | Disk | -| --------- | ---- | -------- | +|-----------|------|----------| | 16 cores | 64GB | 1TB NVMe | ### Build Version and Genesis Table diff --git a/pages/dev-node/quickstart.mdx b/pages/dev-node/quickstart.mdx index cd7c583..5b3c51e 100644 --- a/pages/dev-node/quickstart.mdx +++ b/pages/dev-node/quickstart.mdx @@ -1,16 +1,7 @@ -Running a Sei RPC node +# Running a Sei RPC node A full Sei node is a fundamental building block of the Sei Blockchain. It consists of a local copy of the blockchain, including its history and state. Running a full node is essential for participating in network operations like validating transactions, joining consensus, and broadcasting events to other network participants. -System Configuration -CPU Cores RAM Disk -16 cores 64GB 1TB NVMe -Quick start -There is a setup script that runs a lot of the basic setup to easily get you started running an RPC node. If you are an advanced user, please see Node Configurations. - -You can use this startup script: - -python3 scripts/run-node.py - +``` ..:=++****++=:. .:+*##############*+:. .=*#####+:....:+#######+. @@ -30,5 +21,16 @@ python3 scripts/run-node.py .:+#######*-:..::*#####=. .-+###############*+:. ..-+********+-.. +``` + +## System Configuration +- CPU Cores RAM Disk +- 16 cores 64GB 1TB NVMe + +## Quick start +There is a setup script that runs a lot of the basic setup to easily get you started running an RPC node. If you are an advanced user, please see Node Configurations. + +You can use this startup script: + +`python3 scripts/run-node.py` -Welcome to the Sei node installer! diff --git a/pages/dev-node/running-seid.mdx b/pages/dev-node/running-seid.mdx index 12eeb41..82bf111 100644 --- a/pages/dev-node/running-seid.mdx +++ b/pages/dev-node/running-seid.mdx @@ -1,14 +1,14 @@ -## Running Seid -How to start and run seid on a full node +# Running Seid -### Prerequisites +## Prerequisites This section assumes that you have set up a full node, configured all settings and joined a network. -### Run Seid +## Run Seid You may run seid with ```bash seid start ``` + If you want to see all the flags, you can use ```bash seid start --help @@ -39,6 +39,7 @@ The node may be started in a 'query only' mode where only the gRPC and JSON HTTP API services are enabled via the `--grpc-only` flag. In this mode, Tendermint is bypassed and can be used when legacy queries are needed after an on-chain upgrade is performed. Note, when enabled, gRPC will also be automatically enabled. + ```bash Usage: seid start [flags] @@ -107,7 +108,8 @@ Global Flags: --log_level string The logging level (trace|debug|info|warn|error|fatal|panic) --trace print out full stack trace on errors ``` -### Systemd + +## Systemd Seid should be running at all times, it's recommended you register Seid as a systemd service so that it will be automatically restarted if your system reboots Create a definition file in `/etc/systemd/system/seid.service` @@ -137,6 +139,7 @@ LimitNOFILE=65535 [Install] WantedBy=multi-user.target ``` + Modify the file with the proper path and network. - `` - Enter the path to the Seid executable. `` is likely `/home//go/bin/seid` or `/usr/go/bin`. Confirm this with where is seid. @@ -146,7 +149,7 @@ Modify the file with the proper path and network. Make sure you made the correct edits to `/etc/security/limits.conf`. Run systemctl daemon-reload followed by systemctl enable seid. This will register seid as a system service and run the program upon startup. -### Controlling the service +## Controlling the service Use `systemctl` to start, stop and restart the service. ```bash # Check health @@ -158,6 +161,7 @@ Use `systemctl` to start, stop and restart the service. # Restart systemctl restart seid ``` + Use `journalctl -t` to access entire logs, entire logs in reverse, and the latest and continuous log. ```bash # Entire log reversed @@ -169,7 +173,8 @@ Use `journalctl -t` to access entire logs, entire logs in reverse, and the lates # Since 30 minutes ago journalctl -t seid --since -30m ``` -### (Optional) Cosmovisor + +## (Optional) Cosmovisor You may also want to use Cosmovisor such that it's easier to manage upgrades, it's a wrapper around the default seid -binary, to install it follow [Cosmosvisor Quick Start](https://docs.cosmos.network/v0.45/run-node/cosmovisor.html) \ No newline at end of file +binary, to install it follow [Cosmosvisor Quick Start](https://docs.cosmos.network/v0.45/run-node/cosmovisor.html) diff --git a/pages/dev-validators/oracle-price-feeder/running-an-oracle-price-feeder.mdx b/pages/dev-validators/oracle-price-feeder.mdx similarity index 100% rename from pages/dev-validators/oracle-price-feeder/running-an-oracle-price-feeder.mdx rename to pages/dev-validators/oracle-price-feeder.mdx