Skip to main content

Running a Node on Testnet

Osmosis Installer

Join a network by using Osmosis Installer from https://get.osmosis.zone

Simply run:

curl -sL https://get.osmosis.zone/install > i.py && python3 i.py

Osmosis CLI

Make sure you have installed the Osmosis Binary (CLI) prior to following the below instructions.

You may also use the Osmosis installer if you want everything to be done automatically.

Faucet

In order to get testnet tokens use https://faucet.osmosis.zone/

Initialize Osmosis Node

Use osmosisd to initialize your node (replace the NODE_NAME with a name of your choosing):

osmosisd init NODE_NAME --chain-id=osmo-test-5

Open the config.toml to edit the seeds and persistent peers:

cd $HOME/.osmosisd/config
nano config.toml

Use page down or arrow keys to get to the line that says seeds = "" and replace it with the following:

seeds = "[email protected]:26656"

Next, add persistent peers:

persistent_peers = "[email protected]:26656,[email protected]:26656"

Then press Ctrl+O then enter to save, then Ctrl+X to exit

Set Up Cosmovisor

Set up cosmovisor to ensure future upgrades happen flawlessly. To install Cosmovisor:

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

(You may also refer to the Cosmovisor installation instructions.)

Create the required directories:

mkdir -p ~/.osmosisd/cosmovisor
mkdir -p ~/.osmosisd/cosmovisor/genesis
mkdir -p ~/.osmosisd/cosmovisor/genesis/bin
mkdir -p ~/.osmosisd/cosmovisor/upgrades

Set the environment variables:

echo "# Setup Cosmovisor" >> ~/.profile
echo "export DAEMON_NAME=osmosisd" >> ~/.profile
echo "export DAEMON_HOME=$HOME/.osmosisd" >> ~/.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

You may leave out UNSAFE_SKIP_BACKUP=true, however the backup takes a decent amount of time and public snapshots of old states are available.

Download and replace the genesis file:

cd $HOME/.osmosisd/config
wget https://github.com/osmosis-labs/networks/raw/main/osmo-test-5/genesis.tar.bz2
tar -xjf genesis.tar.bz2 && rm genesis.tar.bz2

Copy the current osmosisd binary into the cosmovisor/genesis folder:

cp $GOPATH/bin/osmosisd ~/.osmosisd/cosmovisor/genesis/bin

To check your work, ensure the version of cosmovisor and osmosisd are the same:

cosmovisor version
osmosisd version

These two commands should both output the current osmosisd version (for example v31.x.x; check the latest Osmosis release for the canonical tag).

Reset private validator file to genesis state:

osmosisd unsafe-reset-all

Download Chain Data

Download the latest chain data from a snapshot provider. The official source is https://snapshots.osmosis.zone/, which publishes pruned osmo-test-5 testnet snapshots. The snapshot URL is timestamped and rotates, so copy the current one from that page rather than hardcoding it.

Download liblz4-tool to handle the compressed file:

sudo apt-get install wget liblz4-tool aria2 -y

Download a pruned snapshot from snapshots.osmosis.zone and extract it into the data directory. Replace <SNAPSHOT_URL> with the current URL copied from that page:

wget -q -O - <SNAPSHOT_URL> | lz4 -d | tar -C $HOME/.osmosisd -xvf -

Set Up Osmosis Service

Set up a service to allow cosmovisor to run in the background as well as restart automatically if it runs into any problems:

echo "[Unit]
Description=Cosmovisor daemon
After=network-online.target
[Service]
Environment="DAEMON_NAME=osmosisd"
Environment="DAEMON_HOME=${HOME}/.osmosisd"
Environment="DAEMON_RESTART_AFTER_UPGRADE=true"
Environment="DAEMON_ALLOW_DOWNLOAD_BINARIES=false"
Environment="DAEMON_LOG_BUFFER_SIZE=512"
Environment="UNSAFE_SKIP_BACKUP=true"
User=$USER
ExecStart=${HOME}/go/bin/cosmovisor run start
Restart=always
RestartSec=3
LimitNOFILE=infinity
LimitNPROC=infinity
[Install]
WantedBy=multi-user.target
" >cosmovisor.service

Move this new file to the systemd directory:

sudo mv cosmovisor.service /etc/systemd/system/cosmovisor.service
note

Previously, this documentation suggested to move the systemd unit file to:

/lib/systemd/system/cosmovisor.service

If dealing with a server that may have followed older instructions, you may consider looking there.

Start Osmosis Service

Reload and start the service:

sudo systemctl daemon-reload
systemctl restart systemd-journald
sudo systemctl start cosmovisor

Check the status of the service:

sudo systemctl status cosmovisor

To see live logs of the service:

journalctl -u cosmovisor -f

Updating Cosmovisor for the Next Testnet Upgrade

To allow osmosisd to upgrade automatically when the testnet hits the next upgrade height, prepare the upgrade binary in advance. Replace <UPGRADE_VERSION> and <UPGRADE_HEIGHT> below with the values from the latest Osmosis release and the corresponding testnet upgrade announcement.

This step is only needed if syncing from genesis and you haven't passed <UPGRADE_HEIGHT> yet.

# Example: upgrading from v31 -> v32. Replace the placeholders below.
mkdir -p ~/.osmosisd/cosmovisor/upgrades/<UPGRADE_VERSION>/bin
cd $HOME/osmosis
git pull
git checkout <UPGRADE_VERSION>
make build
systemctl stop cosmovisor.service
cp build/osmosisd ~/.osmosisd/cosmovisor/upgrades/<UPGRADE_VERSION>/bin
systemctl start cosmovisor.service
cd $HOME