From 671452ffce79f650915285fb3fa569f1906b7331 Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Wed, 22 Nov 2023 19:08:39 +0100 Subject: [PATCH] docs: bring v2.4.0-lsm changelog section to main (#1441) * backport v2.4.0-lsm changelog section to main * update release info * add existing major features --- .changelog/epilogue.md | 22 ++++++++++++++++++++++ CHANGELOG.md | 11 +++++++++++ FEATURES.md | 18 ++++++++++++++++++ README.md | 6 +++++- RELEASES.md | 8 +++++--- 5 files changed, 61 insertions(+), 4 deletions(-) create mode 100644 FEATURES.md diff --git a/.changelog/epilogue.md b/.changelog/epilogue.md index c8963c332f..861dc712e3 100644 --- a/.changelog/epilogue.md +++ b/.changelog/epilogue.md @@ -23,6 +23,28 @@ Interchain Security v3 uses SDK 0.47 and IBC 7. * `[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. +## v2.4.0-lsm + +*November 20, 2023* + +* (fix) [#1439](https://github.com/cosmos/interchain-security/pull/1439) Fix unmarshaling for the CLI consumer double vote cmd. +* (feat!) [#1435](https://github.com/cosmos/interchain-security/pull/1435) Add height-base filter for consumer equivocation evidence. + +## v2.3.0-provider-lsm + +*November 15, 2023* + +❗ *This release is deprecated and should not be used in production.* + +* (fix!) [#1422](https://github.com/cosmos/interchain-security/pull/1422) Fix the misbehaviour handling by verifying the signatures of byzantine validators. + +## v2.2.0-provider-lsm + +❗ *This release is deprecated and should not be used in production.* + +### Cryptographic verification of equivocation +* New feature enabling the provider chain to verify equivocation evidence on its own instead of trusting consumer chains, see [EPIC](https://github.com/cosmos/interchain-security/issues/732). + ## v2.1.0-provider-lsm Date: September 15th, 2023 diff --git a/CHANGELOG.md b/CHANGELOG.md index 046a01c16e..7236eb5ec7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,14 +25,25 @@ Interchain Security v3 uses SDK 0.47 and IBC 7. * `[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. +## v2.4.0-lsm + +*November 20, 2023* + +* (fix) [#1439](https://github.com/cosmos/interchain-security/pull/1439) Fix unmarshaling for the CLI consumer double vote cmd. +* (feat!) [#1435](https://github.com/cosmos/interchain-security/pull/1435) Add height-base filter for consumer equivocation evidence. + ## v2.3.0-provider-lsm *November 15, 2023* +❗ *This release is deprecated and should not be used in production.* + * (fix!) [#1422](https://github.com/cosmos/interchain-security/pull/1422) Fix the misbehaviour handling by verifying the signatures of byzantine validators. ## v2.2.0-provider-lsm +❗ *This release is deprecated and should not be used in production.* + ### Cryptographic verification of equivocation * New feature enabling the provider chain to verify equivocation evidence on its own instead of trusting consumer chains, see [EPIC](https://github.com/cosmos/interchain-security/issues/732). diff --git a/FEATURES.md b/FEATURES.md new file mode 100644 index 0000000000..d536a58643 --- /dev/null +++ b/FEATURES.md @@ -0,0 +1,18 @@ +# Features + +The following table indicates the major ICS features available in the [currently active releases](./RELEASES.md#version-matrix): + +| Feature | Release | `v1.2.0-multiden` | `v2.0.0` | `v2.1.0-provider-lsm` | `v2.4.0-lsm` | `v3.1.0` | +|---------|---------|------------------:|---------:|----------------------:|-------------:|---------:| +| [Channel initialization: new chains](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#channel-initialization-new-chains) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Validator set update](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#validator-set-update) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Completion of unbonding operations](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#completion-of-unbonding-operations) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Consumer initiated slashing](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#consumer-initiated-slashing) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Reward distribution](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#reward-distribution) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Consumer chain removal](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/methods.md#consumer-chain-removal) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Key assignment](https://github.com/cosmos/interchain-security/issues/26) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Jail throttling](https://github.com/cosmos/interchain-security/issues/404) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Soft opt-out](https://github.com/cosmos/interchain-security/issues/851) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Channel initialization: existing chains](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#channel-initialization-existing-chains) (aka [Standalone to consumer changeover](https://github.com/cosmos/interchain-security/issues/756))| | ❌ | ✅ | ✅ | ✅ | ✅ | +| [Cryptographic verification of equivocation](https://github.com/cosmos/interchain-security/issues/732) | | ❌ | ❌ | ❌ | ✅ | ❌ | + diff --git a/README.md b/README.md index 0b9ea0e5c9..c3e908b4b3 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,11 @@ **interchain-security** contains a working and in-production implementation of the Replicated Security protocol (aka Interchain Security V1). Replicated security is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another. -For more details on the Replicated Security protocol, take a look at the [docs](https://cosmos.github.io/interchain-security/) or [technical specification](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md). +For more details on the **Replicated Security protocol**, take a look at the [docs](https://cosmos.github.io/interchain-security/) or [technical specification](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md). + +For a list of **currently active releases**, see [RELEASES.md](./RELEASES.md#version-matrix). + +For a list of **major ICS features** available in the currently active releases, see [FEATURES.md](./FEATURES.md). ## Instructions diff --git a/RELEASES.md b/RELEASES.md index 92662b3318..ee382b0309 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -61,7 +61,7 @@ All missing minor release versions have been discontinued. | `v1.2.x` | February 21, 2024 | | `v2.0.x` | June 09, 2024 | | `v2.1.x-provider-lsm` | June 09, 2024 | -| `v2.3.x-provider-lsm` | June 09, 2024 | +| `v2.4.x-lsm` | June 09, 2024 | | `v3.1.x` | July 10, 2024 | | `v3.2.x` | July 10, 2024 | @@ -81,16 +81,18 @@ Versions of Golang, IBC, Cosmos SDK and CometBFT used by ICS in the currently ac | [v1.2.0-multiden](https://github.com/cosmos/interchain-security/releases/tag/v1.2.0-multiden) | 1.18 | v4.2.0 | v0.45.15-ics | v0.34.27 | Consumer only | | [v2.0.0](https://github.com/cosmos/interchain-security/releases/tag/v2.0.0) | 1.19 | v4.4.2 | v0.45.15-ics | v0.34.28 | | [v2.1.0-provider-lsm](https://github.com/cosmos/interchain-security/releases/tag/v2.1.0-provider-lsm) | 1.19 | v4.4.2 | v0.45.16-ics-lsm | v0.34.28 | Provider only (Cosmos Hub specific) | -| [v2.3.0-provider-lsm](https://github.com/cosmos/interchain-security/releases/tag/v2.3.0-provider-lsm) | 1.19 | v4.4.2 | v0.45.16-ics-lsm | v0.34.28 | Provider only (Cosmos Hub specific) | +| [v2.4.0-lsm](https://github.com/cosmos/interchain-security/releases/tag/v2.4.0-lsm) | 1.19 | v4.4.2 | v0.45.16-ics-lsm | v0.34.28 | Provider only (Cosmos Hub specific) | | [v3.1.0](https://github.com/cosmos/interchain-security/releases/tag/v3.1.0) | 1.20 | v7.1.0 | v0.47.3 | v0.37.2 | +**Note:** For a list of major ICS features available in the currently active releases, see [FEATURES.md](./FEATURES.md). + ### Backwards Compatibility A MAJOR version of ICS will always be backwards compatible with the previous MAJOR version of ICS. The following table indicates the compatibility of currently active releases: -| consumer | provider | `v2.0.0` | `v2.1.0-provider-lsm` | `v2.3.0-provider-lsm` | `v3.1.0` | +| Consumer | Provider | `v2.0.0` | `v2.1.0-provider-lsm` | `v2.4.0-lsm` | `v3.1.0` | |----------|----------|--------:|----------------------:|----------------------:|---------:| | `v1.2.0-multiden` || ✅ | ✅ | ✅ | ✅ | | `v2.0.0` || ✅ | ✅ | ✅ | ✅ |