feat: add custom queries to wasm module #5261

aeryz · 2023-11-30T08:39:51Z

Description

Adds custom query support to the wasm client module, see the issue for more details.

closes: #5192

Commit Message / Changelog Entry

type: commit message

see the guidelines for commit messages. (view raw markdown for examples)

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md).
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards and Go style guide.
Wrote unit and integration tests.
Updated relevant documentation (docs/) or specification (x/<module>/spec/).
Added relevant godoc comments.
Provide a commit message to be used for the changelog entry in the PR description for review.
Re-reviewed Files changed in the Github PR explorer.
Review Codecov Report in the comment section below once CI passes.

Signed-off-by: aeryz <abdullaheryz@protonmail.com>

modules/light-clients/08-wasm/types/client_state_test.go

modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go

Signed-off-by: aeryz <abdullaheryz@protonmail.com>

damiannolan

Looks great @aeryz, thank you so much! 🙏🏻

Once there's consensus on the interface usage (which looks like there is) we can remove the duplicated interface! Will drop an approval then 🚀

edit: also happy to collaborate on this branch to help push things over the line

modules/light-clients/08-wasm/internal/ibcwasm/wasm.go

modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go

aeryz · 2023-11-30T18:16:04Z

Looks great @aeryz, thank you so much! 🙏🏻

Once there's consensus on the interface usage (which looks like there is) we can remove the duplicated interface! Will drop an approval then 🚀

edit: also happy to collaborate on this branch to help push things over the line

Hey, thanks! Please go ahead :)

crodriguezvega · 2023-11-30T18:44:59Z

modules/light-clients/08-wasm/internal/ibcwasm/wasm.go

@@ -32,6 +34,16 @@ func GetVM() WasmEngine {
 	return vm
 }

+// SetQuerier sets the custom wasm query handle for the 08-wasm module.
+func SetQuerier(wasmQuerier WasmQuerier) {
+	querier = wasmQuerier


Simon from Confio has warned us against nil queriers and they will not be allowed in the future, so it would be good to add a check here that wasmQuerier is not nil and also in NewKeeperWithVM, just as we do now for the vm.

That makes sense but also, isn't it a better API for end users to pass nil to NewKeeperWithVM and in the setter function, do:

if wasmQuerier == nil { querier = defaultQuerier // or noop or error, etc. }

This way we could hide the default type and users won't have to give that to the NewKeeperWithVM function.

Oh, basically this comment. Sorry lol: #5261 (comment)

modules/light-clients/08-wasm/internal/ibcwasm/wasm.go

DimitrisJim

dropping my approval here. I think it might be best to do #5281 afterwards, considering additional testing that should be added. Feel free to override if anyone wants to push it in on this branch.

DimitrisJim

Ack changes, beautiful @crodriguezvega!

damiannolan

LGTM! Thanks everyone for their input and @aeryz for opening the initial issue and PR ❤️

* feat: add custom queries to wasm module Signed-off-by: aeryz <abdullaheryz@protonmail.com> * linter stuff as per usual. * review comments Signed-off-by: aeryz <abdullaheryz@protonmail.com> * lint Signed-off-by: aeryz <abdullaheryz@protonmail.com> * Use wasmvm.Querier. * Lint this bad boy * Small test nits. * add default querier and update documentation --------- Signed-off-by: aeryz <abdullaheryz@protonmail.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 7016a94) # Conflicts: # docs/docs/03-light-clients/04-wasm/03-integration.md # docs/docs/03-light-clients/04-wasm/05-governance.md # modules/light-clients/08-wasm/internal/ibcwasm/wasm.go # modules/light-clients/08-wasm/keeper/keeper.go # modules/light-clients/08-wasm/keeper/keeper_test.go # modules/light-clients/08-wasm/testing/simapp/app.go

* feat: add custom queries to wasm module Signed-off-by: aeryz <abdullaheryz@protonmail.com> * linter stuff as per usual. * review comments Signed-off-by: aeryz <abdullaheryz@protonmail.com> * lint Signed-off-by: aeryz <abdullaheryz@protonmail.com> * Use wasmvm.Querier. * Lint this bad boy * Small test nits. * add default querier and update documentation --------- Signed-off-by: aeryz <abdullaheryz@protonmail.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 7016a94)

* feat: add custom queries to wasm module (#5261) * feat: add custom queries to wasm module Signed-off-by: aeryz <abdullaheryz@protonmail.com> * linter stuff as per usual. * review comments Signed-off-by: aeryz <abdullaheryz@protonmail.com> * lint Signed-off-by: aeryz <abdullaheryz@protonmail.com> * Use wasmvm.Querier. * Lint this bad boy * Small test nits. * add default querier and update documentation --------- Signed-off-by: aeryz <abdullaheryz@protonmail.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 7016a94) # Conflicts: # docs/docs/03-light-clients/04-wasm/03-integration.md # docs/docs/03-light-clients/04-wasm/05-governance.md # modules/light-clients/08-wasm/internal/ibcwasm/wasm.go # modules/light-clients/08-wasm/keeper/keeper.go # modules/light-clients/08-wasm/keeper/keeper_test.go # modules/light-clients/08-wasm/testing/simapp/app.go * rm docs * Fix conflicts. * Update wasm.go * gofumpt --------- Co-authored-by: Abdullah Eryuzlu <24809834+aeryz@users.noreply.github.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* feat: add custom queries to wasm module Signed-off-by: aeryz <abdullaheryz@protonmail.com> * linter stuff as per usual. * review comments Signed-off-by: aeryz <abdullaheryz@protonmail.com> * lint Signed-off-by: aeryz <abdullaheryz@protonmail.com> * Use wasmvm.Querier. * Lint this bad boy * Small test nits. * add default querier and update documentation --------- Signed-off-by: aeryz <abdullaheryz@protonmail.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 7016a94) Co-authored-by: Abdullah Eryuzlu <24809834+aeryz@users.noreply.github.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* feat: add custom queries to wasm module Signed-off-by: aeryz <abdullaheryz@protonmail.com> * linter stuff as per usual. * review comments Signed-off-by: aeryz <abdullaheryz@protonmail.com> * lint Signed-off-by: aeryz <abdullaheryz@protonmail.com> * Use wasmvm.Querier. * Lint this bad boy * Small test nits. * add default querier and update documentation --------- Signed-off-by: aeryz <abdullaheryz@protonmail.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

feat: add custom queries to wasm module

e548d6b

Signed-off-by: aeryz <abdullaheryz@protonmail.com>

aeryz requested review from colin-axner, AdityaSripal, damiannolan, charleenfei, chatton, DimitrisJim and srdtrk as code owners November 30, 2023 08:39

github-actions bot added the 08-wasm label Nov 30, 2023

linter stuff as per usual.

75d7a9c

DimitrisJim reviewed Nov 30, 2023

View reviewed changes

modules/light-clients/08-wasm/types/client_state_test.go Outdated Show resolved Hide resolved

DimitrisJim reviewed Nov 30, 2023

View reviewed changes

modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go Outdated Show resolved Hide resolved

crodriguezvega added priority PRs that need prompt reviews backport-wasm-v0.1.x+ibc-go-v7.3.x-wasmvm-v1.5.x labels Nov 30, 2023

crodriguezvega and others added 3 commits November 30, 2023 12:37

Merge branch 'main' into feat/wasm-custom-queries

7dc57e9

review comments

6ae37b7

Signed-off-by: aeryz <abdullaheryz@protonmail.com>

lint

3c87e16

Signed-off-by: aeryz <abdullaheryz@protonmail.com>

crodriguezvega mentioned this pull request Nov 30, 2023

Replace nil querier with error querier #5281

Closed

3 tasks

Merge branch 'main' into feat/wasm-custom-queries

8d62994

damiannolan reviewed Nov 30, 2023

View reviewed changes

modules/light-clients/08-wasm/internal/ibcwasm/wasm.go Show resolved Hide resolved

modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go Outdated Show resolved Hide resolved

Merge branch 'main' into feat/wasm-custom-queries

827f7cb

crodriguezvega reviewed Nov 30, 2023

View reviewed changes

DimitrisJim added 3 commits November 30, 2023 21:03

Use wasmvm.Querier.

718b01f

Lint this bad boy

e2368bd

Small test nits.

7164508

DimitrisJim approved these changes Nov 30, 2023

View reviewed changes

add default querier and update documentation

d27e469

github-actions bot added the docs Improvements or additions to documentation label Nov 30, 2023

DimitrisJim approved these changes Dec 1, 2023

View reviewed changes

damiannolan approved these changes Dec 1, 2023

View reviewed changes

DimitrisJim merged commit 7016a94 into cosmos:main Dec 1, 2023
63 checks passed

mergify bot mentioned this pull request Dec 1, 2023

feat: add custom queries to wasm module (backport #5261) #5292

Merged

mergify bot mentioned this pull request Dec 1, 2023

feat: add custom queries to wasm module (backport #5261) #5293

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add custom queries to wasm module #5261

feat: add custom queries to wasm module #5261

aeryz commented Nov 30, 2023

damiannolan left a comment •

edited

Loading

aeryz commented Nov 30, 2023

crodriguezvega Nov 30, 2023

aeryz Nov 30, 2023 •

edited

Loading

aeryz Nov 30, 2023

DimitrisJim left a comment

DimitrisJim left a comment

damiannolan left a comment

feat: add custom queries to wasm module #5261

feat: add custom queries to wasm module #5261

Conversation

aeryz commented Nov 30, 2023

Description

Commit Message / Changelog Entry

damiannolan left a comment • edited Loading

Choose a reason for hiding this comment

aeryz commented Nov 30, 2023

crodriguezvega Nov 30, 2023

Choose a reason for hiding this comment

aeryz Nov 30, 2023 • edited Loading

Choose a reason for hiding this comment

aeryz Nov 30, 2023

Choose a reason for hiding this comment

DimitrisJim left a comment

Choose a reason for hiding this comment

DimitrisJim left a comment

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

damiannolan left a comment •

edited

Loading

aeryz Nov 30, 2023 •

edited

Loading