From 41181efde7b5fc04b44519f52e9d7e8ed58b8db3 Mon Sep 17 00:00:00 2001 From: Robert Zaremba Date: Mon, 11 Mar 2024 11:36:37 +0100 Subject: [PATCH 1/2] docs: update validator docs --- README.md | 2 +- VALIDATOR.md => docs/VALIDATOR.md | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) rename VALIDATOR.md => docs/VALIDATOR.md (84%) diff --git a/README.md b/README.md index 7d94cc85f9..c59706c96a 100644 --- a/README.md +++ b/README.md @@ -195,7 +195,7 @@ $ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.5.0/internal/api/lib ## Validators -Please follow [Validator Instructions](./VALIDATOR.md) for setting up a validator node. +Please follow [Validator Instructions](./docs/VALIDATOR.md) for setting up a validator node. ## Liquidators diff --git a/VALIDATOR.md b/docs/VALIDATOR.md similarity index 84% rename from VALIDATOR.md rename to docs/VALIDATOR.md index 76c106d0e4..90afd08982 100644 --- a/VALIDATOR.md +++ b/docs/VALIDATOR.md @@ -14,8 +14,9 @@ To run a validator you need 2 binaries: `umeed` and `price-feeder`. You can get a binary by: -1. [Build](./README.md#build) yourself and follow the latest [Release Notes](./RELEASE_NOTES.md). - If you build the binary on a different OS than your validator OS, then you need to copy `libwasmvm`: +1. [Build](./README.md#build) yourself and follow the latest [Release Notes](./RELEASE_NOTES.md). Make sure you run the right binary for the testnet or the mainnet. Consult the chain upgrades on [mainnet](https://www.mintscan.io/umee/proposals) and [testnet](https://explorer.network.umee.cc/Canon-4/gov). + +2. If you build the binary on a different OS than your validator OS, then you need to copy `libwasmvm`: ```sh scp $GOPATH/pkg/mod/github.com/!cosm!wasm/wasmvm@/internal/api/libwasmvm.$(uname -m).so running_os:/ @@ -23,13 +24,13 @@ You can get a binary by: NOTE: use the correct `wasmvm` version, according to the latest [Release Notes](./RELEASE_NOTES.md) or the [compatibility matrix](./README.md#release-compatibility-matrix). -2. Download latest [binary build](https://github.com/umee-network/umee/releases). The build is compatible with the latest Ubuntu LTS x86-64. You MUST also copy the `libwasmvm` (see note in 1. about libwasmvm version): +3. Download the right [binary build](https://github.com/umee-network/umee/releases) or use a [container image](https://github.com/umee-network/umee/pkgs/container/umeed) (docker). The binary build is compatible with the latest Ubuntu LTS x86-64. You MUST also copy the `libwasmvm` (see note in 2. about libwasmvm version): ```sh wget https://raw.githubusercontent.com/CosmWasm/wasmvm//internal/api/libwasmvm.$(uname -m).so -O /lib/libwasmvm.$(uname -m).so ``` -3. Use our released docker [umeed container](https://github.com/umee-network/umee/pkgs/container/umeed). +4. Use our released docker [umeed container](https://github.com/umee-network/umee/pkgs/container/umeed). To test if the `libwasm` is linked correctly, run `umeed version`. From 4cb79dfc4b5f2d3d0eed351c60288447d96d59fa Mon Sep 17 00:00:00 2001 From: Robert Zaremba Date: Mon, 11 Mar 2024 12:38:22 +0100 Subject: [PATCH 2/2] language --- docs/VALIDATOR.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/VALIDATOR.md b/docs/VALIDATOR.md index 90afd08982..dc68bf3c6a 100644 --- a/docs/VALIDATOR.md +++ b/docs/VALIDATOR.md @@ -4,11 +4,11 @@ This document describes a process of joining a testnet or a mainnet as a validat ## Umeeversity -Full documentation is hosted at [learning.ux.xyz](https://learning.ux.xyz). However it may not be up to date. +Full documentation is hosted at [learning.ux.xyz](https://learning.ux.xyz). However, it may not be up to date. ## Getting a Binary -To run a validator you need 2 binaries: `umeed` and `price-feeder`. +You need 2 binaries to run a validator: `umeed` and `price-feeder`. ### Umeed @@ -44,7 +44,7 @@ NOTE: for self building and configuration examples you MUST use the [umee branch ## Running a node -1. Update the `app.toml` , `client.toml` and `config.toml` based on your preference. You MUST set non zero min gas prices in `app.toml`. Query `umeed q ugov min-gas-price` to see the what is the minimum acceptable value: +1. Update the `app.toml`, `client.toml` and `config.toml` based on your preference. You MUST set non-zero min gas prices in `app.toml`. Query `umeed q ugov min-gas-price` to see the what is the minimum acceptable value: ```toml # your app.toml file @@ -57,7 +57,7 @@ Before joining the mainnet you should join a testnet! ### Testnet -1. Make sure your are able to run `umeed` and price feeder locally. +1. Make sure you can run `umeed` and `price-feeder` locally. 2. Join the [Discord server](https://discord.gg/4ZJAFvg9). Make sure you are in the Testnet group. 3. Follow the state sync [canon-4 instructions](https://mzonder.notion.site/UMEE-Start-from-STATE-SYNC-canon-4-f485563a089a436d9d1fe98f54af8737). Make sure you use the [latest](https://github.com/umee-network/umee/releases/) version. 4. You can use the following peers in your `config.toml`: @@ -67,7 +67,7 @@ Before joining the mainnet you should join a testnet! ``` 5. Using discord, ping one of the UX Team members to send you testnet `uumee`. -6. Once your validator is setup (and you did self delegation), ping again UX Team members and send your validator address. We will do a delegation. +6. Once your node validator is set up (and you did self delegation), ping again UX Team members and send your validator address. We will do a delegation. 7. Make sure your Price Feeder is running correctly. If your [testnet window misses](https://canon.price-feeder.com/) are above 50% then something is wrong. Look for a help on Discord. Here are our testnet public endpoints: