Skip to content

Commit

Permalink
api!: rename path to merkle path for contract api json msgs (#6923)
Browse files Browse the repository at this point in the history
* api! rename path to merkle path in contract api json msgs

* chore: add retract

* chore: add changelog

* chore: update retractions doc

* chore: additional retraction
  • Loading branch information
damiannolan committed Jul 25, 2024
1 parent bb71eef commit 985f266
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
6 changes: 6 additions & 0 deletions modules/light-clients/08-wasm/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ Ref: https://keepachangelog.com/en/1.0.0/

# Changelog

## Unreleased

### 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.

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

Expand Down
6 changes: 5 additions & 1 deletion modules/light-clients/08-wasm/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ module github.com/cosmos/ibc-go/modules/light-clients/08-wasm
go 1.21

retract (
// use MerklePath type with []string for KeyPath in contract API messages
// Note the following releases are retracted and require a migration for deployed 08-wasm client contracts.
// 08-wasm client contracts deployed using the following releases MUST migrate in conjunction with the upgrade from the listed releases.
// For more information please refer to the 08-wasm migrations documentation: https://ibc.cosmos.network/main/ibc/light-clients/wasm/migrations/
v0.3.1-0.20240717085919-bb71eef0f3bf
v0.2.1-0.20240717085554-570d057959e3
v0.2.1-0.20240523101951-4b45d1822fb6
v0.1.2-0.20240412103620-7ee2a2452b79
v0.1.1-0.20231213092650-57fcdb9a9a9d
Expand Down
4 changes: 2 additions & 2 deletions modules/light-clients/08-wasm/types/contract_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ type VerifyMembershipMsg struct {
DelayTimePeriod uint64 `json:"delay_time_period"`
DelayBlockPeriod uint64 `json:"delay_block_period"`
Proof []byte `json:"proof"`
Path internaltypes.MerklePath `json:"path"`
Path internaltypes.MerklePath `json:"merkle_path"`
Value []byte `json:"value"`
}

Expand All @@ -84,7 +84,7 @@ type VerifyNonMembershipMsg struct {
DelayTimePeriod uint64 `json:"delay_time_period"`
DelayBlockPeriod uint64 `json:"delay_block_period"`
Proof []byte `json:"proof"`
Path internaltypes.MerklePath `json:"path"`
Path internaltypes.MerklePath `json:"merkle_path"`
}

// VerifyUpgradeAndUpdateStateMsg is a sudoMsg sent to the contract to verify an upgrade and update its state.
Expand Down

0 comments on commit 985f266

Please sign in to comment.