Skip to content

Commit b798ad9

Browse files
mpokeMSalopeksainoe
authored
docs: prepare v15.1.0 (#3003)
* update changelog * update upgrading instructions * update release notes * Update RELEASE_NOTES.md Co-authored-by: Simon Noetzlin <[email protected]> --------- Co-authored-by: MSalopek <[email protected]> Co-authored-by: Simon Noetzlin <[email protected]>
1 parent 8e22d1c commit b798ad9

File tree

8 files changed

+44
-37
lines changed

8 files changed

+44
-37
lines changed
File renamed without changes.

.changelog/unreleased/features/2974-add-snapshot-commands.md renamed to .changelog/v15.1.0/features/2974-add-snapshot-commands.md

File renamed without changes.
File renamed without changes.

.changelog/unreleased/state-breaking/2993-migrate-escrow-accounts.md renamed to .changelog/v15.1.0/state-breaking/2993-migrate-escrow-accounts.md

File renamed without changes.

.changelog/v15.1.0/summary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*March 15, 2024*

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# CHANGELOG
22

3+
## v15.1.0
4+
5+
*March 15, 2024*
6+
7+
### DEPENDENCIES
8+
9+
- Bump [PFM](https://github.com/cosmos/ibc-apps/tree/main/middleware) to `v7.1.3-0.20240228213828-cce7f56d000b`.
10+
([\#2982](https://github.com/cosmos/gaia/pull/2982))
11+
12+
### FEATURES
13+
14+
- Add gaiad snapshots command set ([\#2974](https://github.com/cosmos/gaia/pull/2974))
15+
16+
### STATE BREAKING
17+
18+
- Bump [PFM](https://github.com/cosmos/ibc-apps/tree/main/middleware) to `v7.1.3-0.20240228213828-cce7f56d000b`.
19+
([\#2982](https://github.com/cosmos/gaia/pull/2982))
20+
- Mint and transfer missing assets in escrow accounts
21+
to reach parity with counterparty chain supply.
22+
([\#2993](https://github.com/cosmos/gaia/pull/2993))
23+
324
## v15.0.0
425

526
*February 20, 2024*

RELEASE_NOTES.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,29 @@
1-
# Gaia v15.0.0 Release Notes
1+
# Gaia v15.1.0 Release Notes
2+
3+
***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~~).***
24

35
## 📝 Changelog
46

5-
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.
7+
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.
68

79
<!-- Add the following line for major releases -->
8-
Refer to the [upgrading guide](https://github.com/cosmos/gaia/blob/release/v15.x/UPGRADING.md) when migrating from `v14.x` to `v15.x`.
10+
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`.
911

1012
## 🚀 Highlights
1113

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

14-
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:
15-
16-
- IBC to [v7.3.1](https://github.com/cosmos/ibc-go/releases/tag/v7.3.1)
17-
- CometBFT to [v0.37.4](https://github.com/cometbft/cometbft/releases/tag/v0.37.4)
18-
- Interchain Security to [v3.3.3-lsm](https://github.com/cosmos/interchain-security/releases/tag/v3.3.3-lsm)
19-
- Packet Forward Middleware to [v7.1.2](https://github.com/cosmos/ibc-apps/releases/tag/middleware%2Fpacket-forward-middleware%2Fv7.1.2)
20-
21-
In addition, this release migrates the following state:
22-
23-
- 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)).
24-
- Migrates the vesting funds from _cosmos145hytrc49m0hn6fphp8d5h4xspwkawcuzmx498_
25-
to the community pool (according to [governance proposal 860](https://www.mintscan.io/cosmos/proposals/860)).
26-
27-
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.
28-
29-
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:
30-
31-
- Reject `MsgVote` messages from accounts with less than 1 ATOM staked.
32-
- 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.
16+
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.
3317

18+
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.
3419

3520
## 🔨 Build from source
3621

3722
You must use Golang `v1.21` if building from source.
3823

3924
```bash
4025
git clone https://github.com/cosmos/gaia
41-
cd gaia && git checkout v15.0.0
26+
cd gaia && git checkout v15.1.0
4227
make install
4328
```
4429

UPGRADING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Upgrading Gaia
22

3-
This guide provides instructions for upgrading Gaia from v14.1.x to v15.x.
3+
This guide provides instructions for upgrading Gaia from v14.2.x to v15.1.x.
44

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

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

99
**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.
1010

1111
## Release Binary
1212

13-
Please use the correct release binary: `v15.0.0`.
13+
Please use the correct release binary: `v15.1.0`.
1414

1515
## Instructions
1616

@@ -41,7 +41,7 @@ Please use the correct release binary: `v15.0.0`.
4141

4242
## On-chain governance proposal attains consensus
4343

44-
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).
44+
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).
4545
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.
4646
Neither core developers nor core funding entities control the governance.
4747

@@ -82,11 +82,11 @@ For those validator and full node operators that are interested in ensuring prep
8282

8383
### Current runtime
8484

85-
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.
85+
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.
8686

8787
### Target runtime
8888

89-
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.
89+
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.
9090

9191
## Upgrade steps
9292

@@ -101,15 +101,15 @@ If you prefer to use Cosmovisor to upgrade, some preparation work is needed befo
101101

102102
### Method I: Manual Upgrade
103103

104-
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`.
104+
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`.
105105

106-
Run Gaia v14.1.0 till upgrade height, the node will panic:
106+
Run Gaia v14.2.0 till upgrade height, the node will panic:
107107

108108
```shell
109109
ERR UPGRADE "v15" NEEDED at height: <UPGRADE_HEIGHT>: upgrade to v15 and applying upgrade "v15" at height:<UPGRADE_HEIGHT>
110110
```
111111

112-
Stop the node, and switch the binary to **Gaia v15.0.0** and re-start by `gaiad start`.
112+
Stop the node, and switch the binary to **Gaia v15.1.0** and re-start by `gaiad start`.
113113

114114
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.
115115

@@ -127,14 +127,14 @@ cosmovisor version
127127
# cosmovisor version: v1.5.0
128128
```
129129

130-
- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v14.1.0` into `$GAIA_HOME/cosmovisor/genesis/bin`:
130+
- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v14.2.0` into `$GAIA_HOME/cosmovisor/genesis/bin`:
131131

132132
```shell
133133
mkdir -p $GAIA_HOME/cosmovisor/genesis/bin
134134
cp $(which gaiad) $GAIA_HOME/cosmovisor/genesis/bin
135135
```
136136

137-
- Build Gaia `v15.0.0`, and move gaiad `v15.0.0` to `$GAIA_HOME/cosmovisor/upgrades/v15/bin`
137+
- Build Gaia `v15.1.0`, and move gaiad `v15.1.0` to `$GAIA_HOME/cosmovisor/upgrades/v15/bin`
138138

139139
```shell
140140
mkdir -p $GAIA_HOME/cosmovisor/upgrades/v15/bin
@@ -148,11 +148,11 @@ At this moment, you should have the following structure:
148148
├── current -> genesis or upgrades/<name>
149149
├── genesis
150150
│ └── bin
151-
│ └── gaiad # old: v14.1.0
151+
│ └── gaiad # old: v14.2.0
152152
└── upgrades
153153
└── v15
154154
└── bin
155-
└── gaiad # new: v15.0.0
155+
└── gaiad # new: v15.1.0
156156
```
157157

158158
- Export the environmental variables:
@@ -192,7 +192,7 @@ The upgrade may take a few minutes to several hours to complete because cosmoshu
192192

193193
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.
194194

195-
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:
195+
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:
196196

197197
```shell
198198
gaiad start --unsafe-skip-upgrade <UPGRADE_HEIGHT>

0 commit comments

Comments
 (0)