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

Update CHANGELOG.md #748

Merged
merged 3 commits into from
Nov 4, 2024
Merged

Update CHANGELOG.md #748

merged 3 commits into from
Nov 4, 2024

Conversation

dangell7
Copy link
Contributor

@dangell7 dangell7 commented Sep 16, 2024

High Level Overview of Change

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 CHANGELOG.md?

  • Yes
  • No, this change does not impact library users

Test Plan

Summary by CodeRabbit

  • New Features

    • Added include_deleted parameter to the ledger_entry request.
  • Breaking Changes

    • Removed support for Python 3.7; Python 3.8 is now the default version.
  • Bug Fixes

    • Fixed retrieval of FeeSettings values from the latest validated ledger, removing hard-coded transaction cost.
  • Documentation

    • Updated CHANGELOG.md to reflect notable changes and improvements across versions.

@ckeshava
Copy link
Collaborator

Hello,
Thank you for this change.

  1. This change needs to be placed under the "Unreleased Version" at the top of the CHANGELOG file. At the moment, v3.0.0 has already been released.
  2. There is a mixture of SECP256K1 and ED25519 algorithms used as defaults in the codebase. This needs to be fixed for the sake of consistency.
    cls: Type[Self], algorithm: CryptoAlgorithm = CryptoAlgorithm.ED25519

    algorithm: CryptoAlgorithm = CryptoAlgorithm.SECP256K1,

^^ Here are two different default-choices used in two different methods.

Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

Walkthrough

The pull request updates the CHANGELOG.md file to document significant changes in the project. It adds an entry for the new include_deleted parameter in the ledger_entry request and notes a breaking change that removes support for Python 3.7, making Python 3.8 the new default. Additionally, it addresses a fix related to retrieving FeeSettings values and summarizes updates from previous versions regarding various enhancements and removals.

Changes

File Change Summary
CHANGELOG.md Updated to include new include_deleted parameter in ledger_entry request and breaking change for Python version support. Added historical updates on various changes across releases.

Possibly related PRs

Suggested reviewers

  • ckeshava
  • shawnxie999
  • pdp2121

🐇 In the changelog, we hop and play,
New features added, come what may!
Python 3.8, we now embrace,
With include_deleted, we quicken the pace.
From drops to fees, all changes are clear,
A joyful update, let’s give a cheer! 🎉


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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

Copy link
Contributor

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between edfb99b and 640481c.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🔇 Additional comments (1)
CHANGELOG.md (1)

Line range hint 8-19: LGTM! The Unreleased section follows changelog guidelines.

The changes are properly categorized and provide clear, meaningful information to users. The breaking change about Python 3.7 removal is well-documented with its rationale.

🧰 Tools
🪛 Markdownlint

95-95: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


89-89: null
Bare URL used

(MD034, no-bare-urls)

Comment on lines +92 to +94
### BREAKING CHANGE
- The default signing algorithm in the `Wallet` was changed from secp256k1 to ed25519
-
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Inconsistent default signing algorithm found in xrpl/wallet/main.py

The codebase shows inconsistency with the changelog's statement about ED25519 being the default signing algorithm:

  • Most methods in xrpl/wallet/main.py use ED25519 as default:
    • generate_faucet_wallet
    • from_seed
    • from_entropy
  • However, from_secret_numbers method still uses SECP256K1 as default with a comment referencing XUMM standard from December 2022
🔗 Analysis chain

Verify cryptographic algorithm consistency in the codebase.

While the changelog documents ED25519 as the new default signing algorithm, there appears to be inconsistency in its implementation. As noted in the PR comments, there's a mixture of SECP256K1 and ED25519 being used as defaults in xrpl/wallet/main.py.

Let's verify the algorithm usage:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for inconsistent cryptographic algorithm usage
# Expected: ED25519 should be the default as per v2.0.0 changelog

# Search for algorithm-related code in wallet implementation
rg -A 5 "(?i)(secp256k1|ed25519)" "xrpl/wallet/main.py"

Length of output: 1831

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants