xrpl 4.0.1-mpt-beta → 4.2.0-batch.0

package/dist/npm/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAAA,+DAe6B;AAmM3B,yGAjNA,+CAAwB,OAiNA;AAOxB,gGAvNA,sCAAe,OAuNA;AAIf,oGA1NA,0CAAmB,OA0NA;AAFnB,iGAvNA,uCAAgB,OAuNA;AAJhB,2FAlNA,iCAAU,OAkNA;AAQV,+FAzNA,qCAAc,OAyNA;AAPd,gGAjNA,sCAAe,OAiNA;AAIf,oGApNA,0CAAmB,OAoNA;AAFnB,iGAjNA,uCAAgB,OAiNA;AAJhB,2FA5MA,iCAAU,OA4MA;AAQV,+FAnNA,qCAAc,OAmNA;AATd,sGAzMA,4CAAqB,OAyMA;AADrB,gGAvMA,sCAAe,OAuMA;AADf,yGArMA,+CAAwB,OAqMA;AAnM1B,6DAM4B;AAC5B,qDAAkE;AAuLhE,uGAvLiB,wBAAsB,OAuLjB;AA/KxB,qCAAuE;AA2KrE,8FA3KO,sBAAa,OA2KP;AACb,8FA5KsB,sBAAa,OA4KtB;AACb,+FA7KqC,uBAAc,OA6KrC;AA5KhB,4EAAmD;AAyJjD,4BAzJK,2BAAiB,CAyJL;AAxJnB,kEAAyC;AAoMvC,uBApMK,sBAAY,CAoML;AAnMd,0EAAiD;AAqM/C,2BArMK,0BAAgB,CAqML;AApMlB,qCAaiB;AACjB,sEAA6C;AAqL3C,yBArLK,wBAAc,CAqLL;AApLhB,uCAOkB;AA0IhB,sGAhJA,+BAAqB,OAgJA;AACrB,sGAhJA,+BAAqB,OAgJA;AACrB,sGAhJA,+BAAqB,OAgJA;AAJrB,iGA3IA,0BAAgB,OA2IA;AAChB,iGA3IA,0BAAgB,OA2IA;AAIhB,iGA9IA,0BAAgB,OA8IA;AA5IlB,wFAA+D;AAmJ7D,kCAnJK,iCAAuB,CAmJL;AAlJzB,yDAA2E;AAsJzE,mGAtJO,qCAAkB,OAsJP;AADlB,mGArJ2B,qCAAkB,OAqJ3B;AApJpB,qDAKyB;AA4HvB,oGAhIA,oCAAmB,OAgIA;AACnB,oGAhIA,oCAAmB,OAgIA;AACnB,qGAhIA,qCAAoB,OAgIA;AACpB,qGAhIA,qCAAoB,OAgIA;AA9HtB,4FAAmE;AA6IjE,oCA7IK,mCAAyB,CA6IL;AA5I3B,mDAAwD;AAwHtD,2FAxHO,0BAAU,OAwHP;AADV,2FAvHmB,0BAAU,OAuHnB;AAtHZ,mDAAgD;AAoK9C,+FApKO,8BAAc,OAoKP;AA3JhB,SAAS,aAAa,CAAC,MAAc;IACnC,IAAI;QACF,IAAA,sBAAa,EAAC,MAAM,CAAC,CAAA;QACrB,OAAO,IAAI,CAAA;KACZ;IAAC,OAAO,IAAI,EAAE;QACb,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAmHC,sCAAa;AA3Gf,SAAS,MAAM,CAAC,MAAiC;IAC/C,OAAO,IAAA,4BAAS,EAAC,MAAM,CAAC,CAAA;AAC1B,CAAC;AAkIC,wBAAM;AA1HR,SAAS,gBAAgB,CAAC,MAAmB;IAC3C,OAAO,IAAA,sCAAmB,EAAC,MAAM,CAAC,CAAA;AACpC,CAAC;AA2HC,4CAAgB;AAnHlB,SAAS,qBAAqB,CAAC,MAA2B;IACxD,OAAO,IAAA,2CAAwB,EAAC,MAAM,CAAC,CAAA;AACzC,CAAC;AAkHC,sDAAqB;AAzGvB,SAAS,qBAAqB,CAAC,MAAmB,EAAE,MAAc;IAChE,OAAO,IAAA,2CAAwB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACjD,CAAC;AAqGC,sDAAqB;AA7FvB,SAAS,MAAM,CAAC,GAAW;IACzB,OAAO,IAAA,4BAAS,EAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AA0FC,wBAAM;AAhFR,SAAS,cAAc,CAAC,OAAe;IACrC,OAAO,IAAA,sCAAe,EAAC,OAAO,CAAC,IAAI,IAAA,4CAAqB,EAAC,OAAO,CAAC,CAAA;AACnE,CAAC;AAqDC,wCAAc;AAvChB,SAAS,WAAW,CAAC,QAA8B;IAEjD,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC3C,CAAC;AAwBC,kCAAW;AAnBb,MAAM,MAAM,GAAG;IACb,YAAY,EAAZ,qBAAY;IACZ,MAAM,EAAN,eAAM;IACN,eAAe,EAAf,wBAAe;IACf,gBAAgB,EAAhB,yBAAgB;IAChB,WAAW,EAAX,oBAAW;IACX,aAAa,EAAb,sBAAa;IACb,UAAU,EAAV,mBAAU;IACV,aAAa,EAAb,sBAAa;IACb,UAAU,EAAV,mBAAU;IACV,gBAAgB,EAAhB,yBAAgB;IAChB,UAAU,EAAV,mBAAU;IACV,kBAAkB,EAAlB,2BAAkB;CACnB,CAAA;AAmBC,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAAA,+DAe6B;AAkM3B,yGAhNA,+CAAwB,OAgNA;AAOxB,gGAtNA,sCAAe,OAsNA;AAIf,oGAzNA,0CAAmB,OAyNA;AAFnB,iGAtNA,uCAAgB,OAsNA;AAJhB,2FAjNA,iCAAU,OAiNA;AAQV,+FAxNA,qCAAc,OAwNA;AAPd,gGAhNA,sCAAe,OAgNA;AAIf,oGAnNA,0CAAmB,OAmNA;AAFnB,iGAhNA,uCAAgB,OAgNA;AAJhB,2FA3MA,iCAAU,OA2MA;AAQV,+FAlNA,qCAAc,OAkNA;AATd,sGAxMA,4CAAqB,OAwMA;AADrB,gGAtMA,sCAAe,OAsMA;AADf,yGApMA,+CAAwB,OAoMA;AAlM1B,6DAM4B;AAC5B,qDAAkE;AAsLhE,uGAtLiB,wBAAsB,OAsLjB;AA9KxB,qCAAuE;AA0KrE,8FA1KO,sBAAa,OA0KP;AACb,8FA3KsB,sBAAa,OA2KtB;AACb,+FA5KqC,uBAAc,OA4KrC;AA3KhB,4EAAmD;AAwJjD,4BAxJK,2BAAiB,CAwJL;AAvJnB,kEAAyC;AAmMvC,uBAnMK,sBAAY,CAmML;AAlMd,0EAAiD;AAoM/C,2BApMK,0BAAgB,CAoML;AAnMlB,qCAaiB;AACjB,sEAA6C;AAoL3C,yBApLK,wBAAc,CAoLL;AAnLhB,uCAOkB;AAyIhB,sGA/IA,+BAAqB,OA+IA;AACrB,sGA/IA,+BAAqB,OA+IA;AACrB,sGA/IA,+BAAqB,OA+IA;AAJrB,iGA1IA,0BAAgB,OA0IA;AAChB,iGA1IA,0BAAgB,OA0IA;AAIhB,iGA7IA,0BAAgB,OA6IA;AA3IlB,wFAA+D;AAkJ7D,kCAlJK,iCAAuB,CAkJL;AAjJzB,yDAA2E;AAqJzE,mGArJO,qCAAkB,OAqJP;AADlB,mGApJ2B,qCAAkB,OAoJ3B;AAnJpB,qDAKyB;AA2HvB,oGA/HA,oCAAmB,OA+HA;AACnB,oGA/HA,oCAAmB,OA+HA;AACnB,qGA/HA,qCAAoB,OA+HA;AACpB,qGA/HA,qCAAoB,OA+HA;AA7HtB,4FAAmE;AA4IjE,oCA5IK,mCAAyB,CA4IL;AA3I3B,mDAAwD;AAuHtD,2FAvHO,0BAAU,OAuHP;AADV,2FAtHmB,0BAAU,OAsHnB;AA7GZ,SAAS,aAAa,CAAC,MAAc;IACnC,IAAI;QACF,IAAA,sBAAa,EAAC,MAAM,CAAC,CAAA;QACrB,OAAO,IAAI,CAAA;KACZ;IAAC,OAAO,IAAI,EAAE;QACb,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAmHC,sCAAa;AA3Gf,SAAS,MAAM,CAAC,MAAiC;IAC/C,OAAO,IAAA,4BAAS,EAAC,MAAM,CAAC,CAAA;AAC1B,CAAC;AAkIC,wBAAM;AA1HR,SAAS,gBAAgB,CAAC,MAAmB;IAC3C,OAAO,IAAA,sCAAmB,EAAC,MAAM,CAAC,CAAA;AACpC,CAAC;AA2HC,4CAAgB;AAnHlB,SAAS,qBAAqB,CAAC,MAA2B;IACxD,OAAO,IAAA,2CAAwB,EAAC,MAAM,CAAC,CAAA;AACzC,CAAC;AAkHC,sDAAqB;AAzGvB,SAAS,qBAAqB,CAAC,MAAmB,EAAE,MAAc;IAChE,OAAO,IAAA,2CAAwB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACjD,CAAC;AAqGC,sDAAqB;AA7FvB,SAAS,MAAM,CAAC,GAAW;IACzB,OAAO,IAAA,4BAAS,EAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AA0FC,wBAAM;AAhFR,SAAS,cAAc,CAAC,OAAe;IACrC,OAAO,IAAA,sCAAe,EAAC,OAAO,CAAC,IAAI,IAAA,4CAAqB,EAAC,OAAO,CAAC,CAAA;AACnE,CAAC;AAqDC,wCAAc;AAvChB,SAAS,WAAW,CAAC,QAA8B;IAEjD,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC3C,CAAC;AAwBC,kCAAW;AAnBb,MAAM,MAAM,GAAG;IACb,YAAY,EAAZ,qBAAY;IACZ,MAAM,EAAN,eAAM;IACN,eAAe,EAAf,wBAAe;IACf,gBAAgB,EAAhB,yBAAgB;IAChB,WAAW,EAAX,oBAAW;IACX,aAAa,EAAb,sBAAa;IACb,UAAU,EAAV,mBAAU;IACV,aAAa,EAAb,sBAAa;IACb,UAAU,EAAV,mBAAU;IACV,gBAAgB,EAAhB,yBAAgB;IAChB,UAAU,EAAV,mBAAU;IACV,kBAAkB,EAAlB,2BAAkB;CACnB,CAAA;AAmBC,wBAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xrpl",
-  "version": "4.0.1-mpt-beta",
+  "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": "^4.0.1-mpt-beta",
+    "ripple-binary-codec": "^2.3.0-batch.0",
     "ripple-keypairs": "^2.0.0"
   },
   "devDependencies": {
@@ -41,9 +41,9 @@
     "karma-jasmine": "^5.1.0",
     "karma-webpack": "^5.0.0",
     "lodash": "^4.17.4",
-    "react": "^18.2.0",
+    "react": "^19.0.0",
     "run-s": "^0.0.0",
-    "typedoc": "0.26.4",
+    "typedoc": "0.27.6",
     "ws": "^8.14.2"
   },
   "resolutions": {
@@ -64,7 +64,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",
@@ -88,5 +88,5 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "gitHead": "5e8ee83815fd38df53c309e577f810fd910183bb"
+  "gitHead": "3c563434d49d4d656f8b62933f035082733af560"
 }

package/src/Wallet/batchSigner.ts

@@ -0,0 +1,222 @@
+import { bytesToHex } from '@xrplf/isomorphic/utils'
+import BigNumber from 'bignumber.js'
+import { decodeAccountID } from 'ripple-address-codec'
+import { decode, encode, encodeForSigningBatch } from 'ripple-binary-codec'
+import { sign } from 'ripple-keypairs'
+
+import { ValidationError } from '../errors'
+import { Batch, Transaction, validate } from '../models'
+import { BatchSigner, validateBatch } from '../models/transactions/batch'
+import { hashSignedTx } from '../utils/hashes'
+
+import { Wallet } from '.'
+
+/**
+ * Sign a multi-account Batch transaction.
+ *
+ * @param wallet - Wallet instance.
+ * @param transaction - The Batch transaction to sign.
+ * @param opts - Additional options for regular key and multi-signing complexity.
+ * @param opts.batchAccount - The account submitting the inner Batch transaction, on behalf of which is this signature.
+ * @param opts.multisign - Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.
+ *                       The actual address is only needed in the case of regular key usage.
+ * @throws ValidationError if the transaction is malformed.
+ */
+// eslint-disable-next-line max-lines-per-function -- TODO: refactor
+export function signMultiBatch(
+  wallet: Wallet,
+  transaction: Batch,
+  opts: { batchAccount?: string; multisign?: boolean | string } = {},
+): void {
+  const batchAccount = opts.batchAccount ?? wallet.classicAddress
+  let multisignAddress: boolean | string = false
+  if (typeof opts.multisign === 'string') {
+    multisignAddress = opts.multisign
+  } else if (opts.multisign) {
+    multisignAddress = wallet.classicAddress
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS
+  if (transaction.TransactionType !== 'Batch') {
+    throw new ValidationError('Must be a Batch transaction.')
+  }
+
+  const involvedAccounts = transaction.RawTransactions.map(
+    (raw) => raw.RawTransaction.Account,
+  )
+  if (!involvedAccounts.includes(batchAccount)) {
+    throw new ValidationError(
+      'Must be signing for an address included in the Batch.',
+    )
+  }
+  /*
+   * This will throw a more clear error for JS users if the supplied transaction has incorrect formatting
+   */
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- validate does not accept Transaction type
+  validate(transaction as unknown as Record<string, unknown>)
+  const fieldsToSign = {
+    flags: transaction.Flags,
+    txIDs: transaction.RawTransactions.map((rawTx) =>
+      hashSignedTx(rawTx.RawTransaction),
+    ),
+  }
+  let batchSigner: BatchSigner
+  if (multisignAddress) {
+    batchSigner = {
+      BatchSigner: {
+        Account: batchAccount,
+        Signers: [
+          {
+            Signer: {
+              Account: multisignAddress,
+              SigningPubKey: wallet.publicKey,
+              TxnSignature: sign(
+                encodeForSigningBatch(fieldsToSign),
+                wallet.privateKey,
+              ),
+            },
+          },
+        ],
+      },
+    }
+  } else {
+    batchSigner = {
+      BatchSigner: {
+        Account: batchAccount,
+        SigningPubKey: wallet.publicKey,
+        TxnSignature: sign(
+          encodeForSigningBatch(fieldsToSign),
+          wallet.privateKey,
+        ),
+      },
+    }
+  }
+
+  // eslint-disable-next-line no-param-reassign -- okay for signing
+  transaction.BatchSigners = [batchSigner]
+}
+
+/**
+ * Takes several transactions with BatchSigners fields (in object or blob form) and creates a
+ * single transaction with all BatchSigners that then gets signed and returned.
+ *
+ * @param transactions The transactions to combine `BatchSigners` values on.
+ * @returns A single signed Transaction which has all BatchSigners from transactions within it.
+ * @throws ValidationError if:
+ * - There were no transactions given to sign
+ * @category Signing
+ */
+export function combineBatchSigners(
+  transactions: Array<Batch | string>,
+): string {
+  if (transactions.length === 0) {
+    throw new ValidationError('There are 0 transactions to combine.')
+  }
+
+  const decodedTransactions: Transaction[] = transactions.map((txOrBlob) => {
+    return getDecodedTransaction(txOrBlob)
+  })
+
+  decodedTransactions.forEach((tx) => {
+    if (tx.TransactionType !== 'Batch') {
+      throw new ValidationError('TransactionType must be `Batch`.')
+    }
+    /*
+     * This will throw a more clear error for JS users if any of the supplied transactions has incorrect formatting
+     */
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- validate does not accept Transaction type
+    validateBatch(tx as unknown as Record<string, unknown>)
+    if (tx.BatchSigners == null || tx.BatchSigners.length === 0) {
+      throw new ValidationError(
+        'For combining Batch transaction signatures, all transactions must include a BatchSigners field containing an array of signatures.',
+      )
+    }
+
+    if (tx.TxnSignature != null || tx.Signers != null) {
+      throw new ValidationError('Batch transaction must be unsigned.')
+    }
+  })
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- checked above
+  const batchTransactions = decodedTransactions as Batch[]
+
+  validateBatchTransactionEquivalence(batchTransactions)
+
+  return encode(getTransactionWithAllBatchSigners(batchTransactions))
+}
+
+/**
+ * The transactions should all be equal except for the 'Signers' field.
+ *
+ * @param transactions - An array of Transactions which are expected to be equal other than 'Signers'.
+ * @throws ValidationError if the transactions are not equal in any field other than 'Signers'.
+ */
+function validateBatchTransactionEquivalence(transactions: Batch[]): void {
+  const exampleTransaction = JSON.stringify({
+    flags: transactions[0].Flags,
+    transactionIDs: transactions[0].RawTransactions.map((rawTx) =>
+      hashSignedTx(rawTx.RawTransaction),
+    ),
+  })
+  if (
+    transactions.slice(1).some(
+      (tx) =>
+        JSON.stringify({
+          flags: tx.Flags,
+          transactionIDs: tx.RawTransactions.map((rawTx) =>
+            hashSignedTx(rawTx.RawTransaction),
+          ),
+        }) !== exampleTransaction,
+    )
+  ) {
+    throw new ValidationError(
+      'Flags and transaction hashes are not the same for all provided transactions.',
+    )
+  }
+}
+
+function getTransactionWithAllBatchSigners(transactions: Batch[]): Batch {
+  // Signers must be sorted in the combined transaction - See compareSigners' documentation for more details
+  const sortedSigners: BatchSigner[] = transactions
+    .flatMap((tx) => tx.BatchSigners ?? [])
+    .filter((signer) => signer.BatchSigner.Account !== transactions[0].Account)
+    .sort(compareBatchSigners)
+
+  return { ...transactions[0], BatchSigners: sortedSigners }
+}
+
+/**
+ * If presented in binary form, the BatchSigners array must be sorted based on
+ * the numeric value of the signer addresses, with the lowest value first.
+ * (If submitted as JSON, the submit_multisigned method handles this automatically.)
+ * https://xrpl.org/multi-signing.html.
+ *
+ * @param left - A BatchSigner to compare with.
+ * @param right - A second BatchSigner to compare with.
+ * @returns 1 if left \> right, 0 if left = right, -1 if left \< right, and null if left or right are NaN.
+ */
+function compareBatchSigners(left: BatchSigner, right: BatchSigner): number {
+  return addressToBigNumber(left.BatchSigner.Account).comparedTo(
+    addressToBigNumber(right.BatchSigner.Account),
+  )
+}
+
+// copied from signer.ts
+// TODO: refactor
+const NUM_BITS_IN_HEX = 16
+
+function addressToBigNumber(address: string): BigNumber {
+  const hex = bytesToHex(decodeAccountID(address))
+  return new BigNumber(hex, NUM_BITS_IN_HEX)
+}
+
+function getDecodedTransaction(txOrBlob: Transaction | string): Transaction {
+  if (typeof txOrBlob === 'object') {
+    // We need this to handle X-addresses in multisigning
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are casting here to get strong typing
+    return decode(encode(txOrBlob)) as unknown as Transaction
+  }
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are casting here to get strong typing
+  return decode(txOrBlob) as unknown as Transaction
+}

package/src/Wallet/defaultFaucets.ts

@@ -14,11 +14,13 @@ export interface FaucetWallet {
 export enum FaucetNetwork {
   Testnet = 'faucet.altnet.rippletest.net',
   Devnet = 'faucet.devnet.rippletest.net',
+  Batchnet = 'batch.faucet.nerdnest.xyz',
 }
 
 export const FaucetNetworkPaths: Record<string, string> = {
   [FaucetNetwork.Testnet]: '/accounts',
   [FaucetNetwork.Devnet]: '/accounts',
+  [FaucetNetwork.Batchnet]: '/accounts',
 }
 
 /**
@@ -36,6 +38,10 @@ export function getFaucetHost(client: Client): FaucetNetwork | undefined {
     return FaucetNetwork.Testnet
   }
 
+  if (connectionUrl.includes('batchnet')) {
+    return FaucetNetwork.Batchnet
+  }
+
   if (connectionUrl.includes('sidechain-net2')) {
     throw new XRPLFaucetError(
       'Cannot fund an account on an issuing chain. Accounts must be created via the bridge.',

package/src/Wallet/index.ts

@@ -24,6 +24,8 @@ import {
 import ECDSA from '../ECDSA'
 import { ValidationError } from '../errors'
 import { Transaction, validate } from '../models/transactions'
+import { GlobalFlags } from '../models/transactions/common'
+import { hasFlag } from '../models/utils/flags'
 import { ensureClassicAddress } from '../sugar/utils'
 import { omitBy } from '../utils/collections'
 import { hashSignedTx } from '../utils/hashes/hashLedger'
@@ -367,6 +369,7 @@ export class Wallet {
    * @param this - Wallet instance.
    * @param transaction - A transaction to be signed offline.
    * @param multisign - Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.
+   *                    The actual address is only needed in the case of regular key usage.
    * @returns A signed transaction.
    * @throws ValidationError if the transaction is already signed or does not encode/decode to same result.
    * @throws XrplError if the issued currency being signed is XRP ignoring case.
@@ -381,7 +384,7 @@ export class Wallet {
     hash: string
   } {
     let multisignAddress: boolean | string = false
-    if (typeof multisign === 'string' && multisign.startsWith('X')) {
+    if (typeof multisign === 'string') {
       multisignAddress = multisign
     } else if (multisign) {
       multisignAddress = this.classicAddress
@@ -407,12 +410,14 @@ export class Wallet {
      */
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- validate does not accept Transaction type
     validate(tx as unknown as Record<string, unknown>)
+    if (hasFlag(tx, GlobalFlags.tfInnerBatchTxn)) {
+      throw new ValidationError('Cannot sign a Batch inner transaction.')
+    }
 
     const txToSignAndEncode = { ...tx }
 
-    txToSignAndEncode.SigningPubKey = multisignAddress ? '' : this.publicKey
-
     if (multisignAddress) {
+      txToSignAndEncode.SigningPubKey = ''
       const signer = {
         Account: multisignAddress,
         SigningPubKey: this.publicKey,
@@ -424,6 +429,7 @@ export class Wallet {
       }
       txToSignAndEncode.Signers = [{ Signer: signer }]
     } else {
+      txToSignAndEncode.SigningPubKey = this.publicKey
       txToSignAndEncode.TxnSignature = computeSignature(
         txToSignAndEncode,
         this.privateKey,

package/src/client/RequestManager.ts

@@ -175,6 +175,7 @@ export default class RequestManager {
    * @param response - The response to handle.
    * @throws ResponseFormatError if the response format is invalid, RippledError if rippled returns an error.
    */
+  // eslint-disable-next-line complexity -- handling a response is complex
   public handleResponse(
     response: Partial<Response<APIVersion> | ErrorResponse>,
   ): void {
@@ -195,7 +196,9 @@ export default class RequestManager {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We know this must be true
       const errorResponse = response as Partial<ErrorResponse>
       const error = new RippledError(
-        errorResponse.error_message ?? errorResponse.error,
+        errorResponse.error_message ??
+          errorResponse.error_exception ??
+          errorResponse.error,
         errorResponse,
       )
       this.reject(response.id, error)

package/src/client/connection.ts

@@ -349,7 +349,6 @@ export class Connection extends EventEmitter {
       try {
         this.requestManager.handleResponse(data)
       } catch (error) {
-        // eslint-disable-next-line max-depth -- okay here
         if (error instanceof Error) {
           this.emit('error', 'badMessage', error.message, message)
         } else {

package/src/client/index.ts

@@ -40,14 +40,19 @@ import type {
   MarkerRequest,
   MarkerResponse,
   SubmitResponse,
+  SimulateRequest,
 } from '../models/methods'
 import type { BookOffer, BookOfferCurrency } from '../models/methods/bookOffers'
+import {
+  SimulateBinaryResponse,
+  SimulateJsonResponse,
+} from '../models/methods/simulate'
 import type {
   EventTypes,
   OnEventToListenerMap,
 } from '../models/methods/subscribe'
 import type { SubmittableTransaction } from '../models/transactions'
-import { setTransactionFlagsToNumber } from '../models/utils/flags'
+import { convertTxFlagsToNumber } from '../models/utils/flags'
 import {
   ensureClassicAddress,
   submitRequest,
@@ -62,6 +67,8 @@ import {
   setLatestValidatedLedgerSequence,
   checkAccountDeleteBlockers,
   txNeedsNetworkID,
+  autofillBatchTxn,
+  handleDeliverMax,
 } from '../sugar/autofill'
 import { formatBalances } from '../sugar/balances'
 import {
@@ -657,7 +664,6 @@ class Client extends EventEmitter<EventTypes> {
    * @throws ValidationError If Amount and DeliverMax fields are not identical in a Payment Transaction
    */
 
-  // eslint-disable-next-line complexity -- handling Payment transaction API v2 requires more logic
   public async autofill<T extends SubmittableTransaction>(
     transaction: T,
     signersCount?: number,
@@ -665,7 +671,7 @@ class Client extends EventEmitter<EventTypes> {
     const tx = { ...transaction }
 
     setValidAddresses(tx)
-    setTransactionFlagsToNumber(tx)
+    tx.Flags = convertTxFlagsToNumber(tx)
 
     const promises: Array<Promise<void>> = []
     if (tx.NetworkID == null) {
@@ -683,33 +689,11 @@ class Client extends EventEmitter<EventTypes> {
     if (tx.TransactionType === 'AccountDelete') {
       promises.push(checkAccountDeleteBlockers(this, tx))
     }
-
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
-    // @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
-    if (tx.TransactionType === 'Payment' && tx.DeliverMax != null) {
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- This is a valid null check for Amount
-      if (tx.Amount == null) {
-        // If only DeliverMax is provided, use it to populate the Amount field
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
-        // @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- DeliverMax is a known RPC-level property
-        tx.Amount = tx.DeliverMax
-      }
-
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
-      // @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- This is a valid null check for Amount
-      if (tx.Amount != null && tx.Amount !== tx.DeliverMax) {
-        return Promise.reject(
-          new ValidationError(
-            'PaymentTransaction: Amount and DeliverMax fields must be identical when both are provided',
-          ),
-        )
-      }
-
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
-      // @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
-      delete tx.DeliverMax
+    if (tx.TransactionType === 'Batch') {
+      promises.push(autofillBatchTxn(this, tx))
+    }
+    if (tx.TransactionType === 'Payment') {
+      handleDeliverMax(tx)
     }
 
     return Promise.all(promises).then(() => tx)
@@ -764,6 +748,41 @@ class Client extends EventEmitter<EventTypes> {
     return submitRequest(this, signedTx, opts?.failHard)
   }
 
+  /**
+   * Simulates an unsigned transaction.
+   * Steps performed on a transaction:
+   *    1. Autofill.
+   *    2. Sign & Encode.
+   *    3. Submit.
+   *
+   * @category Core
+   *
+   * @param transaction - A transaction to autofill, sign & encode, and submit.
+   * @param opts - (Optional) Options used to sign and submit a transaction.
+   * @param opts.binary - If true, return the metadata in a binary encoding.
+   *
+   * @returns A promise that contains SimulateResponse.
+   * @throws RippledError if the simulate request fails.
+   */
+
+  public async simulate<Binary extends boolean = false>(
+    transaction: SubmittableTransaction | string,
+    opts?: {
+      // If true, return the binary-encoded representation of the results.
+      binary?: Binary
+    },
+  ): Promise<
+    Binary extends true ? SimulateBinaryResponse : SimulateJsonResponse
+  > {
+    // send request
+    const binary = opts?.binary ?? false
+    const request: SimulateRequest =
+      typeof transaction === 'string'
+        ? { command: 'simulate', tx_blob: transaction, binary }
+        : { command: 'simulate', tx_json: transaction, binary }
+    return this.request(request)
+  }
+
   /**
    * Asynchronously submits a transaction and verifies that it has been included in a
    * validated ledger (or has errored/will not be included for some reason).

package/src/client/partialPayment.ts

@@ -4,9 +4,16 @@ import { decode } from 'ripple-binary-codec'
 import type {
   TransactionEntryResponse,
   TransactionStream,
+  TransactionV1Stream,
   TxResponse,
 } from '..'
-import type { Amount, IssuedCurrency,APIVersion, DEFAULT_API_VERSION , MPTAmount } from '../models/common'
+import type {
+  Amount,
+  IssuedCurrency,
+  APIVersion,
+  DEFAULT_API_VERSION,
+  MPTAmount,
+} from '../models/common'
 import type {
   AccountTxTransaction,
   RequestResponseMap,
@@ -19,10 +26,13 @@ import { isFlagEnabled } from '../models/utils'
 
 const WARN_PARTIAL_PAYMENT_CODE = 2001
 
+/* eslint-disable complexity -- check different token types */
+/* eslint-disable @typescript-eslint/consistent-type-assertions -- known currency type */
 function amountsEqual(
   amt1: Amount | MPTAmount,
   amt2: Amount | MPTAmount,
 ): boolean {
+  // Compare XRP
   if (typeof amt1 === 'string' && typeof amt2 === 'string') {
     return amt1 === amt2
   }
@@ -31,13 +41,13 @@ function amountsEqual(
     return false
   }
 
+  // Compare MPTs
   if (isMPTAmount(amt1) && isMPTAmount(amt2)) {
     const aValue = new BigNumber(amt1.value)
     const bValue = new BigNumber(amt2.value)
 
     return (
-      (amt1 as MPTAmount).mpt_issuance_id ===
-        (amt2 as MPTAmount).mpt_issuance_id && aValue.isEqualTo(bValue)
+      amt1.mpt_issuance_id === amt2.mpt_issuance_id && aValue.isEqualTo(bValue)
     )
   }
 
@@ -45,6 +55,7 @@ function amountsEqual(
     return false
   }
 
+  // Compare issued currency (IOU)
   const aValue = new BigNumber(amt1.value)
   const bValue = new BigNumber(amt2.value)
 
@@ -54,6 +65,8 @@ function amountsEqual(
     aValue.isEqualTo(bValue)
   )
 }
+/* eslint-enable complexity */
+/* eslint-enable @typescript-eslint/consistent-type-assertions */
 
 function isPartialPayment(
   tx?: Transaction,
@@ -176,10 +189,10 @@ export function handlePartialPayment<
  * @param log - The method used for logging by the connection (to report the partial payment).
  */
 export function handleStreamPartialPayment(
-  stream: TransactionStream,
+  stream: TransactionStream | TransactionV1Stream,
   log: (id: string, message: string) => void,
 ): void {
-  if (isPartialPayment(stream.transaction, stream.meta)) {
+  if (isPartialPayment(stream.tx_json ?? stream.transaction, stream.meta)) {
     const warnings = stream.warnings ?? []
 
     const warning = {

package/src/models/common/index.ts

@@ -162,6 +162,16 @@ export interface AuthAccount {
   }
 }
 
+export interface AuthorizeCredential {
+  Credential: {
+    /** The issuer of the credential. */
+    Issuer: string
+
+    /** A hex-encoded value to identify the type of credential from the issuer. */
+    CredentialType: string
+  }
+}
+
 export interface XChainBridge {
   LockingChainDoor: string
   LockingChainIssue: Currency

package/src/models/index.ts

@@ -8,8 +8,9 @@
  */
 export * as LedgerEntry from './ledger'
 export {
-  setTransactionFlagsToNumber,
   parseAccountRootFlags,
+  setTransactionFlagsToNumber,
+  convertTxFlagsToNumber,
   parseTransactionFlags,
 } from './utils/flags'
 export * from './methods'

package/src/models/ledger/Credential.ts

@@ -0,0 +1,47 @@
+import { GlobalFlagsInterface } from '../transactions/common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+export interface CredentialFlags extends GlobalFlagsInterface {
+  lsfAccepted?: boolean
+}
+
+/**
+ *
+ * A Credential object describes a credential, similar to a passport, which is an issuable identity verifier
+ * that can be used as a prerequisite for other transactions
+ *
+ * @category Ledger Entries
+ */
+export default interface Credential extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Credential'
+  /**
+   * A bit-map of boolean flags
+   */
+  Flags: number | CredentialFlags
+
+  /** The account that the credential is for. */
+  Subject: string
+
+  /** The issuer of the credential. */
+  Issuer: string
+
+  /** A hex-encoded value to identify the type of credential from the issuer. */
+  CredentialType: string
+
+  /** A hint indicating which page of the subject's owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  SubjectNode: string
+
+  /** A hint indicating which page of the issuer's owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  IssuerNode: string
+
+  /** Credential expiration. */
+  Expiration?: number
+
+  /** Additional data about the credential (such as a link to the VC document). */
+  URI?: string
+}