Skip to content

Commit

Permalink
chore: update changelog and upgrading intructions (#3187)
Browse files Browse the repository at this point in the history
* init commit

* update changelog

* update upgrading docs for v18.1 release

* bump ICS to v4.3.1-lsm

* update changelog to be aligned with main branch
  • Loading branch information
sainoe committed Jul 8, 2024
1 parent 0fa19c3 commit 58b4e54
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 41 deletions.
1 change: 1 addition & 0 deletions .changelog/v18.1.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*July 8, 2024*
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# CHANGELOG

## v18.1.0

*July 8, 2024*

### DEPENDENCIES

- Bump [ICS](https://github.com/cosmos/interchain-security) to
[v4.3.1-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.3.1-
lsm) ([\#3193](https://github.com/cosmos/gaia/pull/3193))

### STATE BREAKING

- Bump [ICS](https://github.com/cosmos/interchain-security) to
[v4.3.1-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.3.1-
lsm) ([\#3193](https://github.com/cosmos/gaia/pull/3193))

## v18.0.0

*June 25, 2024*
Expand Down
35 changes: 8 additions & 27 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,30 @@
# Gaia v18.0.0 Release Notes
# Gaia v18.1.0 Release Notes

⚠️ ***This is a special point release in the v18 release series. It includes the fix introduced in the [v17.3.0](https://github.com/cosmos/gaia/tree/v17.3.0) emergency release and should be used for the v18 upgrade. This release replaces the now deprecated [v18.0.0](https://github.com/cosmos/gaia/tree/v18.0.0) release.***

## 📝 Changelog

Check out the [changelog](https://github.com/cosmos/gaia/blob/v18.0.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v17.2.0...v18.0.0) from last release.
Check out the [changelog](https://github.com/cosmos/gaia/blob/v18.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v17.3.0...v18.1.0) from last release.

<!-- Add the following line for major releases -->
Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v18.x/UPGRADING.md) when migrating from `v17.2.x` to `v18.x`.
Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v18.1.x/UPGRADING.md) when migrating from `v17.3.x` to `v18.1.x`.

## 🚀 Highlights

<!-- Add any highlights of this release -->

This release adds the following features:

- Permissioned CosmWasm (as per [prop 895](https://www.mintscan.io/cosmos/proposals/895)) enables the governance-gated deployment of CosmWasm contracts. See [this forum discussion](https://forum.cosmos.network/t/discussion-hub-cosmwasm-guidelines/13788) for more details on what contracts should be deployed on the Hub.
- Skip's [feemarket module](https://github.com/skip-mev/feemarket) (as per [prop 842](https://www.mintscan.io/cosmos/proposals/842)) enables the dynamic adjustment of the base transaction fee based on the block utilization (the more transactions in a block, the higher the base fee). This module replaces the [x/globalfee module](https://hub.cosmos.network/v17.1.0/architecture/adr/adr-002-globalfee).
- [Expedited proposals](https://docs.cosmos.network/v0.50/build/modules/gov#expedited-proposals) (as per [prop 926](https://www.mintscan.io/cosmos/proposals/926)) enable governance proposals with a shorter voting period (i.e., one week instead of two), but with a higher tally threshold (i.e., 66.7% of Yes votes for the proposal to pass) and a higher minimum deposit (i.e., 500 ATOMs instead of the 250 for regular proposals). Initially, only `MsgSoftwareUpgrade` and `MsgCancelUpgrade` can be expedited.

The release also bumps the following dependencies:
- Golang to v1.22
- Cosmos SDK to [v0.47.16-ics-lsm](https://github.com/cosmos/cosmos-sdk/tree/v0.47.16-ics-lsm)
- IBC to [v7.6.0](https://github.com/cosmos/ibc-go/releases/tag/v7.6.0)
- ICS to [v4.3.0-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.3.0-lsm)

## ❤️ Contributors

* Binary Builders ([@binary_builders](https://x.com/binary_builders))
* Informal Systems ([@informalinc](https://x.com/informalinc))
* Hypha Worker Co-operative ([@HyphaCoop](https://x.com/HyphaCoop))
* Skip Protocol ([@skipprotocol](https://x.com/skipprotocol))
* Strangelove ([@strangelovelabs](https://x.com/strangelovelabs))

This list is non-exhaustive and ordered alphabetically.
Thank you to everyone who contributed to this release!
As this release replaces [v18.0.0](https://github.com/cosmos/gaia/releases/tag/v18.0.0), please refer to the v18 release notes for all the highlights from that version.

## 🔨 Build from source

***You must use Golang v1.22 if building from source.***

```bash
git clone https://github.com/cosmos/gaia
cd gaia && git checkout v18.0.0
cd gaia && git checkout v18.1.0
make install
```

## ⚡️ Download binaries

Binaries for linux, darwin, and windows are available below.
Binaries for linux, darwin, and windows are available below.
28 changes: 14 additions & 14 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Upgrading Gaia

This guide provides instructions for upgrading Gaia from v17.2.x to v18.x.
This guide provides instructions for upgrading Gaia from v17.3.x to v18.1.x.

This document describes the steps for validators, full node operators and relayer operators, to upgrade successfully for the Gaia v18 release.

For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v18.0.0)
For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v18.1.0)

**Relayer Operators** for the Cosmos Hub and consumer chains, will also need to update to use [Hermes v1.8.0](https://github.com/informalsystems/hermes/releases/tag/v1.8.0) or higher. You may need to restart your relayer software after a major chain upgrade.

## Release Binary

Please use the correct release binary: `v18.0.0`.
Please use the correct release binary: `v18.1.0`.

## Instructions

Expand Down Expand Up @@ -39,7 +39,7 @@ Please use the correct release binary: `v18.0.0`.

## On-chain governance proposal attains consensus

Once a software upgrade governance proposal is submitted to the Cosmos Hub, both a reference to this proposal and an `UPGRADE_HEIGHT` are added to the [release notes](https://github.com/cosmos/gaia/releases/tag/v18.0.0).
Once a software upgrade governance proposal is submitted to the Cosmos Hub, both a reference to this proposal and an `UPGRADE_HEIGHT` are added to the [release notes](https://github.com/cosmos/gaia/releases/tag/v18.1.0).
If and when this proposal reaches consensus, the upgrade height will be used to halt the "old" chain binaries. You can check the proposal on one of the block explorers or using the `gaiad` CLI tool.

## Upgrade date
Expand All @@ -61,11 +61,11 @@ For those validator and full node operators that are interested in ensuring prep

### Current runtime

The Cosmos Hub mainnet network, `cosmoshub-4`, is currently running [Gaia v17.2.0](https://github.com/cosmos/gaia/releases/v17.2.0). We anticipate that operators who are running on v17.2.0, will be able to upgrade successfully. Validators are expected to ensure that their systems are up to date and capable of performing the upgrade. This includes running the correct binary and if building from source, building with the appropriate `go` version.
The Cosmos Hub mainnet network, `cosmoshub-4`, is currently running [Gaia v17.3.0](https://github.com/cosmos/gaia/releases/v17.3.0). We anticipate that operators who are running on v17.3.0, will be able to upgrade successfully. Validators are expected to ensure that their systems are up to date and capable of performing the upgrade. This includes running the correct binary and if building from source, building with the appropriate `go` version.

### Target runtime

The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v18.0.0](https://github.com/cosmos/gaia/releases/tag/v18.0.0)**. Operators _**MUST**_ use this version post-upgrade to remain connected to the network. The new version requires `go v1.22` to build successfully.
The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v18.1.0](https://github.com/cosmos/gaia/releases/tag/v18.1.0)**. Operators _**MUST**_ use this version post-upgrade to remain connected to the network. The new version requires `go v1.22` to build successfully.

## Upgrade steps

Expand All @@ -80,15 +80,15 @@ If you prefer to use Cosmovisor to upgrade, some preparation work is needed befo

### Method I: Manual Upgrade

Make sure **Gaia v17.2.0** is installed by either downloading a [compatible binary](https://github.com/cosmos/gaia/releases/tag/v17.2.0), or building from source. Check the required version to build this binary in the `Makefile`.
Make sure **Gaia v17.3.0** is installed by either downloading a [compatible binary](https://github.com/cosmos/gaia/releases/tag/v17.3.0), or building from source. Check the required version to build this binary in the `Makefile`.

Run Gaia v17.2.0 till upgrade height, the node will panic:
Run Gaia v17.3.0 till upgrade height, the node will panic:

```shell
ERR UPGRADE "v18" NEEDED at height: <UPGRADE_HEIGHT>: upgrade to v18 and applying upgrade "v18" at height:<UPGRADE_HEIGHT>
```

Stop the node, and switch the binary to **Gaia v18.0.0** and re-start by `gaiad start`.
Stop the node, and switch the binary to **Gaia v18.1.0** and re-start by `gaiad start`.

It may take several minutes to a few hours until validators with a total sum voting power > 2/3 to complete their node upgrades. After that, the chain can continue to produce blocks.

Expand All @@ -106,14 +106,14 @@ cosmovisor version
# cosmovisor version: v1.5.0
```

- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v17.2.0` into `$GAIA_HOME/cosmovisor/genesis/bin`:
- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v17.3.0` into `$GAIA_HOME/cosmovisor/genesis/bin`:

```shell
mkdir -p $GAIA_HOME/cosmovisor/genesis/bin
cp $(which gaiad) $GAIA_HOME/cosmovisor/genesis/bin
```

- Build Gaia `v18.0.0`, and move gaiad `v18.0.0` to `$GAIA_HOME/cosmovisor/upgrades/v18/bin`
- Build Gaia `v18.1.0`, and move gaiad `v18.1.0` to `$GAIA_HOME/cosmovisor/upgrades/v18/bin`

```shell
mkdir -p $GAIA_HOME/cosmovisor/upgrades/v18/bin
Expand All @@ -127,11 +127,11 @@ At this moment, you should have the following structure:
├── current -> genesis or upgrades/<name>
├── genesis
│ └── bin
│ └── gaiad # old: v17.2.0
│ └── gaiad # old: v17.3.0
└── upgrades
└── v18
└── bin
└── gaiad # new: v18.0.0
└── gaiad # new: v18.1.0
```

- Export the environmental variables:
Expand Down Expand Up @@ -169,7 +169,7 @@ The upgrade may take a few minutes to complete because cosmoshub-4 participants

During the network upgrade, core Cosmos teams will be keeping an ever vigilant eye and communicating with operators on the status of their upgrades. During this time, the core teams will listen to operator needs to determine if the upgrade is experiencing unintended challenges. In the event of unexpected challenges, the core teams, after conferring with operators and attaining social consensus, may choose to declare that the upgrade will be skipped.

Steps to skip this upgrade proposal are simply to resume the cosmoshub-4 network with the (downgraded) v17.2.0 binary using the following command:
Steps to skip this upgrade proposal are simply to resume the cosmoshub-4 network with the (downgraded) v17.3.0 binary using the following command:

```shell
gaiad start --unsafe-skip-upgrade <UPGRADE_HEIGHT>
Expand Down

0 comments on commit 58b4e54

Please sign in to comment.