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

refactor: remove redundant validateBasic check #2382

Closed
wants to merge 2 commits into from
Closed

refactor: remove redundant validateBasic check #2382

wants to merge 2 commits into from

Conversation

lukema95
Copy link

@lukema95 lukema95 commented Jan 7, 2024

Description

ValidateBasic has already been called in the GenerateOrBroadcastTxCLI function and we no longer need to call it in the CLi

closes: #XXXX


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
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Refactor

    • Streamlined transaction processing by removing preliminary message validation steps in various financial operations.
  • Bug Fixes

    • Ensured consistent transaction handling across different modules by standardizing control flow.

@lukema95 lukema95 requested review from a team as code owners January 7, 2024 15:30
Copy link
Contributor

coderabbitai bot commented Jan 7, 2024

Walkthrough

The codebase has undergone a significant simplification process, where basic message validation steps have been removed from several transaction-related functions. This affects how transactions are processed, specifically in the Collateralize, Decollateralize, Liquidate, LeveragedLiquidate, DelegateFeedConsent, AggregateExchangeRatePrevote, and AggregateExchangeRateVote functions, potentially streamlining the flow but also raising questions about where validation is now being handled.

Changes

File Path Change Summary
x/leverage/client/cli/tx.go Removed msg.ValidateBasic() calls from Collateralize, Decollateralize, Liquidate, LeveragedLiquidate
x/oracle/client/cli/tx.go Removed message validation in DelegateFeedConsent, AggregateExchangeRatePrevote, AggregateExchangeRateVote

🐇
Code hops away, less checks in the fray,
No more validate, the rabbit does say,
🎉 Transactions flow, validators know,
The blockchain's swift, as validations go.

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-tests for this file.
  • 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.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 10647b5 and d5744c0.
Files selected for processing (2)
  • x/leverage/client/cli/tx.go (4 hunks)
  • x/oracle/client/cli/tx.go (3 hunks)
Additional comments: 2
x/oracle/client/cli/tx.go (1)
  • 55-60: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-122]

The changes in the x/oracle/client/cli/tx.go file appear to remove redundant ValidateBasic calls from the DelegateFeedConsent, AggregateExchangeRatePrevote, and AggregateExchangeRateVote functions. This aligns with the PR objectives to streamline the codebase by eliminating unnecessary validation steps that are already covered by the GenerateOrBroadcastTxCLI function. Ensure that the removal of these calls does not affect other areas of the code where ValidateBasic might be required for different reasons.

x/leverage/client/cli/tx.go (1)
  • 142-147: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-234]

The changes in the x/leverage/client/cli/tx.go file appear to remove redundant ValidateBasic calls from the Collateralize, Decollateralize, Liquidate, and LeveragedLiquidate functions. This aligns with the PR objectives to streamline the codebase by eliminating unnecessary validation steps that are already covered by the GenerateOrBroadcastTxCLI function. Ensure that the removal of these calls does not affect other areas of the code where ValidateBasic might be required for different reasons.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d5744c0 and a33136a.
Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • CHANGELOG.md

Copy link
Member

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

The checks are not redundant. We want to keep them, and avoid broadcasting a transactions with messages that are not correct.

@lukema95
Copy link
Author

lukema95 commented Jan 9, 2024

The checks are not redundant. We want to keep them, and avoid broadcasting a transactions with messages that are not correct.

As I said, the ValidateBasic function is called before the broadcast by performing the following steps, so you are essentially calling ValidateBasic twice before broadcasting the message.

return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)

func GenerateOrBroadcastTxCLI(clientCtx client.Context, flagSet *pflag.FlagSet, msgs ...sdk.Msg) error {
	txf, err := NewFactoryCLI(clientCtx, flagSet)
	if err != nil {
		return err
	}

	return GenerateOrBroadcastTxWithFactory(clientCtx, txf, msgs...)
}

func GenerateOrBroadcastTxWithFactory(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error {
	// Validate all msgs before generating or broadcasting the tx.
	// We were calling ValidateBasic separately in each CLI handler before.
	// Right now, we're factorizing that call inside this function.
	// ref: https://github.com/cosmos/cosmos-sdk/pull/9236#discussion_r623803504
	for _, msg := range msgs {
		if err := msg.ValidateBasic(); err != nil {
			return err
		}
	}
...
}

Relevant PRss: cosmos/cosmos-sdk#9236 (comment)

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.

2 participants