mirror of
				https://github.com/0glabs/0g-chain.git
				synced 2025-11-04 11:47:28 +00:00 
			
		
		
		
	kd-document-migration (#847)
* feat: add bep-3 migration * remove comments * address review comments * update min/max block locks * set open swaps to expired and adjust asset supply * fix: handle open swaps * feat: add migration doc * fix typos
This commit is contained in:
		
							parent
							
								
									667ad87825
								
							
						
					
					
						commit
						915d86bf35
					
				
							
								
								
									
										87
									
								
								migrate/v0_13/migrate.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										87
									
								
								migrate/v0_13/migrate.md
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,87 @@
 | 
			
		||||
# Kava-4 Upgrade Instructions
 | 
			
		||||
 | 
			
		||||
## Software Version and Key Dates
 | 
			
		||||
 | 
			
		||||
* The version of Kava for kava-4 is v0.13
 | 
			
		||||
* Kava-4 validators should prepare to shutdown their nodes March 4th, 2021 at 13:00 UTC
 | 
			
		||||
* Kava-4 genesis time is set to March 4th, 2021 at 15:00 UTC
 | 
			
		||||
* The version of cosmos-sdk for kava-5 is v0.39.2
 | 
			
		||||
* The version of tendermint for kava-5 v0.33.9
 | 
			
		||||
* The minimum version of golang for kava-5 is 1.13+, 1.15+ has been tested and is recommended.
 | 
			
		||||
 | 
			
		||||
### Risks
 | 
			
		||||
 | 
			
		||||
As a validator, performing the upgrade procedure on your consensus nodes carries a heightened risk of double-signing and being slashed. The most important piece of this procedure is verifying your software version and genesis file hash before starting your validator and signing.
 | 
			
		||||
 | 
			
		||||
The riskiest thing a validator can do is discover that they made a mistake and repeat the upgrade procedure again during the network startup. If you discover a mistake in the process, the best thing to do is wait for the network to start before correcting it. If the network is halted and you have started with a different genesis file than the expected one, seek advice from a Kava developer before resetting your validator.
 | 
			
		||||
 | 
			
		||||
### Recovery
 | 
			
		||||
 | 
			
		||||
Prior to exporting kava-4 state, validators are encouraged to take a full data snapshot at the export height before proceeding. Snap-shotting depends heavily on infrastructure, but generally this can be done by backing up the .kvd and .kvcli directories.
 | 
			
		||||
 | 
			
		||||
It is critically important to back-up the .kvd/data/priv_validator_state.json file after stopping your kvd process. This file is updated every block as your validator participates in consensus rounds. It is a critical file needed to prevent double-signing, in case the upgrade fails and the previous chain needs to be restarted.
 | 
			
		||||
 | 
			
		||||
In the event that the upgrade does not succeed, validators and operators must downgrade back to v0.12.2 of the Kava software and restore to their latest snapshot before restarting their nodes.
 | 
			
		||||
 | 
			
		||||
## Upgrade Procedure
 | 
			
		||||
 | 
			
		||||
### Before the upgrade
 | 
			
		||||
 | 
			
		||||
Set your node to produce the final block of kava-4 at __13:00__ UTC March 4th, 2021. To restart your node with that stop time,
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
kvd start --halt-time 1614862800
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
You can safely set the halt-time flag at any time.
 | 
			
		||||
 | 
			
		||||
### On the day of the upgrade
 | 
			
		||||
 | 
			
		||||
__The kava chain is expected to halt at 13:00 UTC, and restart with new software at 15:00 UTC March 15th. Do not stop your node and begin the upgrade before 13:00UTC on March 4th, or you may go offline and be unable to recover until after the upgrade!__
 | 
			
		||||
 | 
			
		||||
Kava developers will update this PR with the final block number when it is reached. __Make sure the kvd process is stopped before proceeding and that you have backed up your validator__. Failure to backup your validator could make it impossible to restart your node if the upgrade fails.
 | 
			
		||||
 | 
			
		||||
1. Export State (this __MUST__ be done using __v0.12.2__, previous v0.12.x versions will not produce the same genesis hash!)
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
kvd export --for-zero-height > export-genesis.json
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
__Note:__ This can take a while!
 | 
			
		||||
 | 
			
		||||
2. Update to kava-5
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
  # in the `kava` folder
 | 
			
		||||
    git pull
 | 
			
		||||
    git checkout v0.13.0
 | 
			
		||||
    make install
 | 
			
		||||
 | 
			
		||||
  # verify versions
 | 
			
		||||
  kvd version --long
 | 
			
		||||
  # name: kava
 | 
			
		||||
  # server_name: kvd
 | 
			
		||||
  # client_name: kvcli
 | 
			
		||||
  # version: 0.13.0
 | 
			
		||||
  # commit: PLACEHOLDER
 | 
			
		||||
  # build_tags: netgo,ledger
 | 
			
		||||
  # go: go version go1.15.8 linux/amd64
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
  # Migrate genesis state
 | 
			
		||||
  kvd migrate export-genesis.json > genesis.json
 | 
			
		||||
 | 
			
		||||
  # Verify output of genesis migration
 | 
			
		||||
  kvd validate-genesis genesis.json # should say it's valid
 | 
			
		||||
  jq -S -c -M '' genesis.json | shasum -a 256
 | 
			
		||||
  # [PLACEHOLDER]
 | 
			
		||||
 | 
			
		||||
  # Restart node with migrated genesis state
 | 
			
		||||
  cp genesis.json ~/.kvd/config/genesis.json
 | 
			
		||||
  kvd unsafe-reset-all
 | 
			
		||||
  kvd start
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Coordination
 | 
			
		||||
 | 
			
		||||
If the kava-5 chain does not launch by March 4, 2021 at 17:00 UTC, the launch should be considered a failure. Validators should restore the state from kava-4 and coordinate a relaunch. In the event of launch failure, coordination will occur in the [Kava discord](https://discord.com/invite/kQzh3Uv).
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user