xrpl.js icon indicating copy to clipboard operation
xrpl.js copied to clipboard
verified publisher icon XRPLF

update the default signing algorithm to ed25519

Open ckeshava opened this issue 1 year ago • 15 comments

High Level Overview of Change

If no signing algorithm is specified, use ed25519. At the moment, the code uses secp256k1. This causes incoherence between the fromSeed and generateSeed functions because they use different defaults.

Note: This change causes breakage in downstream classes like Account

Context of Change

Type of Change

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ ] Refactor (non-breaking change that only restructures code)
  • [x] Tests (You added tests for code that already exists, or your new feature included in this PR)
  • [ ] Documentation Updates
  • [ ] Release

Did you update HISTORY.md?

  • [x] Yes
  • [ ] No, this change does not impact library users

Test Plan

The current unit tests have been updated to use new values.

ckeshava avatar Mar 07 '24 20:03 ckeshava

You should add a way to supply algorithm in secret numbers. Also this should be a major release for some of the packages.

ckniffen avatar Mar 07 '24 20:03 ckniffen

@ckniffen Are you suggesting that I add an algorithm data member to the Account class? I don't see any other relevant classes in the secret-numbers package.

I agree that this change needs to wait for a major revision of the packages.

ckeshava avatar Mar 07 '24 20:03 ckeshava

Does this count as a breaking change?

mvadari avatar Mar 08 '24 16:03 mvadari

@ckniffen Are you suggesting that I add an algorithm data member to the Account class? I don't see any other relevant classes in the secret-numbers package.

I agree that this change needs to wait for a major revision of the packages.

Yes the reason being is if you have your secret numbers recorded from a previous account generation it will now not be possbile to generate the same wallet again.

ckniffen avatar Mar 08 '24 22:03 ckniffen

The default signing algorithm of rippled's wallet_propose method is secp256k1 (Docs: https://xrpl.org/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose)

Why do we have this discrepancy (the defaults for JS client library is ed25519) ?

I saw a note about the inability of rippled command line to generate ed25519 keys, but I don't believe that would have influenced the choice of defaults

ckeshava avatar Mar 09 '24 00:03 ckeshava

@ckniffen I have added the algorithm data member in this commit: a234fa9

Please review at your convenience

ckeshava avatar Mar 12 '24 17:03 ckeshava

@ckeshava please fix lint errors and rebase

justinr1234 avatar Apr 04 '24 21:04 justinr1234

If this is a breaking change, it needs to wait for a major version bump.

mvadari avatar Apr 07 '24 18:04 mvadari

If this is a breaking change, it needs to wait for a major version bump.

We could release this with rippled v2 client library support as that will also require a major version bump.

khancode avatar May 08 '24 22:05 khancode

@coderabbit full review

justinr1234 avatar Sep 19 '24 16:09 justinr1234

@coderabbitai full review

justinr1234 avatar Sep 19 '24 16:09 justinr1234

Actions performed

Full review triggered.

coderabbitai[bot] avatar Sep 19 '24 16:09 coderabbitai[bot]

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 84943ae0b61544f85c9b9dce676302a48c33020c and 6006e2f6a666ec3102d4ea67057fa5c967a9b954.

📒 Files selected for processing (9)
  • CONTRIBUTING.md (1 hunks)
  • packages/ripple-keypairs/HISTORY.md (1 hunks)
  • packages/ripple-keypairs/README.md (1 hunks)
  • packages/ripple-keypairs/src/index.ts (2 hunks)
  • packages/ripple-keypairs/test/api.test.ts (2 hunks)
  • packages/secret-numbers/src/schema/Account.ts (4 hunks)
  • packages/secret-numbers/test/api.test.ts (3 hunks)
  • packages/xrpl/src/Wallet/index.ts (3 hunks)
  • packages/xrpl/test/wallet/index.test.ts (1 hunks)
 _________________________________
< Pvt. Rabbit reporting for duty! >
 ---------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

[!TIP]

CodeRabbit can generate a title for your PR based on the changes.

Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the reviews.auto_title_placeholder setting.

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.

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.

coderabbitai[bot] avatar Sep 19 '24 16:09 coderabbitai[bot]

@achowdhry-ripple can you please review this PR at your convinience?

ckeshava avatar Jan 02 '25 19:01 ckeshava

Note that making too many major bumps in succession (due to breaking changes) contributes to poor DX

mvadari avatar Jan 03 '25 13:01 mvadari