From 0670c822b02b1742527b753b5c74230925196b69 Mon Sep 17 00:00:00 2001 From: MSalopek Date: Tue, 5 Dec 2023 17:03:45 +0100 Subject: [PATCH] docs: add v3.3.0 changelog to main --- .../consumer/1458-consumer-genesis-cli-fix.md | 2 + .../1458-consumer-genesis-cli-fix.md | 2 + .../state-breaking/1460-msg-validation.md | 3 - ...ic-verification-of-equivocation-feature.md | 0 .../dependencies/1373-bump-ibc.md | 0 .../features/1336-quint-model.md | 0 .../1339-check-key-assignment-in-use.md | 0 ...1340-cryptographic-equivocation-feature.md | 0 .../improvements/1324-consumer-genesis.md | 0 .../improvements/1350-cleanup-types.md | 0 .../state-breaking/1324-consumer-genesis.md | 0 .../state-breaking}/1460-msg-validation.md | 0 .../1339-check-key-assignment-in-use.md | 0 ...1340-cryptographic-equivocation-feature.md | 0 .changelog/v3.3.0/summary.md | 1 + CHANGELOG.md | 73 ++++++++++++++++++- 16 files changed, 76 insertions(+), 5 deletions(-) create mode 100644 .changelog/unreleased/api-breaking/consumer/1458-consumer-genesis-cli-fix.md create mode 100644 .changelog/unreleased/bug-fixes/1458-consumer-genesis-cli-fix.md delete mode 100644 .changelog/unreleased/state-breaking/1460-msg-validation.md rename .changelog/{unreleased => v3.3.0}/api-breaking/provider/1340-add-cryptographic-verification-of-equivocation-feature.md (100%) rename .changelog/{unreleased => v3.3.0}/dependencies/1373-bump-ibc.md (100%) rename .changelog/{unreleased => v3.3.0}/features/1336-quint-model.md (100%) rename .changelog/{unreleased => v3.3.0}/features/provider/1339-check-key-assignment-in-use.md (100%) rename .changelog/{unreleased => v3.3.0}/features/provider/1340-cryptographic-equivocation-feature.md (100%) rename .changelog/{unreleased => v3.3.0}/improvements/1324-consumer-genesis.md (100%) rename .changelog/{unreleased => v3.3.0}/improvements/1350-cleanup-types.md (100%) rename .changelog/{unreleased => v3.3.0}/state-breaking/1324-consumer-genesis.md (100%) rename .changelog/{unreleased/bug-fixes => v3.3.0/state-breaking}/1460-msg-validation.md (100%) rename .changelog/{unreleased => v3.3.0}/state-breaking/provider/1339-check-key-assignment-in-use.md (100%) rename .changelog/{unreleased => v3.3.0}/state-breaking/provider/1340-cryptographic-equivocation-feature.md (100%) create mode 100644 .changelog/v3.3.0/summary.md diff --git a/.changelog/unreleased/api-breaking/consumer/1458-consumer-genesis-cli-fix.md b/.changelog/unreleased/api-breaking/consumer/1458-consumer-genesis-cli-fix.md new file mode 100644 index 0000000000..0f838eb6e5 --- /dev/null +++ b/.changelog/unreleased/api-breaking/consumer/1458-consumer-genesis-cli-fix.md @@ -0,0 +1,2 @@ +- Fix a bug in consmer genesis file tranform CLI command. +([\#1458](https://github.com/cosmos/interchain-security/pull/1458)) \ No newline at end of file diff --git a/.changelog/unreleased/bug-fixes/1458-consumer-genesis-cli-fix.md b/.changelog/unreleased/bug-fixes/1458-consumer-genesis-cli-fix.md new file mode 100644 index 0000000000..0f838eb6e5 --- /dev/null +++ b/.changelog/unreleased/bug-fixes/1458-consumer-genesis-cli-fix.md @@ -0,0 +1,2 @@ +- Fix a bug in consmer genesis file tranform CLI command. +([\#1458](https://github.com/cosmos/interchain-security/pull/1458)) \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/1460-msg-validation.md b/.changelog/unreleased/state-breaking/1460-msg-validation.md deleted file mode 100644 index 46d18bd4c9..0000000000 --- a/.changelog/unreleased/state-breaking/1460-msg-validation.md +++ /dev/null @@ -1,3 +0,0 @@ -- 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)) \ No newline at end of file diff --git a/.changelog/unreleased/api-breaking/provider/1340-add-cryptographic-verification-of-equivocation-feature.md b/.changelog/v3.3.0/api-breaking/provider/1340-add-cryptographic-verification-of-equivocation-feature.md similarity index 100% rename from .changelog/unreleased/api-breaking/provider/1340-add-cryptographic-verification-of-equivocation-feature.md rename to .changelog/v3.3.0/api-breaking/provider/1340-add-cryptographic-verification-of-equivocation-feature.md diff --git a/.changelog/unreleased/dependencies/1373-bump-ibc.md b/.changelog/v3.3.0/dependencies/1373-bump-ibc.md similarity index 100% rename from .changelog/unreleased/dependencies/1373-bump-ibc.md rename to .changelog/v3.3.0/dependencies/1373-bump-ibc.md diff --git a/.changelog/unreleased/features/1336-quint-model.md b/.changelog/v3.3.0/features/1336-quint-model.md similarity index 100% rename from .changelog/unreleased/features/1336-quint-model.md rename to .changelog/v3.3.0/features/1336-quint-model.md diff --git a/.changelog/unreleased/features/provider/1339-check-key-assignment-in-use.md b/.changelog/v3.3.0/features/provider/1339-check-key-assignment-in-use.md similarity index 100% rename from .changelog/unreleased/features/provider/1339-check-key-assignment-in-use.md rename to .changelog/v3.3.0/features/provider/1339-check-key-assignment-in-use.md diff --git a/.changelog/unreleased/features/provider/1340-cryptographic-equivocation-feature.md b/.changelog/v3.3.0/features/provider/1340-cryptographic-equivocation-feature.md similarity index 100% rename from .changelog/unreleased/features/provider/1340-cryptographic-equivocation-feature.md rename to .changelog/v3.3.0/features/provider/1340-cryptographic-equivocation-feature.md diff --git a/.changelog/unreleased/improvements/1324-consumer-genesis.md b/.changelog/v3.3.0/improvements/1324-consumer-genesis.md similarity index 100% rename from .changelog/unreleased/improvements/1324-consumer-genesis.md rename to .changelog/v3.3.0/improvements/1324-consumer-genesis.md diff --git a/.changelog/unreleased/improvements/1350-cleanup-types.md b/.changelog/v3.3.0/improvements/1350-cleanup-types.md similarity index 100% rename from .changelog/unreleased/improvements/1350-cleanup-types.md rename to .changelog/v3.3.0/improvements/1350-cleanup-types.md diff --git a/.changelog/unreleased/state-breaking/1324-consumer-genesis.md b/.changelog/v3.3.0/state-breaking/1324-consumer-genesis.md similarity index 100% rename from .changelog/unreleased/state-breaking/1324-consumer-genesis.md rename to .changelog/v3.3.0/state-breaking/1324-consumer-genesis.md diff --git a/.changelog/unreleased/bug-fixes/1460-msg-validation.md b/.changelog/v3.3.0/state-breaking/1460-msg-validation.md similarity index 100% rename from .changelog/unreleased/bug-fixes/1460-msg-validation.md rename to .changelog/v3.3.0/state-breaking/1460-msg-validation.md diff --git a/.changelog/unreleased/state-breaking/provider/1339-check-key-assignment-in-use.md b/.changelog/v3.3.0/state-breaking/provider/1339-check-key-assignment-in-use.md similarity index 100% rename from .changelog/unreleased/state-breaking/provider/1339-check-key-assignment-in-use.md rename to .changelog/v3.3.0/state-breaking/provider/1339-check-key-assignment-in-use.md diff --git a/.changelog/unreleased/state-breaking/provider/1340-cryptographic-equivocation-feature.md b/.changelog/v3.3.0/state-breaking/provider/1340-cryptographic-equivocation-feature.md similarity index 100% rename from .changelog/unreleased/state-breaking/provider/1340-cryptographic-equivocation-feature.md rename to .changelog/v3.3.0/state-breaking/provider/1340-cryptographic-equivocation-feature.md diff --git a/.changelog/v3.3.0/summary.md b/.changelog/v3.3.0/summary.md new file mode 100644 index 0000000000..08b255631d --- /dev/null +++ b/.changelog/v3.3.0/summary.md @@ -0,0 +1 @@ +*December 5, 2023* diff --git a/CHANGELOG.md b/CHANGELOG.md index ea360f3039..b7e50dc80d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,74 @@ # CHANGELOG +## v3.3.0 + +*December 5, 2023* + +### 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: + $ 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* @@ -161,9 +230,9 @@ Date: June 1st, 2023 Unlike prior releases, the ICS `v2.0.0` release will be based on the main branch. `v2.0.0` will contain all the accumulated PRs from the various releases below, along with other PRs that were merged, but not released to production. After `v2.0.0`, we plan to revamp release practices, and how we modularize the repo for consumer/provider. -Upgrading a provider from `v1.1.0-multiden` to `v2.0.0` will require state migrations. See [migration.go](x/ccv/provider/keeper/migration.go). See the provider module's `ConsensusVersion` in [module](x/ccv/provider/module.go) +Upgrading a provider from `v1.1.0-multiden` to `v2.0.0` will require state migrations. See [migration.go](./x/ccv/provider/keeper/migration.go). See the provider module's `ConsensusVersion` in [module](./x/ccv/provider/module.go) -Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations. See the consumer module's `ConsensusVersion` in [module](x/ccv/consumer/module.go) +Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations. See the consumer module's `ConsensusVersion` in [module](./x/ccv/consumer/module.go) Some PRs from v2.0.0 may reappear from other releases below. This is due to the fact that ICS v1.1.0 deviates from the commit ordering of the main branch, and other releases thereafter are based on v1.1.0.