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(sidecar): hex private key #118

Merged
merged 1 commit into from
Jul 5, 2024
Merged

Conversation

namn-grg
Copy link
Contributor

@namn-grg namn-grg commented Jul 5, 2024

fixes #114

Summary by CodeRabbit

  • Bug Fixes
    • Improved private key processing to handle input strings starting with "0x" correctly.
    • Corrected assignment behavior for config.fee_recipient.

Copy link
Contributor

coderabbitai bot commented Jul 5, 2024

Walkthrough

The recent changes in bolt-sidecar/src/config/mod.rs involve modifying how private keys are processed by stripping the "0x" prefix before decoding, and an additional assignment for config.fee_recipient. These adjustments improve the configuration parsing, ensuring accurate handling of key inputs and proper setting of the fee recipient.

Changes

Files Change Summary
bolt-sidecar/src/config/mod.rs Modified private key processing to strip "0x" prefix before decoding and added assignment for config.fee_recipient

Sequence Diagram(s)

None provided due to simplicity of changes.

Assessment against linked issues

Objective Addressed Explanation
Parse a private key starting with "0x" prefix correctly (#114)

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

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.

@namn-grg namn-grg changed the title fix(sidecar): hex sk, fee_recipient fix(sidecar): hex private key Jul 5, 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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 4265a14 and 572b8ed.

Files selected for processing (1)
  • bolt-sidecar/src/config/mod.rs (2 hunks)
Additional comments not posted (1)
bolt-sidecar/src/config/mod.rs (1)

212-213: LGTM!

The assignment of config.fee_recipient looks good.

Comment on lines +172 to +175
// Check if the string starts with "0x" and remove it
let hex_sk = if sk.starts_with("0x") { &sk[2..] } else { &sk };

let sk = SecretKey::from_bytes(&hex::decode(hex_sk)?)
Copy link
Contributor

Choose a reason for hiding this comment

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

Improve error handling for invalid hex strings.

The current code does not handle cases where the hex string might still be invalid after removing the "0x" prefix. Consider adding additional checks or handling for such cases.

-  let sk = SecretKey::from_bytes(&hex::decode(hex_sk)?)
-    .map_err(|e| eyre::eyre!("Failed decoding BLS secret key: {:?}", e))?;
+  let decoded_hex = hex::decode(hex_sk).map_err(|e| eyre::eyre!("Failed decoding hex string: {:?}", e))?;
+  let sk = SecretKey::from_bytes(&decoded_hex)
+    .map_err(|e| eyre::eyre!("Failed decoding BLS secret key: {:?}", e))?;
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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Check if the string starts with "0x" and remove it
let hex_sk = if sk.starts_with("0x") { &sk[2..] } else { &sk };
let sk = SecretKey::from_bytes(&hex::decode(hex_sk)?)
// Check if the string starts with "0x" and remove it
let hex_sk = if sk.starts_with("0x") { &sk[2..] } else { &sk };
let decoded_hex = hex::decode(hex_sk).map_err(|e| eyre::eyre!("Failed decoding hex string: {:?}", e))?;
let sk = SecretKey::from_bytes(&decoded_hex)
.map_err(|e| eyre::eyre!("Failed decoding BLS secret key: {:?}", e))?;

@merklefruit
Copy link
Collaborator

Awesome!

@merklefruit merklefruit merged commit 8791515 into unstable Jul 5, 2024
@merklefruit merklefruit deleted the fix/sidecar/cli-params branch July 5, 2024 10:18
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.

bug(sidecar): parse a private key starting with 0x
2 participants