XRPLF
Condition and fulfillment in escrow
High Level Overview of Change
Provide utility functions to generate cryptographic condition and fulfillment for conditional escrows.
Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] 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?
- [x] Yes
- [ ] No, this change does not impact library users
Test Plan
Included unit test and snippet test to validate the working of generate_crypto_conditions function.
This work was inspired by the PR by author and also the XRPL tutorials
Many thanks to both these sources.
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: pypi/[email protected], pypi/[email protected], pypi/[email protected], pypi/[email protected]
![socket-security[bot] avatar](https://avatars.githubusercontent.com/in/156372?v=4 "Published by a pub.dev verified publisher"){kind=small}
Walkthrough
This pull request introduces functionality for creating conditional escrows in the XRPL Python library. The changes include adding a new utility function generate_escrow_cryptoconditions to generate cryptographic conditions and fulfillments for escrow transactions. A new dependency cryptoconditions is added to the project, and the escrow-related models and snippets are updated to support conditional escrows with additional parameters like condition and fulfillment. New tests are also implemented to validate these changes.
Changes
| File | Change Summary |
|---|---|
CHANGELOG.md |
Added entry for new generate_escrow_cryptoconditions utility function |
pyproject.toml |
Added cryptoconditions = "0.8.1" dependency |
snippets/send_escrow.py |
Updated escrow creation to include cryptographic conditions and cancellation parameters |
xrpl/models/transactions/escrow_create.py |
Added CryptoConditions class and generate_escrow_cryptoconditions function |
tests/unit/models/transactions/test_escrow_create.py |
Added new test method test_escrow_condition_and_fulfillment |
Possibly related PRs
- #748: Changes in the main PR involve an addition to the
CHANGELOG.md, which is also the focus of PR #748, indicating updates to the changelog documentation.
Suggested reviewers
- anissa-ripple
- justinr1234
Poem
🐰 A Rabbit's Escrow Ballad 🔒
Crypto conditions, oh so neat,
Escrows now dance to a cryptic beat
Random bytes, a magical key
Unlocking funds with security
XRPL hops with joy today! 🚀
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. (Beta) -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere 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](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}