Skip to content

Commit

Permalink
docs: update validator docs (#2454)
Browse files Browse the repository at this point in the history
* docs: update validator docs

* language
  • Loading branch information
robert-zaremba authored Mar 11, 2024
1 parent 1300a9a commit 4bba462
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 10 additions & 9 deletions VALIDATOR.md → docs/VALIDATOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,33 @@ 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

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@<version>/internal/api/libwasmvm.$(uname -m).so running_os:/<lib/path>
```

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/<version>/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`.

Expand All @@ -43,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
Expand All @@ -56,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`:
Expand All @@ -66,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:
Expand Down

0 comments on commit 4bba462

Please sign in to comment.