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

base64 encode permissioned keys config arg #2668

Merged
merged 1 commit into from
Dec 23, 2024
Merged

base64 encode permissioned keys config arg #2668

merged 1 commit into from
Dec 23, 2024

Conversation

jayy04
Copy link
Contributor

@jayy04 jayy04 commented Dec 23, 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

  • New Features

    • Enhanced authenticator registration to support base64-encoded input.
  • Bug Fixes

    • Improved error handling for decoding failures during authenticator registration.

@jayy04 jayy04 requested a review from a team as a code owner December 23, 2024 15:59
Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Walkthrough

The pull request modifies the CmdAddAuthenticator function in the account plus CLI module to introduce base64 decoding for the third argument during authenticator registration. This change enhances the input processing by allowing base64-encoded data to be used when adding an authenticator, with added error handling for decoding failures. The modification ensures more flexible and secure data input for the authenticator registration process.

Changes

File Change Summary
protocol/x/accountplus/client/cli/tx.go Added base64 package import and modified CmdAddAuthenticator to decode the third argument from base64 before populating the MsgAddAuthenticator.Data field

Suggested labels

protocol

Suggested reviewers

  • teddyding

Poem

🐰 Base64 magic, encoding delight,
Authenticators dancing in binary light,
Decoding secrets with a rabbit's flair,
Input transformed without a care!
CLI magic, secure and bright ✨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@jayy04 jayy04 changed the title base64 encode permissioned keys public key arg base64 encode permissioned keys config arg Dec 23, 2024
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

🧹 Nitpick comments (1)
protocol/x/accountplus/client/cli/tx.go (1)

39-42: Prefer a more descriptive error message for failures.

Currently, any decoding error is returned directly to the user. Consider wrapping the error for better clarity:
• Differentiates invalid base64 from other potential errors.
• Aids in debugging by clearly indicating which argument must be base64.

Example improvement:

 config, err := base64.StdEncoding.DecodeString(args[2])
 if err != nil {
-  return err
+  return fmt.Errorf("invalid base64 data for authenticator: %w", err)
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fa7038b and cb93945.

📒 Files selected for processing (1)
  • protocol/x/accountplus/client/cli/tx.go (2 hunks)
🔇 Additional comments (2)
protocol/x/accountplus/client/cli/tx.go (2)

4-4: Import usage acknowledgement.

The introduction of "encoding/base64" is appropriate given the need to decode base64-encoded public key data.


46-46: Ensure correct usage of the decoded data.

You’re saving the decoded bytes directly into Data. This is fine, but confirm that the receiving logic in the codebase (or on-chain) expects raw binary. If it needs further parsing (e.g., JSON or another format), ensure proper decoding or deserialization is performed before usage.

@jayy04 jayy04 merged commit 59abb7b into main Dec 23, 2024
22 checks passed
@jayy04 jayy04 deleted the jy/encoding-config branch December 23, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants