Skip to content

Commit

Permalink
merge
Browse files Browse the repository at this point in the history
  • Loading branch information
mj850 committed May 27, 2024
2 parents 01e2fa6 + 305bbc5 commit 4ad99e7
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 17 deletions.
12 changes: 6 additions & 6 deletions pages/dev-node/node-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -38,5 +39,4 @@ LimitNOFILE=65535

[Install]
WantedBy=multi-user.target

```
```
2 changes: 1 addition & 1 deletion pages/dev-node/node-operators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 16 additions & 2 deletions pages/dev-node/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +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.

<<<<<<< HEAD
System Configuration
CPU Cores RAM Disk
16 cores 64GB 1TB NVMe
Expand All @@ -12,6 +13,9 @@ You can use this startup script:
```sh
python3 scripts/run-node.py

=======
```
>>>>>>> devrel
..:=++****++=:.
.:+*##############*+:.
.=*#####+:....:+#######+.
Expand All @@ -33,4 +37,14 @@ python3 scripts/run-node.py
..-+********+-..
```
Welcome to the Sei node installer!
## 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`
21 changes: 13 additions & 8 deletions pages/dev-node/running-seid.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -137,6 +139,7 @@ LimitNOFILE=65535
[Install]
WantedBy=multi-user.target
```

Modify the file with the proper path and network.

- `<PATH_TO_SEID>` - Enter the path to the Seid executable. `<PATH_TO_SEID>` is likely `/home/<YOUR_USER>/go/bin/seid` or `/usr/go/bin`. Confirm this with where is seid.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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)
binary, to install it follow [Cosmosvisor Quick Start](https://docs.cosmos.network/v0.45/run-node/cosmovisor.html)

0 comments on commit 4ad99e7

Please sign in to comment.