Skip to content

Commit

Permalink
docs: update info on releases (#2218)
Browse files Browse the repository at this point in the history
* update info on releases

* update supported_versions.json
  • Loading branch information
mpoke authored Sep 5, 2024
1 parent 50fa4cc commit f469211
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 30 deletions.
32 changes: 16 additions & 16 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

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` |
|---------|---------:|---------:|-------------:|---------:|---------:|
| [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) ||||||
| [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) ||||||
| Feature | `v4.0.0` | `v4.3.1` | `v4.3.1-lsm` | `v4.4.0` | `v5.0.0` | `v5.2.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) |||||||
| [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) |||||||
27 changes: 14 additions & 13 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,25 +62,25 @@ All missing minor release versions have been discontinued.
| `v4.3.x` | January 24, 2025 |
| `v4.4.x` | January 24, 2025 |
| `v5.0.x` | May 9, 2025 |
| `v5.2.x` | May 9, 2025 |

**Note**: As of [Gaia v17.2.0](https://github.com/cosmos/gaia/releases/tag/v17.2.0),
the Cosmos Hub uses a fork of Cosmos SDK ([v0.47.15-ics-lsm](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.15-ics-lsm))
that contains the Liquid Staking Module (LSM).
This means the Cosmos Hub requires a fork of ICS.
**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.
As soon as the Cosmos Hub uses mainline Cosmos SDK, the `-lsm` releases will reach end of life.
Starting with Gaia `v19.0.x` (that uses SDK 0.50), the fork of ICS is no longer needed.

## 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 | Provider on >= v4.0.0 backwards compatible with consumers >= v3.2.0 |
| [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.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 |

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

Expand All @@ -90,9 +90,10 @@ 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` |
|----------|----------|--------------|
| `v4.0.0` |||
| `v4.3.1` |||
| `v4.4.0` |||
| `v5.0.0` |||
| Consumer | Provider | `v4.3.1-lsm` | `v5.2.0` |
|----------|----------|---------------|----------|
| `v4.0.0` ||||
| `v4.3.1` ||||
| `v4.4.0` ||||
| `v5.0.0` ||||
| `v5.2.0` ||||
2 changes: 1 addition & 1 deletion docs/supported_versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[
"v5.1.0",
"v5.2.0",
"v4.4.1"
]

0 comments on commit f469211

Please sign in to comment.