From 1efc7767f50085f3b1cf9703b23ceef400062c0c Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Wed, 21 Aug 2024 12:07:40 +0200 Subject: [PATCH] docs: prepare v19.1.0 (#3283) * update release notes * update upgrading instr. * update changelog --- .../bug-fixes/92a2a88-bump-feemarket.md | 3 +++ .../dependencies/92a2a88-bump-feemarket.md | 3 +++ .changelog/v19.1.0/summary.md | 1 + CHANGELOG.md | 16 ++++++++++++++ RELEASE_NOTES.md | 20 ++++++++++++----- UPGRADING.md | 22 +++++++++---------- 6 files changed, 48 insertions(+), 17 deletions(-) create mode 100644 .changelog/v19.1.0/bug-fixes/92a2a88-bump-feemarket.md create mode 100644 .changelog/v19.1.0/dependencies/92a2a88-bump-feemarket.md create mode 100644 .changelog/v19.1.0/summary.md diff --git a/.changelog/v19.1.0/bug-fixes/92a2a88-bump-feemarket.md b/.changelog/v19.1.0/bug-fixes/92a2a88-bump-feemarket.md new file mode 100644 index 00000000000..911d06527f2 --- /dev/null +++ b/.changelog/v19.1.0/bug-fixes/92a2a88-bump-feemarket.md @@ -0,0 +1,3 @@ +- Bump [feemarket](https://github.com/skip-mev/feemarket) to + [v1.1.0](https://github.com/skip-mev/feemarket/releases/tag/v1.1.0) + ([92a2a88](https://github.com/cosmos/gaia/commit/92a2a88da512a1d8102817c61bd23cd65dda93c8)) \ No newline at end of file diff --git a/.changelog/v19.1.0/dependencies/92a2a88-bump-feemarket.md b/.changelog/v19.1.0/dependencies/92a2a88-bump-feemarket.md new file mode 100644 index 00000000000..911d06527f2 --- /dev/null +++ b/.changelog/v19.1.0/dependencies/92a2a88-bump-feemarket.md @@ -0,0 +1,3 @@ +- Bump [feemarket](https://github.com/skip-mev/feemarket) to + [v1.1.0](https://github.com/skip-mev/feemarket/releases/tag/v1.1.0) + ([92a2a88](https://github.com/cosmos/gaia/commit/92a2a88da512a1d8102817c61bd23cd65dda93c8)) \ No newline at end of file diff --git a/.changelog/v19.1.0/summary.md b/.changelog/v19.1.0/summary.md new file mode 100644 index 00000000000..786faed77eb --- /dev/null +++ b/.changelog/v19.1.0/summary.md @@ -0,0 +1 @@ +*August 21, 2024* diff --git a/CHANGELOG.md b/CHANGELOG.md index 69f05449c66..e4dd98f03b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # CHANGELOG +## v19.1.0 + +*August 21, 2024* + +### BUG FIXES + +- Bump [feemarket](https://github.com/skip-mev/feemarket) to + [v1.1.0](https://github.com/skip-mev/feemarket/releases/tag/v1.1.0) + ([92a2a88](https://github.com/cosmos/gaia/commit/92a2a88da512a1d8102817c61bd23cd65dda93c8)) + +### DEPENDENCIES + +- Bump [feemarket](https://github.com/skip-mev/feemarket) to + [v1.1.0](https://github.com/skip-mev/feemarket/releases/tag/v1.1.0) + ([92a2a88](https://github.com/cosmos/gaia/commit/92a2a88da512a1d8102817c61bd23cd65dda93c8)) + ## v19.0.0 *August 1st, 2024* diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index e56526ea254..41308cbfc38 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,23 +1,31 @@ -# Gaia v19.0.0 Release Notes +# Gaia v19.1.0 Release Notes + +⚠️ ***This is a special point release in the v19 release series and should be used for the v19 upgrade. This release replaces the now deprecated [v19.0.0](https://github.com/cosmos/gaia/tree/v19.0.0) release.*** + +## 🕐 Timeline +**This is a mandatory upgrade for all validators and full node operators.** +The upgrade height is [21835200](https://www.mintscan.io/cosmos/block/21835200), which is approx. August 21st 2024, 14:00 UTC. ## 📝 Changelog -Check out the [changelog](https://github.com/cosmos/gaia/blob/v19.0.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v18.1.0...v19.0.0) from last release. +Check out the [changelog](https://github.com/cosmos/gaia/blob/v19.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v19.0.0...v19.1.0) from last release. -Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/v19.0.0/UPGRADING.md) when migrating from `v18.1.0` to `v19.0.0`. +Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/v19.1.0/UPGRADING.md) when migrating from `v18.1.0` to `v19.1.0`. ## 🚀 Highlights -This release uses go1.22 and brings cosmos-sdk v0.50.x, ibc-go v8.x, interchain-security v5.1.0, and cometbft v0.38.9 to the Cosmos Hub. +Bug fixes and performance enhancements. -Aside from the security and performance upgrades, this release will allow [channel upgrades](https://ibc.cosmos.network/main/ibc/channel-upgrades/) and help relayer incentivization through ibc fees on existing channels. +As this release replaces [v19.0.0](https://github.com/cosmos/gaia/releases/tag/v19.0.0), please refer to the v19 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 v19.0.0 +cd gaia && git checkout v19.1.0 make install ``` diff --git a/UPGRADING.md b/UPGRADING.md index 821cff78727..9a0705ebe62 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,16 +1,16 @@ # Upgrading Gaia -This guide provides instructions for upgrading Gaia from v18.1.x. v19.0.0. +This guide provides instructions for upgrading Gaia from v18.1.x. to v19.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/v19.0.0) +For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v19.1.0) **Relayer Operators** for the Cosmos Hub and consumer chains, will also need to update to use [Hermes v1.10.0](https://github.com/informalsystems/hermes/releases/tag/v1.10.0) or higher. You may need to restart your relayer software after a major chain upgrade. ## Release Binary -Please use the correct release binary: `v19.0.0`. +Please use the correct release binary: `v19.1.0`. ## Instructions @@ -39,7 +39,7 @@ Please use the correct release binary: `v19.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/v19.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/v19.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 v18.1. ### Target runtime -The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v19.0.0](https://github.com/cosmos/gaia/releases/tag/v19.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 v19.1.0](https://github.com/cosmos/gaia/releases/tag/v19.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 @@ -88,7 +88,7 @@ Run Gaia v18.1.0 till upgrade height, the node will panic: ERR UPGRADE "v19" NEEDED at height: : upgrade to v19 and applying upgrade "v19" at height: ``` -Stop the node, and switch the binary to **Gaia v19.0.0** and re-start by `gaiad start`. +Stop the node, and switch the binary to **Gaia v19.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,11 +113,11 @@ mkdir -p $GAIA_HOME/cosmovisor/genesis/bin cp $(which gaiad) $GAIA_HOME/cosmovisor/genesis/bin ``` -- Build Gaia `v19.0.0`, and move gaiad `v19.0.0` to `$GAIA_HOME/cosmovisor/upgrades/v18/bin` +- Build Gaia `v19.1.0`, and move gaiad `v19.1.0` to `$GAIA_HOME/cosmovisor/upgrades/v19/bin` ```shell -mkdir -p $GAIA_HOME/cosmovisor/upgrades/v18/bin -cp $(which gaiad) $GAIA_HOME/cosmovisor/upgrades/v18/bin +mkdir -p $GAIA_HOME/cosmovisor/upgrades/v19/bin +cp $(which gaiad) $GAIA_HOME/cosmovisor/upgrades/v19/bin ``` At this moment, you should have the following structure: @@ -129,9 +129,9 @@ At this moment, you should have the following structure: │ └── bin │ └── gaiad # old: v18.1.0 └── upgrades - └── v18 + └── v19 └── bin - └── gaiad # new: v19.0.0 + └── gaiad # new: v19.1.0 ``` - Export the environmental variables: