Skip to content

Commit

Permalink
docs: mark v2 as EOL and add v3.3.3-lsm (#1716)
Browse files Browse the repository at this point in the history
* mark v2 as EOL and add v3.3.3-lsm

* update compatibility matrix
  • Loading branch information
mpoke authored Apr 4, 2024
1 parent 1febe0a commit d66cdc8
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 35 deletions.
30 changes: 15 additions & 15 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

The following table indicates the major ICS features available in the [currently active releases](./RELEASES.md#version-matrix):

| Feature | `v2.0.0` | `v2.4.0-lsm` | `v3.1.0` | `v3.2.0` | `v3.3.0` | `v4.0.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) ||| || ||
| [Jail throttling with retries](https://github.com/cosmos/interchain-security/issues/713) - consumer-side changes | || ||||
| [Jail throttling with retries](https://github.com/cosmos/interchain-security/issues/713) - [provider-side changes](https://github.com/cosmos/interchain-security/issues/1102) |||| || |
| Feature | `v3.2.0` | `v3.3.0` | `v3.3.3-lsm` | `v4.0.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) |||||
| [Jail throttling with retries](https://github.com/cosmos/interchain-security/issues/713) - consumer-side changes | ||||
| [Jail throttling with retries](https://github.com/cosmos/interchain-security/issues/713) - [provider-side changes](https://github.com/cosmos/interchain-security/issues/1102) |||||
33 changes: 13 additions & 20 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,13 @@ All missing minor release versions have been discontinued.

| Release | End of Life Date |
|---------|------------------|
| `v2.0.x` | June 09, 2024 |
| `v2.4.x-lsm` | June 09, 2024 |
| `v3.1.x` | July 10, 2024 |
| `v3.2.x` | July 10, 2024 |
| `v3.3.x` | July 10, 2024 |
| `v4.0.x` | TBA |
| `v3.3.x-lsm` | July 10, 2024 |
| `v4.0.x` | January 24, 2025 |

**Note**: As of [Gaia v12.0.0](https://github.com/cosmos/gaia/releases/tag/v12.0.0),
the Cosmos Hub uses a fork of Cosmos SDK ([v0.45.16-ics-lsm](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.16-ics-lsm))
**Note**: As of [Gaia v15.1.0](https://github.com/cosmos/gaia/releases/tag/v15.1.0),
the Cosmos Hub uses a fork of Cosmos SDK ([v0.47.10-ics-lsm](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.10-ics-lsm))
that contains the Liquid Staking Module (LSM).
This means the Cosmos Hub requires a fork of ICS.
This fork is maintained by the development team and released using the `-lsm` prefix.
Expand All @@ -79,12 +77,10 @@ Versions of Golang, IBC, Cosmos SDK and CometBFT used by ICS in the currently ac

| ICS | Golang | IBC | Cosmos SDK | CometBFT | Note |
|-----|--------|-----|------------|----------|------|
| [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.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 |
| [v3.2.0](https://github.com/cosmos/interchain-security/releases/tag/v3.2.0) | 1.20 | v7.3.0 | v0.47.5 | v0.37.2 |
| v3.3.0 | 1.20 | v7.3.0 | v0.47.5 | v0.37.2 |
| v4.0.0 | 1.21 | v7.3.0 | v0.47.5 | v0.37.2 | Provider on >= v4.0.0 backwards compatible with consumers >= v3.2.0 |
| [v3.3.0](https://github.com/cosmos/interchain-security/releases/tag/v3.3.0) | 1.20 | v7.3.0 | v0.47.5 | v0.37.2 |
| [v3.3.3-lsm](https://github.com/cosmos/interchain-security/releases/tag/v3.3.3-lsm) | 1.20 | v7.3.1 | v0.47.10-ics-lsm | v0.37.4 | Provider only (Cosmos Hub specific) |
| [v4.0.0](https://github.com/cosmos/interchain-security/releases/tag/v4.0.0) | 1.21 | v7.3.1 | v0.47.7 | v0.37.4 | Provider on >= v4.0.0 backwards compatible with consumers >= v3.2.0 |

**Note:** For a list of major ICS features available in the currently active releases, see [FEATURES.md](./FEATURES.md).

Expand All @@ -94,17 +90,14 @@ A MAJOR version of ICS will always be backwards compatible with the previous MAJ

The following table indicates the compatibility of currently active releases:

| Consumer | Provider | `v2.0.0` | `v2.4.0-lsm` | `v3.1.0` | `v3.2.0` | `v3.3.0` | `v4.0.0` |
|----------|----------|----------|--------------|----------|----------|----------|----------|
| `v2.0.0` |||| ✅ (1) | ✅ (1) | ✅ (1),(2) ||
| `v3.1.0` |||||| ✅ (2) ||
| `v3.2.0` |||||| ✅ (2) ||
| `v3.3.0` || ✅ (2) | ✅ (2) | ✅ (2) | ✅ (2) |||
| `v4.0.0` || ✅ (2) | ✅ (2) | ✅ (2) | ✅ (2)| ✅ (2)||
| Consumer | Provider | `v3.2.0` | `v3.3.0` | `v3.3.3-lsm` | `v4.0.0` |
|----------|----------|----------|----------|--------------|----------|
| `v3.2.0` ||| ✅ (1) |||
| `v3.3.0` || ✅ (1) ||||
| `v4.0.0` || ✅ (1)| ✅ (1)| ✅ (1) ||

#### Notes

The following adjustments must be made to the CCV consumer genesis state that is obtained from the provider chain after the spawn time is reached in order for the consumer chain to start without errors.

- (1) Remove “prehash_key_before_comparison” keys
- (2) Use `interchain-security-cd genesis transform` to transform the consumer genesis file obtained from the provider.
- (1) Use `interchain-security-cd genesis transform` to transform the consumer genesis file obtained from the provider.

0 comments on commit d66cdc8

Please sign in to comment.