XRPLF · mvadari · May 3, 2024 · May 7, 2024 · May 8, 2024 · May 8, 2024
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -3,6 +3,8 @@
     "cSpell.words": [
         "altnet",
         "Autofills",
+        "Batchnet",
+        "bignumber",
         "Clawback",
         "hostid",
         "keypair",
@@ -16,7 +18,8 @@
         "secp256k1",
         "Setf",
         "Sidechains",
-        "xchain"
+        "xchain",
+        "xrplf"
     ],
     "[javascript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode",

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/ripple-binary-codec/HISTORY.md b/packages/ripple-binary-codec/HISTORY.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Added
+* Support for the `Batch` amendment (XLS-56).
+
 ### Fixed
 * add `MPTCurrency` support in `Issue` (rippled internal type)
 * Throw an error during serialization if a field is unknown, rather than silently throwing it away.
@@ -15,7 +18,7 @@
 ## 2.2.0 (2024-12-23)
 
 ### Added
-* Support for the Multi-Purpose Token amendment (XLS-33)
+* Support for the Multi-Purpose Token amendment (XLS-33).
 
 ## 2.1.0 (2024-06-03)
 

diff --git a/packages/ripple-binary-codec/package.json b/packages/ripple-binary-codec/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ripple-binary-codec",
-  "version": "2.3.0",
+  "version": "2.3.0-batch.0",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",

diff --git a/packages/ripple-binary-codec/src/binary.ts b/packages/ripple-binary-codec/src/binary.ts
@@ -177,11 +177,51 @@ function multiSigningData(
   })
 }
 
+/**
+ * Interface describing fields required for a Batch signer
+ * @property flags - Flags indicating Batch transaction properties
+ * @property txIDs - Array of transaction IDs included in the Batch
+ */
+interface BatchObject extends JsonObject {
+  flags: number
+  txIDs: string[]
+}
+
+/**
+ * Serialize a signingClaim
+ *
+ * @param batch A Batch object to serialize.
+ * @returns the serialized object with appropriate prefix
+ */
+function signingBatchData(batch: BatchObject): Uint8Array {
+  if (batch.flags == null) {
+    throw Error("No field `flags'")
+  }
+  if (batch.txIDs == null) {
+    throw Error('No field `txIDs`')
+  }
+  const prefix = HashPrefix.batch
+  const flags = coreTypes.UInt32.from(batch.flags).toBytes()
+  const txIDsLength = coreTypes.UInt32.from(batch.txIDs.length).toBytes()
+
+  const bytesList = new BytesList()
+
+  bytesList.put(prefix)
+  bytesList.put(flags)
+  bytesList.put(txIDsLength)
+  batch.txIDs.forEach((txID: string) => {
+    bytesList.put(coreTypes.Hash256.from(txID).toBytes())
+  })
+
+  return bytesList.toBytes()
+}
+
 export {
   BinaryParser,
   BinarySerializer,
   BytesList,
   ClaimObject,
+  BatchObject,
   makeParser,
   serializeObject,
   readJSON,
@@ -191,4 +231,5 @@ export {
   binaryToJSON,
   sha512Half,
   transactionID,
+  signingBatchData,
 }
diff --git a/packages/ripple-binary-codec/src/enums/definitions.json b/packages/ripple-binary-codec/src/enums/definitions.json
@@ -1260,6 +1260,16 @@
         "type": "Hash256"
       }
     ],
+    [
+      "ParentBatchID",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 35,
+        "type": "Hash256"
+      }
+    ],
     [
       "hash",
       {
@@ -2340,6 +2350,26 @@
         "type": "STObject"
       }
     ],
+    [
+      "RawTransaction",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 34,
+        "type": "STObject"
+      }
+    ],
+    [
+      "BatchSigner",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 35,
+        "type": "STObject"
+      }
+    ],
     [
       "Signers",
       {
@@ -2560,6 +2590,26 @@
         "type": "STArray"
       }
     ],
+    [
+      "RawTransactions",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 29,
+        "type": "STArray"
+      }
+    ],
+    [
+      "BatchSigners",
+      {
+        "isSerialized": true,
+        "isSigningField": false,
+        "isVLEncoded": false,
+        "nth": 30,
+        "type": "STArray"
+      }
+    ],
     [
       "CloseResolution",
       {
@@ -3059,6 +3109,7 @@
     "temINVALID_ACCOUNT_ID": -268,
     "temINVALID_COUNT": -266,
     "temINVALID_FLAG": -276,
+    "temINVALID_INNER_BATCH": -250,
     "temMALFORMED": -299,
     "temREDUNDANT": -275,
     "temRIPPLE_EMPTY": -274,
@@ -3098,6 +3149,7 @@
     "AMMWithdraw": 37,
     "AccountDelete": 21,
     "AccountSet": 3,
+    "Batch": 64,
     "CheckCancel": 18,
     "CheckCash": 17,
     "CheckCreate": 16,

diff --git a/packages/ripple-binary-codec/src/hash-prefixes.ts b/packages/ripple-binary-codec/src/hash-prefixes.ts
@@ -35,6 +35,8 @@ const HashPrefix: Record<string, Uint8Array> = {
   proposal: bytes(0x50525000),
   // payment channel claim
   paymentChannelClaim: bytes(0x434c4d00),
+  // batch
+  batch: bytes(0x42434800),
 }
 
 export { HashPrefix }
diff --git a/packages/ripple-binary-codec/src/index.ts b/packages/ripple-binary-codec/src/index.ts
@@ -1,6 +1,6 @@
 import { quality, binary, HashPrefix } from './coretypes'
 import { decodeLedgerData } from './ledger-hashes'
-import { ClaimObject } from './binary'
+import { ClaimObject, BatchObject } from './binary'
 import { JsonObject } from './types/serialized-type'
 import {
   XrplDefinitionsBase,
@@ -15,6 +15,7 @@ const {
   signingData,
   signingClaimData,
   multiSigningData,
+  signingBatchData,
   binaryToJSON,
   serializeObject,
 } = binary
@@ -71,12 +72,10 @@ function encodeForSigning(
 }
 
 /**
- * Encode a transaction and prepare for signing with a claim
+ * Encode a payment channel claim for signing.
  *
- * @param json JSON object representing the transaction
- * @param signer string representing the account to sign the transaction with
- * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
- * @returns a hex string of the encoded transaction
+ * @param json JSON object representing the claim.
+ * @returns a hex string of the encoded claim.
  */
 function encodeForSigningClaim(json: object): string {
   if (typeof json !== 'object') {
@@ -86,12 +85,12 @@ function encodeForSigningClaim(json: object): string {
 }
 
 /**
- * Encode a transaction and prepare for multi-signing
+ * Encode a transaction and prepare for multi-signing.
  *
- * @param json JSON object representing the transaction
- * @param signer string representing the account to sign the transaction with
+ * @param json JSON object representing the transaction.
+ * @param signer string representing the account to sign the transaction with.
  * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
- * @returns a hex string of the encoded transaction
+ * @returns a hex string of the encoded transaction.
  */
 function encodeForMultisigning(
   json: object,
@@ -110,6 +109,19 @@ function encodeForMultisigning(
   )
 }
 
+/**
+ * Encode a Batch transaction for signing.
+ *
+ * @param json JSON object representing the transaction.
+ * @returns a hex string of the encoded transaction.
+ */
+function encodeForSigningBatch(json: object): string {
+  if (typeof json !== 'object') {
+    throw new Error('Need an object to encode a Batch transaction')
+  }
+  return bytesToHex(signingBatchData(json as BatchObject))
+}
+
 /**
  * Encode a quality value
  *
@@ -142,6 +154,7 @@ export {
   encodeForSigning,
   encodeForSigningClaim,
   encodeForMultisigning,
+  encodeForSigningBatch,
   encodeQuality,
   decodeQuality,
   decodeLedgerData,

diff --git a/packages/ripple-binary-codec/src/types/hash.ts b/packages/ripple-binary-codec/src/types/hash.ts
@@ -27,6 +27,9 @@ class Hash extends Comparable<Hash | string> {
     }
 
     if (typeof value === 'string') {
+      if (!/^[A-F0-9]*$/i.test(value)) {
+        throw new Error(`Invalid hash string ${value}`)
+      }
       return new this(hexToBytes(value))
     }
 

diff --git a/packages/ripple-binary-codec/test/signing-data-encoding.test.ts b/packages/ripple-binary-codec/test/signing-data-encoding.test.ts
@@ -3,6 +3,7 @@ const {
   encodeForSigning,
   encodeForSigningClaim,
   encodeForMultisigning,
+  encodeForSigningBatch,
 } = require('../src')
 
 const normalDefinitions = require('../src/enums/definitions.json')
@@ -244,4 +245,27 @@ describe('Signing data', function () {
       ].join(''),
     )
   })
+
+  it('can create batch blob', function () {
+    const flags = 1
+    const txIDs = [
+      'ABE4871E9083DF66727045D49DEEDD3A6F166EB7F8D1E92FE868F02E76B2C5CA',
+      '795AAC88B59E95C3497609749127E69F12958BC016C600C770AEEB1474C840B4',
+    ]
+    const json = { flags, txIDs }
+    const actual = encodeForSigningBatch(json)
+    expect(actual).toBe(
+      [
+        // hash prefix
+        '42434800',
+        // flags
+        '00000001',
+        // txIds length
+        '00000002',
+        // txIds
+        'ABE4871E9083DF66727045D49DEEDD3A6F166EB7F8D1E92FE868F02E76B2C5CA',
+        '795AAC88B59E95C3497609749127E69F12958BC016C600C770AEEB1474C840B4',
+      ].join(''),
+    )
+  })
 })
diff --git a/packages/xrpl/.eslintrc.js b/packages/xrpl/.eslintrc.js
@@ -66,6 +66,7 @@ module.exports = {
     'tsdoc/syntax': 'off',
     'jsdoc/require-description-complete-sentence': 'off',
     'import/prefer-default-export': 'off',
+    'max-depth': ['warn', 3],
   },
   overrides: [
     {
@@ -155,7 +156,6 @@ module.exports = {
         'max-lines-per-function': ['off'],
         'max-statements': ['off'],
         complexity: ['off'],
-        'max-depth': ['warn', 3],
       },
     },
   ],

diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md
@@ -6,6 +6,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 
 ### Added
 * Support for `NFTokenMintOffer` (XLS-52)
+* Add support for `Batch` amendment (XLS-56)
 
 ### Fixed
 * `OracleSet` transaction accepts hexadecimal string values for `AssetPrice` field

diff --git a/packages/xrpl/package.json b/packages/xrpl/package.json
@@ -1,6 +1,6 @@
 {
   "name": "xrpl",
-  "version": "4.2.5",
+  "version": "4.2.0-batch.0",
   "license": "ISC",
   "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
   "files": [
@@ -29,7 +29,7 @@
     "bignumber.js": "^9.0.0",
     "eventemitter3": "^5.0.1",
     "ripple-address-codec": "^5.0.0",
-    "ripple-binary-codec": "^2.3.0",
+    "ripple-binary-codec": "^2.3.0-batch.0",
     "ripple-keypairs": "^2.0.0"
   },
   "devDependencies": {
@@ -61,7 +61,7 @@
     "test": "jest --config=jest.config.unit.js --verbose false --silent=false",
     "test:integration": "TS_NODE_PROJECT=tsconfig.build.json jest --config=jest.config.integration.js --verbose false --silent=false --runInBand",
     "test:browser": "npm run build && npm run build:browserTests && karma start ./karma.config.js",
-    "test:watch": "jest --watch --verbose false --silent=false --runInBand ./test/**/*.test.ts --testPathIgnorePatterns=./test/integration --testPathIgnorePatterns=./test/fixtures",
+    "test:watch": "jest --watch --config=jest.config.unit.js --verbose false --silent=false",
     "format": "prettier --write '{src,test}/**/*.ts'",
     "lint": "eslint . --ext .ts --max-warnings 0",
     "perf": "./scripts/perf_test.sh",