Skip to content

Commit ebbae9a

Browse files
authored
docs: update UPGRADING and remove comment (#88)
1 parent 7eceb0c commit ebbae9a

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

UPGRADING.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ case the upgrade fails and the previous chain needs to be restarted.
103103
### Current runtime
104104

105105
The AtomOne mainnet network, `atomone-1`, is currently running [AtomOne
106-
v1.0.0][v1]. We anticipate that operators who are running on v1.0.0, will be
106+
v1.1.1][v1]. We anticipate that operators who are running on v1.1.1, will be
107107
able to upgrade successfully. Validators are expected to ensure that their
108108
systems are up to date and capable of performing the upgrade. This includes
109109
running the correct binary and if building from source, building with the
@@ -174,13 +174,24 @@ Note that unlike the validator config change which still accepts `uatone` for
174174
fees, this change should be done **after** the upgrade because it is restricted
175175
to `uphoton` which has no supply before the upgrade.
176176

177+
### Relayer account balance
178+
179+
Additionally, the relayer account balance will now require `uphoton` token
180+
instead of `uatone` to pay the fees.
181+
182+
Accordingly, after the upgrade, the relayer operator will have to mint some
183+
photons using the new `MsgMintPhoton` message, and then transfer them to the
184+
relayer account. Consequently it is expected that IBC will take a bit of time
185+
to work properly after the upgrade, until the relayer account balance is filled
186+
with photons.
187+
177188
### Method I: Manual Upgrade
178189

179-
Make sure **AtomOne v1.0.0** is installed by either downloading a [compatible
190+
Make sure **AtomOne v1.1.1** is installed by either downloading a [compatible
180191
binary][v1], or building from source. Check the required version to build this
181192
binary in the `Makefile`.
182193

183-
Run AtomOne v1.0.0 till upgrade height, the node will panic:
194+
Run AtomOne v1.1.1 till upgrade height, the node will panic:
184195

185196
```shell
186197
ERR UPGRADE "v2" NEEDED at height: <UPGRADE_HEIGHT>: upgrade to v2 and applying upgrade "v2" at height:<UPGRADE_HEIGHT>
@@ -199,15 +210,13 @@ continue to produce blocks.
199210

200211
##### Preparation
201212

202-
- Install the latest version of Cosmovisor (`1.5.0`):
213+
- Install the latest version of Cosmovisor:
203214

204215
```shell
205216
go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@latest
206-
cosmovisor version
207-
# cosmovisor version: v1.5.0
208217
```
209218

210-
- Create a `cosmovisor` folder inside `$ATOMONE_HOME` and move AtomOne `v1.0.0`
219+
- Create a `cosmovisor` folder inside `$ATOMONE_HOME` and move AtomOne `v1.1.1`
211220
into `$ATOMONE_HOME/cosmovisor/genesis/bin`:
212221

213222
```shell
@@ -230,7 +239,7 @@ At this moment, you should have the following structure:
230239
├── current -> genesis or upgrades/<name>
231240
├── genesis
232241
│ └── bin
233-
│ └── atomoned # old: v1.0.0
242+
│ └── atomoned # old: v1.1.1
234243
└── upgrades
235244
└── v2
236245
└── bin
@@ -286,7 +295,7 @@ challenges, the core teams, after conferring with operators and attaining
286295
social consensus, may choose to declare that the upgrade will be skipped.
287296

288297
Steps to skip this upgrade proposal are simply to resume the `atomone-1`
289-
network with the (downgraded) v1.0.0 binary using the following command:
298+
network with the (downgraded) v1.1.1 binary using the following command:
290299

291300
```shell
292301
atomoned start --unsafe-skip-upgrade <UPGRADE_HEIGHT>
@@ -320,5 +329,5 @@ repeat the upgrade procedure again during the network startup. If you discover
320329
a mistake in the process, the best thing to do is wait for the network to start
321330
before correcting it.
322331

323-
[v1]: https://github.com/atomone-hub/atomone/releases/tag/v1.0.0
332+
[v1]: https://github.com/atomone-hub/atomone/releases/tag/v1.1.1
324333
[v2]: https://github.com/atomone-hub/atomone/releases/tag/v2.0.0

docs/architecture/adr-002-photon-token.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,7 @@ as the PHOTON balances and supply are handled by the `x/bank` module.
121121

122122
### Migration
123123

124-
The PHOTON denom metadata has to be added to the `x/bank` module state (XXX while
125-
admittedly this record does not look very usefull, it is only used in
126-
queries...)
124+
The PHOTON denom metadata has to be added to the `x/bank` module state.
127125

128126
```json
129127
{

0 commit comments

Comments
 (0)