Skip to content

Commit

Permalink
update docs on releases
Browse files Browse the repository at this point in the history
  • Loading branch information
mpoke committed Jan 2, 2025
1 parent 9226c93 commit 7e3ab3e
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 30 deletions.
17 changes: 9 additions & 8 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,22 @@

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

| Feature | `v4.0.0` | `v4.3.1` | `v4.3.1-lsm` | `v4.4.0` | `v5.0.0` | `v5.2.0` | `v6.1.0` |
|---------|---------:|---------:|-------------:|---------:|---------:|---------:|----------:|
| Feature | `v4.0.0` | `v4.4.0` | `v4.5.0` | `v5.0.0` | `v5.2.0` | `v6.1.0` | `v6.3.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) ||||||||
| [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) || | | | |||
| [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) ||||||||
| [ICS epochs](https://cosmos.github.io/interchain-security/adrs/adr-014-epochs) ||||||||
| [Partial Set Security](https://cosmos.github.io/interchain-security/adrs/adr-015-partial-set-security) ||||||||
| [Inactive Provider Validators](https://cosmos.github.io/interchain-security/adrs/adr-017-allowing-inactive-validators) ||||||||
| [Permissionless](https://cosmos.github.io/interchain-security/adrs/adr-019-permissionless-ics) ||||||||
| [ICS epochs](https://cosmos.github.io/interchain-security/adrs/adr-014-epochs) ||||||||
| [Partial Set Security](https://cosmos.github.io/interchain-security/adrs/adr-015-partial-set-security) ||||||||
| [Inactive Provider Validators](https://cosmos.github.io/interchain-security/adrs/adr-017-allowing-inactive-validators) ||||||||
| [Permissionless](https://cosmos.github.io/interchain-security/adrs/adr-019-permissionless-ics) ||||||||
| [ICS Rewards in non-native denoms](https://github.com/cosmos/interchain-security/issues/1634) ||||||||
47 changes: 25 additions & 22 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [Stable Release Policy](#stable-release-policy)
- [Version Matrix](#version-matrix)
- [Backwards Compatibility](#backwards-compatibility)
- [Notes](#notes)

## Semantic Versioning

Expand Down Expand Up @@ -59,30 +60,26 @@ All missing minor release versions have been discontinued.
| Release | End of Life Date |
| -------- | ---------------- |
| `v4.0.x` | January 24, 2025 |
| `v4.3.x` | January 24, 2025 |
| `v4.4.x` | January 24, 2025 |
| `v4.5.x` | January 24, 2025 |
| `v5.0.x` | May 9, 2025 |
| `v5.2.x` | May 9, 2025 |
| `v6.1.x` | Sep 13, 2025 |

**Note**: Gaia versions on SDK 0.47 (i.e., `v15.0.x` -- `v18.1.x`) use a fork of Cosmos SDK (i.e., `v0.47.x-ics-lsm`) that contains the Liquid Staking Module (LSM).
This means that these versions of Gaia require a fork of ICS.
This fork is maintained by the development team and released using the `-lsm` prefix.
Starting with Gaia `v19.0.x` (that uses SDK 0.50), the fork of ICS is no longer needed.
| `v6.3.x` | Sep 13, 2025 |

## Version Matrix

Versions of Golang, IBC, Cosmos SDK and CometBFT used by ICS in the currently active releases:

| ICS | Golang | IBC | Cosmos SDK | CometBFT | Note |
| ----------------------------------------------------------------------------------- | ------ | ------ | ---------------- | -------- | ----------------------------------- |
| [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 | |
| [v4.3.1](https://github.com/cosmos/interchain-security/releases/tag/v4.3.1) | 1.21 | v7.6.0 | v0.47.12 | v0.37.6 | |
| [v4.3.1-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.3.1-lsm) | 1.21 | v7.6.0 | v0.47.16-ics-lsm | v0.37.6 | Provider only (Cosmos Hub specific) |
| [v4.4.0](https://github.com/cosmos/interchain-security/releases/tag/v4.4.0) | 1.21 | v7.6.0 | v0.47.12 | v0.37.6 | |
| [v5.0.0](https://github.com/cosmos/interchain-security/releases/tag/v5.0.0) | 1.21 | v8.1.0 | v0.50.4 | v0.38.5 | |
| [v5.2.0](https://github.com/cosmos/interchain-security/releases/tag/v5.2.0) | 1.22 | v8.3.2 | v0.50.8 | v0.38.9 | |
| [v6.1.0](https://github.com/cosmos/interchain-security/releases/tag/v6.1.0) | 1.22 | v8.5.0 | v0.50.9 | v0.38.11 | |
| ICS | Golang | IBC | Cosmos SDK | CometBFT | Note |
| --------------------------------------------------------------------------- | ------ | ------ | ---------- | -------- | ---- |
| [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 | |
| [v4.4.0](https://github.com/cosmos/interchain-security/releases/tag/v4.4.0) | 1.21 | v7.6.0 | v0.47.12 | v0.37.6 | |
| [v4.5.0](https://github.com/cosmos/interchain-security/releases/tag/v4.4.0) | 1.21 | v7.6.0 | v0.47.12 | v0.37.6 | |
| [v5.0.0](https://github.com/cosmos/interchain-security/releases/tag/v5.0.0) | 1.21 | v8.1.0 | v0.50.4 | v0.38.5 | |
| [v5.2.0](https://github.com/cosmos/interchain-security/releases/tag/v5.2.0) | 1.22 | v8.3.2 | v0.50.8 | v0.38.9 | |
| [v6.1.0](https://github.com/cosmos/interchain-security/releases/tag/v6.1.0) | 1.22 | v8.5.0 | v0.50.9 | v0.38.11 | |
| [v6.3.0](https://github.com/cosmos/interchain-security/releases/tag/v6.3.0) | 1.22 | v8.5.1 | v0.50.9 | v0.38.11 | |

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

Expand All @@ -92,10 +89,16 @@ 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 | `v4.3.1-lsm` | `v5.2.0` | `v6.1.0` |
| -------- | -------- | ------------ | -------- | -------- |
| `v4.0.0` | ||||
| `v4.3.1` | ||||
| `v4.4.0` | ||||
| `v5.0.0` | ||||
| `v5.2.0` | ||||
| Consumer | Provider | `v5.2.0` | `v6.1.0` | `v6.3.0` |
| -------- | -------- | -------- | -------- | -------- |
| `v4.0.0` | ||| ✅ (1) |
| `v4.4.0` | ||| ✅ (1) |
| `v4.5.0` | ||||
| `v5.0.0` | ||| ✅ (1) |
| `v5.2.0` | ||| ✅ (1) |
| `v6.3.0` | ||||

#### 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) Use `interchain-security-cd genesis transform` to transform the consumer genesis file obtained from the provider.

0 comments on commit 7e3ab3e

Please sign in to comment.