Skip to content

Commit

Permalink
docs: prepare v3.2.0 (cosmos#1446)
Browse files Browse the repository at this point in the history
* cleanup changelog.md

* docs: adopt unclog for updating the changelog (cosmos#1410)

* adding .changelog entries up to v3.2.x

* clean CHANGELOG.md

* add provider-side throttling chagelog entry

* add jail throttling as state-breaking change

* add v3.2.0 to changlog.md

* update release notes

* cherry-pick changelog entry for cosmos#1280
  • Loading branch information
mpoke authored Nov 24, 2023
1 parent 34f43a0 commit 57e992b
Show file tree
Hide file tree
Showing 34 changed files with 219 additions and 213 deletions.
21 changes: 21 additions & 0 deletions .changelog/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
project_url = "https://github.com/cosmos/interchain-security"

# 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]
provider = { name = "Provider", path = "x/ccv/provider" }
consumer = { name = "Consumer", path = "x/ccv/consumer" }
tests = { name = "Tests", path = "tests" }
docs = { name = "Documentation", path = "docs/docs" }
28 changes: 28 additions & 0 deletions .changelog/epilogue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## v3.1.0

Date July 11th, 2023

A minor upgrade to v3.0.0, which removes the panic in the consumer ccv module which would occur in an emergency scenario where the ccv channel is closed. This release also fixes how a distribution related event is emitted, and bumps cometbft.

* (feat) [#1127](https://github.com/cosmos/interchain-security/pull/1127) Remove consumer panic when ccv channel is closed
* (fix) [#720](https://github.com/cosmos/interchain-security/issues/720) Fix the attribute `AttributeDistributionTotal` value in `FeeDistribution` event emit.
* (deps) [#1119](https://github.com/cosmos/interchain-security/pull/1119) bump cometbft from `v0.37.1` to `0.37.2`.

## v3.0.0

Date: June 21st, 2023

Interchain Security v3 uses SDK 0.47 and IBC 7.

* (fix) [#1093](https://github.com/cosmos/interchain-security/pull/1093) Make SlashPacketData backward compatible when sending data over the wire
* (deps) [#1019](https://github.com/cosmos/interchain-security/pull/1019) Bump multiple dependencies.
* Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to [v0.47.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.3).
* Bump [ibc-go](https://github.com/cosmos/ibc-go) to [v7.1.0](https://github.com/cosmos/ibc-go/releases/tag/v7.1.0).
* Bump [CometBFT](https://github.com/cometbft/cometbft) to [v0.37.1](https://github.com/cometbft/cometbft/releases/tag/v0.37.1).
* `[x/ccv/provider]` (fix) [#945](https://github.com/cosmos/interchain-security/issues/945) Refactor `AfterUnbondingInitiated` to not panic when `PutUnbondingOnHold` returns error.
* `[x/ccv/provider]` (fix) [#977](https://github.com/cosmos/interchain-security/pull/977) Avoids panicking the provider when an unbonding delegation was removed through a `CancelUnbondingDelegation` message.
* `[x/ccv/democracy]` (feat) [#1019](https://github.com/cosmos/interchain-security/pull/1019) Whitelisting non-legacy params in the "democracy module" require the entire module to be whitelisted.

## Previous Versions

[CHANGELOG of previous versions](https://github.com/cosmos/interchain-security/blob/main/CHANGELOG.md)
Empty file added .changelog/unreleased/.gitkeep
Empty file.
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/bug-fixes/consumer/1146-pending-packets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Fix deletion of pending packets that may cause duplicate sends
([\#1146](https://github.com/cosmos/interchain-security/pull/1146))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Remove `idx` field from the `ccv.ConsumerPacketData` type as this would break the
wire ([\#1150](https://github.com/cosmos/interchain-security/pull/1150))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Validate token transfer messages before calling `Transfer()`.
([\#1244](https://github.com/cosmos/interchain-security/pull/1244))
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/bug-fixes/consumer/1262-fee-pool-addr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Remove incorrect address validation on `ProviderFeePoolAddrStr` param.
([\#1262](https://github.com/cosmos/interchain-security/pull/1262))
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/bug-fixes/consumer/1295-migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Increment consumer consensus version and register consumer migration.
([\#1295](https://github.com/cosmos/interchain-security/pull/1295))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/dependencies/1196-bump-ibc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.2.0](https://github.com/cosmos/ibc-go/releases/tag/v7.2.0).
([\#1196](https://github.com/cosmos/interchain-security/pull/1196))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/dependencies/1258-bump-ibc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.3.0](https://github.com/cosmos/ibc-go/releases/tag/v7.3.0).
([\#1258](https://github.com/cosmos/interchain-security/pull/1258))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/dependencies/1258-bump-sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to
[v0.47.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.4).
([\#1258](https://github.com/cosmos/interchain-security/pull/1258))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/dependencies/1259-bump-sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to
[v0.47.5](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.5).
([\#1259](https://github.com/cosmos/interchain-security/pull/1259))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Add the consumer-side changes for jail throttling with retries (cf. ADR 008).
([\#1024](https://github.com/cosmos/interchain-security/pull/1024))
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- Introduce the gRPC query `/interchain_security/ccv/consumer/provider-
info` and CLI command `interchain-security-cd q ccvconsumer
provider-info` to retrieve provider info from the consumer chain.
([\#1164](https://github.com/cosmos/interchain-security/pull/1164))
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/features/provider/1076-export-timestamps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Add `InitTimeoutTimestamps` and `ExportedVscSendTimestamps` to exported
genesis. ([\#1076](https://github.com/cosmos/interchain-security/pull/1076))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/features/provider/1280-reward-denoms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Add a governance proposal for setting on the provider the denominations for
rewards from consumer chains.
([\#1280](https://github.com/cosmos/interchain-security/pull/1280))
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/improvements/1244-consumer-unbonding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Update the default consumer unbonding period to 2 weeks.
([\#1244](https://github.com/cosmos/interchain-security/pull/1244))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Optimize pending packets storage on consumer, with migration.
([\#1037](https://github.com/cosmos/interchain-security/pull/1037))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/state-breaking/1196-bump-ibc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.2.0](https://github.com/cosmos/ibc-go/releases/tag/v7.2.0).
([\#1196](https://github.com/cosmos/interchain-security/pull/1196))
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/state-breaking/1244-consumer-unbonding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Update the default consumer unbonding period to 2 weeks.
([\#1244](https://github.com/cosmos/interchain-security/pull/1244))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/state-breaking/1258-bump-ibc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.3.0](https://github.com/cosmos/ibc-go/releases/tag/v7.3.0).
([\#1258](https://github.com/cosmos/interchain-security/pull/1258))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/state-breaking/1258-bump-sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to
[v0.47.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.4).
([\#1258](https://github.com/cosmos/interchain-security/pull/1258))
3 changes: 3 additions & 0 deletions .changelog/v3.2.0/state-breaking/1259-bump-sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to
[v0.47.5](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.5).
([\#1259](https://github.com/cosmos/interchain-security/pull/1259))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Add the consumer-side changes for jail throttling with retries (cf. ADR 008).
([\#1024](https://github.com/cosmos/interchain-security/pull/1024))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Optimize pending packets storage on consumer, with migration.
([\#1037](https://github.com/cosmos/interchain-security/pull/1037))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Fix deletion of pending packets that may cause duplicate sends
([\#1146](https://github.com/cosmos/interchain-security/pull/1146))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Remove `idx` field from the `ccv.ConsumerPacketData` type as this would break the
wire ([\#1150](https://github.com/cosmos/interchain-security/pull/1150))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Validate token transfer messages before calling `Transfer()`.
([\#1244](https://github.com/cosmos/interchain-security/pull/1244))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Remove incorrect address validation on `ProviderFeePoolAddrStr` param.
([\#1262](https://github.com/cosmos/interchain-security/pull/1262))
2 changes: 2 additions & 0 deletions .changelog/v3.2.0/state-breaking/consumer/1295-migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Increment consumer consensus version and register consumer migration.
([\#1295](https://github.com/cosmos/interchain-security/pull/1295))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Add a governance proposal for setting on the provider the denominations for
rewards from consumer chains.
([\#1280](https://github.com/cosmos/interchain-security/pull/1280))
1 change: 1 addition & 0 deletions .changelog/v3.2.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*November 24, 2023*
Loading

0 comments on commit 57e992b

Please sign in to comment.