seda-chain

README

SEDA Chain

SEDA is an open-source data transmission and computation network that enables a permissionless environment for developers to deploy data feeds. It is built on top of Cosmos SDK and CosmWasm.

To learn about SEDA protocol, please visit docs.seda.xyz.
To learn how to build a local version, please read developing.
To learn how to contribute, please read contributing.

Installation

System Requirements

The current minimal system requirements are as follows and may be subject to change based on future improvements:

• Quad Core or larger AMD or Intel (amd64) CPU
  • ARM CPUs (e.g., Apple M1) are discouraged at this time
• 32GB RAM (with ample swap space)
• 1TB SSD Storage
• 100MBPS bidirectional internet connection

Running SEDA on lower-spec hardware is feasible, but you may encounter potential performance issues or an increased risk of crashes.

Download From Releases

Download from our Github releases page.

Build From Source

Note that the main branch is under development and might not always be stable. For a stable version, consider checking out a released tag using git checkout. For instructions on how to build, please refer to developing.

Running the Node

This is a guide for operating and running the node.

• Individuals aiming to connect to an external node with SEDA.
• Those who wish to establish their own node and/or set up the node as a validator.

sedad is the command-line tool for interfacing, or CLI for short, with the SEDA blockchain. You can check out the installation instructions here or see the Docker instructions here.

Now, you're all set to engage with the SEDA blockchain via an external node. For a rundown of commands, type sedad --help. For in-depth info on a particular command, add the --help flag, for example:

sedad --help 
sedad query --help 
sedad query bank --help 

Linking to An External Node

This section is for those linking to an external node, so if you want to run commands from your local machine, or don't feel like running a node yourself you can use the sedad binary to connect to an external node. This can be done two ways:

1. Add the --node flag to your CLI commands, followed by the RPC endpoint in the https://<hostname>:<port> format.
2. Alternatively, set a default node: sedad config set client node https://[hostname]:[port]

When connecting externally, choose a trustworthy node operator. Unscrupulous operators might tamper with query outcomes or block transactions. The SEDA team currently supports these RPC endpoints:

• Testnet-seda-node-1: http://18.171.36.35:26657
• Testnet-seda-node-2: http://13.41.125.154:26657

Running the Node Yourself

# Rename the downloaded binary to a simpler name.
mv sedad-${ARCH} sedad
# mv sedad-amd64 sedad
# mv sedad-arm64 sedad

# Make the downloaded binary executable.
chmod +x sedad

# This documentation assumes that you have added the binary to $PATH as well.

# Reset the chain.
sedad tendermint unsafe-reset-all
rm -rf ~/.sedad || true

# Create your operator key.
sedad keys add <key-name>

# Initialize your node and join the network (optionally with an existing key using the recover flag).
sedad join <moniker> --network <devnet|testnet> [--recover]

# Start your node.
sedad start

Joining testnet using snapshot

We recommend joining the testnet using a snapshot that has been taken after the most recent upgrade. The SEDA team is planning to provide links for downloading snapshots soon, but for now you may use the snapshot provided by Lavender.Five Nodes.

sedad join <moniker> --network testnet

# Backup private validator state file if you'd like.
cp $HOME/.sedad/data/priv_validator_state.json $HOME/.sedad/priv_validator_state.json.backup

# Download snapshot, decompress it, and place it under chain directory.
wget https://snapshots.lavenderfive.com/testnet-snapshots/seda/latest.tar.lz4
lz4 -dc < latest.tar.lz4 | tar xvf - -C $HOME/.sedad

sedad start

Lavender.Five Nodes also provides detailed instructions here.

Running the Node Yourself Dockerized

For instructions how to run the node yourself as a normal node or a validator in docker.

To pull the docker image check here.

This section will go over:

• docker commands
• Setting up env variables for docker

Docker Commands

Here's docker commands to show running the node, and executing commands so you can generate a key, and become a validator.

Running

To start a SEDA chain node with docker(we recommend knowing the tool if you go this route):

docker run -d --name seda_node \
-p 26656:26656 \
-p 26657:26657 \
-p 9090:9090 \
--env MONIKER=moniker_here \
--env NETWORK=testnet \
ghcr.io/sedaprotocol/seda-chain:latest sedad start

Exposing the ports is optional. As is providing a network as it defaults to testnet.

To check the status of the node you can check the normal docker way:

docker logs seda_node -n 100

or by interacting with the CLI from within the container:

docker exec seda_node sedad status

Stop and Start

The docker container should be stoppable and resumed as:

docker stop seda_node

# This runs it as a background process handled by docker.
docker start seda_node

Creating a validator

We advise you against using Horcrux signing service as several validators have reported unstable signing. We suspect Horcrux is not yet stable under Cosmos SDK version 0.50.

In order to create your validator, make sure you are fully synced to the latest block height of the network.

You can check by using the following command:

curl -s localhost:26657/status | jq .result | jq .sync_info

In the output of the above command make sure catching_up is false

“catching_up”: false

Create a validator.json file and fill in the create-validator tx parameters:

{
 "pubkey": $(sedad tendermint show-validator),
 "amount": "1000000000000000000000000000000000aseda", 
 "moniker": "the moniker for your validator",
 "identity": "optional identity signature (ex. UPort or Keybase) This key will be used by block explorers to identify the validator.",
 "website": "validator's (optional) website",
 "security": "validator's (optional) security contact email",
 "details": "validator's (optional) details",
 "commission-rate": "0.1",
 "commission-max-rate": "0.2",
 "commission-max-change-rate": "0.01",
 "min-self-delegation": "1" 
}

Use the following command to create a validator:

sedad tx staking create-validator validator.json --from <wallet-name> --chain-id <target-chain> --node <node-url>

That’s it now you can find your validator operator address using the following command, which you can advertise to receive delegations:

sedad keys show <wallet-name> --bech val -a

Running the Node with Cosmovisor

Run the node as a subprocess of Cosmovisor if you want automatic upgrading, which only requires you to place a new binary in the right location before an upgrade height.

Install Cosmovisor.

go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@latest

Then, add these lines to your profile (maybe .profile, .zprofile, or something else) to set up environment variables:

echo "# Cosmovisor Setup" >> ~/.profile
echo "export DAEMON_NAME=sedad" >> ~/.profile
echo "export DAEMON_HOME=$HOME/.sedad" >> ~/.profile
echo "export DAEMON_ALLOW_DOWNLOAD_BINARIES=false" >> ~/.profile
echo "export DAEMON_LOG_BUFFER_SIZE=512" >> ~/.profile
echo "export DAEMON_RESTART_AFTER_UPGRADE=true" >> ~/.profile
echo "export UNSAFE_SKIP_BACKUP=true" >> ~/.profile
source ~/.profile

Initialize Cosmovisor with the chain binary and start the node.

cosmovisor init sedad
cosmovisor run start

Note that for an upgrade, simply run the following command to prepare Cosmovisor with the upgrade binary before the chain reaches the upgrade height.

cosmovisor add-upgrade <upgrade-name> <upgrade-binary-file>

License

Contents of this repository are open source under GNU General Public License v3.0.