feat: add support for Batch amendment (#757)

Author: mvadari

.ci-config/rippled.cfg

@@ -171,32 +171,37 @@ AMM
 Clawback
 fixReducedOffersV1
 fixNFTokenRemint
-# 2.0.0-b4 Amendments
+# 2.0.0 Amendments
 XChainBridge
 DID
-# 2.2.0-b3 Amendments
+# 2.2.0 Amendments
 fixNFTokenReserve
 fixInnerObjTemplate
 fixAMMOverflowOffer
 PriceOracle
 fixEmptyDID
 fixXChainRewardRounding
 fixPreviousTxnID
-# 2.3.0 Amendments
 fixAMMv1_1
-fixAMMv1_2
+# 2.3.0 Amendments
 AMMClawback
-InvariantsV1_1
 Credentials
 NFTokenMintOffer
 MPTokensV1
+fixAMMv1_2
 fixNFTokenPageLinks
 fixInnerObjTemplate2
 fixEnforceNFTokenTrustline
 fixReducedOffersV2
+# 2.4.0 Amendments
 DeepFreeze
+DynamicNFT
 PermissionedDomains
+fixFrozenLPTokenTransfer
+fixInvalidTxFlags
+# 2.5.0 Amendments
 PermissionDelegation
+Batch
 
 # This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
 [voting]

.vscode/settings.json

@@ -4,13 +4,17 @@
     "aiounittest",
     "altnet",
     "asyncio",
+    "autofilling",
     "autofills",
     "binarycodec",
     "Clawback",
     "isnumeric",
     "keypair",
     "keypairs",
+    "multiaccount",
     "multisign",
+    "multisigned",
+    "multisigning",
     "nftoken",
     "PATHSET",
     "rippletest",

CHANGELOG.md

@@ -7,17 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [[Unreleased]]
 
-### Fixed
-- Added `MPTCurrency` support in `Issue` (rippled internal type)
-- Fixed the implementation error in get_latest_open_ledger_sequence method. The change uses the "current" ledger for extracting sequence number.
-- Increase default maximum payload size for websocket client
-- Fixed the default behavior of flags field when preparing transactions. By default, flags are not part of the transaction if not explicitly provided.
-- Added support for `amm_info` to `Request.from_dict`
-- Improved error handling for `amm_info`
-
 ### Added
 - Improved validation for models to also check param types
 - Support for `Account Permission` and `Account Permission Delegation` (XLS-74d, XLS-75d)
+- Support for the `Batch` amendment (XLS-56d)
+
+### Fixed
+- Add `MPTCurrency` support in `Issue` (rippled internal type)
+- Fix the implementation error in get_latest_open_ledger_sequence method. The change uses the "current" ledger for extracting sequence number
+- Increase default maximum payload size for websocket client
+- Fix the default behavior of flags field when preparing transactions. By default, flags are not part of the transaction if not explicitly provided
+- Add support for `amm_info` to `Request.from_dict`
+- Improve error handling for `amm_info`
+- Handle autofilling better when multisigning transactions
+- Improve typing for transaction-related helper functions
+- Improve handling of `TicketSequence`
+- Fix issue with failing on a higher than expected fee
+- Improve multi-sign fee calculations
 
 ## [4.1.0] - 2025-2-13
 

tests/integration/it_utils.py

@@ -110,7 +110,7 @@ def fund_wallet(wallet: Wallet) -> None:
         destination=wallet.address,
         amount=FUNDING_AMOUNT,
     )
-    sign_and_submit(payment, client, MASTER_WALLET, check_fee=True)
+    sign_and_submit(payment, client, MASTER_WALLET)
     client.request(LEDGER_ACCEPT_REQUEST)
 
 
@@ -122,7 +122,7 @@ async def fund_wallet_async(
         destination=wallet.address,
         amount=FUNDING_AMOUNT,
     )
-    await sign_and_submit_async(payment, client, MASTER_WALLET, check_fee=True)
+    await sign_and_submit_async(payment, client, MASTER_WALLET)
     await client.request(LEDGER_ACCEPT_REQUEST)
 
 

tests/integration/sugar/test_transaction.py

@@ -6,6 +6,7 @@
 )
 from tests.integration.reusable_values import DESTINATION as DESTINATION_WALLET
 from tests.integration.reusable_values import WALLET
+from xrpl.asyncio.account import get_next_valid_seq_number
 from xrpl.asyncio.ledger import get_fee, get_latest_validated_ledger_sequence
 from xrpl.asyncio.transaction import (
     XRPLReliableSubmissionException,
@@ -24,7 +25,15 @@
 from xrpl.models.amounts.issued_currency_amount import IssuedCurrencyAmount
 from xrpl.models.exceptions import XRPLException
 from xrpl.models.requests import ServerState, Tx
-from xrpl.models.transactions import AccountDelete, AccountSet, EscrowFinish, Payment
+from xrpl.models.transactions import (
+    AccountDelete,
+    AccountSet,
+    Batch,
+    DepositPreauth,
+    EscrowFinish,
+    Payment,
+    TransactionFlag,
+)
 from xrpl.utils import xrp_to_drops
 
 ACCOUNT = WALLET.address
@@ -326,6 +335,37 @@ async def test_simulate(self, client):
         self.assertEqual(response.result["engine_result_code"], 0)
         self.assertFalse(response.result["applied"])
 
+    @test_async_and_sync(
+        globals(),
+        ["xrpl.transaction.autofill", "xrpl.account.get_next_valid_seq_number"],
+    )
+    async def test_batch_autofill(self, client):
+        tx = Batch(
+            account="rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+            raw_transactions=[
+                DepositPreauth(
+                    account=WALLET.address,
+                    authorize="rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+                ),
+                DepositPreauth(
+                    account=WALLET.address,
+                    authorize="rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+                ),
+            ],
+        )
+        transaction = await autofill(tx, client)
+
+        sequence = await get_next_valid_seq_number(WALLET.address, client)
+        for i in range(len(transaction.raw_transactions)):
+            raw_tx = transaction.raw_transactions[i]
+            self.assertTrue(raw_tx.has_flag(TransactionFlag.TF_INNER_BATCH_TXN))
+            self.assertEqual(raw_tx.sequence, sequence + i)
+            self.assertEqual(raw_tx.network_id, 63456)
+            self.assertIsNone(raw_tx.last_ledger_sequence)
+            self.assertEqual(raw_tx.fee, "0")
+            self.assertEqual(raw_tx.signing_pub_key, "")
+            self.assertEqual(raw_tx.txn_signature, None)
+
 
 class TestSubmitAndWait(IntegrationTestCase):
     @test_async_and_sync(

tests/integration/transactions/test_batch.py

@@ -0,0 +1,51 @@
+from tests.integration.integration_test_case import IntegrationTestCase
+from tests.integration.it_utils import (
+    sign_and_reliable_submission_async,
+    test_async_and_sync,
+)
+from tests.integration.reusable_values import DESTINATION, WALLET
+from xrpl.asyncio.transaction import autofill
+from xrpl.models import Batch, BatchFlag, Payment
+from xrpl.models.response import ResponseStatus
+from xrpl.transaction.batch_signers import sign_multiaccount_batch
+
+
+class TestBatch(IntegrationTestCase):
+    @test_async_and_sync(globals())
+    async def test_basic_functionality(self, client):
+        payment = Payment(
+            account=WALLET.address,
+            amount="1",
+            destination=DESTINATION.address,
+        )
+        batch = Batch(
+            account=WALLET.address,
+            flags=BatchFlag.TF_ALL_OR_NOTHING,
+            raw_transactions=[payment, payment],
+        )
+        response = await sign_and_reliable_submission_async(batch, WALLET, client)
+        self.assertEqual(response.status, ResponseStatus.SUCCESS)
+        self.assertEqual(response.result["engine_result"], "tesSUCCESS")
+
+    @test_async_and_sync(globals(), ["xrpl.transaction.autofill"])
+    async def test_multisign(self, client):
+        payment = Payment(
+            account=WALLET.address,
+            amount="1",
+            destination=DESTINATION.address,
+        )
+        payment2 = Payment(
+            account=DESTINATION.address,
+            amount="1",
+            destination=WALLET.address,
+        )
+        batch = Batch(
+            account=WALLET.address,
+            flags=BatchFlag.TF_ALL_OR_NOTHING,
+            raw_transactions=[payment, payment2],
+        )
+        autofilled = await autofill(batch, client, 1)
+        signed = sign_multiaccount_batch(DESTINATION, autofilled)
+        response = await sign_and_reliable_submission_async(signed, WALLET, client)
+        self.assertEqual(response.status, ResponseStatus.SUCCESS)
+        self.assertEqual(response.result["engine_result"], "tesSUCCESS")

tests/unit/core/binarycodec/test_main.py

@@ -11,6 +11,7 @@
     encode,
     encode_for_multisigning,
     encode_for_signing,
+    encode_for_signing_batch,
     encode_for_signing_claim,
 )
 
@@ -401,6 +402,30 @@ def test_claim(self):
         )
         self.assertEqual(encode_for_signing_claim(json), expected)
 
+    def test_batch(self):
+        flags = 1
+        transaction_ids = [
+            "ABE4871E9083DF66727045D49DEEDD3A6F166EB7F8D1E92FE868F02E76B2C5CA",
+            "795AAC88B59E95C3497609749127E69F12958BC016C600C770AEEB1474C840B4",
+        ]
+
+        json = {"flags": flags, "transaction_ids": transaction_ids}
+        actual = encode_for_signing_batch(json)
+        self.assertEqual(
+            actual,
+            (
+                # hash prefix
+                "42434800"
+                # flags
+                "00000001"
+                # transaction_ids length
+                "00000002"
+                # transaction_ids
+                "ABE4871E9083DF66727045D49DEEDD3A6F166EB7F8D1E92FE868F02E76B2C5CA"
+                "795AAC88B59E95C3497609749127E69F12958BC016C600C770AEEB1474C840B4"
+            ),
+        )
+
     def test_multisig(self):
         signing_account = "rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN"
         multisig_json = {**signing_json, "SigningPubKey": ""}

tests/unit/models/transactions/test_batch.py

@@ -0,0 +1,41 @@
+from unittest import TestCase
+
+from xrpl.models import Batch, BatchFlag, Payment, TransactionFlag
+from xrpl.models.exceptions import XRPLModelException
+
+_ACCOUNT = "r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ"
+_DESTINATION = "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg"
+
+
+class TestBatch(TestCase):
+    def test_basic(self):
+        payment = Payment(
+            account=_ACCOUNT,
+            amount="1",
+            destination=_DESTINATION,
+        )
+        batch = Batch(
+            account=_ACCOUNT,
+            flags=BatchFlag.TF_ALL_OR_NOTHING,
+            raw_transactions=[payment, payment],
+        )
+        self.assertTrue(batch.is_valid())
+        self.assertTrue(
+            batch.raw_transactions[0].has_flag(TransactionFlag.TF_INNER_BATCH_TXN)
+        )
+        self.assertTrue(
+            batch.raw_transactions[1].has_flag(TransactionFlag.TF_INNER_BATCH_TXN)
+        )
+
+    def test_too_few_inner_transactions(self):
+        payment = Payment(
+            account=_ACCOUNT,
+            amount="1",
+            destination=_DESTINATION,
+        )
+        with self.assertRaises(XRPLModelException):
+            Batch(
+                account=_ACCOUNT,
+                flags=BatchFlag.TF_ALL_OR_NOTHING,
+                raw_transactions=[payment],
+            )

tests/unit/models/transactions/test_delegate_set.py

@@ -95,7 +95,7 @@ def test_account_and_delegate_are_the_same(self):
             + "'}",
         )
 
-    def test_non_delegatable_transactions(self):
+    def test_non_delegable_transactions(self):
         with self.assertRaises(XRPLModelException) as error:
             DelegateSet(
                 account=_ACCOUNT,
@@ -109,6 +109,6 @@ def test_non_delegatable_transactions(self):
             )
         self.assertEqual(
             error.exception.args[0],
-            "{'permissions': \"Non-delegatable transactions found in `permissions` "
+            "{'permissions': \"Non-delegable transactions found in `permissions` "
             "list: {<TransactionType.ACCOUNT_DELETE: 'AccountDelete'>}.\"}",
         )