-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add v5.1 validator upgrade guide (#1869)
- Loading branch information
1 parent
b18ac9b
commit 891bda4
Showing
7 changed files
with
116 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# Upgrade Guide v5.1 | ||
|
||
This document provides guidelines for node operators upgrading from Regen Ledger v5.0 to v5.1. For a general overview of the upgrade process, please refer to [Upgrade Overview](README.md). | ||
|
||
## Upgrade Info | ||
|
||
### Regen Ledger v5.1 | ||
|
||
- [Release Notes](https://github.com/regen-network/regen-ledger/releases/tag/v5.1.0) | ||
|
||
### Regen Mainnet | ||
|
||
- Upgrade Height: `10068550` | ||
|
||
### Redwood Testnet | ||
|
||
- Upgrade Height: `8341536` | ||
|
||
## Upgrade Guidelines | ||
|
||
### Update Go | ||
|
||
**Go `1.19` or later is required.** | ||
|
||
For available downloads, see [Go Downloads](https://go.dev/dl/). | ||
|
||
### Option 1: Using Cosmovisor | ||
|
||
**Cosmovisor `v1.0` or later is required.** | ||
|
||
The following instructions assume the `cosmovisor` binary is already installed and `cosmovisor` is set up as a systemd service. If this is not the case, please refer to [Using Cosmovisor](../get-started/using-cosmovisor.md) for instructions on how to install and set up `cosmovisor`. | ||
|
||
::: warning Auto-Download Not Recommended | ||
Cosmovisor provides an auto-download option that prevents the need for the following steps in preparing for the upgrade. Although available to validators, this feature should only be used for non-validator nodes and validators should build the binary from source. | ||
::: | ||
|
||
Build the upgrade binary (`v5.1.0`) from source: | ||
|
||
```bash | ||
cd regen-ledger | ||
git fetch v5.1.0 | ||
git checkout v5.1.0 | ||
make build | ||
``` | ||
|
||
Ensure the `regen` binary has been built: | ||
|
||
```bash | ||
./build/regen version | ||
``` | ||
|
||
You should see the following: | ||
|
||
```bash | ||
v5.1.0 | ||
``` | ||
|
||
Create a `v5.1` directory and copy the upgrade binary (`v5.1.0`) to the directory: | ||
|
||
```bash | ||
mkdir -p $HOME/.regen/cosmovisor/upgrades/v5.1/bin | ||
cp ./build/regen $HOME/.regen/cosmovisor/upgrades/v5.1/bin | ||
``` | ||
Ensure the right `regen` binary has been placed in the directory: | ||
|
||
```bash | ||
$HOME/.regen/cosmovisor/upgrades/v5.1/bin/regen version | ||
``` | ||
|
||
You should see the following: | ||
|
||
```bash | ||
v5.1.0 | ||
``` | ||
|
||
At the proposed block height, `cosmovisor` will automatically stop the current binary (`v5.0.x`), set the upgrade binary as the current binary (`v5.1.0`), and then (depending on the cosmovisor settings) perform a backup and restart the node. | ||
|
||
### Option 2: Without Cosmovisor | ||
|
||
Using `cosmovisor` to perform the upgrade is not required. Node operators also have the option to manually update the `regen` binary at the time of the upgrade. | ||
|
||
First Build the upgrade binary (`v5.1.0`) from source: | ||
|
||
```bash | ||
cd regen-ledger | ||
git fetch v5.1.0 | ||
git checkout v5.1.0 | ||
make install | ||
``` | ||
|
||
Ensure the `regen` binary has been updated: | ||
|
||
```bash | ||
regen version | ||
``` | ||
|
||
You should see the following: | ||
|
||
```bash | ||
v5.1.0 | ||
``` | ||
|
||
When the chain halts at the proposed upgrade height, stop the current process running `regen`. | ||
|
||
Restart the process running `regen`. |