Skip to content

chore: remove more mentions of elliptic#2920

Merged
mvadari merged 2 commits intomainfrom
remove-elliptic
Mar 18, 2025
Merged

chore: remove more mentions of elliptic#2920
mvadari merged 2 commits intomainfrom
remove-elliptic

Conversation

@mvadari
Copy link
Collaborator

@mvadari mvadari commented Mar 6, 2025

High Level Overview of Change

Title says it all.

Context of Change

https://slowmist.medium.com/private-key-leakage-in-ecdsa-signatures-analysis-of-malformed-input-vulnerability-in-the-elliptic-24f73c05cac1

There were a few mentions left after #2273

Type of Change

  • Documentation Updates

Did you update HISTORY.md?

  • No, this change does not impact library users

Test Plan

CI passes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 6, 2025 •
edited
Loading

Walkthrough

This pull request updates the documentation and dependency configuration across two packages. In the ripple-keypairs package, the README has been modified to reflect the change from using the elliptic library to the noble library for keypair and wallet generation. Additionally, the xrpl package's package.json no longer specifies a resolution for the elliptic package version, removing the override for "elliptic": "^6.5.4". No changes have been made to the exported or public entities.

Changes

File(s) Change Summary
packages/ripple-keypairs/README.md Updated the README to replace the reference from "using elliptic" to "using noble".
packages/xrpl/package.json Removed the "resolutions": { "elliptic": "^6.5.4" } field, terminating the forced dependency version for the elliptic package.

Possibly related PRs

  • 4.2.0 release #2896: This PR involved changes to update the cryptographic library from elliptic to noble, directly relating to the dependency configuration adjustments observed here.

Poem

I'm a rabbit with a coding beat,
Hopping from one library to a new elite;
Elliptic out, and noble shines bright,
Dependencies now dance from day to night;
With each small change, my heart does skip—
A merry code hop on a crypto trip! 🐇💻
Cheers to cleaner hops in every script!

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d55cb3 and 43dd151.

📒 Files selected for processing (2)
  • packages/ripple-keypairs/README.md (1 hunks)
  • packages/xrpl/package.json (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/xrpl/package.json
✅ Files skipped from review due to trivial changes (1)
  • packages/ripple-keypairs/README.md
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: unit (22.x)
  • GitHub Check: unit (20.x)
  • GitHub Check: integration (22.x)
  • GitHub Check: snippets (22.x)
  • GitHub Check: unit (18.x)
  • GitHub Check: integration (20.x)
  • GitHub Check: snippets (20.x)
  • GitHub Check: browser (18.x)
  • GitHub Check: snippets (18.x)
  • GitHub Check: integration (18.x)
  • GitHub Check: build-and-lint (18.x)
  • GitHub Check: Analyze (javascript)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

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.

@sublimator
Copy link
Contributor

sublimator commented Mar 6, 2025 via email

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 6, 2025

Tip

For best results, initiate chat on the files or code changes.

@sublimator Thank you for your acknowledgment. I'm here if you need any assistance with this PR that's removing mentions of the elliptic library.

ckeshava
ckeshava requested changes Mar 12, 2025
View reviewed changes
Copy link
Collaborator

@ckeshava ckeshava left a comment

Choose a reason for hiding this comment

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

This line needs to b e removed:

xrpl.js/packages/ripple-keypairs/src/signing-schemes/secp256k1/utils.ts

Line 26 in c68902d

// https://github.com/indutny/elliptic/blob/master/lib/elliptic/curves.js#L182

@mvadari
Copy link
Collaborator Author

mvadari commented Mar 12, 2025

This line needs to be removed:

xrpl.js/packages/ripple-keypairs/src/signing-schemes/secp256k1/utils.ts

Line 26 in c68902d

// https://github.com/indutny/elliptic/blob/master/lib/elliptic/curves.js#L182

I left that in on purpose - it's just a helpful comment

@ckeshava
Copy link
Collaborator

ckeshava commented Mar 13, 2025

This line needs to be removed:

xrpl.js/packages/ripple-keypairs/src/signing-schemes/secp256k1/utils.ts

Line 26 in c68902d

// https://github.com/indutny/elliptic/blob/master/lib/elliptic/curves.js#L182

I left that in on purpose - it's just a helpful comment

We are not using that library anymire. Moreover, that line is pointing to raw-bytes which are not relevant to the context at all.

I don't see how that is helpful.

@mvadari
Copy link
Collaborator Author

mvadari commented Mar 18, 2025

This line needs to be removed:

xrpl.js/packages/ripple-keypairs/src/signing-schemes/secp256k1/utils.ts

Line 26 in c68902d

// https://github.com/indutny/elliptic/blob/master/lib/elliptic/curves.js#L182

I left that in on purpose - it's just a helpful comment

We are not using that library anymire. Moreover, that line is pointing to raw-bytes which are not relevant to the context at all.

I don't see how that is helpful.

I don't either, but I figured the comment served a purpose and I didn't look into it enough to matter. It definitely doesn't matter for the purpose of this PR, which is just to ensure people aren't confused about what packages we are and aren't using (a comment doesn't affect that).

@mvadari mvadari merged commit c97bbab into main Mar 18, 2025
23 of 27 checks passed
@mvadari mvadari deleted the remove-elliptic branch March 18, 2025 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ckeshava ckeshava ckeshava approved these changes

@achowdhry-ripple achowdhry-ripple achowdhry-ripple approved these changes

@pdp2121 pdp2121 Awaiting requested review from pdp2121

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mvadari @sublimator @ckeshava @achowdhry-ripple