From 79d813c2bc84d2506ba726d272dd6021b05d116c Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Wed, 21 Jun 2023 13:32:06 +0200 Subject: [PATCH] chore: start using unclog (#2605) * add unrelease changelog entries to .changelog * run unclog build -a * rename changelog categories * add tests as a component * update workflow doc --- .changelog/config.toml | 20 + .changelog/epilogue.md | 556 ++++++++++++++++++ .changelog/unreleased/.gitkeep | 0 .../api-breaking/globalfee/2424-params.md | 2 + .../unreleased/dependencies/2554-bump-ibc.md | 3 + .../globalfee/2352-migration.md | 3 + .../state-breaking/globalfee/2424-params.md | 2 + .../globalfee/2447-delivertx.md | 2 + .github/PULL_REQUEST_TEMPLATE/production.md | 4 +- CHANGELOG.md | 65 +- CONTRIBUTING.md | 56 +- 11 files changed, 664 insertions(+), 49 deletions(-) create mode 100644 .changelog/config.toml create mode 100644 .changelog/epilogue.md create mode 100644 .changelog/unreleased/.gitkeep create mode 100644 .changelog/unreleased/api-breaking/globalfee/2424-params.md create mode 100644 .changelog/unreleased/dependencies/2554-bump-ibc.md create mode 100644 .changelog/unreleased/state-breaking/globalfee/2352-migration.md create mode 100644 .changelog/unreleased/state-breaking/globalfee/2424-params.md create mode 100644 .changelog/unreleased/state-breaking/globalfee/2447-delivertx.md diff --git a/.changelog/config.toml b/.changelog/config.toml new file mode 100644 index 00000000000..818370b9cc1 --- /dev/null +++ b/.changelog/config.toml @@ -0,0 +1,20 @@ +project_url = "https://github.com/cosmos/gaia" + +# Settings related to components/sub-modules. Only relevant if you make use of +# components/sub-modules. +[components] + +# The title to use for the section of entries not relating to a specific +# component. +general_entries_title = "General" + +# The number of spaces to inject before each component-related entry. +entry_indent = 2 + + # The components themselves. Each component has a name (used when rendered + # to Markdown) and a path relative to the project folder (i.e. relative to + # the parent of the `.changelog` folder). + [components.all] + globalfee = { name = "GlobalFee", path = "x/globalfee" } + tests = { name = "Tests", path = "tests" } + docs = { name = "Documentation", path = "docs" } \ No newline at end of file diff --git a/.changelog/epilogue.md b/.changelog/epilogue.md new file mode 100644 index 00000000000..e3d494a4422 --- /dev/null +++ b/.changelog/epilogue.md @@ -0,0 +1,556 @@ +## [v10.0.1] 2023-05-25 + +* (deps) [#2543](https://github.com/cosmos/gaia/pull/2543) Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v4.4.1](https://github.com/cosmos/ibc-go/releases/tag/v4.4.1). + +## [v10.0.0] 2023-05-19 + +* (deps) [#2498](https://github.com/cosmos/gaia/pull/2498) Bump multiple dependencies. + * Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.16-ics](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.16-ics). See the [v0.45.16 release notes](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.16) for details. + * Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v4.4.0](https://github.com/cosmos/ibc-go/releases/tag/v4.4.0). + * Bump [CometBFT](https://github.com/cometbft/cometbft) to [v0.34.28](https://github.com/cometbft/cometbft/releases/tag/v0.34.28). +* (gaia) Bump Golang prerequisite from 1.18 to 1.20. See (https://go.dev/blog/go1.20) for details. + +## [v9.1.1] - 2023-05-25 + +* (deps) [#2542](https://github.com/cosmos/gaia/pull/2542) Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v4.2.1](https://github.com/cosmos/ibc-go/releases/tag/v4.2.1). + +## [v9.1.0] - 2023-05-08 + +* (fix) [#2474](https://github.com/cosmos/gaia/pull/2474) Multisig and distribution fix in [Interchain-Security](https://github.com/cosmos/interchain-security). Bump Interchain-Security to [v1.1.0-multiden](https://github.com/cosmos/interchain-security/tree/v1.1.0-multiden). + +This release combines two fixes that we judged were urgent to get onto the Cosmos Hub before the launch of the first ICS consumer chain. _Please note that user funds were not at risk and these fixes pertain to the liveness of the Hub and consumer chains_. + +The first fix is to enable the use of multisigs and Ledger devices when assigning keys for consumer chains. The second is to prevent a possible DOS vector involving the reward distribution system. + +### Multisig fix + +On April 25th (a week and a half ago), we began receiving reports that validators using multisigs and Ledger devices were getting errors reading Error: unable to resolve type URL /interchain_security.ccv.provider.v1.MsgAssignConsumerKey: tx parse error when attempting to assign consensus keys for consumer chains. + +This was surprising because we had never seen this error before, even though we have done many testnets. The reason for this is probably because people don’t bother to use high security key management techniques in testnets. + +We quickly narrowed the problem down to issues having to do with using the PubKey type directly in the MsgAssignConsumerKey transaction, and Amino (a deprecated serialization library still used in Ledger devices and multisigs) not being able to handle this. We attempted to fix this with the assistance of the Cosmos-SDK team, but after making no headway for a few days, we decided to simply use a JSON representation of the PubKey in the transaction. This is how it is usually represented anyway. We have verified that this fixes the problem. + +### Distribution fix + +The ICS distribution system works by allowing consumer chains to send rewards to a module address on the Hub called the FeePoolAddress. From here they are automatically distributed to all validators and delegators through the distribution system that already exists to distribute Atom staking rewards. The FeePoolAddress is usually blocked so that no tokens can be sent to it, but to enable ICS distribution we had to unblock it. + +We recently realized that unblocking the FeePoolAddress could enable an attacker to send a huge number of different denoms into the distribution system. The distribution system would then attempt to distribute them all, leading to out of memory errors. Fixing a similar attack vector that existed in the distribution system before ICS led us to this realization. + +To fix this problem, we have re-blocked the FeePoolAddress and created a new address called the ConsumerRewardsPool. Consumer chains now send rewards to this new address. There is also a new transaction type called RegisterConsumerRewardDenom. This transaction allows people to register denoms to be used as rewards from consumer chains. It costs 10 Atoms to run this transaction.The Atoms are transferred to the community pool. Only denoms registered with this command are then transferred to the FeePoolAddress and distributed out to delegators and validators. + +Note: The fee of 10 Atoms was originally intended to be a parameter that could be changed by governance (10 Atoms might cost too much in the future). However, we ran into some problems creating a new parameter as part of an emergency upgrade. After consulting with the Cosmos-SDK team, we learned that creating new parameters is only supported as part of a scheduled upgrade. So in the current code, the number of Atoms is hardcoded. It will turn into a parameter in the next scheduled upgrade. + +## [v9.0.3] - 2023-04-19 +* (deps) [#2399](https://github.com/cosmos/gaia/pull/2399) Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.15-ics](https://github.com/cosmos/cosmos +sdk/releases/tag/v0.45.15-ics) and migrate to [CometBFT](https://github.com/cometbft/cometbft). + +## [v9.0.2] - 2023-04-03 +* (feat) Bump [Interchain-Security](https://github.com/cosmos/interchain-security) [v1.1.0](https://github.com/cosmos/interchain-security/releases/tag/v1.1.0) provider module. See the [release notes](https://github.com/cosmos/interchain-security/releases/tag/v1.1.0) for details. +* (feat) Add two more msg types `/ibc.core.channel.v1.MsgTimeout` and `/ibc.core.channel.v1.MsgTimeoutOnClose` to default `bypass-min-fee-msg-types`. +* (feat) Change the bypassing gas usage criteria. Instead of requiring 200,000 gas per `bypass-min-fee-msg`, we will now allow a maximum total usage of 1,000,000 gas for all bypassed messages in a transaction. Note that all messages in the transaction must be the `bypass-min-fee-msg-types` for the bypass min fee to take effect, otherwise, fee payment will still apply. +* (fix) [#2087](https://github.com/cosmos/gaia/issues/2087) Fix `bypass-min-fee-msg-types` parsing in `app.toml`. Parsing of `bypass-min-fee-types` is changed to allow node operators to use empty bypass list. Removing the `bypass-min-fee-types` from `app.toml` applies the default message types. See [#2092](https://github.com/cosmos/gaia/pull/2092) for details. + +## [v9.0.1] - 2023-03-09 + +* (feat) [Add spam prevention antehandler](https://github.com/cosmos/gaia/pull/2262) to alleviate recent governance spam issues. + +## [v9.0.0] - 2023-02-21 + +* (feat) Add [Interchain-Security](https://github.com/cosmos/interchain-security) [v1.0.0](https://github.com/cosmos/interchain-security/releases/tag/v1.0.0) provider module. See the [ICS Spec](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md) for more details. +* (gaia) Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.13-ics](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.13-ics). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/releases/tag/v0.45.13-ics) for details. +* (gaia) Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v4.2.0](https://github.com/cosmos/ibc-go/blob/release/v4.2.x/CHANGELOG.md). See [v4.2 Release Notes](https://github.com/cosmos/ibc-go/releases/tag/v4.2.0) for details. +* (gaia) Bump [tendermint](https://github.com/informalsystems/tendermint) to [0.34.26](https://github.com/informalsystems/tendermint/tree/v0.34.26). See [CHANGELOG.md](https://github.com/informalsystems/tendermint/blob/v0.34.26/CHANGELOG.md#v03426) for details. +* (gaia) Bump [packet-forward-middleware](https://github.com/strangelove-ventures/packet-forward-middleware) to [v4.0.4](https://github.com/strangelove-ventures/packet-forward-middleware/releases/tag/v4.0.4). +* (tests) Add [E2E ccv tests](https://github.com/cosmos/gaia/blob/main/tests/e2e/e2e_gov_test.go#L138). Tests covering new functionality introduced by the provider module to add and remove a consumer chain via governance proposal. +* (tests) Add [integration ccv tests](https://github.com/cosmos/gaia/blob/main/tests/ics/interchain_security_test.go). Imports Interchain-Security's `TestCCVTestSuite` and implements Gaia as the provider chain. +* (fix) [#2017](https://github.com/cosmos/gaia/issues/2017) Fix Gaiad binary build tag for ubuntu system. See [#2018](https://github.com/cosmos/gaia/pull/2018) for details. + +## [v8.0.1] - 2023-02-17 + +* (gaia) Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.14](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.14). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/release/v0.45.x/CHANGELOG.md) for details. +* (gaia) Bump [tendermint](https://github.com/informalsystems/tendermint) to [0.34.26](https://github.com/informalsystems/tendermint/tree/v0.34.26). See [CHANGELOG.md](https://github.com/informalsystems/tendermint/blob/v0.34.26/CHANGELOG.md) for details. + +## [v8.0.0] - 2023-01-31 + +* (gaia) Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v3.4.0](https://github.com/cosmos/ibc-go/blob/v3.4.0/CHANGELOG.md) to fix a vulnerability in ICA. See [v3.4.0 CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/v0.45.9/CHANGELOG.md) and [v3.2.1 Release Notes](https://github.com/cosmos/ibc-go/releases/tag/v3.2.1) for details. +* (gaia) Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.12](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.12). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/release/v0.45.x/CHANGELOG.md) for details. +* (gaia) Bump [tendermint](https://github.com/informalsystems/tendermint) to [0.34.24](https://github.com/informalsystems/tendermint/tree/v0.34.24). See [CHANGELOG.md](https://github.com/informalsystems/tendermint/blob/v0.34.24/CHANGELOG.md) for details. +* (gaia) Bump [liquidity](https://github.com/Gravity-Devs/liquidity) to [v1.5.3](https://github.com/Gravity-Devs/liquidity/releases/tag/v1.5.3). +* (gaia) Bump [packet-forward-middleware](https://github.com/strangelove-ventures/packet-forward-middleware) to [v3.1.1](https://github.com/strangelove-ventures/packet-forward-middleware/releases/tag/v3.1.1). +* (feat) Add [globalfee](https://github.com/cosmos/gaia/tree/main/x/globalfee) module. See [globalfee docs](https://github.com/cosmos/gaia/blob/main/docs/modules/globalfee.md) for more details. +* (feat) [#1845](https://github.com/cosmos/gaia/pull/1845) Add bech32-convert command to gaiad. +* (fix) [#2080](https://github.com/cosmos/gaia/issues/2074) Reintroduce deleted configuration for client rpc endpoints, transaction routes, and module REST routes in app.go. +* (fix) [Add new fee decorator](https://github.com/cosmos/gaia/pull/1961) to change `MaxBypassMinFeeMsgGasUsage` so importers of x/globalfee can change `MaxGas`. +* (fix) [#1870](https://github.com/cosmos/gaia/issues/1870) Fix bank denom metadata in migration. See [#1892](https://github.com/cosmos/gaia/pull/1892) for more details. +* (fix) [#1976](https://github.com/cosmos/gaia/pull/1976) Fix Quicksilver ICA exploit in migration. See [the bug fix forum post](https://forum.cosmos.network/t/upcoming-interchain-accounts-bugfix-release/8911) for more details. +* (tests) Add [E2E tests](https://github.com/cosmos/gaia/tree/main/tests/e2e). The tests cover transactions/queries tests of different modules, including Bank, Distribution, Encode, Evidence, FeeGrant, Global Fee, Gov, IBC, packet forwarding middleware, Slashing, Staking, and Vesting module. +* (tests) [#1941](https://github.com/cosmos/gaia/pull/1941) Fix packet forward configuration for e2e tests. +* (tests) Use gaiad to swap out [Ignite](https://github.com/ignite/cli) in [liveness tests](https://github.com/cosmos/gaia/blob/main/.github/workflows/test.yml). + +## [v7.1.1] - 2023-02-06 + +* (gaia) bump [tendermint](https://github.com/tendermint/tendermint) to [0.34.25](https://github.com/informalsystems/tendermint/releases/tag/v0.34.25) to patch p2p issue. See [CHANGELOG.md](https://github.com/informalsystems/tendermint/blob/v0.34.25/CHANGELOG.md#v03425) for details. + +## [v7.1.0] - 2022-10-14 +* (gaia) bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.9](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.9) to fix the security vulnerability! See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/v0.45.9/CHANGELOG.md) for details. + +## [v7.0.3] - 2022-08-03 +* (gaia) update go to 1.18. +* (gaia) bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.6](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.6). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/v0.45.6/CHANGELOG.md) for details. +* (gaia) bump [Liquidity](https://github.com/Gravity-Devs/liquidity) module to [v1.5.1](https://github.com/Gravity-Devs/liquidity/releases/tag/v1.5.1). +* (gaia) bump [cosmos ledger](https://github.com/cosmos/ledger-go) to [v0.9.3](https://github.com/cosmos/ledger-go/releases/tag/v0.9.3) to fix issue [#1573](https://github.com/cosmos/gaia/issues/1573) - Ledger Nano S Plus not detected by gaiad. +* +## [v7.0.2] -2022-05-09 + +* (gaia) bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.4). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/v0.45.4/CHANGELOG.md#v0454---2022-04-25) for details. +* (gaia) [#1447](https://github.com/cosmos/gaia/pull/1447) Support custom message types to bypass minimum fee checks for. + If a transaction contains only bypassed message types, the transaction will not have minimum fee + checks performed during `CheckTx`. Operators can supply these message types via the `bypass-min-fee-msg-types` + configuration in `app.toml`. Note, by default they include various IBC message types. + +## [v7.0.1] -2022-04-13 + +* (gaia) bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.3). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/v0.45.3/CHANGELOG.md#v0453---2022-04-12) for details. +* (gaia) bump [tendermint](https://github.com/tendermint/tendermint) to [0.34.19](https://github.com/tendermint/tendermint/tree/v0.34.19). See [CHANGELOG.md](https://github.com/tendermint/tendermint/blob/v0.34.19/CHANGELOG.md#v03419) for details. +* (gaia) bump [tm-db](https://github.com/tendermint/tm-db) to [v0.6.7](https://github.com/tendermint/tm-db/tree/v0.6.7). See [CHANGELOG.md](https://github.com/tendermint/tm-db/blob/v0.6.7/CHANGELOG.md#067) for details. + +## [v7.0.0] - 2022-03-24 + +* (gaia) bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.45.1](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.1). See [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/v0.45.1/CHANGELOG.md#v0451---2022-02-03) for details. +* (gaia) bump [ibc-go](https://github.com/cosmos/ibc-go) module to [v3.0.0](https://github.com/cosmos/ibc-go/releases/tag/v3.0.0). See [CHANGELOG.md](https://github.com/cosmos/ibc-go/blob/v3.0.0/CHANGELOG.md#v300---2022-03-15) for details. +* (gaia) add [interchain account](https://github.com/cosmos/ibc-go/tree/main/modules/apps/27-interchain-accounts) module (interhchain-account module is part of ibc-go module). +* (gaia) bump [liquidity](https://github.com/gravity-devs/liquidity) module to [v1.5.0](https://github.com/Gravity-Devs/liquidity/releases/tag/v1.5.0). See [CHANGELOG.md](https://github.com/Gravity-Devs/liquidity/blob/v1.5.0/CHANGELOG.md#v150---20220223) for details. +* (gaia) bump [packet-forward-middleware](https://github.com/strangelove-ventures/packet-forward-middleware) module to [v2.1.1](https://github.com/strangelove-ventures/packet-forward-middleware/releases/tag/v2.1.1). +* (gaia) add migration logs for upgrade process. + +## [v6.0.4] - 2022-03-10 + +* (gaia) Bump [Liquidity](https://github.com/gravity-devs/liquidity) module to [v1.4.6](https://github.com/Gravity-Devs/liquidity/releases/tag/v1.4.6). +* (gaia) Bump [IBC](https://github.com/cosmos/ibc-go) module to [2.0.3](https://github.com/cosmos/ibc-go/releases/tag/v2.0.3). +* (gaia) [#1230](https://github.com/cosmos/gaia/pull/1230) Fix: update gRPC Web Configuration in `contrib/testnets/test_platform`. +* (gaia) [#1135](https://github.com/cosmos/gaia/pull/1135) Fix rocksdb build tag usage. +* (gaia) [#1160](https://github.com/cosmos/gaia/pull/1160) Improvement: update state sync configs. +* (gaia) [#1208](https://github.com/cosmos/gaia/pull/1208) Update statesync.bash. + * * (gaia) Bump [Cosmos-SDK](https://github.com/cosmos/cosmos-sdk) to [v0.44.6](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.44.6) +* (gaia) Bump [Versions](https://github.com/cosmos/gaia/pull/1100) of various smaller dependencies, remove the Cosmos SDK replace statement, update `initiClientCtx` params, ensure `stdout` and `stderr` are handled correctly in the CLI. + +## [v6.0.3] - 2022-02-18 + +* This is a reverted release that is the same as v6.0.0 + +## [v6.0.2] - 2022-02-17 + +* Unusable release + +## [v6.0.1] - 2022-02-10 + +* Unusable release + +## [v6.0.0] - 2021-11-24 + +* (gaia) Add NewSetUpContextDecorator to anteDecorators +* (gaia) Reconfigure SetUpgradeHandler to ensure vesting is configured after auth and new modules have InitGenesis run. +* (golang) Bump golang prerequisite to 1.17. +* (gaia) Bump [Liquidity](https://github.com/gravity-devs/liquidity) module to [v1.4.2](https://github.com/Gravity-Devs/liquidity/releases/tag/v1.4.2). +* (gaia) Bump [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) to [v0.44.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.44.3). See the [CHANGELOG.md](https://github.com/cosmos/cosmos-sdk/blob/release/v0.44.x/CHANGELOG.md#v0443---2021-10-21) for details. +* (gaia) Add [IBC](https://github.com/cosmos/ibc-go) as a standalone module from the Cosmos SDK using version [v2.0.0](https://github.com/cosmos/ibc-go/releases/tag/v2.0.0). See the [CHANGELOG.md](https://github.com/cosmos/ibc-go/blob/v2.0.0/CHANGELOG.md) for details. +* (gaia) Add [packet-forward-middleware](https://github.com/strangelove-ventures/packet-forward-middleware) [v1.0.1](https://github.com/strangelove-ventures/packet-forward-middleware/releases/tag/v1.0.1). +* (gaia) [#969](https://github.com/cosmos/gaia/issues/969) Remove legacy migration code. + +## [v5.0.8] - 2021-10-14 + +* (gaia) This release includes a new AnteHandler that rejects redundant IBC transactions to save relayers fees. + +## [v5.0.7] - 2021-09-30 + +* (gaia) Bump Cosmos SDK to 0.42.10 + +## [v5.0.6] - 2021-09-16 + +* (gaia) Bump tendermint to 0.34.13 + +## [v5.0.5] - 2021-08-05 + +* (gaia) Bump SDK to [0.42.9](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.9) to resolve IBC channel restart issue ([9800](https://github.com/cosmos/cosmos-sdk/issues/9800)). + +## [v5.0.4] - 2021-07-31 + +* (chore) Fix release to include intended items from `v5.0.3`. + +## [v5.0.3] - 2021-07-30 + +* (gaia) Bump SDK to [0.42.8](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.8) to resolve tx query issues. +* (gaia) Bump SDK to [0.42.7](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.7) to resolve state sync issues. + +## [v5.0.2] - 2021-07-15 + +* (gaia) Fix misspelling in RELEASE.md +* (gaia) Add releases to .gitignore + +## [v5.0.1] - 2021-07-15 + +* (gaia) Configure gaiad command to add back `config` capabilities. + +## [v5.0.0] - 2021-06-28 + +* (golang) Bump golang prerequisite from 1.15 to 1.16. +* (gaia) Add [Liquidity](https://github.com/gravity-devs/liquidity) module [v1.2.9](https://github.com/Gravity-Devs/liquidity/releases/tag/v1.2.9). +* (sdk) Bump SDK version to [v0.42.6](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.6). +* (tendermint) Bump Tendermint version to [v0.34.11](https://github.com/tendermint/tendermint/releases/tag/v0.34.11). + +## [v4.2.1] - 2021-04-08 + +A critical security vulnerability was identified in Tendermint Core, which impacts Tendermint Lite Client. + +This release fixes the identified security vulnerability. + +### Bug Fixes + +* (sdk) Bump SDK version to [v0.42.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.4) +* (tendermint) Bump Tendermint version to [v0.34.9](https://github.com/tendermint/tendermint/releases/tag/v0.34.9). + +## [v4.2.0] - 2021-03-25 + +A critical security vulnerability has been identified in Gaia v4.1.x. +User funds are NOT at risk; however, the vulnerability can result in a chain halt. + +This release fixes the identified security vulnerability. + +If the chain halts before or during the upgrade, validators with sufficient voting power need to upgrade +and come online in order for the chain to resume. + +### Bug Fixes + +* (sdk) Bump SDK version to [v0.42.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.3) + +## [v4.1.2] - 2021-03-22 + +This release removes unnecessary dependencies. + +### Bug Fixes + +* (gaia) [\#781](https://github.com/cosmos/gaia/pull/781) Remove unnecessary dependencies + +## [v4.1.1] - 2021-03-19 + +This release bring improvements to keyring UX, tx search results, and multi-sig account migrations. +See the Cosmos SDK [release notes](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.2) for details. + +### Bug Fixes + +* (sdk) Bump SDK version to [v0.42.2](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.2) + +## [v4.1.0] - 2021-03-10 + +### Bug Fixes + +A critical security vulnerability has been identified in Gaia v4.0.x. +User funds are NOT at risk; however, the vulnerability can result in a chain halt. + +This release fixes the identified security vulnerability. + +If the chain halts before or during the upgrade, validators with sufficient voting power need to upgrade +and come online in order for the chain to resume. + +## [v4.0.6] - 2021-03-09 + +### Bug Fixes + +This release bumps the Cosmos SDK, which includes an important security fix for all non +Cosmos Hub chains (e.g. any chain that does not use the default cosmos bech32 prefix), +and a few performance improvements. The SDK also applies a security fix for validator +address conversion in evidence handling, and the full header is now emitted on an +IBC UpdateClient message event. + +* (sdk) Bump SDK version to [v0.42.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.0) + +## [v4.0.5] - 2021-03-02 + +### Bug Fixes + +* (tendermint) Bump Tendermint version to [v0.34.8](https://github.com/tendermint/tendermint/releases/tag/v0.34.8). +* (sdk) Bump SDK version to [v0.41.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.4), which reduces startup time with the cosmoshub-4 mainnet genesis without invariant checks. + +## [v4.0.4] - 2021-02-19 + +### Bug Fixes + +This release applies a patched version to grpc dependencies in order to resolve some queries; no explicit version bumps are included. + +## [v4.0.3] - 2021-02-18 + +### Bug Fixes + +This release fixes build failures caused by a small API breakage introduced in tendermint v0.34.7. + +* (sdk) Bump SDK version to [v0.41.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.3). + +## [v4.0.2] - 2021-02-18 + +### Bug Fixes + +This release fixes a downstream security issue which impacts Cosmos SDK users. +See the [Tendermint v0.34.7 SDK changelog](https://github.com/tendermint/tendermint/blob/v0.34.x/CHANGELOG.md#v0347) for details. + +* (sdk) [\#640](https://github.com/cosmos/gaia/pull/640) Bump SDK version to [v0.41.2](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.2). +* (tendermint) [\#640](https://github.com/cosmos/gaia/pull/640) Bump Tendermint version to [v0.34.7](https://github.com/tendermint/tendermint/releases/tag/v0.34.7). + +## [v4.0.1] - 2021-02-17 + +### Bug Fixes + +* (sdk) [\#579](https://github.com/cosmos/gaia/pull/635) Bump SDK version to [v0.41.1](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.1). +* (tendermint) [\#622](https://github.com/cosmos/gaia/pull/622) Bump Tendermint version to [v0.34.4](https://github.com/tendermint/tendermint/releases/tag/v0.34.4). + +## [v4.0.0] - 2021-01-26 + +### Improvements + +* (app) [\#564](https://github.com/cosmos/gaia/pull/564) Add client denomination metadata for atoms. + +### Bug Fixes + +* (cmd) [\#563](https://github.com/cosmos/gaia/pull/563) Add balance coin to supply when adding a new genesis account +* (sdk) [\#579](https://github.com/cosmos/gaia/pull/579) Bump SDK version to [v0.41.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.0). + +## [v3.0.1] - 2021-01-19 + +### Improvements + +* (protobuf) [\#553](https://github.com/cosmos/gaia/pull/553) Bump gogo protobuf deps to v1.3.3 +* (github) [\#543](https://github.com/cosmos/gaia/pull/543) Add docker deployment +* (starport) [\#535](https://github.com/cosmos/gaia/pull/535) Add config.yml +* (docker) [\#534](https://github.com/cosmos/gaia/pull/534) Update to python3 + +### Bug Fixes + +* (sdk) Bump SDK version to [v0.40.1](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.40.1). +* (tendermint) Bump Tendermint version to [v0.34.3](https://github.com/tendermint/tendermint/releases/tag/v0.34.3). +* (github) [\#544](https://github.com/cosmos/gaia/pull/544) Deploy from main not master +* (docs) [\#550](https://github.com/cosmos/gaia/pull/550) Bump vuepress-theme-cosmos to 1.0.180 +* (docker) [\#537](https://github.com/cosmos/gaia/pull/537) Fix single-node.sh setup script + +## [v3.0.0] - 2021-01-09 + +### Improvements + +* (sdk) Bump SDK version to [v0.40.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.40.0). +* (tendermint) Bump Tendermint version to [v0.34.1](https://github.com/tendermint/tendermint/releases/tag/v0.34.1). + +## [v2.0.14] - 2020-12-10 + +* (sdk) Bump SDK version to [v0.37.15](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.15). +* (tendermint) Bump Tendermint version to [v0.32.14](https://github.com/tendermint/tendermint/releases/tag/v0.32.14). + +## [v2.0.13] - 2020-08-13 + +* (sdk) Bump SDK version to [v0.37.14](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.14). + +## [v2.0.12] - 2020-08-13 + +* This version did not contain the update to [v0.37.14](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.14). Please use v2.0.13 + +## [v2.0.11] - 2020-05-06 + +* (sdk) Bump SDK version to [v0.37.13](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.13). + +## [v2.0.10] - 2020-05-06 + +* (sdk) Bump SDK version to [v0.37.12](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.12). + +## [v2.0.9] - 2020-04-23 + +* (sdk) Bump SDK version to [v0.37.11](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.11). + +## [v2.0.8] - 2020-04-09 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.9](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.9). + +## [v2.0.7] - 2020-03-11 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.8](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.8). + +## [v2.0.6] - 2020-02-10 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.7](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.7). + +## [v2.0.5] - 2020-01-21 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.6](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.6). +* (tendermint) Bump Tendermint version to [v0.32.9](https://github.com/tendermint/tendermint/releases/tag/v0.32.9). + +## [v2.0.4] - 2020-01-09 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.5](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.5). +* (tendermint) Bump Tendermint version to [v0.32.8](https://github.com/tendermint/tendermint/releases/tag/v0.32.8). + +### Bug Fixes + +* (cli) Fixed `gaiacli query txs` to use `events` instead of `tags`. Events take the form of `'{eventType}.{eventAttribute}={value}'`. Please + see the [events doc](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/events.md#events-1) + for further documentation. + +## [v2.0.3] - 2019-11-04 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.4). +* (tendermint) Bump Tendermint version to [v0.32.7](https://github.com/tendermint/tendermint/releases/tag/v0.32.7). + +## [v2.0.2] - 2019-10-12 + +### Improvements + +* (sdk) Bump SDK version to [v0.37.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.37.3). +* (tendermint) Bump Tendermint version to [v0.32.6](https://github.com/tendermint/tendermint/releases/tag/v0.32.6). + +## [v2.0.1] - 2019-09-20 + +### Features + +* (gaiad) [\#119](https://github.com/cosmos/gaia/pull/119) Add support for the `--halt-time` CLI flag and configuration. + +### Improvements + +* [\#119](https://github.com/cosmos/gaia/pull/119) Refactor and upgrade Circle CI + configuration. +* (sdk) Update SDK version to v0.37.1 + +## [v2.0.0] - 2019-08-22 + +### Bug Fixes + +* [\#104](https://github.com/cosmos/gaia/issues/104) Fix `ModuleAccountAddrs` to + not rely on the `x/supply` keeper to get module account addresses for blacklisting. + +### Breaking Changes + +* (sdk) Update SDK version to v0.37.0 + +## [v1.0.0] - 2019-08-13 + +### Bug Fixes + +* (gaiad) [\#4113](https://github.com/cosmos/cosmos-sdk/issues/4113) Fix incorrect `$GOBIN` in `Install Go` +* (gaiacli) [\#3945](https://github.com/cosmos/cosmos-sdk/issues/3945) There's no check for chain-id in TxBuilder.SignStdTx +* (gaiacli) [\#4190](https://github.com/cosmos/cosmos-sdk/issues/4190) Fix redelegations-from by using the correct params and query endpoint. +* (gaiacli) [\#4219](https://github.com/cosmos/cosmos-sdk/issues/4219) Return an error when an empty mnemonic is provided during key recovery. +* (gaiacli) [\#4345](https://github.com/cosmos/cosmos-sdk/issues/4345) Improved Ledger Nano X detection + +### Breaking Changes + +* (sdk) Update SDK version to v0.36.0 +* (gaiad) [\#3985](https://github.com/cosmos/cosmos-sdk/issues/3985) ValidatorPowerRank uses potential consensus power +* (gaiad) [\#4027](https://github.com/cosmos/cosmos-sdk/issues/4027) gaiad version command does not return the checksum of the go.sum file shipped along with the source release tarball. + Go modules feature guarantees dependencies reproducibility and as long as binaries are built via the Makefile shipped with the sources, no dependendencies can break such guarantee. +* (gaiad) [\#4159](https://github.com/cosmos/cosmos-sdk/issues/4159) use module pattern and module manager for initialization +* (gaiad) [\#4272](https://github.com/cosmos/cosmos-sdk/issues/4272) Merge gaiareplay functionality into gaiad replay. + Drop `gaiareplay` in favor of new `gaiad replay` command. +* (gaiacli) [\#3715](https://github.com/cosmos/cosmos-sdk/issues/3715) query distr rewards returns per-validator + rewards along with rewards total amount. +* (gaiacli) [\#40](https://github.com/cosmos/cosmos-sdk/issues/40) rest-server's --cors option is now gone. +* (gaiacli) [\#4027](https://github.com/cosmos/cosmos-sdk/issues/4027) gaiacli version command dooes not return the checksum of the go.sum file anymore. +* (gaiacli) [\#4142](https://github.com/cosmos/cosmos-sdk/issues/4142) Turn gaiacli tx send's --from into a required argument. + New shorter syntax: `gaiacli tx send FROM TO AMOUNT` +* (gaiacli) [\#4228](https://github.com/cosmos/cosmos-sdk/issues/4228) Merge gaiakeyutil functionality into gaiacli keys. + Drop `gaiakeyutil` in favor of new `gaiacli keys parse` command. Syntax and semantic are preserved. +* (rest) [\#3715](https://github.com/cosmos/cosmos-sdk/issues/3715) Update /distribution/delegators/{delegatorAddr}/rewards GET endpoint + as per new specs. For a given delegation, the endpoint now returns the + comprehensive list of validator-reward tuples along with the grand total. +* (rest) [\#3942](https://github.com/cosmos/cosmos-sdk/issues/3942) Update pagination data in txs query. +* (rest) [\#4049](https://github.com/cosmos/cosmos-sdk/issues/4049) update tag MsgWithdrawValidatorCommission to match type +* (rest) The `/auth/accounts/{address}` now returns a `height` in the response. The + account is now nested under `account`. + +### Features + +* (gaiad) Add `migrate` command to `gaiad` to provide the ability to migrate exported + genesis state from one version to another. +* (gaiad) Update Gaia for community pool spend proposals per Cosmos Hub governance proposal [\#7](https://github.com/cosmos/cosmos-sdk/issues/7) "Activate the Community Pool" + +### Improvements + +* (gaiad) [\#4042](https://github.com/cosmos/cosmos-sdk/issues/4042) Update docs and scripts to include the correct `GO111MODULE=on` environment variable. +* (gaiad) [\#4066](https://github.com/cosmos/cosmos-sdk/issues/4066) Fix 'ExportGenesisFile() incorrectly overwrites genesis' +* (gaiad) [\#4064](https://github.com/cosmos/cosmos-sdk/issues/4064) Remove `dep` and `vendor` from `doc` and `version`. +* (gaiad) [\#4080](https://github.com/cosmos/cosmos-sdk/issues/4080) add missing invariants during simulations +* (gaiad) [\#4343](https://github.com/cosmos/cosmos-sdk/issues/4343) Upgrade toolchain to Go 1.12.5. +* (gaiacli) [\#4068](https://github.com/cosmos/cosmos-sdk/issues/4068) Remove redundant account check on `gaiacli` +* (gaiacli) [\#4227](https://github.com/cosmos/cosmos-sdk/issues/4227) Support for Ledger App v1.5 +* (rest) [\#2007](https://github.com/cosmos/cosmos-sdk/issues/2007) Return 200 status code on empty results +* (rest) [\#4123](https://github.com/cosmos/cosmos-sdk/issues/4123) Fix typo, url error and outdated command description of doc clients. +* (rest) [\#4129](https://github.com/cosmos/cosmos-sdk/issues/4129) Translate doc clients to chinese. +* (rest) [\#4141](https://github.com/cosmos/cosmos-sdk/issues/4141) Fix /txs/encode endpoint + + + +[v10.0.1]: https://github.com/cosmos/gaia/releases/tag/v10.0.1 +[v10.0.0]: https://github.com/cosmos/gaia/releases/tag/v10.0.0 +[v9.1.1]: https://github.com/cosmos/gaia/releases/tag/v9.1.1 +[v9.1.0]: https://github.com/cosmos/gaia/releases/tag/v9.1.0 +[v9.0.3]: https://github.com/cosmos/gaia/releases/tag/v9.0.3 +[v9.0.2]: https://github.com/cosmos/gaia/releases/tag/v9.0.2 +[v9.0.1]: https://github.com/cosmos/gaia/releases/tag/v9.0.1 +[v9.0.0]: https://github.com/cosmos/gaia/releases/tag/v9.0.0 +[v8.0.1]: https://github.com/cosmos/gaia/releases/tag/v8.0.1 +[v8.0.0]: https://github.com/cosmos/gaia/releases/tag/v8.0.0 +[v7.1.1]: https://github.com/cosmos/gaia/releases/tag/v7.1.1 +[v7.1.0]: https://github.com/cosmos/gaia/releases/tag/v7.1.0 +[v7.0.3]: https://github.com/cosmos/gaia/releases/tag/v7.0.3 +[v7.0.2]: https://github.com/cosmos/gaia/releases/tag/v7.0.2 +[v7.0.1]: https://github.com/cosmos/gaia/releases/tag/v7.0.1 +[v7.0.0]: https://github.com/cosmos/gaia/releases/tag/v7.0.0 +[v6.0.4]: https://github.com/cosmos/gaia/releases/tag/v6.0.4 +[v6.0.3]: https://github.com/cosmos/gaia/releases/tag/v6.0.3 +[v6.0.2]: https://github.com/cosmos/gaia/releases/tag/v6.0.2 +[v6.0.1]: https://github.com/cosmos/gaia/releases/tag/v6.0.1 +[v6.0.0]: https://github.com/cosmos/gaia/releases/tag/v6.0.0 +[v5.0.8]: https://github.com/cosmos/gaia/releases/tag/v5.0.8 +[v5.0.7]: https://github.com/cosmos/gaia/releases/tag/v5.0.7 +[v5.0.6]: https://github.com/cosmos/gaia/releases/tag/v5.0.6 +[v5.0.5]: https://github.com/cosmos/gaia/releases/tag/v5.0.5 +[v5.0.4]: https://github.com/cosmos/gaia/releases/tag/v5.0.4 +[v5.0.3]: https://github.com/cosmos/gaia/releases/tag/v5.0.3 +[v5.0.2]: https://github.com/cosmos/gaia/releases/tag/v5.0.2 +[v5.0.1]: https://github.com/cosmos/gaia/releases/tag/v5.0.1 +[v5.0.0]: https://github.com/cosmos/gaia/releases/tag/v5.0.0 +[v4.2.1]: https://github.com/cosmos/gaia/releases/tag/v4.2.1 +[v4.2.0]: https://github.com/cosmos/gaia/releases/tag/v4.2.0 +[v4.1.2]: https://github.com/cosmos/gaia/releases/tag/v4.1.2 +[v4.1.1]: https://github.com/cosmos/gaia/releases/tag/v4.1.1 +[v4.1.0]: https://github.com/cosmos/gaia/releases/tag/v4.1.0 +[v4.0.6]: https://github.com/cosmos/gaia/releases/tag/v4.0.6 +[v4.0.5]: https://github.com/cosmos/gaia/releases/tag/v4.0.5 +[v4.0.4]: https://github.com/cosmos/gaia/releases/tag/v4.0.4 +[v4.0.3]: https://github.com/cosmos/gaia/releases/tag/v4.0.3 +[v4.0.2]: https://github.com/cosmos/gaia/releases/tag/v4.0.2 +[v4.0.1]: https://github.com/cosmos/gaia/releases/tag/v4.0.1 +[v4.0.0]: https://github.com/cosmos/gaia/releases/tag/v4.0.0 +[v3.0.1]: https://github.com/cosmos/gaia/releases/tag/v3.0.1 +[v3.0.0]: https://github.com/cosmos/gaia/releases/tag/v3.0.0 +[v2.0.14]: https://github.com/cosmos/gaia/releases/tag/v2.0.14 +[v2.0.13]: https://github.com/cosmos/gaia/releases/tag/v2.0.13 +[v2.0.12]: https://github.com/cosmos/gaia/releases/tag/v2.0.12 +[v2.0.11]: https://github.com/cosmos/gaia/releases/tag/v2.0.11 +[v2.0.10]: https://github.com/cosmos/gaia/releases/tag/v2.0.10 +[v2.0.9]: https://github.com/cosmos/gaia/releases/tag/v2.0.9 +[v2.0.8]: https://github.com/cosmos/gaia/releases/tag/v2.0.8 +[v2.0.7]: https://github.com/cosmos/gaia/releases/tag/v2.0.7 +[v2.0.6]: https://github.com/cosmos/gaia/releases/tag/v2.0.6 +[v2.0.5]: https://github.com/cosmos/gaia/releases/tag/v2.0.5 +[v2.0.4]: https://github.com/cosmos/gaia/releases/tag/v2.0.4 +[v2.0.3]: https://github.com/cosmos/gaia/releases/tag/v2.0.3 +[v2.0.2]: https://github.com/cosmos/gaia/releases/tag/v2.0.2 +[v2.0.1]: https://github.com/cosmos/gaia/releases/tag/v2.0.1 +[v2.0.0]: https://github.com/cosmos/gaia/releases/tag/v2.0.0 +[v1.0.0]: https://github.com/cosmos/gaia/releases/tag/v1.0.0 \ No newline at end of file diff --git a/.changelog/unreleased/.gitkeep b/.changelog/unreleased/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/.changelog/unreleased/api-breaking/globalfee/2424-params.md b/.changelog/unreleased/api-breaking/globalfee/2424-params.md new file mode 100644 index 00000000000..99a978eed59 --- /dev/null +++ b/.changelog/unreleased/api-breaking/globalfee/2424-params.md @@ -0,0 +1,2 @@ +- Add `bypass-min-fee-msg-types` and `maxTotalBypassMinFeeMsgGagUsage` to + globalfee params ([\#2424](https://github.com/cosmos/gaia/pull/2424)) \ No newline at end of file diff --git a/.changelog/unreleased/dependencies/2554-bump-ibc.md b/.changelog/unreleased/dependencies/2554-bump-ibc.md new file mode 100644 index 00000000000..62c59cfb087 --- /dev/null +++ b/.changelog/unreleased/dependencies/2554-bump-ibc.md @@ -0,0 +1,3 @@ +- Bump [ibc-go](https://github.com/cosmos/ibc-go) to + [v4.4.2](https://github.com/cosmos/ibc-go/releases/tag/v4.4.2) + ([\#2554](https://github.com/cosmos/gaia/pull/2554)) \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/globalfee/2352-migration.md b/.changelog/unreleased/state-breaking/globalfee/2352-migration.md new file mode 100644 index 00000000000..976a9fe659b --- /dev/null +++ b/.changelog/unreleased/state-breaking/globalfee/2352-migration.md @@ -0,0 +1,3 @@ +- Create the upgrade handler and params migration for the new Gloabal Fee module + parameters introduced in [#2424](https://github.com/cosmos/gaia/pull/2424) + ([\#2352](https://github.com/cosmos/gaia/pull/2352)) \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/globalfee/2424-params.md b/.changelog/unreleased/state-breaking/globalfee/2424-params.md new file mode 100644 index 00000000000..99a978eed59 --- /dev/null +++ b/.changelog/unreleased/state-breaking/globalfee/2424-params.md @@ -0,0 +1,2 @@ +- Add `bypass-min-fee-msg-types` and `maxTotalBypassMinFeeMsgGagUsage` to + globalfee params ([\#2424](https://github.com/cosmos/gaia/pull/2424)) \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/globalfee/2447-delivertx.md b/.changelog/unreleased/state-breaking/globalfee/2447-delivertx.md new file mode 100644 index 00000000000..8b2210c916e --- /dev/null +++ b/.changelog/unreleased/state-breaking/globalfee/2447-delivertx.md @@ -0,0 +1,2 @@ +- Update Global Fee's AnteHandler to check tx fees against the network min gas + prices in DeliverTx mode ([\#2447](https://github.com/cosmos/gaia/pull/2447)) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/production.md b/.github/PULL_REQUEST_TEMPLATE/production.md index 572206b232e..79b5534fb21 100644 --- a/.github/PULL_REQUEST_TEMPLATE/production.md +++ b/.github/PULL_REQUEST_TEMPLATE/production.md @@ -1,5 +1,5 @@ ## Description @@ -26,7 +26,7 @@ I have... * [ ] Provided a link to the relevant issue or specification * [ ] Followed the guidelines for [building SDK modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules) * [ ] Included the necessary unit and integration [tests](https://github.com/cosmos/gaia/blob/main/CONTRIBUTING.md#testing) -* [ ] Added a changelog entry to `CHANGELOG.md` +* [ ] Added a changelog entry in `.changelog` (for details, see [contributing guidelines](../../CONTRIBUTING.md#changelog)) * [ ] Included comments for [documenting Go code](https://blog.golang.org/godoc) * [ ] Updated the relevant documentation or specification * [ ] Reviewed "Files changed" and left comments if necessary diff --git a/CHANGELOG.md b/CHANGELOG.md index 546e05ab6da..2a5a290b46d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,55 +1,29 @@ - - -# Changelog - -## [Unreleased] - -* (docs) [#2599](https://github.com/cosmos/gaia/pull/2599) Updating the quickstart, joining mainnet & upgrade docs for v10 -* (docs) [#2560](https://github.com/cosmos/gaia/pull/2560) Updates for v9.1.1 and re-arranging roadmap docs -* (deps) [#2554](https://github.com/cosmos/gaia/pull/2554) Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v4.4.2](https://github.com/cosmos/ibc-go/releases/tag/v4.4.2). - -### Improvements -* (test) [#2440](https://github.com/cosmos/gaia/pull/2440) Add vulncheck to nightly builds -* (gaia) [#2442](https://github.com/cosmos/gaia/pull/2442) Bump [Interchain-Security](https://github.com/cosmos/interchain-security) to [v1.1.1](https://github.com/cosmos/interchain-security/tree/v1.1.1). - -### State Machine Breaking - -* (feat!) [#2424](https://github.com/cosmos/gaia/pull/2424) Add `bypass-min-fee-msg-types` and `maxTotalBypassMinFeeMsgGagUsage` to globalfee params. Note that this change is both state breaking and API breaking. The previous API endpoint was "/gaia/globalfee/v1beta1/minimum_gas_prices," and the new API endpoint is "/gaia/globalfee/v1beta1/params." -* (feat!) [#2352](https://github.com/cosmos/gaia/pull/2352) Create the upgrade handler and params migration for the new Gloabal Fee module parameters introduced in [#2424](https://github.com/cosmos/gaia/pull/2424). -Update the CI upgrade tests from v9 to the v10 and check that the parameters are successfully migrated. -* (feat!) [#2447](https://github.com/cosmos/gaia/pull/2447) Update Global Fee's AnteHandler to check tx fees against the network min gas prices in DeliverTx mode. +- [GlobalFee](x/globalfee) + - Create the upgrade handler and params migration for the new Gloabal Fee module + parameters introduced in [#2424](https://github.com/cosmos/gaia/pull/2424) + ([\#2352](https://github.com/cosmos/gaia/pull/2352)) + - Add `bypass-min-fee-msg-types` and `maxTotalBypassMinFeeMsgGagUsage` to + globalfee params ([\#2424](https://github.com/cosmos/gaia/pull/2424)) + - Update Global Fee's AnteHandler to check tx fees against the network min gas + prices in DeliverTx mode ([\#2447](https://github.com/cosmos/gaia/pull/2447)) ## [v10.0.1] 2023-05-25 @@ -550,6 +524,7 @@ See the [Tendermint v0.34.7 SDK changelog](https://github.com/tendermint/tenderm +[v10.0.1]: https://github.com/cosmos/gaia/releases/tag/v10.0.1 [v10.0.0]: https://github.com/cosmos/gaia/releases/tag/v10.0.0 [v9.1.1]: https://github.com/cosmos/gaia/releases/tag/v9.1.1 [v9.1.0]: https://github.com/cosmos/gaia/releases/tag/v9.1.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fece5389fdf..b17ad3bca62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,7 @@ - [Pull Request Templates](#pull-request-templates) - [Requesting Reviews](#requesting-reviews) - [Updating Documentation](#updating-documentation) + - [Changelog](#changelog) - [Dependencies](#dependencies) - [Protobuf](#protobuf) - [Branching Model and Release](#branching-model-and-release) @@ -173,7 +174,6 @@ Then: Draft PRs also help the stewarding team provide early feedback and ensure the work is in the right direction. 2. When the code is complete, change your PR from `Draft` to `Ready for Review`. 3. Go through the actions for each checkbox present in the PR template description. The PR actions are automatically provided for each new PR. -4. Be sure to include a relevant changelog entry in the `Unreleased` section of `CHANGELOG.md` (see file for log format). The entry should be on top of all others changes in the section. PRs must have a category prefix that is based on the type of changes being made (for example, `fix`, `feat`, `refactor`, `docs`, and so on). The [type](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) @@ -190,7 +190,7 @@ Pull requests are merged automatically using [`A:automerge` action](https://merg There are three PR templates. The [default template](./.github/PULL_REQUEST_TEMPLATE.md) contains links to the three templates. Please go the the `Preview` tab and select the appropriate sub-template: -- The [production template](./.github/PULL_REQUEST_TEMPLATE/production.md) is for types `fix`, `feat`, and `refactor`. +- The [production template](./.github/PULL_REQUEST_TEMPLATE/production.md) is for types `fix`, `feat`, `deps`, and `refactor`. - The [docs template](./.github/PULL_REQUEST_TEMPLATE/docs.md) is for documentation changes. - The [other template](./.github/PULL_REQUEST_TEMPLATE/other.md) is for changes that do not affect production code. @@ -224,6 +224,58 @@ items. In addition, use the following review explanations: If you open a PR in Gaia, it is mandatory to update the relevant documentation in `/docs`. +### Changelog + +To manage and generate our changelog, we currently use [unclog](https://github.com/informalsystems/unclog). + +Every PR with types `fix`, `feat`, `deps`, and `refactor` should include a file +`.changelog/unreleased/${section}/[${component}/]${pr-number}-${short-description}.md`, +where: + +- `section` is one of + `dependencies`, `improvements`, `features`, `bug-fixes`, `state-breaking`, `api-breaking`, + and _**if multiple apply, create multiple files**_; +- `pr-number` is the PR number; +- `short-description` is a short (4 to 6 word), hyphen separated description of the change; +- `component` is used for changes that affect one of the components defined in the [config](.changelog/config.toml), e.g., `tests`, `globalfee`. + +For examples, see the [.changelog](.changelog) folder. + +Use `unclog` to add a changelog entry in `.changelog` (check the [requirements](https://github.com/informalsystems/unclog#requirements) first): +```bash +# add a general entry +unclog add + -i "${pr-number}-${short-description}" + -p "${pr-number}" + -s "${section}" + -m "${description}" + +# add a entry to a component +unclog add + -i "${pr-number}-${short-description}" + -p "${pr-number}" + -c "${component}" + -s "${section}" + -m "${description}" +``` +where `${description}` is a detailed description of the changelog entry. + +For example, +```bash +# add an entry for bumping IBC to v4.4.2 +unclog add -i "2554-bump-ibc" -p 2554 -s "dependencies" -m "Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v4.4.2](https://github.com/cosmos/ibc-go/releases/tag/v4.4.2)" + +# add an entry for changing the global fee module; +# note that the entry is added to both state-breaking and api-breaking sections +unclog add -i "2424-params" -p 2424 -c globalfee -s "state-breaking" -m "Add \`bypass-min-fee-msg-types\` and \`maxTotalBypassMinFeeMsgGagUsage\` to globalfee params" +unclog add -i "2424-params" -p 2424 -c globalfee -s "api-breaking" -m "Add \`bypass-min-fee-msg-types\` and \`maxTotalBypassMinFeeMsgGagUsage\` to globalfee params" +``` + +**Note:** Changelog entries should answer the question: "what is important about this +change for users to know?" or "what problem does this solve for users?". It +should not simply be a reiteration of the title of the associated PR, unless the +title of the PR _very_ clearly explains the benefit of a change to a user. + ## Dependencies We use [Go Modules](https://github.com/golang/go/wiki/Modules) to manage