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(client/v2): resolve keyring flags properly #19060

Merged
merged 8 commits into from
Jan 18, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 15, 2024

Description

Closes: #18122

ref: #18994 (comment)

I dropped the refactoring away of the keyring as defined in the issue, as we want to be minimally breaking for v0.50 client/v2. This is a fix meant to be backported and then I'll do it the "better way".

I'll update Hubl in a follow-up.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Jan 15, 2024
@julienrbrt julienrbrt marked this pull request as ready for review January 15, 2024 17:18
@julienrbrt julienrbrt requested a review from a team as a code owner January 15, 2024 17:18
Copy link
Contributor

coderabbitai bot commented Jan 15, 2024

Walkthrough

The changes across various files in the client module seem to focus on enhancing the command-line interface (CLI) by streamlining context management and error reporting. The modifications include the integration of context into CLI commands, simplification of flag parsing, and removal of redundant code. Additionally, the changes address a bug related to sending transactions via the CLI by improving how commands are set up and executed, ensuring that the context is consistently passed and utilized.

Changes

File Pattern Change Summary
client/cmd.go Added context import, replaced direct assignment with fmt.Errorf, and updated command context setting.
client/v2/... Support for pubkey in autocli, streamlined context usage, and simplified key flag parsing. Removed redundant fields and imports.
scripts/init-simapp.sh Added --indiscreet flag in key addition commands.

Assessment against linked issues

Objective Addressed Explanation
Ensure CLI can send transactions (Issue #18122) -
Improve error reporting and context handling in CLI commands -
Simplify flag parsing logic in CLI -
Remove redundant code and streamline context management -
Address the specific bug with sending transactions (Issue #18122) The summary does not explicitly mention the resolution of the "invalid argument" error reported in the issue. While context management could impact this, it is not clear without context on how the CLI processes the "node0" argument.

The changes seem aligned with the objectives of improving CLI functionality and code quality, but without additional context on the CLI's argument processing, it is not entirely clear if the specific bug reported in issue #18122 is resolved.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@julienrbrt
Copy link
Member Author

cc @luchenqun

@@ -278,7 +279,7 @@ func readTxCommandFlags(clientCtx Context, flagSet *pflag.FlagSet) (Context, err
from, _ := flagSet.GetString(flags.FlagFrom)
fromAddr, fromName, keyType, err := GetFromFields(clientCtx, clientCtx.Keyring, from)
if err != nil {
return clientCtx, err
return clientCtx, fmt.Errorf("failed to convert address field to address: %w", err)
Copy link
Contributor

Choose a reason for hiding this comment

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

The error message has been improved to provide more context, but the error wrapping with %w is only useful if the error is going to be unwrapped later. If not, %v should be used instead.

- return clientCtx, fmt.Errorf("failed to convert address field to address: %w", err)
+ return clientCtx, fmt.Errorf("failed to convert address field to address: %v", err)

Committable suggestion

IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
return clientCtx, fmt.Errorf("failed to convert address field to address: %w", err)
return clientCtx, fmt.Errorf("failed to convert address field to address: %v", err)

@tac0turtle tac0turtle assigned likhita-809 and unassigned atheeshp Jan 17, 2024
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

lgtm

@PoisonPhang
Copy link
Contributor

PoisonPhang commented Jan 18, 2024

Still needs changes from #18994 before the client config is being correctly used.

I'll go ahead and open up #18994 for review. Let me know if it needs any changes.

Steps to reproduce client config not being loaded on this PR:

  1. Initialize a directory in $CONFIG (a folder other than $HOME/.simapp)
  2. Ensure $HOME/.simapp does not exist
  3. Create a test key, $TEST_KEY inside $CONFIG
  4. Configure $CONFIG/config/client.toml with a chain ID
  5. Run the following command:
simd --home $CONFIG tx --keyring-backend test slashing unjail --from `$TEST_KEY` --offline -a 1 -s 1

Result:

chain ID required but not specified

Despite chain ID being specified in $CONFIG/config/client.toml

This also applies to all values from the client config.

Both this PR and #18994 together seem to fix the issue.

@julienrbrt
Copy link
Member Author

julienrbrt commented Jan 18, 2024

Yea, definitely, your PR is still needed. This only fixes the keyring flags and pass the root context to AutoCLI commands.

@julienrbrt julienrbrt added this pull request to the merge queue Jan 18, 2024
Merged via the queue into main with commit 8f39bfb Jan 18, 2024
59 of 60 checks passed
@julienrbrt julienrbrt deleted the julien/fix-autocli-keyring branch January 18, 2024 19:30
mergify bot pushed a commit that referenced this pull request Jan 18, 2024
(cherry picked from commit 8f39bfb)

# Conflicts:
#	client/v2/CHANGELOG.md
#	client/v2/autocli/builder.go
#	client/v2/autocli/common_test.go
#	client/v2/autocli/msg.go
julienrbrt added a commit that referenced this pull request Jan 18, 2024
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
roy-dydx pushed a commit to dydxprotocol/cosmos-sdk that referenced this pull request Feb 14, 2024
@julienrbrt julienrbrt mentioned this pull request Feb 22, 2024
5 tasks
yihuang added a commit to yihuang/ethermint that referenced this pull request Apr 12, 2024
Solution:
- update dependency to include the fix, see cosmos/cosmos-sdk#19060
yihuang added a commit to yihuang/ethermint that referenced this pull request Apr 12, 2024
Solution:
- update dependency to include the fix, see cosmos/cosmos-sdk#19060

changelog

fix test
yihuang added a commit to crypto-org-chain/ethermint that referenced this pull request Apr 12, 2024
Solution:
- update dependency to include the fix, see cosmos/cosmos-sdk#19060

changelog

fix test
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:CLI Type: Build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: code using main branch cannot send transactions using cli command
6 participants