Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add v3.3.0 changelog entries #1468

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file.

This file was deleted.

This file was deleted.

mpoke marked this conversation as resolved.
Show resolved Hide resolved
File renamed without changes.
17 changes: 17 additions & 0 deletions .changelog/v3.3.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*December 4th, 2023*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The date is enough for a summary. Info on the release should go in the release notes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the release highlights, I can remove them but they do no harm.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just want to keep things simple and have release highlights in the release notes, while the changelog contains a list of relevant changes. Not that important though


This release is state and api breaking.

Notable features of this release:
* Cryptohraphic-equivocation feature added to provider in [\#1340](https://github.com/cosmos/interchain-security/pull/1340) moves ICS towards untrusted consumers.
* Key assignment upgrades [\#1339](https://github.com/cosmos/interchain-security/pull/1339)
* Additional message validation and constraints for the core protocol [\#1460](https://github.com/cosmos/interchain-security/pull/1460)
* ICS quint model added [\#1336](https://github.com/cosmos/interchain-security/pull/1336)
* Upgrades to consumer genesis procedure [\#1324](https://github.com/cosmos/interchain-security/pull/1324)
This PR extends the consumer command with a `transform` subcommand that transform genesis outputs from provider on v1/2/3 into output that can be used by consumer on `>=v3.3.0`

```shell
# Example:
$ interchain-security-cd transform /path/to/ccv_consumer_genesis.json
```

84 changes: 84 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,89 @@
# CHANGELOG

## v3.3.0

*December 4th, 2023*

This release is state and api breaking.

Notable features of this release:
* Cryptohraphic-equivocation feature added to provider in [\#1340](https://github.com/cosmos/interchain-security/pull/1340) moves ICS towards untrusted consumers.
* Key assignment upgrades [\#1339](https://github.com/cosmos/interchain-security/pull/1339)
* Additional message validation and constraints for the core protocol [\#1460](https://github.com/cosmos/interchain-security/pull/1460)
* ICS quint model added [\#1336](https://github.com/cosmos/interchain-security/pull/1336)
* Upgrades to consumer genesis procedure [\#1324](https://github.com/cosmos/interchain-security/pull/1324)
This PR extends the consumer command with a `transform` subcommand that transform genesis outputs from provider on v1/2/3 into output that can be used by consumer on `>=v3.3.0`

```shell
# Example:
$ interchain-security-cd transform /path/to/ccv_consumer_genesis.json
```

### API BREAKING

- [Provider](x/ccv/provider)
- Deprecate equivocation proposals.
([\#1340](https://github.com/cosmos/interchain-security/pull/1340))

### DEPENDENCIES

- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.3.1](https://github.com/cosmos/ibc-go/releases/tag/v7.3.1).
([\#1373](https://github.com/cosmos/interchain-security/pull/1373))

### FEATURES

- General
- Add Quint model of Replicated Security.
([\#1336](https://github.com/cosmos/interchain-security/pull/1336))
- [Provider](x/ccv/provider)
- Update how consumer-assigned keys are checked when a validator is
created on the provider.
([\#1339](https://github.com/cosmos/interchain-security/pull/1339))
- Introduce the cryptographic verification of equivocation feature to the provider
(cf. [ADR-005](/docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md)
& [ADR-013](/docs/docs/adrs/adr-013-equivocation-slashing.md)).
([\#1340](https://github.com/cosmos/interchain-security/pull/1340))

### IMPROVEMENTS

- Split out consumer genesis state to reduce shared data between provider and
consumer. ([\#1324](https://github.com/cosmos/interchain-security/pull/1324))
- Note: This breaks json format used by augmenting Genesis files of consumer
chains with consumer genesis content exported from provider chain. Consumer
Genesis content exported from a provider chain using major version 1, 2 or 3
of the provider module needs to be transformed with the transformation command
introduced by this PR:
```
Transform the consumer genesis file from a provider version v1, v2 or v3 to a version supported by this consumer. Result is printed to STDOUT.

Example:
$ <appd> transform /path/to/ccv_consumer_genesis.json

Usage:
interchain-security-cd genesis transform [genesis-file] [flags]
```
- Refactor shared events, codecs and errors assign to
consumer and provider dedicated types where possible.
([\#1350](https://github.com/cosmos/interchain-security/pull/1350))

### STATE BREAKING

- General
- Split out consumer genesis state to reduce shared data between provider and
consumer. ([\#1324](https://github.com/cosmos/interchain-security/pull/1324))
- Improve validation of IBC packet data and provider messages. Also,
enable the provider to validate consumer packets before handling them.
([\#1460](https://github.com/cosmos/interchain-security/pull/1460))
- [Provider](x/ccv/provider)
- Change the states by adding a consumer key for each chain that is
not yet registered meaning for which the gov proposal has not passed.
([\#1339](https://github.com/cosmos/interchain-security/pull/1339))
- Introduce the cryptographic verification of equivocation feature to the provider
(cf. [ADR-005](/docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md)
& [ADR-013](/docs/docs/adrs/adr-013-equivocation-slashing.md)).
([\#1340](https://github.com/cosmos/interchain-security/pull/1340))

## v3.2.0

*November 24, 2023*
Expand Down
Loading