Skip to content

api!: rename path to merkle path for contract api json msgs #6923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damiannolan merged 5 commits into from
Jul 25, 2024
Merged

api!: rename path to merkle path for contract api json msgs #6923

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c5ecb29
api! rename path to merkle path in contract api json msgs
damiannolan Jul 23, 2024
545572f
chore: add retract
damiannolan Jul 23, 2024
dc1e1c8
chore: add changelog
damiannolan Jul 23, 2024
69594d3
chore: update retractions doc
damiannolan Jul 24, 2024
2bfcc14
chore: additional retraction
damiannolan Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions modules/light-clients/08-wasm/CHANGELOG.md
View file
Open in desktop
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
2 changes: 2 additions & 0 deletions modules/light-clients/08-wasm/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ module github.com/cosmos/ibc-go/modules/light-clients/08-wasm
go 1.21

retract (
// explicitly break api for client contracts
Copy link
Copy Markdown
Contributor

@crodriguezvega crodriguezvega Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe something more explicit? rename field of JSON-encoded verify messages from path to merlke_path, or something like that.

Copy link
Copy Markdown
Contributor Author

@damiannolan damiannolan Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated with a more informative godoc message. Let me know what you think

v0.3.1-0.20240717085919-bb71eef0f3bf
// use MerklePath type with []string for KeyPath in contract API messages
v0.2.1-0.20240523101951-4b45d1822fb6
v0.1.2-0.20240412103620-7ee2a2452b79
Expand Down
4 changes: 2 additions & 2 deletions modules/light-clients/08-wasm/types/contract_api.go
View file
Open in desktop
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