Skip to content
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.

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

change provwasm stargate query plugin to use protocodec #2034

Merged
merged 9 commits into from
Jun 20, 2024

Conversation

kwtalley
Copy link
Contributor

@kwtalley kwtalley commented Jun 14, 2024

Description

This PR changes the codec for wasm Stargate (proto based) queries to use the protocodec. This gets around the issue of Any type messages returned from a wasm query missing their type information, thus breaking the deserialization to the contract level.


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.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Summary by CodeRabbit

  • New Features

    • Upgraded the supported contract capabilities version on the chain from cosmwasm_1_1 to cosmwasm_1_4.
  • Enhancements

    • Improved codec handling for query plugins, enhancing compatibility and performance.
    • Introduced WasmInterfaceRegistry for advanced protocol buffer message handling.

@kwtalley kwtalley added the wasm label Jun 14, 2024
@kwtalley kwtalley self-assigned this Jun 14, 2024
@kwtalley kwtalley requested a review from a team as a code owner June 14, 2024 07:39
Copy link
Contributor

coderabbitai bot commented Jun 14, 2024

Walkthrough

The recent changes involve enhancing the ProV-WASM codebase to support a new codec type (protoCdc) and updating interface registries. Additionally, the supported features for contracts within the chain have been updated to support cosmwasm_1_4. Key updates include modifications to the QueryPlugins function and the addition of new structures and methods to handle protocol buffer messages.

Changes

File Change Summary
internal/provwasm/query_plugins.go Updated QueryPlugins function for new codec handling (protoCdc), added stargateCdc variable and import.
x/wasm/types/any.go, x/wasm/types/interface_registry.go Introduced WasmAny type methods and WasmInterfaceRegistry struct implementing protocol buffer handling.
app/app.go Updated supported features for contracts from cosmwasm_1_1 to cosmwasm_1_4.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Codec

    User ->> App: Query Plugins
    App ->> Codec: Initialize protoCdc
    Codec -->> App: Return protoCdc
    App ->> App: Create stargateCdc using protoCdc
    App ->> User: Return Plugins (including Stargate with stargateCdc)
Loading

Poem

In bytes and code, we danced anew,
With protobufs in stargate's view,
From cosmwasm_1_1 we took our flight,
To 1_4, the future's bright.
Code embraced the changing tide,
Now in harmony, we stride.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2058ec2 and bf6e8da.

Files selected for processing (3)
  • internal/provwasm/query_plugins.go (2 hunks)
  • x/wasm/types/any.go (1 hunks)
  • x/wasm/types/interface_registry.go (1 hunks)
Files not reviewed due to errors (3)
  • x/wasm/types/any.go (Error: Server error. Please try again later.)
  • x/wasm/types/interface_registry.go (Error: Server error. Please try again later.)
  • internal/provwasm/query_plugins.go (Error: Server error. Please try again later.)
Additional context used
GitHub Check: golangci-lint
x/wasm/types/any.go

[failure] 11-11:
var-naming: don't use underscores in Go names; method XXX_WellKnownType should be XXXWellKnownType (revive)

x/wasm/types/interface_registry.go

[failure] 22-22:
unused-parameter: parameter 'typeUrl' seems to be unused, consider removing or renaming it as _ (revive)

Taztingo
Taztingo previously approved these changes Jun 14, 2024
@kwtalley kwtalley dismissed stale reviews from Taztingo and nullpointer0x00 via 4abb827 June 14, 2024 18:17
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bf6e8da and 4abb827.

Files selected for processing (1)
  • x/wasm/types/interface_registry.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/wasm/types/interface_registry.go

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4abb827 and 613b511.

Files selected for processing (1)
  • x/wasm/types/interface_registry.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/wasm/types/interface_registry.go

SpicyLemon
SpicyLemon previously approved these changes Jun 14, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 613b511 and 154de11.

Files selected for processing (1)
  • app/app.go (1 hunks)
Additional comments not posted (1)
app/app.go (1)

652-652: Update to cosmwasm_1_4 in supportedFeatures reflects newer capabilities for contracts.

@iramiller
Copy link
Member

The XXX_ linter error needs an annotation to ignore it so the check will pass given this is standard naming convention within the generate protocol code.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 154de11 and cfb3ac0.

Files selected for processing (1)
  • app/app.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/app.go

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cfb3ac0 and d8f95b5.

Files selected for processing (2)
  • internal/provwasm/query_plugins.go (2 hunks)
  • x/wasm/types/any.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • internal/provwasm/query_plugins.go
  • x/wasm/types/any.go

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d8f95b5 and 0ef12d2.

Files selected for processing (1)
  • app/app.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/app.go

@kwtalley kwtalley merged commit 9f62c9a into main Jun 20, 2024
31 checks passed
@kwtalley kwtalley deleted the kwtalley/serde-any-fix branch June 20, 2024 21:36
@SpicyLemon SpicyLemon added this to the v1.19.0 milestone Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

5 participants