Lending Protocol implementation XLS-66 #5270

ximinez · 2025-01-31T23:28:35Z

High Level Overview of Change

Implement the Lending Protocol as described in XLS-66

Context of Change

Type of Change

New feature (non-breaking change which adds functionality)
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)

API Impact

Public API: New feature (new methods and/or new fields)
Public API: Breaking change (in general, breaking changes should only impact the next api_version)
libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
Peer protocol change (must be backward compatible or bump the peer protocol version)

codecov · 2025-02-04T20:14:56Z

Codecov Report

❌ Patch coverage is 90.63685% with 247 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.0%. Comparing base (c9f17dd) to head (3ca1593).
⚠️ Report is 1 commits behind head on develop.

Files with missing lines	Patch %	Lines
src/xrpld/app/misc/detail/LendingHelpers.cpp	85.7%	78 Missing ⚠️
src/xrpld/app/tx/detail/InvariantCheck.cpp	89.0%	27 Missing ⚠️
src/xrpld/app/tx/detail/LoanManage.cpp	84.9%	27 Missing ⚠️
src/xrpld/app/tx/detail/LoanSet.cpp	91.4%	27 Missing ⚠️
src/xrpld/app/tx/detail/LoanBrokerDelete.cpp	72.5%	25 Missing ⚠️
src/xrpld/rpc/handlers/LedgerEntry.cpp	0.0%	20 Missing ⚠️
src/libxrpl/ledger/View.cpp	94.5%	16 Missing ⚠️
src/xrpld/app/tx/detail/LoanPay.cpp	95.5%	11 Missing ⚠️
...rc/xrpld/app/tx/detail/LoanBrokerCoverClawback.cpp	97.8%	3 Missing ⚠️
src/xrpld/app/tx/detail/LoanBrokerCoverDeposit.cpp	94.8%	3 Missing ⚠️
... and 6 more

Additional details and impacted files

@@            Coverage Diff            @@
##           develop   #5270     +/-   ##
=========================================
+ Coverage     78.6%   79.0%   +0.5%     
=========================================
  Files          818     839     +21     
  Lines        68938   71377   +2439     
  Branches      8240    8339     +99     
=========================================
+ Hits         54177   56422   +2245     
- Misses       14761   14955    +194

Files with missing lines	Coverage Δ
include/xrpl/basics/Number.h	`100.0% <ø> (ø)`
include/xrpl/json/json_value.h	`98.5% <ø> (ø)`
include/xrpl/ledger/ApplyView.h	`100.0% <ø> (ø)`
include/xrpl/ledger/View.h	`100.0% <100.0%> (ø)`
include/xrpl/protocol/Asset.h	`96.3% <100.0%> (+0.8%)`	⬆️
include/xrpl/protocol/Indexes.h	`100.0% <100.0%> (ø)`
include/xrpl/protocol/Protocol.h	`100.0% <100.0%> (ø)`
include/xrpl/protocol/SField.h	`100.0% <ø> (ø)`
include/xrpl/protocol/STAmount.h	`95.7% <100.0%> (+1.2%)`	⬆️
include/xrpl/protocol/STObject.h	`93.1% <ø> (ø)`
... and 50 more

... and 13 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

src/xrpld/app/tx/detail/LoanBrokerCoverClawback.cpp

src/xrpld/app/tx/detail/LoanSet.cpp

shawnxie999 · 2025-11-28T19:46:39Z

src/xrpld/app/tx/detail/InvariantCheck.cpp

    [[maybe_unused]] bool const enforce =
        view.rules().enabled(featureInvariantsV1_1) ||
-        view.rules().enabled(featureSingleAssetVault);
+        view.rules().enabled(featureSingleAssetVault) ||
+        view.rules().enabled(featureLendingProtocol);


If featureInvariantsV1_1 is enabled, but one node hasn’t upgraded to the rippled version that includes lending while another node has (and therefore runs the new invariant checks), wouldn’t they end up producing different transaction results? (I guess it would be okay since invaraints are meant to be defensive checks)

If featureInvariantsV1_1 is enabled, but one node hasn’t upgraded to the rippled version that includes lending while another node has (and therefore runs the new invariant checks), wouldn’t they end up producing different transaction results? (I guess it would be okay since invaraints are meant to be defensive checks)

Nope. That's not a problem, since the checks are joined by "or". In your scenario, assuming both nodes are running a version that supports featureInvariantsV1_1 (it's not supported in any version at the moment), then they would both run the invariant check and get identical results. (If one of them did not support it, it would be amendment blocked.)

To clarify, I'm taking about the scenario where:

featureInvariantsV1_1 is enabled across the network and featureLendingProtocol is not enabled

Node A supports featureInvariantsV1_1 but does not support featureLendingProtocol (didn't upgrade to latest rippled version)

Node B supports both featureInvariantsV1_1 and featureLendingProtocol (upgraded to latest rippled version)

Now with the invariant checks below introduced in lending, gated by enforce

If one of these new checks fails for a transaction, Node A would still succeed (since it runs on an older version and does not have these checks) but Node B would fail.

Anyways, since featureInvariantsV1_1 is not supported, this can be left for later discussion.

dangell7

non amendment guarded code review

src/xrpld/app/tx/detail/Transactor.cpp

src/libxrpl/ledger/ApplyView.cpp

shawnxie999

Approving the PR (non amendment gated portion) in its current state, given that we are keeping the lending feature unsupported for the time being.

gregtatcam

👍 LGTM

ximinez · 2025-12-02T00:42:19Z

@dangell7 I've addressed your comments. Could you re-review ASAP, so I can resolve the issue with unsigned commits, and get this thing merged?

dangell7

Approving ONLY non amendment gated code

- Spec: XLS-66 - Introduces amendment "featureLendingProtocol", but leaves it UNSUPPORTED to allow for future development work. - AccountInfo RPC will indicate the type of pseudo-account when appropriate. - Refactors and improves several existing classes and functional areas, including Number, STAmount, STObject, json_value, Asset, directory handling, View helper functions, and unit test helpers.

ximinez · 2025-12-02T16:28:59Z

Commit message:

Implement Lending Protocol (unsupported) (#5270)

- Spec: XLS-66
- Introduces amendment "LendingProtocol", but leaves it UNSUPPORTED to
  allow for standalone testing, future development work, and potential
  bug fixes.
- AccountInfo RPC will indicate the type of pseudo-account when
  appropriate.
- Refactors and improves several existing classes and functional areas,
  including Number, STAmount, STObject, json_value, Asset, directory
  handling, View helper functions, and unit test helpers.

This reverts commit 6c67f1f.

- Spec: XLS-66 - Introduces amendment "LendingProtocol", but leaves it UNSUPPORTED to allow for standalone testing, future development work, and potential bug fixes. - AccountInfo RPC will indicate the type of pseudo-account when appropriate. - Refactors and improves several existing classes and functional areas, including Number, STAmount, STObject, json_value, Asset, directory handling, View helper functions, and unit test helpers.

## High Level Overview of Change  Add support for XLS-0066 Lending Protocol. ### Context of Change  The specification can be found here: XRPLF/XRPL-Standards#240 The cpp implementation is available here: XRPLF/rippled#5270 ### 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 - [ ] Translation Updates - [ ] Release ## Before / After  ### LoanBrokerSet (Special case for `DebtMaximum`: ``` The maximum amount the protocol can owe the Vault. The default value of 0 means there is no limit to the debt. Must not be negative. ``` when zero, the UI will display `No Limit`) <img width="908" height="932" alt="Screenshot 2025-12-05 at 10 26 50 AM" src="https://github.com/user-attachments/assets/af1bbdca-c4c2-4aa3-979e-bc7adebe5f75" /> <img width="1324" height="193" alt="Screenshot 2025-12-05 at 10 25 00 AM" src="https://github.com/user-attachments/assets/804fe8f5-7a83-4c0e-be1c-465e6dcf12b7" /> ### LoanBrokerDelete (This one is failing due to Loan term had not expired, but all fields are there): <img width="916" height="731" alt="Screenshot 2025-11-10 at 12 30 18 PM" src="https://github.com/user-attachments/assets/0c5623d4-e179-4e90-ac31-9ae3ec25cf3f" /> <img width="860" height="167" alt="Screenshot 2025-11-10 at 12 30 32 PM" src="https://github.com/user-attachments/assets/dab01931-9b09-4415-9dac-54d5d8db4a8e" /> ### LoanBrokerCoverDeposit <img width="922" height="723" alt="Screenshot 2025-11-10 at 12 31 05 PM" src="https://github.com/user-attachments/assets/a9736f63-c067-4712-952e-107a5ab4cdaf" /> <img width="1323" height="147" alt="Screenshot 2025-11-10 at 12 31 24 PM" src="https://github.com/user-attachments/assets/ccf358f0-dc46-422f-aa1e-9720dc17183d" /> ### LoanBrokerCoverWithdraw <img width="1047" height="693" alt="Screenshot 2025-11-10 at 12 31 55 PM" src="https://github.com/user-attachments/assets/2590418c-de9b-472d-8be9-85d2fc165c3f" /> <img width="1323" height="145" alt="Screenshot 2025-11-10 at 12 32 05 PM" src="https://github.com/user-attachments/assets/0093feec-e5cd-405a-83c3-79950bbbbf07" /> ### LoanBrokerCoverCallback (There a special case for `Amount` field when it is set to zero: ``` The First-Loss Capital amount to clawback. If the amount is 0 or not provided, clawback funds up to LoanBroker.DebtTotal * LoanBroker.CoverRateMinimum. ``` which has been handled by the code) <img width="1035" height="710" alt="Screenshot 2025-11-10 at 12 32 20 PM" src="https://github.com/user-attachments/assets/c9758f6c-d612-4bb2-9e49-d3ff54668c31" /> <img width="1325" height="161" alt="Screenshot 2025-11-10 at 12 32 51 PM" src="https://github.com/user-attachments/assets/174d6d4e-f5b0-40a8-b89e-a85114cb3460" /> ### LoanSet <img width="985" height="1916" alt="localhost_3000_lend devnet rippletest net_transactions_5A579D21B53A8D113D612D05AF191A59F852DD9FBBF58AB093F4F5270F7C07A2" src="https://github.com/user-attachments/assets/d8098b8b-a856-45bd-80d9-c326f8bcba0f" /> <img width="1324" height="230" alt="Screenshot 2025-12-05 at 10 25 10 AM" src="https://github.com/user-attachments/assets/9ed80709-32e5-4b08-a78c-7da3675e190d" /> ### LoanPay <img width="942" height="710" alt="Screenshot 2025-11-10 at 12 37 18 PM" src="https://github.com/user-attachments/assets/37ebe409-bcdc-4ee7-9976-2f834c73118e" /> <img width="1294" height="145" alt="Screenshot 2025-11-10 at 12 37 32 PM" src="https://github.com/user-attachments/assets/9cdf49a4-cae0-45cd-8d5f-df3e0da044e7" /> ### LoanManage (with Flags displayed in Detailed tab) <img width="928" height="706" alt="Screenshot 2025-11-10 at 12 37 55 PM" src="https://github.com/user-attachments/assets/cd83a430-5456-41a8-b43d-1a53185523f4" /> <img width="908" height="593" alt="Screenshot 2025-11-10 at 12 38 09 PM" src="https://github.com/user-attachments/assets/2ed7c920-d148-4e97-b840-d324f5cb971e" /> <img width="1280" height="139" alt="Screenshot 2025-11-10 at 12 38 28 PM" src="https://github.com/user-attachments/assets/d3a22f59-ba29-487c-a0fe-7d565d3f12ca" /> ### LoanDelete (This one is failing due to Loan term had not expired, but all fields are there) <img width="936" height="716" alt="Screenshot 2025-11-10 at 12 39 02 PM" src="https://github.com/user-attachments/assets/e8a5f6a7-853e-4cc0-aede-7cd79ee0fb3e" /> <img width="855" height="162" alt="Screenshot 2025-11-10 at 12 39 16 PM" src="https://github.com/user-attachments/assets/3887b8fc-26e5-410c-bfd2-54ef1c253340" /> ### MPT as underlying asset is displayed correctly <img width="1328" height="1047" alt="Screenshot 2025-12-07 at 6 55 08 PM" src="https://github.com/user-attachments/assets/19449e2c-9bc2-4fa4-99b6-660deb460cbe" /> ## Test Plan

ximinez force-pushed the ximinez/lending-XLS-66 branch 4 times, most recently from 1240135 to 6f5d1ad Compare February 4, 2025 19:35

ximinez force-pushed the ximinez/lending-XLS-66 branch 3 times, most recently from 27e4c4f to 2d209c4 Compare February 8, 2025 00:58

ximinez force-pushed the ximinez/lending-XLS-66 branch 5 times, most recently from e8fbd22 to a697138 Compare February 28, 2025 19:24

ximinez force-pushed the ximinez/lending-XLS-66 branch 7 times, most recently from 72d979e to 441d5b5 Compare March 17, 2025 20:23

ximinez changed the base branch from develop to ximinez/Bronek/vault March 17, 2025 22:52

ximinez force-pushed the ximinez/Bronek/vault branch from b1e091c to 2a8861d Compare March 19, 2025 00:44

ximinez force-pushed the ximinez/lending-XLS-66 branch 8 times, most recently from 5223459 to c7b296c Compare March 25, 2025 16:30

shawnxie999 reviewed Nov 25, 2025

View reviewed changes

src/xrpld/app/tx/detail/LoanBrokerCoverClawback.cpp Outdated Show resolved Hide resolved

shawnxie999 reviewed Nov 28, 2025

View reviewed changes

src/xrpld/app/tx/detail/LoanSet.cpp Show resolved Hide resolved

shawnxie999 reviewed Nov 28, 2025

View reviewed changes

src/xrpld/app/tx/detail/LoanSet.cpp Show resolved Hide resolved

shawnxie999 reviewed Nov 28, 2025

View reviewed changes

dangell7 reviewed Dec 1, 2025

View reviewed changes

src/xrpld/app/tx/detail/Transactor.cpp Show resolved Hide resolved

src/libxrpl/ledger/ApplyView.cpp Show resolved Hide resolved

src/libxrpl/ledger/ApplyView.cpp Outdated Show resolved Hide resolved

src/libxrpl/ledger/ApplyView.cpp Outdated Show resolved Hide resolved

This was referenced Dec 1, 2025

Placeholder to use as a base for the next lending PR #6092

Draft

Lending protocol Part 2 for re-review - XLS-66 #6093

Open

shawnxie999 approved these changes Dec 1, 2025

View reviewed changes

gregtatcam approved these changes Dec 1, 2025

View reviewed changes

ximinez requested a review from dangell7 December 1, 2025 22:48

Tapanito approved these changes Dec 2, 2025

View reviewed changes

dangell7 approved these changes Dec 2, 2025

View reviewed changes

ximinez force-pushed the ximinez/lending-XLS-66 branch from a5a2b38 to 3ca1593 Compare December 2, 2025 16:17

ximinez added the Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required. label Dec 2, 2025

ximinez enabled auto-merge (squash) December 2, 2025 16:31

ximinez merged commit 6c67f1f into develop Dec 2, 2025
24 checks passed

ximinez deleted the ximinez/lending-XLS-66 branch December 2, 2025 16:38

ximinez added a commit that referenced this pull request Dec 2, 2025

Revert "Implement Lending Protocol (unsupported) (#5270)"

b772f62

This reverts commit 6c67f1f.

ximinez mentioned this pull request Dec 2, 2025

release-3.0.0-rc2 #6079

Merged

13 tasks

This was referenced Dec 3, 2025

Lending protocol - ongoing work and bug fixes - XLS-66 #6102

Open

Thoughts on the interaction of STAmount and STNumber with expanded mantissas (an offshoot of #6025) #6105

Closed

Fixing LoanBrokerCoverClawback to check for lsfMPTCanLock flag #6128

Closed

ximinez mentioned this pull request Dec 12, 2025

Number: Change LendingProtocol and SAV features to supported #6146

Draft

1 task

ximinez mentioned this pull request Dec 18, 2025

(Release 3.1) Lending protocol - ongoing work - XLS-66 #6156

Open

7 tasks

Lending Protocol implementation XLS-66 #5270

Lending Protocol implementation XLS-66 #5270

Uh oh!

Conversation

ximinez commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

High Level Overview of Change

Context of Change

Type of Change

API Impact

Uh oh!

codecov bot commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shawnxie999 Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

ximinez Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

shawnxie999 Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dangell7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shawnxie999 left a comment

Choose a reason for hiding this comment

Uh oh!

gregtatcam left a comment

Choose a reason for hiding this comment

Uh oh!

ximinez commented Dec 2, 2025

Uh oh!

dangell7 left a comment

Choose a reason for hiding this comment

Uh oh!

ximinez commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

ximinez commented Jan 31, 2025 •

edited

Loading

codecov bot commented Feb 4, 2025 •

edited

Loading

shawnxie999 Dec 1, 2025 •

edited

Loading

ximinez commented Dec 2, 2025 •

edited

Loading