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

(feat) Added a new config option to disable the auto fix of sequence … #220

Merged
merged 1 commit into from
Apr 30, 2024

Conversation

aarmoa
Copy link
Collaborator

@aarmoa aarmoa commented Apr 26, 2024

This PR has been created to replace #213
It implements the same changes but on top of dev branch

  • Make the sequence mismatch error handling optional with a new configuration parameter
  • Add local Network configuration

Summary by CodeRabbit

  • New Features

    • Introduced an option to automatically fix sequence mismatches in transactions.
    • Added support for local network configurations in the LoadNetwork function.
  • Enhancements

    • Implemented a new function for building signed transactions to improve transaction handling efficiency.

…mismatch. Added configuration for local network.
@aarmoa aarmoa requested a review from nicolasbaum April 26, 2024 17:54
Copy link

coderabbitai bot commented Apr 26, 2024

Walkthrough

The recent updates focus on refining error handling and configuration options across several components. A notable enhancement includes the introduction of a condition to address "account sequence mismatch" errors selectively. This is complemented by a new function for building signed transactions. Additionally, the network loading function now supports a "local" configuration, enhancing flexibility.

Changes

File Path Change Summary
client/chain/chain.go Introduced conditional error handling for sequence mismatches and a new function for transaction signing.
client/common/network.go Updated LoadNetwork to support "local" configuration with specific settings.
client/common/options.go Added a boolean field to handle sequence mismatches by default in client options.

🐇✨
In the code where bytes dance,
A rabbit tweaked the stance,
Sequence checks, local nets,
With a hop, no bug gets,
In the burrow, all is chance.
🥕🌟


Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 73f266a and 6514823.
Files selected for processing (3)
  • client/chain/chain.go (6 hunks)
  • client/common/network.go (1 hunks)
  • client/common/options.go (1 hunks)
Additional comments not posted (6)
client/common/options.go (2)

25-25: Added ShouldFixSequenceMismatch field to ClientOptions struct to allow configuration of sequence mismatch handling.


32-32: Set default value of ShouldFixSequenceMismatch to true in DefaultClientOptions to ensure backward compatibility.

client/common/network.go (1)

207-221: Added a new case for "local" network configuration in LoadNetwork function, including specific endpoints and cookie assistants set to DisabledCookieAssistant.

client/chain/chain.go (3)

678-678: Ensure proper error handling for sequence mismatch.

Please verify that the error message check for "account sequence mismatch" is robust and won't accidentally trigger on similar but unrelated errors.


744-744: Ensure proper error handling for sequence mismatch in asynchronous broadcasts.

Please verify that the error message check for "account sequence mismatch" is robust and won't accidentally trigger on similar but unrelated errors in the asynchronous broadcast method.


964-964: Check for sequence mismatch in batch broadcast.

Ensure that the sequence mismatch handling in runBatchBroadcast is consistent with other parts of the code and correctly resets the nonce.


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.

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.
  • 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

@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: 3

Comment on lines +764 to +765
return c.buildSignedTx(clientCtx, txf, msgs...)
}
Copy link

Choose a reason for hiding this comment

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

Add documentation for BuildSignedTx.

This method is public and complex enough to warrant a detailed comment explaining its parameters, return type, and usage. Would you like me to draft a suggested doc comment?


func (c *chainClient) buildSignedTx(clientCtx client.Context, txf tx.Factory, msgs ...sdk.Msg) ([]byte, error) {
Copy link

Choose a reason for hiding this comment

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

Refactor buildSignedTx to handle simulation and signing separately.

The buildSignedTx method currently handles both transaction simulation and signing within the same function. This could be split into separate methods for clarity and reusability.

Comment on lines +879 to +881
txBytes, err := c.buildSignedTx(clientCtx, txf, msgs...)
if err != nil {
err = errors.Wrap(err, "failed to BuildUnsignedTx")
return nil, err
}

txn.SetFeeGranter(clientCtx.GetFeeGranterAddress())
err = tx.Sign(txf, clientCtx.GetFromName(), txn, true)
if err != nil {
err = errors.Wrap(err, "failed to Sign Tx")
return nil, err
}

txBytes, err := clientCtx.TxConfig.TxEncoder()(txn.GetTx())
if err != nil {
err = errors.Wrap(err, "failed TxEncoder to encode Tx")
err = errors.Wrap(err, "failed to build signed Tx")
Copy link

Choose a reason for hiding this comment

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

Improve error handling in broadcastTx.

The error handling in broadcastTx could be improved by specifically checking for known errors and handling them accordingly, rather than wrapping all errors in a generic message.

@aarmoa aarmoa merged commit 68f05f6 into dev Apr 30, 2024
4 checks passed
@aarmoa aarmoa deleted the feat/configurable_seq_mismatch_fixing branch April 30, 2024 13:15
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