update the default signing algorithm to ed25519 #2658

ckeshava · 2024-03-07T20:22:12Z

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)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Refactor (non-breaking change that only restructures code)
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?

Yes
No, this change does not impact library users

Test Plan

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

… in downstream classes like Account

ckniffen · 2024-03-07T20:26:58Z

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

ckeshava · 2024-03-07T20:31:54Z

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

mvadari · 2024-03-08T16:39:34Z

Does this count as a breaking change?

ckniffen · 2024-03-08T22:50:54Z

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

ckeshava · 2024-03-09T00:34:35Z

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

…519 as the default signing algorithm

…orithm - explicitly state the algorithm used with generateSeed(), instead of relying on the defaults

ckeshava · 2024-03-12T17:54:50Z

packages/secret-numbers/src/schema/Account.ts

@@ -7,6 +7,9 @@ import {
  secretToEntropy,
 } from '../utils'

+// TODO: preferably import this type from ripple-keypairs
+// import type { Algorithm } from 'ripple-keypairs'


Module '"ripple-keypairs"' declares 'Algorithm' locally, but it is not exported. ts(2459) index.d.ts(2, 15): 'Algorithm' is declared here.

I tried to import the Algorithm type from ripple-keypairs, but I get the above error.
I'm confused, Algorithm is exported here:

xrpl.js/packages/ripple-keypairs/src/types.ts

Line 2 in be732a4

export type Algorithm = 'ecdsa-secp256k1' | 'ed25519'

It would need to be exported in https://github.com/XRPLF/xrpl.js/blob/be732a4a6b7bdf58d0efff084b76a66f3f625fe6/packages/ripple-keypairs/src/index.ts

thanks, updated in
c25d871

ckeshava · 2024-03-12T17:55:55Z

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

Please review at your convenience

justinr1234 · 2024-04-04T21:40:05Z

@ckeshava please fix lint errors and rebase

mvadari · 2024-04-07T18:38:26Z

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

khancode · 2024-05-08T22:13:43Z

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.

ckniffen · 2024-07-08T20:12:30Z

packages/ripple-keypairs/src/index.ts

@@ -38,7 +38,7 @@ function generateSeed(
  const entropy = options.entropy
    ? options.entropy.slice(0, 16)
    : randomBytes(16)
-  const type = options.algorithm === 'ed25519' ? 'ed25519' : 'secp256k1'
+  const type = options.algorithm === 'ecdsa-secp256k1' ? 'secp256k1' : 'ed25519'


Should this be tested against the enum?

Line 24 should use the enum too for the key

I've lost some of the context here. Which enum are you referring to?
In line 24, I'm using secp256k1 imported from './signing-schemes/secp256k1'

Are you referring to that import?

justinr1234 · 2024-09-19T16:16:44Z

@CodeRabbit full review

justinr1234 · 2024-09-19T16:17:53Z

@coderabbitai full review

coderabbitai · 2024-09-19T16:17:59Z

Actions performed

Full review triggered.

coderabbitai · 2024-09-19T16:18:02Z

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 84943ae and 6006e2f.

📒 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.

ckeshava · 2025-01-02T19:25:12Z

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

mvadari · 2025-01-03T13:52:01Z

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

ckeshava added 2 commits March 7, 2024 12:19

update the default signing algorithm to ed25519. This causes breakage…

2126ad8

… in downstream classes like Account

update HISTORY file

f2c68dd

ckeshava requested review from justinr1234, mvadari and JST5000 March 7, 2024 20:27

include trouble shooting steps: broken dependencies

5260525

ckeshava added 3 commits March 8, 2024 16:40

update Wallet.fromMnemonic and Wallet.fromRFC1751Mnemonic to use ed25…

0a20edf

…519 as the default signing algorithm

- add unit tests for Wallet.generateSeed() with secp256k1 signing alg…

a15c7c7

…orithm - explicitly state the algorithm used with generateSeed(), instead of relying on the defaults

include algorithm data member in the secret-numbers/Account class

a234fa9

ckeshava commented Mar 12, 2024

View reviewed changes

ckeshava added 2 commits March 12, 2024 10:57

fix lint error

3156306

import Algorithm type from ripple-keypairs module

c25d871

justinr1234 approved these changes Apr 4, 2024

View reviewed changes

Merge branch 'main' into defaultSigningAlg

9d4cec5

ckeshava requested review from ckniffen and khancode May 8, 2024 20:32

ckeshava and others added 2 commits May 8, 2024 14:09

fic lint errors: use an import alias

82e5c08

Merge branch 'main' into defaultSigningAlg

d094afc

ckniffen reviewed Jul 8, 2024

View reviewed changes

Merge branch 'main' into defaultSigningAlg

787ff55

Merge branch 'main' into defaultSigningAlg

6006e2f

ckeshava requested a review from ckniffen January 2, 2025 19:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update the default signing algorithm to ed25519 #2658

update the default signing algorithm to ed25519 #2658

ckeshava commented Mar 7, 2024

ckniffen commented Mar 7, 2024

ckeshava commented Mar 7, 2024

mvadari commented Mar 8, 2024

ckniffen commented Mar 8, 2024

ckeshava commented Mar 9, 2024

ckeshava Mar 12, 2024

ckniffen Mar 13, 2024

ckeshava Mar 13, 2024

ckeshava commented Mar 12, 2024

justinr1234 commented Apr 4, 2024

mvadari commented Apr 7, 2024

khancode commented May 8, 2024

ckniffen Jul 8, 2024

ckniffen Jul 8, 2024

ckeshava Jul 9, 2024

justinr1234 commented Sep 19, 2024

justinr1234 commented Sep 19, 2024

coderabbitai bot commented Sep 19, 2024

coderabbitai bot commented Sep 19, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

ckeshava commented Jan 2, 2025

mvadari commented Jan 3, 2025

update the default signing algorithm to ed25519 #2658

Are you sure you want to change the base?

update the default signing algorithm to ed25519 #2658

Conversation

ckeshava commented Mar 7, 2024

High Level Overview of Change

Context of Change

Type of Change

Did you update HISTORY.md?

Test Plan

ckniffen commented Mar 7, 2024

ckeshava commented Mar 7, 2024

mvadari commented Mar 8, 2024

ckniffen commented Mar 8, 2024

ckeshava commented Mar 9, 2024

ckeshava Mar 12, 2024

Choose a reason for hiding this comment

ckniffen Mar 13, 2024

Choose a reason for hiding this comment

ckeshava Mar 13, 2024

Choose a reason for hiding this comment

ckeshava commented Mar 12, 2024

justinr1234 commented Apr 4, 2024

mvadari commented Apr 7, 2024

khancode commented May 8, 2024

ckniffen Jul 8, 2024

Choose a reason for hiding this comment

ckniffen Jul 8, 2024

Choose a reason for hiding this comment

ckeshava Jul 9, 2024

Choose a reason for hiding this comment

justinr1234 commented Sep 19, 2024

justinr1234 commented Sep 19, 2024

coderabbitai bot commented Sep 19, 2024

coderabbitai bot commented Sep 19, 2024 • edited Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

ckeshava commented Jan 2, 2025

mvadari commented Jan 3, 2025

coderabbitai bot commented Sep 19, 2024 •

edited

Loading