search

XRPLF / xrpl-py

A Python library to interact with the XRP Ledger (XRPL) blockchain
ISC License
151 stars 86 forks source link

fix: Update default cryptographic algorithm in `Wallet` class methods #770

Open ckeshava opened 2 weeks ago

ckeshava commented 2 weeks ago

High Level Overview of Change

This change is related to this PR: https://github.com/XRPLF/xrpl-py/pull/748 I've addressed my comment (https://github.com/XRPLF/xrpl-py/pull/748#issuecomment-2438533913) in the current PR.

@anissa-ripple @justinr1234 @dangell7 please review the changes in this PR

Context of Change

Use ed25519 as the default cryptographic algorithm in Wallet.from_secret_numbers method. This ensures consistency amongst all the methods of the Wallet class.

Type of Change

Did you update CHANGELOG.md?

Test Plan

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces several significant updates to the project. It adds the include_deleted parameter to the ledger_entry request and removes support for Python 3.7, establishing Python 3.8 as the new default version. The default cryptographic algorithm in the Wallet.from_secret_numbers method is updated to ED25519. Additionally, the changelog has been revised to document these changes and previous versions, including notable breaking changes and new features.

Changes

File Change Summary
CHANGELOG.md Updated to include include_deleted parameter, removed Python 3.7 support, updated default algorithm to ED25519, and documented previous versions.
tests/unit/asyn/wallet/test_main.py Modified expected algorithm in test cases from secp256k1 to ed25519 for specific test methods.
xrpl/wallet/main.py Updated comments, enhanced error handling in __init__, and changed default algorithm in from_secret_numbers method to ED25519.

Possibly related PRs

Suggested reviewers

🐇 In the code, I hop and play,
New features bloom, bright as day!
With ED25519, we leap so high,
Python 3.8, we wave goodbye!
Changelog's clear, the path is bright,
Hopping forward, all feels right! 🌟

📜 Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 9637590075544f973fdff799b3bfacde82d7388e and 5195623318a49a0045c9c03b39e32a3151bb953b.
📒 Files selected for processing (1) * `CHANGELOG.md` (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * CHANGELOG.md

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
ckeshava commented 2 weeks ago

Note to the reviewers: I've made an attempt to update the docs to better communicate these changes here: https://github.com/XRPLF/xrpl-dev-portal/pull/2844

mvadari commented 2 weeks ago

This is a breaking change.

justinr1234 commented 1 week ago

@ckeshava would need to put this into a major version release --- and move to the breaking change docs

ckeshava commented 1 week ago

@justinr1234 I've moved the update-message into the "Breaking Changes" section. There is already one other breaking change as well.

How do I indicate that the next release needs to be a major version upgrade? Since we are removing support for Python 3.7, I suspect we need to do a major version upgrade anyway.