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: allow to generate a random secp256k1 private key #1021

Merged
merged 3 commits into from
Feb 12, 2024

Conversation

manu0466
Copy link

@manu0466 manu0466 commented Feb 9, 2024

Description

Closes: #XXXX

This PR adds a static method to the PrivateKeySigner to generate a new PrivateKeySigner instance with a randomly generated private key.


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
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue 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
  • confirmed that this PR does not change production code

Summary by CodeRabbit

  • New Features
    • Enhanced cryptographic operations by adding a feature to generate secure private keys using the secp256k1 standard.

@manu0466 manu0466 added kind/new-feature Propose the addition of a new feature that does not yet exist pkg/core Related to the core package automerge Automatically merge PR once all prerequisites pass labels Feb 9, 2024
Copy link

coderabbitai bot commented Feb 9, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • yarn.lock is excluded by: !**/*.lock

Walkthrough

The update introduces the elliptic library to the project, specifically utilizing the secp256k1 curve for cryptographic operations. It adds functionality to the PrivateKeySigner class, enabling the generation of a signer with a randomly generated secp256k1 private key.

Changes

Files Change Summary
.../signers/privatekey.ts Imported elliptic, created secp256k1 instance, added generate method
in PrivateKeySigner for random key generation

🐇✨
In the realm of code, where secrets hide,
A rabbit hopped, with strides so wide.
With elliptic curves and keys so bright,
It carved out secrets, in the night. 🌙✨

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

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

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 97c710b and 87bafbf.
Files ignored due to path filters (2)
  • packages/core/package.json is excluded by: !**/*.json
  • yarn.lock is excluded by: !**/*.lock
Files selected for processing (2)
  • packages/core/src/signers/privatekey.ts (2 hunks)
  • packages/core/src/signers/privatekey.unit.spec.ts (1 hunks)
Additional comments: 1
packages/core/src/signers/privatekey.ts (1)
  • 209-218: Verify the cryptographic security of the random number generator used by the elliptic library to ensure it meets the security requirements for generating private keys.

packages/core/src/signers/privatekey.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@RiccardoM RiccardoM left a comment

Choose a reason for hiding this comment

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

Any reason why not to address CodeRabbitAI comments? Especially the one regarding a better test could be useful. Just to assert that the key was generated properly

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 87bafbf and a09d166.
Files selected for processing (1)
  • packages/core/src/signers/privatekey.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/core/src/signers/privatekey.ts

@mergify mergify bot merged commit 290dd8a into main Feb 12, 2024
6 checks passed
@mergify mergify bot deleted the manuel/generate-random-private-key branch February 12, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Automatically merge PR once all prerequisites pass kind/new-feature Propose the addition of a new feature that does not yet exist pkg/core Related to the core package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants