Skip to content

Commit a2e8154

Browse files
chore: remove v9 references + minor readme updates (#7962)
* chore: remove v9 references + minor readme updates * markdown lint * Update RELEASES.md Co-authored-by: Aditya <[email protected]> --------- Co-authored-by: Aditya <[email protected]>
1 parent 093b08e commit a2e8154

25 files changed

+61
-136
lines changed

.github/mergify.yml

-16
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,6 @@ pull_request_rules:
7070
backport:
7171
branches:
7272
- 08-wasm/release/v0.5.x+ibc-go-v8.4.x-wasmvm-v2.1.x
73-
- name: backport patches to v0.5.x wasm ibc-go v9.0.x & wasmvm 2.1.x branch
74-
conditions:
75-
- base=main
76-
- label=backport-wasm-v0.5.x+ibc-go-v9.0.x-wasmvm-v2.1.x
77-
actions:
78-
backport:
79-
branches:
80-
- 08-wasm/release/v0.5.x+ibc-go-v9.0.x-wasmvm-v2.1.x
8173
- name: backport patches to v7.4.x branch
8274
conditions:
8375
- base=main
@@ -134,14 +126,6 @@ pull_request_rules:
134126
backport:
135127
branches:
136128
- release/v8.5.x
137-
- name: backport patches to v9.0.x branch
138-
conditions:
139-
- base=main
140-
- label=backport-to-v9.0.x
141-
actions:
142-
backport:
143-
branches:
144-
- release/v9.0.x
145129
- name: backport patches to v10.0.x branch
146130
conditions:
147131
- base=main

.github/workflows/e2e-compatibility.yaml

-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ on:
2020
- release/v7.8.x
2121
- release/v8.4.x
2222
- release/v8.5.x
23-
- release/v9.0.x
2423
- release/v10.0.x
2524
- main
2625
ibc-go-version:
@@ -62,7 +61,6 @@ jobs:
6261
- release/v7.8.x
6362
- release/v8.4.x
6463
- release/v8.5.x
65-
- release/v9.0.x
6664
- release/v10.0.x
6765
- main
6866
steps:

.github/workflows/e2e-manual-simd.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ on:
3030
default: main
3131
options:
3232
- main
33-
- v9.0.0
33+
- v10.0.0
3434
- v8.5.0
3535
- v8.4.0
3636
- v7.7.0
@@ -48,7 +48,7 @@ on:
4848
type: choice
4949
options:
5050
- main
51-
- v9.0.0
51+
- v10.0.0
5252
- v8.5.0
5353
- v8.4.0
5454
- v7.7.0

.github/workflows/e2e-upgrade.yaml

+8-8
Original file line numberDiff line numberDiff line change
@@ -69,25 +69,25 @@ jobs:
6969
test: "TestV8ToV8_1ChainUpgrade_FeeMiddlewareChannelUpgrade"
7070
upload-logs: true
7171

72-
upgrade-v9:
72+
upgrade-v10:
7373
uses: ./.github/workflows/e2e-test-workflow-call.yml
7474
with:
7575
chain-image: ghcr.io/cosmos/ibc-go-simd
76-
chain-a-tag: v8.4.0
77-
chain-b-tag: v8.4.0
78-
upgrade-plan-name: "v9"
76+
chain-a-tag: v8.5.0
77+
chain-b-tag: v8.5.0
78+
upgrade-plan-name: "v10"
7979
test-entry-point: "TestUpgradeTestSuite"
80-
test: "TestV8ToV9ChainUpgrade"
80+
test: "TestV8ToV10ChainUpgrade"
8181
upload-logs: true
8282

83-
upgrade-v9-localhost:
83+
upgrade-v10-localhost:
8484
uses: ./.github/workflows/e2e-test-workflow-call.yml
8585
with:
8686
chain-image: ghcr.io/cosmos/ibc-go-simd
8787
chain-a-tag: v8.4.0
8888
chain-b-tag: v8.4.0
89-
upgrade-plan-name: "v9"
89+
upgrade-plan-name: "v10"
9090
test-entry-point: "TestUpgradeTestSuite"
91-
test: "TestV8ToV9ChainUpgrade_Localhost"
91+
test: "TestV8ToV10ChainUpgrade_Localhost"
9292
upload-logs: true
9393

CHANGELOG.md

+10-31
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
4444
### Dependencies
4545

4646
* [\#7540](https://github.com/cosmos/ibc-go/pull/7540) Bump CometBFT to v0.38.15.
47+
* [\#6193](https://github.com/cosmos/ibc-go/pull/6193) Bump `cosmossdk.io/store` to v1.1.0.
48+
* [\#6828](https://github.com/cosmos/ibc-go/pull/6828) Bump Cosmos SDK to v0.50.9.
49+
* [\#6380](https://github.com/cosmos/ibc-go/pull/6380) Bump go to v1.22.
50+
* [\#7223](https://github.com/cosmos/ibc-go/pull/7223) Update ics23 to v0.11.0.
4751

4852
### API Breaking
4953

@@ -60,35 +64,6 @@ Ref: https://keepachangelog.com/en/1.0.0/
6064
* (capability) [\#7279](https://github.com/cosmos/ibc-go/pull/7279) The module `capability` has been removed.
6165
* (testing) [\#7305](https://github.com/cosmos/ibc-go/pull/7305) Added `TrustedValidators` map to `TestChain`. This removes the dependency on the `x/staking` module for retrieving trusted validator sets at a given height, and removes the `GetTrustedValidators` method from the `TestChain` struct.
6266
* (23-commitment) [\#7486](https://github.com/cosmos/ibc-go/pull/7486) Remove unimplemented `BatchVerifyMembership` and `BatchVerifyNonMembership` functions
63-
64-
### State Machine Breaking
65-
66-
### Improvements
67-
68-
* (testing)[\#7430](https://github.com/cosmos/ibc-go/pull/7430) Update the block proposer in test chains for each block.
69-
70-
### Features
71-
72-
* (apps/transfer) [\#7650](https://github.com/cosmos/ibc-go/pull/7650) Add support for transfer of entire balance for vesting accounts
73-
74-
### Bug Fixes
75-
76-
* (apps/27-interchain-accounts) [\#7277](https://github.com/cosmos/ibc-go/pull/7277) Use `GogoResolver` when populating module query safe allow list to avoid panics from unresolvable protobuf dependencies.
77-
* (core/04-channel) [\#7342](https://github.com/cosmos/ibc-go/pull/7342) Read Tx cmd flags including from address to avoid Address cannot be empty error when upgrade-channels via cli.
78-
* (core/03-connection) [\#7397](https://github.com/cosmos/ibc-go/pull/7397) Skip the genesis validation connectionID for localhost client.
79-
80-
## [v9.0.0](https://github.com/cosmos/ibc-go/releases/tag/v9.0.0) - 2024-10-01
81-
82-
### Dependencies
83-
84-
* [\#6828](https://github.com/cosmos/ibc-go/pull/6828) Bump Cosmos SDK to v0.50.9.
85-
* [\#6193](https://github.com/cosmos/ibc-go/pull/6193) Bump `cosmossdk.io/store` to v1.1.0.
86-
* [\#7126](https://github.com/cosmos/ibc-go/pull/7126) Bump CometBFT to v0.38.11.
87-
* [\#6380](https://github.com/cosmos/ibc-go/pull/6380) Bump go to v1.22.
88-
* [\#7223](https://github.com/cosmos/ibc-go/pull/7223) Update ics23 to v0.11.0.
89-
90-
### API Breaking
91-
9267
* (core/02-client, light-clients) [\#5806](https://github.com/cosmos/ibc-go/pull/5806) Decouple light client routing from their encoding structure.
9368
* (core/04-channel) [\#5991](https://github.com/cosmos/ibc-go/pull/5991) The client CLI `QueryLatestConsensusState` has been removed.
9469
* (light-clients/06-solomachine) [\#6037](https://github.com/cosmos/ibc-go/pull/6037) Remove `Initialize` function from `ClientState` and move logic to `Initialize` function of `LightClientModule`.
@@ -121,18 +96,22 @@ Ref: https://keepachangelog.com/en/1.0.0/
12196

12297
### Improvements
12398

99+
* (testing)[\#7430](https://github.com/cosmos/ibc-go/pull/7430) Update the block proposer in test chains for each block.
124100
* (apps/27-interchain-accounts) [\#5533](https://github.com/cosmos/ibc-go/pull/5533) ICA host sets the host connection ID on `OnChanOpenTry`, so that ICA controller implementations are not obliged to set the value on `OnChanOpenInit` if they are not able.
125101
* (core/02-client, core/03-connection, apps/27-interchain-accounts) [\#6256](https://github.com/cosmos/ibc-go/pull/6256) Add length checking of array fields in messages.
126102

127103
### Features
128104

129-
* (apps/transfer) [\#6492](https://github.com/cosmos/ibc-go/pull/6492) Added new `Tokens` field to `MsgTransfer` to enable sending of multiple denoms, and deprecated the `Token` field.
130-
* (apps/transfer) [\#6693](https://github.com/cosmos/ibc-go/pull/6693) Added new `Forwarding` field to `MsgTransfer` to enable forwarding tokens through multiple intermediary chains with a single transaction. This also enables automatic unwinding of tokens to their native chain. `x/authz` support for transfer allows granters to specify a set of possible forwarding hops that are allowed for grantees.
105+
* (apps/transfer) [\#7650](https://github.com/cosmos/ibc-go/pull/7650) Add support for transfer of entire balance for vesting accounts
131106

132107
### Bug Fixes
133108

109+
* (apps/27-interchain-accounts) [\#7277](https://github.com/cosmos/ibc-go/pull/7277) Use `GogoResolver` when populating module query safe allow list to avoid panics from unresolvable protobuf dependencies.
110+
* (core/04-channel) [\#7342](https://github.com/cosmos/ibc-go/pull/7342) Read Tx cmd flags including from address to avoid Address cannot be empty error when upgrade-channels via cli.
111+
* (core/03-connection) [\#7397](https://github.com/cosmos/ibc-go/pull/7397) Skip the genesis validation connectionID for localhost client.
134112
* (apps/27-interchain-accounts) [\#6377](https://github.com/cosmos/ibc-go/pull/6377) Generate ICA simtest proposals only for provided keepers.
135113

114+
136115
## [v8.5.0](https://github.com/cosmos/ibc-go/releases/tag/v8.5.0) - 2024-08-30
137116

138117
### Dependencies

CONTRIBUTING.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Contributing to this repository can mean many things such as participating in di
1414

1515
If you find that something is not working as expected, please open an issue using the [bug report template](https://github.com/cosmos/ibc-go/blob/main/.github/ISSUE_TEMPLATE/bug-report.md) and provide as much information possible: how can the bug be reproduced? What's the expected behavior? What version is affected?
1616

17+
This is also true if you plan to fix the bug yourself and submit a PR. As a general rule, we want contributing pull requests to reference an existing issue. See [Submitting pull requests](#submitting-pull-requests)
18+
1719
### Proposing improvements or new features
1820

1921
New features or improvements should be written in an issue using the [new feature template](https://github.com/cosmos/ibc-go/blob/main/.github/ISSUE_TEMPLATE/feature-request.md). Please include in the issue as many details as possible: what use case(s) would this new feature or improvement enable? Why are those use cases important or helpful? what user group would benefit? The team will evaluate and engage with you in a discussion of the proposal, which could have different outcomes:
@@ -23,6 +25,8 @@ New features or improvements should be written in an issue using the [new featur
2325
- discarding the suggestion if deemed not aligned with the objectives of ibc-go;
2426
- or proposing (in the case of applications or light clients) to be developed and maintained in a separate repository.
2527

28+
Unless the change is a minor bug fix with minor code changes, and you want to submit a pull request, please make sure to write a Github issue for it before opening the pull request.
29+
2630
### Architecture Decision Records (ADR)
2731

2832
When proposing an architecture decision for the ibc-go, please create an [ADR](./docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed implementation. Please use the [ADR template](./docs/architecture/adr.template.md) to scaffold any new ADR. If you would like to see some examples of how these are written refer to ibc-go's [ADRs](./docs/architecture/). ADRs are solidified designs that will be implemented in ibc-go (and do not have a spec). They should document the architecture that will be built. Most design feedback should be gathered before the initial draft of the ADR. ADR's can/should be written for any design decisions we make which may be changed at some point in the future.
@@ -33,7 +37,10 @@ New features or improvements are sometimes also debated in [discussions](https:/
3337

3438
### Submitting pull requests
3539

36-
Unless you feel confident your change will be accepted (trivial bug fixes, code cleanup, etc) you should first create an issue to discuss your change with us. This lets us all discuss the design and proposed implementation of your change, which helps ensure your time is well spent and that your contribution will be accepted.
40+
Before opening a pull request, make sure there is an accompanying issue that has been assigned to you.
41+
In the case of smaller changes, opening a pull request without being assigned to the issue **can** be accepted, but to avoid having to redesign or discard your work due to the change no longer being needed, asking to be assigned to the issue is the safest course of action. We welcome contributors, but we have put in place these guidelines to safeguard the time of both external and core contributors.
42+
43+
Unless you feel confident your change will be accepted (see [Unwanted pull requests](#unwanted-pull-requests)) you should first create an issue to discuss your change with us. This lets us all discuss the design and proposed implementation of your change, which helps ensure your time is well spent and that your contribution will be accepted.
3744

3845
Looking for a good place to start contributing? The issue tracker is always the first place to go. Issues are triaged to categorize them:
3946

@@ -52,9 +59,13 @@ If you would like to contribute, follow this process:
5259

5360
Please make sure to check out our [Pull request guidelines](./docs/dev/pull-requests.md) for more information.
5461

55-
> Note: At this time, we will not be accepting contributions that only fix spelling
56-
> or grammar errors in documentation, code or elsewhere. The repository has a nightly job that
57-
> spell checks all files and will automatically open PRs for any spelling errors.
62+
#### Unwanted pull requests
63+
64+
To ensure the core maintainers time are spent well, we have certain pull requests we want to avoid:
65+
66+
- Any non-minor pull requests without an **assigned** issue
67+
- Any non-minor bug fixes without an issue (ideally, also assigned, but we are less strict on this)
68+
- Spelling mistakes/changes (instead, try to fix our CI so that it would be able to catch it automatically - that would be useful)
5869

5970
## Relevant development docs
6071

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For the latest expected release timelines, please check [here](https://github.co
4949

5050
## Releases
5151

52-
The release lines currently supported are v7, v8 and v9.
52+
The release lines currently supported are v7, and v8 (Note: v9 has been retracted and will be replaced by v10).
5353

5454
Please refer to the [Stable Release Policy section of RELEASES.md](https://github.com/cosmos/ibc-go/blob/main/RELEASES.md#stable-release-policy) for more details.
5555

RELEASES.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ When bumping the dependencies of [Cosmos SDK](https://github.com/cosmos/cosmos-s
1717

1818
[ibc-go](https://github.com/cosmos/ibc-go) and the [IBC protocol specification](https://github.com/cosmos/ibc) maintain different versions. Furthermore, ibc-go serves several different user groups (chains, IBC app developers, relayers, IBC light client developers). Each of these groups has different expectations of what *backwards compatible* means. It simply isn't possible to categorize a change as backwards or non backwards compatible for all user groups. We are primarily interested in when our API breaks and when changes are state machine breaking (thus requiring a coordinated upgrade). This is scoping the meaning of ibc-go to that of those interacting with the code (IBC app developers, relayers, IBC light client developers), not chains using IBC to communicate (that should be encapsulated by the IBC protocol specification versioning).
1919

20-
To summarize: **All our ibc-go releases allow chains to communicate successfully with any chain running any version of our code**. That is to say, we are still using IBC protocol specification v1.0.
21-
22-
We ensure all major releases are supported by relayers ([hermes](https://github.com/informalsystems/ibc-rs), [rly](https://github.com/cosmos/relayer) and [ts-relayer](https://github.com/confio/ts-relayer) at the moment) which can relay between the new major release and older releases. We have no plans of upgrading to an IBC protocol specification v2.0, as this would be very disruptive to the ecosystem.
20+
To summarize: **All our ibc-go releases allow chains to communicate successfully with any chain running any version of our code**. That is to say, we are still using IBC protocol specification v1.0 (v10 will also include support for the IBC protocol specification v2.0 - also called IBC Eureka)
2321

2422
## Release cycle
2523

@@ -78,7 +76,6 @@ We reserve the right to drop support for releases if they are deemed unused (for
7876
|`v7.8.x`|March 17, 2025|
7977
|`v8.4.x`|May 10, 2025|
8078
|`v8.5.x`|May 10, 2025|
81-
|`v9.0.x`|October 1, 2025|
8279

8380
### Callbacks middleware
8481

@@ -134,7 +131,6 @@ Versions of Golang, Cosmos SDK and CometBFT used by ibc-go in the currently acti
134131
| 1.19 | v7.8.0 | v0.47.13 | v0.37.5 |
135132
| 1.21 | v8.4.0 | v0.50.7 | v0.38.7 |
136133
| 1.21 | v8.5.0 | v0.50.9 | v0.38.11 |
137-
| 1.22 | v9.0.0 | v0.50.9 | v0.38.11 |
138134

139135
### Callbacks middleware
140136

docs/docusaurus.config.js

+1-5
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,13 @@ const config = {
4949
// Exclude template markdown files from the docs
5050
exclude: ["**/*.template.md"],
5151
// Select the latest version
52-
lastVersion: "v9.0.x",
52+
lastVersion: "v8.5.x",
5353
// Assign banners to specific versions
5454
versions: {
5555
current: {
5656
path: "main",
5757
banner: "unreleased",
5858
},
59-
"v9.0.x": {
60-
path: "v9",
61-
banner: "none",
62-
},
6359
"v8.5.x": {
6460
path: "v8",
6561
banner: "none",

docs/versioned_sidebars/version-v9.0.x-sidebars.json

-40
This file was deleted.

docs/versions.json

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[
2-
"v9.0.x",
32
"v8.5.x",
43
"v7.8.x",
54
"v6.3.x",

e2e/ci-e2e-config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ upgrades:
5959
tag: "v8.0.0"
6060
- planName: "v8.1"
6161
tag: "v8.1.0"
62-
- planName: "v9"
63-
tag: "v9.0.0"
62+
- planName: "v10"
63+
tag: "v10.0.0-beta.0"
6464
- planName: "ibcwasm-v8"
6565
tag: "v8.0.0-e2e-upgrade"

e2e/sample.config.extended.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ upgrades:
6464
tag: "v8.0.0"
6565
- planName: "v8.1"
6666
tag: "v8.1.0"
67-
- planName: "v9"
68-
tag: "v9.0.0"
67+
- planName: "v10"
68+
tag: "v10.0.0"
6969
- planName: "ibcwasm-v8"
7070
tag: "v8.0.0-e2e-upgrade"

e2e/tests/core/02-client/client_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ func (s *ClientTestSuite) QueryAllowedClients(ctx context.Context, chain ibc.Cha
6262
}
6363

6464
// TestScheduleIBCUpgrade_Succeeds tests that a governance proposal to schedule an IBC software upgrade is successful.
65-
// compatibility:TestScheduleIBCUpgrade_Succeeds:from_versions: v8.4.0,v8.5.0,v9.0.0
65+
// compatibility:TestScheduleIBCUpgrade_Succeeds:from_versions: v8.4.0,v8.5.0,v10.0.0
6666
func (s *ClientTestSuite) TestScheduleIBCUpgrade_Succeeds() {
6767
t := s.T()
6868
ctx := context.TODO()
@@ -134,7 +134,7 @@ func (s *ClientTestSuite) TestScheduleIBCUpgrade_Succeeds() {
134134
}
135135

136136
// TestRecoverClient_Succeeds tests that a governance proposal to recover a client using a MsgRecoverClient is successful.
137-
// compatibility:TestRecoverClient_Succeeds:from_versions: v8.4.0,v8.5.0,v9.0.0
137+
// compatibility:TestRecoverClient_Succeeds:from_versions: v8.4.0,v8.5.0,v10.0.0
138138
func (s *ClientTestSuite) TestRecoverClient_Succeeds() {
139139
t := s.T()
140140
ctx := context.TODO()

e2e/tests/interchain_accounts/base_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func (s *InterchainAccountsTestSuite) TestMsgSendTx_SuccessfulTransfer() {
5555
s.testMsgSendTxSuccessfulTransfer(channeltypes.ORDERED)
5656
}
5757

58-
// compatibility:TestMsgSendTx_SuccessfulTransfer_UnorderedChannel:from_versions: v7.5.0,v7.6.0,v7.7.0,v7.8.0,v8.4.0,v8.5.0,v9.0.0
58+
// compatibility:TestMsgSendTx_SuccessfulTransfer_UnorderedChannel:from_versions: v7.5.0,v7.6.0,v7.7.0,v7.8.0,v8.4.0,v8.5.0,v10.0.0
5959
func (s *InterchainAccountsTestSuite) TestMsgSendTx_SuccessfulTransfer_UnorderedChannel() {
6060
s.testMsgSendTxSuccessfulTransfer(channeltypes.UNORDERED)
6161
}

e2e/tests/interchain_accounts/localhost_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type LocalhostInterchainAccountsTestSuite struct {
3939
testsuite.E2ETestSuite
4040
}
4141

42-
// compatibility:TestInterchainAccounts_Localhost:from_versions: v7.4.0,v7.5.0,v7.6.0,v7.7.0,v7.8.0,v8.4.0,v8.5.0,v9.0.0
42+
// compatibility:TestInterchainAccounts_Localhost:from_versions: v7.4.0,v7.5.0,v7.6.0,v7.7.0,v7.8.0,v8.4.0,v8.5.0,v10.0.0
4343
func (s *LocalhostInterchainAccountsTestSuite) TestInterchainAccounts_Localhost() {
4444
t := s.T()
4545
ctx := context.TODO()

e2e/tests/interchain_accounts/params_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ func (s *InterchainAccountsParamsTestSuite) TestControllerEnabledParam() {
112112
})
113113
}
114114

115-
// compatibility:TestHostEnabledParam:from_versions: v9.0.0,v8.4.0,v7.5.0
115+
// compatibility:TestHostEnabledParam:from_versions: v10.0.0,v8.4.0,v7.5.0
116116
func (s *InterchainAccountsParamsTestSuite) TestHostEnabledParam() {
117117
t := s.T()
118118
ctx := context.TODO()

0 commit comments

Comments
 (0)