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

[CT-1195] add keeper methods and msg server implementation #2285

Merged
merged 4 commits into from
Sep 20, 2024
Merged

Conversation

jayy04
Copy link
Contributor

@jayy04 jayy04 commented Sep 18, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced custom error handling for specific scenarios, improving robustness in authenticator management.
    • Added a new message type for adding authenticators, with built-in validation for sender addresses and data length.
  • Improvements

    • Enhanced error management capabilities, allowing for more precise handling of account-related errors.
    • Improved integration with the governance module through enhanced initialization parameters.
  • Tests

    • Implemented unit tests for the new message type, ensuring validation logic is thoroughly tested against various scenarios.

@jayy04 jayy04 requested a review from a team as a code owner September 18, 2024 16:09
Copy link

linear bot commented Sep 18, 2024

Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

The pull request introduces a new error handling mechanism in the protocol/x/accountplus/types/errors.go file, defining three custom error variables. Additionally, it adds a new message type, MsgAddAuthenticator, in message_add_authenticator.go, along with a validation method to ensure correct message formatting. A corresponding test file, message_add_authenticator_test.go, is also introduced, containing unit tests for the validation logic of the new message type. Furthermore, a modification is made in protocol/app/app.go to enhance the initialization of the accountplusmodule with governance-related context.

Changes

Files Change Summary
protocol/x/accountplus/types/errors.go, protocol/x/accountplus/types/message_add_authenticator.go, protocol/x/accountplus/types/message_add_authenticator_test.go Introduced custom error variables for better error handling in errors.go, added the MsgAddAuthenticator message type with a validation method in message_add_authenticator.go, and created unit tests for this message type in message_add_authenticator_test.go, ensuring proper validation of message formatting and error handling.
protocol/app/app.go Modified the instantiation of the accountplusmodule to include a new parameter related to governance, enhancing its integration with other components of the application.

Possibly related PRs

  • [CT-1161] add signature verification authenticator #2183: The changes in this PR introduce a signature verification authenticator, which is relevant to the new error handling mechanism for invalid account addresses and authenticator data length in the main PR.
  • [CT-1193] introduce authenticator manager #2256: This PR introduces an AuthenticatorManager that manages authenticators, including the SignatureVerification authenticator, which relates to the error handling improvements for account address validation and authenticator data length in the main PR.

Suggested reviewers

  • teddyding

🐇 In the realm of accounts, new errors arise,
With authenticators added, we reach for the skies.
Validation ensures we’re on the right track,
In the code of our module, there’s no looking back.
With tests in place, our changes are bright,
A rabbit’s delight, in the code’s gentle light! 🐇


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5c5641 and 8ae3424.

Files selected for processing (1)
  • protocol/app/app.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • protocol/app/app.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>, 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.


string sender = 1;
// Authority is the address that may send this message.
string authority = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
Copy link
Contributor Author

Choose a reason for hiding this comment

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

just updated the name of this field to Authority for consistency with other gov controlled messages

sdk "github.com/cosmos/cosmos-sdk/types"
)

const AUTHENTICATOR_DATA_MAX_LENGTH = 256
Copy link
Contributor Author

Choose a reason for hiding this comment

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

temporarily setting this to 256, can adjust later during testing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants