From b798ad9d3912caef5d6eed3f79f69f65653bfdfb Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Fri, 15 Mar 2024 11:54:47 +0100 Subject: [PATCH] docs: prepare v15.1.0 (#3003) * update changelog * update upgrading instructions * update release notes * Update RELEASE_NOTES.md Co-authored-by: Simon Noetzlin --------- Co-authored-by: MSalopek Co-authored-by: Simon Noetzlin --- .../dependencies/2982-bump-pfm.md | 0 .../features/2974-add-snapshot-commands.md | 0 .../state-breaking/2982-bump-pfm.md | 0 .../2993-migrate-escrow-accounts.md | 0 .changelog/v15.1.0/summary.md | 1 + CHANGELOG.md | 21 +++++++++++++ RELEASE_NOTES.md | 31 +++++-------------- UPGRADING.md | 28 ++++++++--------- 8 files changed, 44 insertions(+), 37 deletions(-) rename .changelog/{unreleased => v15.1.0}/dependencies/2982-bump-pfm.md (100%) rename .changelog/{unreleased => v15.1.0}/features/2974-add-snapshot-commands.md (100%) rename .changelog/{unreleased => v15.1.0}/state-breaking/2982-bump-pfm.md (100%) rename .changelog/{unreleased => v15.1.0}/state-breaking/2993-migrate-escrow-accounts.md (100%) create mode 100644 .changelog/v15.1.0/summary.md diff --git a/.changelog/unreleased/dependencies/2982-bump-pfm.md b/.changelog/v15.1.0/dependencies/2982-bump-pfm.md similarity index 100% rename from .changelog/unreleased/dependencies/2982-bump-pfm.md rename to .changelog/v15.1.0/dependencies/2982-bump-pfm.md diff --git a/.changelog/unreleased/features/2974-add-snapshot-commands.md b/.changelog/v15.1.0/features/2974-add-snapshot-commands.md similarity index 100% rename from .changelog/unreleased/features/2974-add-snapshot-commands.md rename to .changelog/v15.1.0/features/2974-add-snapshot-commands.md diff --git a/.changelog/unreleased/state-breaking/2982-bump-pfm.md b/.changelog/v15.1.0/state-breaking/2982-bump-pfm.md similarity index 100% rename from .changelog/unreleased/state-breaking/2982-bump-pfm.md rename to .changelog/v15.1.0/state-breaking/2982-bump-pfm.md diff --git a/.changelog/unreleased/state-breaking/2993-migrate-escrow-accounts.md b/.changelog/v15.1.0/state-breaking/2993-migrate-escrow-accounts.md similarity index 100% rename from .changelog/unreleased/state-breaking/2993-migrate-escrow-accounts.md rename to .changelog/v15.1.0/state-breaking/2993-migrate-escrow-accounts.md diff --git a/.changelog/v15.1.0/summary.md b/.changelog/v15.1.0/summary.md new file mode 100644 index 00000000000..aa56eae6ae8 --- /dev/null +++ b/.changelog/v15.1.0/summary.md @@ -0,0 +1 @@ +*March 15, 2024* diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ddbf2eb5d7..3a1dcbaedeb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,26 @@ # CHANGELOG +## v15.1.0 + +*March 15, 2024* + +### DEPENDENCIES + +- Bump [PFM](https://github.com/cosmos/ibc-apps/tree/main/middleware) to `v7.1.3-0.20240228213828-cce7f56d000b`. + ([\#2982](https://github.com/cosmos/gaia/pull/2982)) + +### FEATURES + +- Add gaiad snapshots command set ([\#2974](https://github.com/cosmos/gaia/pull/2974)) + +### STATE BREAKING + +- Bump [PFM](https://github.com/cosmos/ibc-apps/tree/main/middleware) to `v7.1.3-0.20240228213828-cce7f56d000b`. + ([\#2982](https://github.com/cosmos/gaia/pull/2982)) +- Mint and transfer missing assets in escrow accounts + to reach parity with counterparty chain supply. + ([\#2993](https://github.com/cosmos/gaia/pull/2993)) + ## v15.0.0 *February 20, 2024* diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 9b8e9d4c476..9178d91f7e2 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,36 +1,21 @@ -# Gaia v15.0.0 Release Notes +# Gaia v15.1.0 Release Notes + +***This release contains the changes introduced by the v14.2.0 emergency release and should be used for the v15 upgrade (instead of ~~v15.0.0~~).*** ## 📝 Changelog -Check out the [changelog](https://github.com/cosmos/gaia/blob/v15.0.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v14.1.0...v15.0.0) from last release. +Check out the [changelog](https://github.com/cosmos/gaia/blob/v15.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/gaia/compare/v14.2.0...v15.1.0) from last release. -Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v15.x/UPGRADING.md) when migrating from `v14.x` to `v15.x`. +Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v15.x/UPGRADING.md) when migrating from `v14.2.x` to `v15.1.x`. ## 🚀 Highlights -The focus of this release is the upgrade of Cosmos SDK to v0.47 -- this release uses [v0.47.10-ics-lsm](https://github.com/cosmos/cosmos-sdk/tree/v0.47.10-ics-lsm), a special Cosmos SDK branch with support for both ICS and LSM. Consequently, it also upgrades the following dependencies: - -- IBC to [v7.3.1](https://github.com/cosmos/ibc-go/releases/tag/v7.3.1) -- CometBFT to [v0.37.4](https://github.com/cometbft/cometbft/releases/tag/v0.37.4) -- Interchain Security to [v3.3.3-lsm](https://github.com/cosmos/interchain-security/releases/tag/v3.3.3-lsm) -- Packet Forward Middleware to [v7.1.2](https://github.com/cosmos/ibc-apps/releases/tag/middleware%2Fpacket-forward-middleware%2Fv7.1.2) - -In addition, this release migrates the following state: - -- Sets the min commission rate staking parameter to `5%` and updates the commission rate for all validators accordingly (according to [governance proposal 826](https://www.mintscan.io/cosmos/proposals/826)). -- Migrates the vesting funds from _cosmos145hytrc49m0hn6fphp8d5h4xspwkawcuzmx498_ - to the community pool (according to [governance proposal 860](https://www.mintscan.io/cosmos/proposals/860)). - -Also, this release adds support for metaprotocols using the transaction extension options. See the [docs of the x/metaprotocols module](https://github.com/cosmos/gaia/tree/release/v15.x/x/metaprotocols) for more details. - -Finally, this releases fixes a series of issues found during the [Oak Security audit of SDK 0.47](https://github.com/oak-security/audit-reports/blob/master/Cosmos%20SDK/2024-01-23%20Audit%20Report%20-%20Cosmos%20SDK%20v1.0.pdf). As a result, this release introduces the following API changes: - - - Reject `MsgVote` messages from accounts with less than 1 ATOM staked. - - A new `MinDepositRatio` param is added (with a default value of `0.01`) and now deposits are required to be at least `MinDepositRatio*MinDeposit` to be accepted. +As this release replaces the [v15.0.0](https://github.com/cosmos/gaia/releases/tag/v15.0.0) release, please check out the release notes for all the highlights. +In addition, this release bumps Packet Forward Middleware to `v7.1.3-0.20240228213828-cce7f56d000b`, which contains the same fix as the one introduced by the [v14.2.0](https://github.com/cosmos/gaia/releases/tag/v14.2.0) emergency release. It also fixes a series of escrow accounts by minting and transfering the missing assets to reach parity with counterparty chain supply. ## 🔨 Build from source @@ -38,7 +23,7 @@ You must use Golang `v1.21` if building from source. ```bash git clone https://github.com/cosmos/gaia -cd gaia && git checkout v15.0.0 +cd gaia && git checkout v15.1.0 make install ``` diff --git a/UPGRADING.md b/UPGRADING.md index 050f3f73eee..0dbba2c4521 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,16 +1,16 @@ # Upgrading Gaia -This guide provides instructions for upgrading Gaia from v14.1.x to v15.x. +This guide provides instructions for upgrading Gaia from v14.2.x to v15.1.x. This document describes the steps for validators, full node operators and relayer operators, to upgrade successfully for the Gaia v15 release. -For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v15.0.0) +For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v15.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: `v15.0.0`. +Please use the correct release binary: `v15.1.0`. ## Instructions @@ -41,7 +41,7 @@ Please use the correct release binary: `v15.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/v15.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/v15.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. Neither core developers nor core funding entities control the governance. @@ -82,11 +82,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 v14.1.0](https://github.com/cosmos/gaia/releases/v14.1.0). We anticipate that operators who are running on v14.1.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 v14.2.0](https://github.com/cosmos/gaia/releases/v14.2.0). We anticipate that operators who are running on v14.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. ### Target runtime -The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v15.0.0](https://github.com/cosmos/gaia/releases/tag/v15.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 v15.1.0](https://github.com/cosmos/gaia/releases/tag/v15.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 @@ -101,15 +101,15 @@ If you prefer to use Cosmovisor to upgrade, some preparation work is needed befo ### Method I: Manual Upgrade -Make sure **Gaia v14.1.0** is installed by either downloading a [compatible binary](https://github.com/cosmos/gaia/releases/tag/v14.1.0), or building from source. Check the required version to build this binary in the `Makefile`. +Make sure **Gaia v14.2.0** is installed by either downloading a [compatible binary](https://github.com/cosmos/gaia/releases/tag/v14.2.0), or building from source. Check the required version to build this binary in the `Makefile`. -Run Gaia v14.1.0 till upgrade height, the node will panic: +Run Gaia v14.2.0 till upgrade height, the node will panic: ```shell ERR UPGRADE "v15" NEEDED at height: : upgrade to v15 and applying upgrade "v15" at height: ``` -Stop the node, and switch the binary to **Gaia v15.0.0** and re-start by `gaiad start`. +Stop the node, and switch the binary to **Gaia v15.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. @@ -127,14 +127,14 @@ cosmovisor version # cosmovisor version: v1.5.0 ``` -- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v14.1.0` into `$GAIA_HOME/cosmovisor/genesis/bin`: +- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v14.2.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 `v15.0.0`, and move gaiad `v15.0.0` to `$GAIA_HOME/cosmovisor/upgrades/v15/bin` +- Build Gaia `v15.1.0`, and move gaiad `v15.1.0` to `$GAIA_HOME/cosmovisor/upgrades/v15/bin` ```shell mkdir -p $GAIA_HOME/cosmovisor/upgrades/v15/bin @@ -148,11 +148,11 @@ At this moment, you should have the following structure: ├── current -> genesis or upgrades/ ├── genesis │ └── bin -│ └── gaiad # old: v14.1.0 +│ └── gaiad # old: v14.2.0 └── upgrades └── v15 └── bin - └── gaiad # new: v15.0.0 + └── gaiad # new: v15.1.0 ``` - Export the environmental variables: @@ -192,7 +192,7 @@ The upgrade may take a few minutes to several hours to complete because cosmoshu 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) v14.1.0 binary using the following command: +Steps to skip this upgrade proposal are simply to resume the cosmoshub-4 network with the (downgraded) v14.2.0 binary using the following command: ```shell gaiad start --unsafe-skip-upgrade