Skip to content

Commit

Permalink
docs(upgrade): add relayer config change section (#56)
Browse files Browse the repository at this point in the history
Relates to #44 

I realized that the running relayers would also have to update their
config to use PHOTON for the fees, or else all txs would be rejected. So
added a section to cover that part.

Also added a kind remind for validators that have `authz` transactions
submitted periodically (for example validators who support services like
restake) to update the tx fee denom as well.

---------

Co-authored-by: Giuseppe Natale <[email protected]>
  • Loading branch information
tbruyelle and giunatale authored Nov 28, 2024
1 parent a632e11 commit 1b5576f
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ upgrade successfully for the AtomOne v2 release.

For more details on the release, please see the [release notes][v2].

**Validators** will have to change their configuration to allow the PHOTON
denom (`uphoton`) for the fees, **before** the upgrade, see [Validator config
change](#validator-config-change).

**Relayer Operators** will also need to update their configuration to use the
PHOTON denom for the fees, but this time **after** the upgrade, see [Relayer
config change](#relayer-config-change) section.

## Release Binary

Please use the correct release binary: `v2.0.0`.
Expand All @@ -25,7 +33,8 @@ Please use the correct release binary: `v2.0.0`.
- [Current runtime](#current-runtime)
- [Target runtime](#target-runtime)
- [Upgrade steps](#upgrade-steps)
- [`minimum-gas-prices` change](#minimum-gas-prices-change)
- [Validator config change](#validator-config-change)
- [Relayer config change](#relayer-config-change)
- [Method I: Manual Upgrade](#method-i-manual-upgrade)
- [Method II: Upgrade using Cosmovisor](#method-ii-upgrade-using-cosmovisor)
- [Manually preparing the binary](#manually-preparing-the-binary)
Expand Down Expand Up @@ -100,7 +109,7 @@ There are 2 major ways to upgrade a node:
If you prefer to use Cosmovisor to upgrade, some preparation work is needed
before upgrade.

### `minimum-gas-prices` change
### Validator config change

**AtomOne v2.0.0** introduces `photon` as the only fee token, so it requires a
modification of the validator configuration, namely the `minimum-gas-prices`
Expand All @@ -117,6 +126,36 @@ Before upgrading, the setting should be changed to:
minimum-gas-prices = "0.001uatone,0.001uphoton"
```

For validators that have `authz` transactions submitted periodically, the tx
fee denom would need to be updated as well.

### Relayer config change

Similarly to the validator config change, any running relayers would have to
change the gas price denom for the AtomOne chain, from `uatone` to `uphoton`.

For Hermes relayers, this setting is located in the `~/.hermes/config.toml`
file.

For example, considerng the existing setting:
```toml
[[ chain ]]
id = 'atomone-1'
(...)
gas_price = { price = 0.001, denom = 'uatone' }
```
Once the chain is upgraded, the setting should be changed to:
```toml
[[ chain ]]
id = 'atomone-1'
(...)
gas_price = { price = 0.001, denom = 'uphoton' }
```

Note that unlike the validator config change which still accepts `uatone` for
fees, this change should be done **after** the upgrade because it is restricted
to `uphoton` which has no supply before the upgrade.

### Method I: Manual Upgrade

Make sure **AtomOne v1.0.0** is installed by either downloading a [compatible
Expand Down

0 comments on commit 1b5576f

Please sign in to comment.