Merge branch 'main' into mptDex

Author: ckeshava

CHANGELOG.md

@@ -12,7 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `sign_loan_set_by_counterparty` helper function to sign LoanSet transactions as the counterparty (supports both single-sign and multi-sign modes)
 - Added `combine_loanset_counterparty_signers` helper function to combine multiple counterparty signatures for multi-sign LoanSet transactions
 - Added `compute_signature` helper function to compute transaction signatures with optional multi-sign support
+- Introduce the binary-codec for the new rippled type titled "Int32". This type is used to represent the LoanScale field relating to the Lending Protocol.
+
+### Fixed
+
 - Updates `Number` codec with mantissa range normalization ([10^18, 10^19 - 1]) and appropriate overflow/underflow checks
+- Fix `Request.from_xrpl` by aliasing it to `Request.from_dict`
 
 ## [[4.4.0]] - 2025-12-16
 

tests/unit/core/binarycodec/types/test_int32.py

@@ -0,0 +1,36 @@
+from unittest import TestCase
+
+from xrpl.core.binarycodec import XRPLBinaryCodecException
+from xrpl.core.binarycodec.types.int32 import Int32
+
+
+class TestInt32(TestCase):
+    def test_compare_INT32(self):
+        value1 = Int32.from_value(124)
+        value2 = Int32.from_value(123)
+        value3 = Int32.from_value(124)
+
+        self.assertGreater(value1, value2)
+        self.assertLess(value2, value1)
+        self.assertNotEqual(value1, value2)
+        self.assertEqual(value1, value3)
+
+    def test_from_value(self):
+        self.assertEqual(Int32.from_value(0).to_json(), 0)
+        self.assertEqual(Int32.from_value(110).to_json(), 110)
+        self.assertEqual(Int32.from_value(-123).to_json(), -123)
+
+    def test_limits(self):
+        self.assertEqual(Int32.from_value(-2147483648).to_json(), -2147483648)
+        self.assertEqual(Int32.from_value(2147483647).to_json(), 2147483647)
+
+    def test_compare(self):
+        value1 = Int32.from_value(124)
+
+        self.assertEqual(value1, 124)
+        self.assertLess(value1, 1000)
+        self.assertGreater(value1, -1000)
+
+    def test_raises_invalid_value_type(self):
+        invalid_value = [1, 2, 3]
+        self.assertRaises(XRPLBinaryCodecException, Int32.from_value, invalid_value)

tests/unit/models/requests/test_requests.py

@@ -29,6 +29,18 @@ def test_from_dict(self):
         }
         self.assertDictEqual(obj.to_dict(), expected)
 
+    def test_from_xrpl(self):
+        req = {"method": "account_tx", "account": "rN6zcSynkRnf8zcgTVrRL8K7r4ovE7J4Zj"}
+        obj = Request.from_xrpl(req)
+        self.assertEqual(obj.__class__.__name__, "AccountTx")
+        expected = {
+            **req,
+            "binary": False,
+            "forward": False,
+            "api_version": _DEFAULT_API_VERSION,
+        }
+        self.assertDictEqual(obj.to_dict(), expected)
+
     def test_from_dict_no_method(self):
         req = {"account": "rN6zcSynkRnf8zcgTVrRL8K7r4ovE7J4Zj"}
         with self.assertRaises(XRPLModelException):

tests/unit/models/transactions/test_loan_broker_cover_withdraw.py

@@ -0,0 +1,28 @@
+from unittest import TestCase
+
+from xrpl.models.transactions import LoanBrokerCoverWithdraw
+
+_ACCOUNT = "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"
+_LOAN_BROKER_ID = "DB303FC1C7611B22C09E773B51044F6BEA02EF917DF59A2E2860871E167066A5"
+_DESTINATION = "rf7HPydP4ihkFkSRHWFq34b4SXRc7GvPCR"
+_DESTINATION_TAG = 2345
+
+
+class TestLoanBrokerCoverWithdraw(TestCase):
+    def test_valid(self):
+        tx = LoanBrokerCoverWithdraw(
+            account=_ACCOUNT,
+            loan_broker_id=_LOAN_BROKER_ID,
+            amount="1000",
+            destination=_DESTINATION,
+            destination_tag=_DESTINATION_TAG,
+        )
+        self.assertTrue(tx.is_valid())
+
+    def test_valid_minimal_fields(self):
+        tx = LoanBrokerCoverWithdraw(
+            account=_ACCOUNT,
+            loan_broker_id=_LOAN_BROKER_ID,
+            amount="1000",
+        )
+        self.assertTrue(tx.is_valid())

tests/unit/models/transactions/test_loan_pay.py

@@ -0,0 +1,45 @@
+from unittest import TestCase
+
+from xrpl.models.exceptions import XRPLModelException
+from xrpl.models.transactions import LoanPay, LoanPayFlag
+
+_SOURCE = "r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ"
+_LOAN_ID = "78381E3BA82D0464D27B6E7D968657EB8EFF95625A4FE623840127F61F468D4C"
+
+
+class TestLoanPay(TestCase):
+    def test_invalid_multiple_flags_enabled(self):
+        with self.assertRaises(XRPLModelException) as error:
+            LoanPay(
+                account=_SOURCE,
+                loan_id=_LOAN_ID,
+                amount="1000",
+                flags=LoanPayFlag.TF_LOAN_OVERPAYMENT
+                | LoanPayFlag.TF_LOAN_FULL_PAYMENT,
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'LoanPay:Flags': 'Only one flag must be enabled in the LoanPay "
+            + "transaction'}",
+        )
+
+    def test_invalid_flag_input(self):
+        with self.assertRaises(XRPLModelException) as error:
+            LoanPay(
+                account=_SOURCE,
+                loan_id=_LOAN_ID,
+                amount="1000",
+                flags=0x00080000,
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'LoanPay:Flags': 'Unrecognised flag in the LoanPay " + "transaction'}",
+        )
+
+    def test_valid_loan_pay(self):
+        tx = LoanPay(
+            account=_SOURCE,
+            loan_id=_LOAN_ID,
+            amount="1000",
+        )
+        self.assertTrue(tx.is_valid())

tests/unit/models/transactions/test_vault_create.py

@@ -18,6 +18,7 @@ def test_valid(self):
             assets_maximum="1000",
             withdrawal_policy=1,
             data=str_to_hex("A" * 256),
+            scale=4,
         )
         self.assertTrue(tx.is_valid())
 
@@ -121,3 +122,33 @@ def test_tx_emits_warning_for_missing_icon_metadata(self):
                 "- uris/us: should be an array of objects each "
                 "with uri/u, category/c, and title/t properties.",
             )
+
+    def test_scale_field_too_large(self):
+        with self.assertRaises(XRPLModelException) as error:
+            VaultCreate(
+                account=_ACCOUNT,
+                asset=IssuedCurrency(currency="USD", issuer=_ACCOUNT),
+                assets_maximum="1000",
+                withdrawal_policy=1,
+                data=str_to_hex("A" * 256),
+                scale=18 + 1,
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'VaultCreate': 'Scale field is higher than the allowed limit (18)'}",
+        )
+
+    def test_scale_field_too_small(self):
+        with self.assertRaises(XRPLModelException) as error:
+            VaultCreate(
+                account=_ACCOUNT,
+                asset=IssuedCurrency(currency="USD", issuer=_ACCOUNT),
+                assets_maximum="1000",
+                withdrawal_policy=1,
+                data=str_to_hex("A" * 256),
+                scale=-1,
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'VaultCreate': 'Scale field is lower than the allowed limit (0)'}",
+        )

tests/unit/models/transactions/test_vault_withdraw.py

@@ -6,6 +6,7 @@
 
 _ACCOUNT = "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"
 _VAULT_ID = "B982D2AAEF6014E6BE3194D939865453D56D16FF7081BB1D0ED865C708ABCEEE"
+_DESTINATION = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
 
 
 class TestVaultWithdraw(TestCase):
@@ -17,6 +18,16 @@ def test_valid(self):
         )
         self.assertTrue(tx.is_valid())
 
+    def test_valid_with_destination_tag(self):
+        tx = VaultWithdraw(
+            account=_ACCOUNT,
+            vault_id=_VAULT_ID,
+            amount=IssuedCurrencyAmount(currency="USD", issuer=_ACCOUNT, value="100"),
+            destination=_DESTINATION,
+            destination_tag=3000,
+        )
+        self.assertTrue(tx.is_valid())
+
     def test_invalid_vault_id_field(self):
         with self.assertRaises(XRPLModelException) as e:
             VaultWithdraw(

xrpl/core/binarycodec/definitions/definitions.json

@@ -2351,7 +2351,7 @@
       }
     ],
     [
-      "DummyInt32",
+      "DebtTotal",
       {
         "isSerialized": true,
         "isSigningField": true,
@@ -2439,6 +2439,36 @@
         "type": "Number"
       }
     ],
+    [
+      "TotalValueOutstanding",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 15,
+        "type": "Number"
+      }
+    ],
+    [
+      "PeriodicPayment",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 16,
+        "type": "Number"
+      }
+    ],
+    [
+      "ManagementFeeOutstanding",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 17,
+        "type": "Number"
+      }
+    ],
     [
       "TransactionMetaData",
       {
@@ -3059,6 +3089,16 @@
         "type": "UInt8"
       }
     ],
+    [
+      "LoanScale",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 1,
+        "type": "Int32"
+      }
+    ],
     [
       "Method",
       {

xrpl/core/binarycodec/types/__init__.py

@@ -9,6 +9,7 @@
 from xrpl.core.binarycodec.types.hash160 import Hash160
 from xrpl.core.binarycodec.types.hash192 import Hash192
 from xrpl.core.binarycodec.types.hash256 import Hash256
+from xrpl.core.binarycodec.types.int32 import Int32
 from xrpl.core.binarycodec.types.issue import Issue
 from xrpl.core.binarycodec.types.number import Number
 from xrpl.core.binarycodec.types.path_set import PathSet
@@ -32,6 +33,7 @@
     "Hash160",
     "Hash192",
     "Hash256",
+    "Int32",
     "Issue",
     "Number",
     "PathSet",

xrpl/core/binarycodec/types/int.py

@@ -0,0 +1,25 @@
+"""Base class for serializing and deserializing signed integers.
+See `Int Fields <https://xrpl.org/serialization.html#int-fields>`_
+"""
+
+from __future__ import annotations
+
+from typing_extensions import Self
+
+from xrpl.core.binarycodec.types.uint import UInt
+
+
+class Int(UInt):
+    """Base class for serializing and deserializing signed integers.
+    See `Int Fields <https://xrpl.org/serialization.html#int-fields>`_
+    """
+
+    @property
+    def value(self: Self) -> int:
+        """
+        Get the value of the Int represented by `self.buffer`.
+
+        Returns:
+            The int value of the Int.
+        """
+        return int.from_bytes(self.buffer, byteorder="big", signed=True)