Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added 4.1 upgrade doc #1510

Merged
merged 3 commits into from
Sep 30, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/validators/upgrades/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This document provides an overview of the upgrade process for software upgrades
- [Upgrade Guide v2.0](v2.0-upgrade.md)
- [Upgrade Guide v3.0](v3.0-upgrade.md)
- [Upgrade Guide v4.0](v4.0-upgrade.md)
- [Upgrade Guide v4.1.2](v4.1-upgrade.md)

## Software Upgrade

Expand Down
106 changes: 106 additions & 0 deletions docs/validators/upgrades/v4.1-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Upgrade Guide v4.1.2

This document provides guidelines for node operators upgrading from Regen Ledger v4.0 to v4.1.2. For a general overview of the upgrade process, please refer to [Upgrade Overview](README.md).

## Upgrade Info

### Regen Ledger v4.1.2

- [Release Notes](https://github.com/regen-network/regen-ledger/releases/tag/v4.1.2)

### Regen Mainnet

- Upgrade Height: `7479500`

### Redwood Testnet

- Upgrade Height: `5814852`

## Upgrade Guidelines

### Update Go

**Go `1.18` 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 (`v4.1.2`) from source:

```bash
cd regen-ledger
git fetch --all
git checkout v4.1.2
make build
```

Ensure the `regen` binary has been built:

```bash
./build/regen version
```

You should see the following:

```bash
v4.1.2
```

Create a `v4.1.0` directory and copy the upgrade binary (`v4.1.2`) to the directory:

```bash
mkdir -p $HOME/.regen/cosmovisor/upgrades/v4.1.0/bin
cp ./build/regen $HOME/.regen/cosmovisor/upgrades/v4.1.0/bin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cp ./build/regen $HOME/.regen/cosmovisor/upgrades/v4.1.0/bin
cp ./build/regen $HOME/.regen/cosmovisor/upgrades/v4.1.0/bin
$HOME/.regen/cosmovisor/upgrades/v4.1.0/bin/regen version # should be v4.1.2

```
Ensure the right `regen` binary has been placed in the directory:

```bash
$HOME/.regen/cosmovisor/upgrades/v4.1.0/bin
```

You should see the following:

```bash
v4.1.2
```


At the proposed block height, `cosmovisor` will automatically stop the current binary (`v4.0.0`), set the upgrade binary as the current binary (`v4.1.2`), 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.

When the chain halts at the proposed upgrade height, stop the current process running `regen`.

Build the upgrade binary (`v4.1.2`) from source:

```bash
cd regen-ledger
git fetch --all
git checkout v4.1.2
make install
```

Ensure the `regen` binary has been updated:

```bash
regen version
```

You should see the following:

```bash
v4.1.2
```

Restart the process running `regen`.