Skip to content

Commit

Permalink
docs: amend docs for 08 wasm releases (#7002)
Browse files Browse the repository at this point in the history 
* docs: amend docs best to my knowledge.

* chore: add commits to compat matrix
  • Loading branch information
@DimitrisJim
DimitrisJim authored Jul 31, 2024
1 parent e9a8518 commit 1a5ccdd
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 15 deletions.
8 changes: 4 additions & 4 deletions RELEASES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ We reserve the right to drop support for releases if they are deemed unused (for

|Release|End of Life Date|
|-------|----------------|
|`v0.3.0+ibc-go-v7.3.x-wasmvm-v1.5.x`|September 17, 2024|
|`v0.4.x+ibc-go-v8.3.x-wasmvm-v2.0.x`|May 10, 2025|
|`v0.3.x+ibc-go-v7.4.x-wasmvm-v1.5.x`|September 17, 2024|
|`v0.4.x+ibc-go-v8.4.x-wasmvm-v2.0.x`|May 10, 2025|

### What pull requests will be included in stable patch-releases?

Expand Down Expand Up @@ -145,8 +145,8 @@ Versions of Golang, ibc-go, Cosmos SDK and CometBFT used by `08-wasm` module in

| Go | callbacks | ibc-go | Cosmos SDK | Tendermint/CometBFT |
|----|-----------|--------|------------|---------------------|
| 1.19 | v0.3.0+ibc-go-v7.3-wasmvm-v1.5 | v7.3.0 | v0.47.6 | v0.37.2 |
| 1.21 | v0.4.0+ibc-go-v8.3-wasmvm-v2.0 | v8.3.0 | v0.50.6 | v0.38.9 |
| 1.19 | v0.3.1+ibc-go-v7.4-wasmvm-v1.5 | v7.4.0 | v0.47.8 | v0.37.4 |
| 1.21 | v0.4.1+ibc-go-v8.4-wasmvm-v2.0 | v8.4.0 | v0.50.7 | v0.38.9 |

## Graphics

Expand Down
6 changes: 2 additions & 4 deletions docs/docs/03-light-clients/04-wasm/03-integration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@ The following table shows the compatibility matrix between the `08-wasm` module,

| **Version** | **Git commit to import** |
|:--------------------------------:|:----------------------------------------:|
| `v0.2.0+ibc-go-v8.3-wasmvm-v2.0` | 4b45d1822fb6a0698e7621112b92c13679061c40 |
| `v0.1.1+ibc-go-v7.3-wasmvm-v1.5` | 7ee2a2452b79d0bc8316dc622a1243afa058e8cb |
| `v0.1.0+ibc-go-v8.0-wasmvm-v1.5` | 57fcdb9a9a9db9b206f7df2f955866dc4e10fef4 |
| `v0.1.0+ibc-go-v7.3-wasmvm-v1.5` | b306e7a706e1f84a5e11af0540987bd68de9bae5 |
| `v0.4.1+ibc-go-v8.4-wasmvm-v2.0` | ccd4dc278e720be87418028026ebd93a80fa5ac0 |
| `v0.3.1+ibc-go-v7.4-wasmvm-v1.5` | 13c071f0b34d67342f0b7a8874d84d2e68b887e1 |

## `app.go` setup

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/03-light-clients/04-wasm/09-migrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ v0.1.1-0.20231213092650-57fcdb9a9a9d => v0.1.0+ibc-go-v8.0-wasmvm-v1.5
v0.1.1-0.20231213092633-b306e7a706e1 => v0.1.0+ibc-go-v7.3-wasmvm-v1.5
```

## From ibc-go v8.3.x to ibc-go v9.0.x
## From ibc-go v8.4.x to ibc-go v9.0.x

### Chains

Expand All @@ -39,7 +39,7 @@ v0.1.1-0.20231213092633-b306e7a706e1 => v0.1.0+ibc-go-v7.3-wasmvm-v1.5
- The `WithQueryPlugins` function signature has changed to take in the `QueryPlugins` type from the `keeper` package (previously from the `types` package).
- The `VMGasRegister` variable has been moved from the `types` package to the `keeper` package.

## From v0.3.0+ibc-go-v8.3-wasmvm-v2.0 to v0.4.0-ibc-go-v8.3-wasmvm-v2.0
## From v0.3.0+ibc-go-v8.3-wasmvm-v2.0 to v0.4.1-ibc-go-v8.4-wasmvm-v2.0

### Contract developers

Expand All @@ -48,7 +48,7 @@ The `path` field on both JSON API messages has been renamed to `merkle_path`.

A migration is required for existing 08-wasm client contracts in order to correctly handle the deserialisation of these fields.

## From v0.2.0+ibc-go-v7.3-wasmvm-v1.5 to v0.3.0-ibc-go-v7.3-wasmvm-v1.5
## From v0.2.0+ibc-go-v7.3-wasmvm-v1.5 to v0.3.1-ibc-go-v7.4-wasmvm-v1.5

### Contract developers

Expand Down
14 changes: 10 additions & 4 deletions modules/light-clients/08-wasm/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ Ref: https://keepachangelog.com/en/1.0.0/

### API Breaking

* [\#6923](https://github.com/cosmos/ibc-go/pull/6923) The JSON msg API for `VerifyMembershipMsg` and `VerifyNonMembershipMsg` payloads for client contract `SudoMsg` has been updated. The field `path` has been changed to `merkle_path`. This change requires updates to 08-wasm client contracts for integration.

### State Machine Breaking

### Improvements
Expand All @@ -53,7 +51,11 @@ Ref: https://keepachangelog.com/en/1.0.0/
### Bug Fixes

<!-- markdown-link-check-disable-next-line -->
## [v0.4.0+ibc-go-v8.3-wasmvm-v2.0](https://github.com/cosmos/ibc-go/releases/tag/modules%2Flight-clients%2F08-wasm%2Fv0.4.0%2Bibc-go-v8.3-wasmvm-v2.0) - 2024-07-29
## [v0.4.1+ibc-go-v8.4-wasmvm-v2.0](https://github.com/cosmos/ibc-go/releases/tag/modules%2Flight-clients%2F08-wasm%2Fv0.4.1%2Bibc-go-v8.4-wasmvm-v2.0) - 2024-07-31

### Dependencies

* [\#6992](https://github.com/cosmos/ibc-go/pull/6992) Bump ibc-go to v8.4.0 and CosmosSDK to v0.50.7.

### API Breaking

Expand Down Expand Up @@ -83,7 +85,11 @@ Ref: https://keepachangelog.com/en/1.0.0/
* [\#6815](https://github.com/cosmos/ibc-go/pull/6815) Decode to bytes the hex-encoded checksum argument of the `migrate-contract` CLI.

<!-- markdown-link-check-disable-next-line -->
## [v0.3.0+ibc-go-v7.3-wasmvm-v1.5](https://github.com/cosmos/ibc-go/releases/tag/modules%2Flight-clients%2F08-wasm%2Fv0.3.0%2Bibc-go-v7.3-wasmvm-v1.5) - 2024-07-29
## [v0.3.1+ibc-go-v7.4-wasmvm-v1.5](https://github.com/cosmos/ibc-go/releases/tag/modules%2Flight-clients%2F08-wasm%2Fv0.3.1%2Bibc-go-v7.4-wasmvm-v1.5) - 2024-07-31

### Dependencies

* [\#6996](https://github.com/cosmos/ibc-go/pull/6992) Bump ibc-go to v7.4.0, CosmosSDK to v0.47.8 and CometBFT to v0.37.4.

### API Breaking

Expand Down

0 comments on commit 1a5ccdd

Please sign in to comment.