diff --git a/.changelog/unreleased/dependencies/3125-bump-sdk.md b/.changelog/v17.1.0/dependencies/3125-bump-sdk.md similarity index 100% rename from .changelog/unreleased/dependencies/3125-bump-sdk.md rename to .changelog/v17.1.0/dependencies/3125-bump-sdk.md diff --git a/.changelog/unreleased/state-breaking/3125-bump-sdk.md b/.changelog/v17.1.0/state-breaking/3125-bump-sdk.md similarity index 100% rename from .changelog/unreleased/state-breaking/3125-bump-sdk.md rename to .changelog/v17.1.0/state-breaking/3125-bump-sdk.md diff --git a/.changelog/v17.1.0/summary.md b/.changelog/v17.1.0/summary.md new file mode 100644 index 0000000000..3b1771c8b4 --- /dev/null +++ b/.changelog/v17.1.0/summary.md @@ -0,0 +1 @@ +*June 4, 2024* diff --git a/CHANGELOG.md b/CHANGELOG.md index f3fab9d9f3..3b8fb9d037 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # CHANGELOG +## v17.1.0 + +*June 4, 2024* + +### DEPENDENCIES + +- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to + [v0.47.14-ics-lsm](https://github.com/cosmos/cosmos-sdk/tree/v0.47.14-ics-lsm). + This is a special cosmos-sdk branch with support for both ICS and LSM. + ([\#3125](https://github.com/cosmos/gaia/pull/3125)) + +### STATE BREAKING + +- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to + [v0.47.14-ics-lsm](https://github.com/cosmos/cosmos-sdk/tree/v0.47.14-ics-lsm). + This is a special cosmos-sdk branch with support for both ICS and LSM. + ([\#3125](https://github.com/cosmos/gaia/pull/3125)) + ## v17.0.0 *May 17, 2024* diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 6abbe145e0..d5c8c9c51a 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,22 +1,30 @@ -# Gaia v17.0.0 Release Notes +# Gaia v17.1.0 Release Notes + +⚠️ ***This is a special point release in the v17 release series. It contains bug fixes and performance enhancements. It replaces the [v17.0.0](https://github.com/cosmos/gaia/releases/tag/v17.0.0) release, which is deprecated.*** + +## 🕐 Timeline +**This is a mandatory upgrade for all validators and full node operators.** +The upgrade height is [20739800](https://www.mintscan.io/cosmos/block/20739800, which is approx. June 5th 2024, 17:00 UTC. ## 📝 Changelog -Check out the [changelog](https://github.com/cosmos/gaia/blob/v17.0.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v16.0.0...v17.0.0) from last release. +Check out the [changelog](https://github.com/cosmos/gaia/blob/v17.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v16.0.0...v17.1.0) from last release. -Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v17.x/UPGRADING.md) when migrating from `v16.x` to `v17.x`. +Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v17.1.x/UPGRADING.md) when migrating from `v16.x` to `v17.1.x`. ## 🚀 Highlights -This release adds ICS 2.0 to Gaia. ICS 2.0 -- also known as Partial Set Security (PSS) -- allows each consumer chain to leverage only a subset of the Hub validator set and enables validators to opt-in to validate the consumer chains they want. For more details, check out the [ICS docs](https://cosmos.github.io/interchain-security/features/partial-set-security). +As this release replaces the [v17.0.0](https://github.com/cosmos/gaia/releases/tag/v17.0.0) release, please check out the release notes for all the highlights. + +In addition, this release contains bug fixes and performance enhancements. ## 🔨 Build from source ```bash git clone https://github.com/cosmos/gaia -cd gaia && git checkout v17.0.0 +cd gaia && git checkout v17.1.0 make install ``` diff --git a/UPGRADING.md b/UPGRADING.md index c28b5da391..3b2f347c74 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,16 +1,16 @@ # Upgrading Gaia -This guide provides instructions for upgrading Gaia from v16.x to v17.x. +This guide provides instructions for upgrading Gaia from v16.x to v17.1.x. This document describes the steps for validators, full node operators and relayer operators, to upgrade successfully for the Gaia v17 release. -For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v17.0.0) +For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v17.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: `v17.0.0`. +Please use the correct release binary: `v17.1.0`. ## Instructions @@ -39,7 +39,7 @@ Please use the correct release binary: `v17.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/v17.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/v17.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 @@ -65,7 +65,7 @@ The Cosmos Hub mainnet network, `cosmoshub-4`, is currently running [Gaia v16.0. ### Target runtime -The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v17.0.0](https://github.com/cosmos/gaia/releases/tag/v17.0.0)**. Operators _**MUST**_ use this version post-upgrade to remain connected to the network. The new version requires `go v1.21` to build successfully. +The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v17.1.0](https://github.com/cosmos/gaia/releases/tag/v17.1.0)**. Operators _**MUST**_ use this version post-upgrade to remain connected to the network. The new version requires `go v1.21` to build successfully. ## Upgrade steps @@ -88,7 +88,7 @@ Run Gaia v16.0.0 till upgrade height, the node will panic: ERR UPGRADE "v17" NEEDED at height: : upgrade to v17 and applying upgrade "v17" at height: ``` -Stop the node, and switch the binary to **Gaia v17.0.0** and re-start by `gaiad start`. +Stop the node, and switch the binary to **Gaia v17.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. @@ -113,7 +113,7 @@ mkdir -p $GAIA_HOME/cosmovisor/genesis/bin cp $(which gaiad) $GAIA_HOME/cosmovisor/genesis/bin ``` -- Build Gaia `v17.0.0`, and move gaiad `v17.0.0` to `$GAIA_HOME/cosmovisor/upgrades/v17/bin` +- Build Gaia `v17.1.0`, and move gaiad `v17.1.0` to `$GAIA_HOME/cosmovisor/upgrades/v17/bin` ```shell mkdir -p $GAIA_HOME/cosmovisor/upgrades/v17/bin @@ -131,7 +131,7 @@ At this moment, you should have the following structure: └── upgrades └── v17 └── bin - └── gaiad # new: v17.0.0 + └── gaiad # new: v17.1.0 ``` - Export the environmental variables: