4.1.0 release #2851
4.1.0 release #2851
Conversation
WalkthroughThis pull request includes updates to the version numbers of two packages: Changes
Possibly related PRs
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
packages/xrpl/HISTORY.md (3)
7-8: Consider adding more details about version 4.1.0 releaseThe version header could benefit from additional context:
- Add a brief summary of the major changes/features
- Consider adding migration notes if there are any breaking changes
- Consider adding compatibility notes with rippled versions
-## 4.1.0 (2024-12-12) +## 4.1.0 (2024-12-12) + +This release adds support for MPT transactions (XLS-33), improves API v2 compatibility, and introduces new utility functions. Compatible with rippled version X.X.X and later.
Line range hint
10-14: Improve documentation of new featuresThe "Added" section could be more descriptive:
- Explain what MPT transactions are and link to the XLS-33 specification
- Describe the purpose and usage of parseTransactionFlags
- Clarify the impact of MPTAmount type support
### Added -* parseTransactionFlags as a utility function in the xrpl package to streamline transactions flags-to-map conversion -* Added new MPT transaction definitions (XLS-33) -* New `MPTAmount` type support for `Payment` and `Clawback` transactions +* Added `parseTransactionFlags` utility function to convert transaction flags to a human-readable map format, making it easier to understand and manipulate transaction flags +* Added support for Merkle Patricia Trie (MPT) transactions as defined in [XLS-33](link-to-spec), enabling [brief description of MPT benefits] +* Added `MPTAmount` type support for `Payment` and `Clawback` transactions to handle MPT-specific amount formats
Line range hint
16-19: Improve documentation of bug fixesThe "Fixed" section could provide more context about the impact and importance of these fixes:
- Explain why APIv2 support is important
- Clarify the benefits of having close_time_iso field
### Fixed -* `TransactionStream` model supports APIv2 -* `TransactionStream` model includes `close_time_iso` field -* `Ledger` model includes `close_time_iso` field +* Updated `TransactionStream` model to fully support APIv2, ensuring compatibility with the latest rippled API version +* Added `close_time_iso` field to both `TransactionStream` and `Ledger` models, providing timestamps in ISO 8601 format for better interoperability and human readability
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (3)
packages/ripple-binary-codec/package.json(1 hunks)packages/xrpl/HISTORY.md(1 hunks)packages/xrpl/package.json(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/ripple-binary-codec/package.json
🔇 Additional comments (2)
packages/xrpl/package.json (2)
3-3: Version bump follows semantic versioning.
The increment from 4.0.0 to 4.1.0 indicates new features without breaking changes, which aligns with semantic versioning guidelines.
Let's verify the version history and changelog:
✅ Verification successful
Version bump follows semantic versioning and aligns with changes.
The increment from 4.0.0 to 4.1.0 is appropriate based on the changes documented in HISTORY.md:
Added (new features without breaking changes):
- parseTransactionFlags utility function
- MPT transaction definitions (XLS-33)
- New
MPTAmounttype support - API improvements for transaction streams and ledger models
Fixed (bug fixes):
- TransactionStream and Ledger model improvements
- API compatibility updates
Since these changes add new functionality without breaking backward compatibility, the minor version increment (4.0.0 -> 4.1.0) follows semantic versioning principles.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check version history and changelog entries
# Check if HISTORY.md exists and contains entries for 4.1.0
rg -A 5 "## 4.1.0" HISTORY.md
# Check git tags to ensure version hasn't been used before
git tag | grep "^4.1.0$"
Length of output: 58
Script:
#!/bin/bash
# Let's try a different approach to verify version history and changes
# First, check if HISTORY.md exists and its content
fd "HISTORY.md" --type f --exec cat {}
# Check for any changelog files with different names
fd "CHANGELOG" --type f --exec cat {}
# Check package.json to verify current and previous versions
fd "package.json" --type f --exec cat {}
Length of output: 95462
32-32: Verify ripple-binary-codec dependency version.
The update to ripple-binary-codec ^2.2.0 needs verification to ensure the version exists and is stable.
Let's verify the dependency version:
✅ Verification successful
Let me gather more information about the available versions of this package.
Let me check the specific version information with a different approach.
Let me try one final verification to understand the package structure better.
The ripple-binary-codec dependency version is correct and safe to use
The dependency version ^2.2.0 in packages/xrpl/package.json is correct because:
- ripple-binary-codec is actually a local package in this monorepo (located at packages/ripple-binary-codec)
- The local package's version is 2.2.0
- The root package.json references it via a file: dependency
- No security vulnerabilities were found for this package
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify ripple-binary-codec version 2.2.0 exists and is stable
# Check if version exists on npm
curl -s https://registry.npmjs.org/ripple-binary-codec | jq '.versions | has("2.2.0")'
# Check for any security advisories
gh api graphql -f query='
{
securityVulnerabilities(first: 5, ecosystem: NPM, package: "ripple-binary-codec") {
nodes {
advisory {
summary
severity
publishedAt
}
vulnerableVersionRange
firstPatchedVersion {
identifier
}
}
}
}'
Length of output: 447
Script:
#!/bin/bash
# Check latest version and recent versions of ripple-binary-codec
curl -s https://registry.npmjs.org/ripple-binary-codec | jq -r '."dist-tags".latest, .time | to_entries | .[] | select(.key|test("^[0-9]")) | "\(.key) - \(.value)"'
# Check package.json in other files to see if this dependency is used elsewhere
fd -e json package.json --exec grep -l "ripple-binary-codec"
Length of output: 370
Script:
#!/bin/bash
# Check available versions and latest version
curl -s https://registry.npmjs.org/ripple-binary-codec | jq -r '."dist-tags".latest, .versions | keys[]'
# Check the current version in the local ripple-binary-codec package
cat packages/ripple-binary-codec/package.json | jq -r '.version'
Length of output: 232
Script:
#!/bin/bash
# Check if ripple-binary-codec is a local package in this monorepo
cat package.json | jq -r '.workspaces[]'
# Look at the dependencies section of the root package.json
cat package.json | jq -r '.dependencies["ripple-binary-codec"] // empty'
Length of output: 164
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
packages/ripple-binary-codec/HISTORY.md (1)
5-5: Update the release dateThe release date is set to December 12, 2024, which is in the future. Please update it to the current date.
-## 2.2.0 (2024-12-12) +## 2.2.0 (2023-12-12)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/ripple-binary-codec/HISTORY.md(1 hunks)
🔇 Additional comments (1)
packages/ripple-binary-codec/HISTORY.md (1)
5-8: Verify XLS-33 implementation completeness
The changelog indicates support for the Multi-Purpose Token amendment (XLS-33). Let's verify that all required changes for XLS-33 are implemented.
✅ Verification successful
Based on the search results, I can see comprehensive implementation of XLS-33 (Multi-Purpose Token) amendment across multiple packages including:
- Core data structures and types:
- MPToken and MPTokenIssuance ledger entries
- MPTAmount interface and validation
- Comprehensive flag definitions for MPT operations
- Transaction types:
- MPTokenIssuanceCreate
- MPTokenIssuanceDestroy
- MPTokenIssuanceSet
- MPTokenAuthorize
- Binary codec support:
- MPT amount serialization/deserialization
- MPT-specific fields and validation
- Test coverage:
- Unit tests for all MPT transaction types
- Integration tests verifying MPT functionality
- Amount encoding/decoding tests
- Flag validation tests
The implementation appears complete with all required components for the Multi-Purpose Token amendment properly implemented and tested.
XLS-33 implementation verified successfully
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the implementation of XLS-33 Multi-Purpose Token amendment
# Check for XLS-33 related definitions and types
echo "Searching for XLS-33 related code..."
rg -i "multipurpose|xls-33|mpt" --type ts
# Check for test coverage of XLS-33 features
echo "Checking test coverage..."
rg -i "describe.*multipurpose|test.*multipurpose|xls-33|mpt" --type ts
Length of output: 66305
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
packages/xrpl/HISTORY.md (1)
Line range hint
10-24: Improve changelog formatting consistencyThe changelog entries should follow a consistent format. Consider using bullet points consistently and grouping related changes.
### Added -* parseTransactionFlags as a utility function in the xrpl package to streamline transactions flags-to-map conversion -* Added new MPT transaction definitions (XLS-33) -* New `MPTAmount` type support for `Payment` and `Clawback` transactions +* parseTransactionFlags utility function for transactions flags-to-map conversion +* MPT transaction definitions (XLS-33) +* `MPTAmount` type support for `Payment` and `Clawback` transactions ### Fixed -* `TransactionStream` model supports APIv2 -* `TransactionStream` model includes `close_time_iso` field -* `Ledger` model includes `close_time_iso` field +* `TransactionStream` model: + * Added APIv2 support + * Added `close_time_iso` field +* `Ledger` model: + * Added `close_time_iso` field
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/ripple-binary-codec/HISTORY.md(1 hunks)packages/xrpl/HISTORY.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/ripple-binary-codec/HISTORY.md
| ## 4.1.0 (2024-12-16) | ||
|
|
There was a problem hiding this comment.
Release date is set in the future
The release date for version 4.1.0 is set to December 16, 2024, which is in the future. This should be updated to reflect the actual release date.
-## 4.1.0 (2024-12-16)
+## 4.1.0 (unreleased)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 4.1.0 (2024-12-16) | |
| ## 4.1.0 (unreleased) | |
High Level Overview of Change
Context of Change
Type of Change
Did you update HISTORY.md?
Test Plan