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

Fix: Add node flag to WASM queries (build-address) #2199

Merged
merged 2 commits into from
Oct 24, 2024

Conversation

SpicyLemon
Copy link
Contributor

@SpicyLemon SpicyLemon commented Oct 24, 2024

This is a recreation of #2194 by GunanshuJoshi, but with signed commits.

Description

This PR adds a new --node flag to support custom endpoints for node connections while making Wasm queries specifically build-address. This update ensures that the provenanced q wasm build-address command works correctly with custom node configurations.

Issue:

While creating the predictable contract address I encountered the following error:

unknown flag: --node

This occurred when running the following command:

provenanced query wasm build-address <code-hash> <creator-address> <salt> --node https://rpc.test.provenance.io:443

It seems the flag is not being recognized properly. I suspect there might be an issue with either the flag registration in the command definition (root.go) or how the CLI parser processes the command.

The main file updated is:

  • cmd/provenanced/cmd/root.go

closes: n/a
I haven't created any particular issue for this change. However, this was discussed on Discord, where it was agreed that the node flag should function correctly.
Reference: Discord conversation.


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 relevant changelog entries under .changelog/unreleased (see Adding Changes).
  • 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

    • Introduced query flags for the query wasm build-addr command, enhancing its functionality and output customization.
    • Added persistent flags for custom denomination and message fee floor price, improving command configurability.
  • Bug Fixes

    • Resolved issues with the "build-address" command under the "query wasm" subcommand, ensuring correct flag recognition and improved error handling.

@SpicyLemon SpicyLemon requested a review from a team as a code owner October 24, 2024 20:53
Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Walkthrough

This pull request introduces enhancements to the query wasm build-addr command by adding query flags, allowing for more configurable command behavior. It also implements a new function, fixQueryWasmBuildAddressFlags, to ensure proper recognition of these flags within the command structure. Additionally, persistent flags for custom denomination and message fee floor price are added to the root command, along with improved error handling during command initialization.

Changes

File Path Change Summary
.changelog/unreleased/bug-fixes/2199-fix-wasm-build-addr.md Added documentation for query flags in query wasm build-addr command.
cmd/provenanced/cmd/root.go Introduced fixQueryWasmBuildAddressFlags function for command flag handling; added persistent flags for customization; updated error handling in PersistentPreRunE.

Possibly related PRs

Suggested reviewers

  • iramiller
  • Taztingo

Poem

In the land of code, where rabbits play,
New flags are added to brighten the day.
With commands that now dance and twirl,
We hop with joy in our code-filled world! 🐇✨
Let's build with ease, no need to stress,
For every change brings a little success!


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

🧹 Outside diff range and nitpick comments (1)
.changelog/unreleased/bug-fixes/2199-fix-wasm-build-addr.md (1)

1-1: Enhance the changelog entry to be more specific and informative.

While the current entry correctly documents the change, it could be more helpful by specifically mentioning the --node flag and the problem it solves. Consider expanding it to:

-* Add the query flags to the query wasm build-addr command [PR 2199](https://github.com/provenance-io/provenance/pull/2199).
+* Fix the `query wasm build-addr` command to properly support the `--node` flag, allowing users to specify custom node endpoints when executing Wasm queries [PR 2199](https://github.com/provenance-io/provenance/pull/2199).

This provides more context about:

  1. The specific flag that was fixed (--node)
  2. The practical benefit (ability to specify custom node endpoints)
  3. The command's use case (executing Wasm queries)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ae45757 and 033aaa2.

📒 Files selected for processing (2)
  • .changelog/unreleased/bug-fixes/2199-fix-wasm-build-addr.md (1 hunks)
  • cmd/provenanced/cmd/root.go (2 hunks)
🧰 Additional context used
📓 Learnings (1)
cmd/provenanced/cmd/root.go (1)
Learnt from: iramiller
PR: provenance-io/provenance#2194
File: cmd/provenanced/cmd/root.go:225-225
Timestamp: 2024-10-21T17:12:02.352Z
Learning: When adding flags in `cmd/provenanced/cmd/root.go`, use `flags.AddTxFlagsToCmd(cmd)` for each command to add the appropriate flags, instead of individually adding flags to the root command.
🔇 Additional comments (3)
cmd/provenanced/cmd/root.go (3)

135-135: LGTM!

The placement of the fixQueryWasmBuildAddressFlags call is appropriate, grouped with other command fixes and executed after all commands are initialized.


540-551: LGTM! Clean and focused implementation.

The implementation correctly adds query flags to the build-address command using the SDK's flags.AddQueryFlagsToCmd. The error handling is appropriate, and the code follows the established patterns in the codebase.


540-551: Verify that this resolves the node flag issue.

Let's verify that this change resolves the specific issue mentioned in the PR objectives where the following command was failing:

provenanced query wasm build-address <code-hash> <creator-address> <salt> --node https://rpc.test.provenance.io:443

@SpicyLemon SpicyLemon merged commit 3f35d38 into main Oct 24, 2024
34 checks passed
@SpicyLemon SpicyLemon deleted the dwedul/fix-wasm-node-flag branch October 24, 2024 22:24
SpicyLemon added a commit that referenced this pull request Oct 24, 2024
…tion events), #2196 (timeout_commit), #2197 (recordspec cmd), #2198 (ParameterChangeProposal) #2199 (wasm build-address cmd). (#2200)

* Suppress scope value owner migration events. (#2195)

* Create a no-op event manager and use that during the metadata module migration.

* Do not suppress the events for a testnet upgrade since they were emitted when the migration ran on testnet.

* Add changelog entry.

* Update all the spec proto links to reference v1.20.0 (#2192)

* Update all the spec proto links to reference v1.20.0 (instead of 1.19.0).

* Add changelog entry.

* When prepping a release, combine the dependency bump changelog entries. (#2181)

* Add a note to get-dep-changes to alert folks that changing those formats might break other things.

* Create an awk script that will combine dependency changelog entries. Update prep-release to use it. Also apply a couple fixes that are alread in the release branch (and will be in main shortly). Also tweak the step 4 and 5 names to provide more context, and fix the verbose output header when recombining the sections.

* Add changelog entry.

* Clarify the new comment in get-dep-changes.sh.

* Update stuff that uses or talks about RELEASE_NOTES.md because it should actually be RELEASE_CHANGELOG.md. The SDK uses _NOTES but only puts a blurb in there, so it's not a changelog. But we include a changelog, so it makes sense to keep it named that way.

* Fix the `query metadata recordspec` command when given a rec-spec-id. (#2197)

* [2148]: Fix the query metadata recordspec command to correctly use the RecordSpecification query (instead of RecordSpecificationsForContractSpecification) when provided a record specification id.

* [2148]: Add changelog entry.

* Fix decoding of gov props with a ParameterChangeProposal in them. (#2198)

* Write a unit test that fails to parse a gov proposal with a ParameterChangeProposal in it because that type isn't being registered anymore.

* Register the params module stuff with the codecs since there's some gov props with a ParameterChangeProposal in them.

* Add changelog entry.

* Hard-code consensus.timeout_commit to 3.5s for mainnet. (#2196)

* [2121]: Change the default consensus timeout value to 3.5 seconds.

* [2121]: Hard-code the consensus.timeout_commit value.

* [2121]: Fix TestIsTestnetFlagSet to not be affected by existing env vars.

* [2121]: Fix a couple unit tests that broke when I changed the default commit timout.

* [2121]: Only hard-code the timeout commit on non-testnets.

* [2121]: Change the default back to 1.5s for faster default testnets.

* [2121]: Fix the TestPreUpgradeCmd that broke because of the hard-coded timeout commit.

* [2121]: Add some unit tests that make sure the consensus timeout commit value is behaving as expected.

* [2121]: Add changelog entry.

* [2121]: When forcing the timeout_commit to be 3.5 seconds, also force the skip flag to be false.

* [2121]: Update warnAboutSettings: Evaluate the timeout commit and skip-timeout-commit fields separately. Issue a warning if skip-timeout-commit is true. Issue a warning if the timeout commit is not exactly what we want it to be.

* Fix: Add node flag to WASM queries (build-address) (#2199)
@coderabbitai coderabbitai bot mentioned this pull request Oct 25, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants