xrpl 4.2.0-batch.0 → 4.3.0-smartescrow.0

package/src/models/transactions/escrowCreate.ts

@@ -47,6 +47,10 @@ export interface EscrowCreate extends BaseTransaction {
    * payment, such as a hosted recipient at the destination address.
    */
   DestinationTag?: number
+
+  FinishFunction?: string
+
+  Data?: string
 }
 
 /**
@@ -75,9 +79,13 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
     )
   }
 
-  if (tx.FinishAfter === undefined && tx.Condition === undefined) {
+  if (
+    tx.FinishAfter === undefined &&
+    tx.Condition === undefined &&
+    tx.FinishFunction === undefined
+  ) {
     throw new ValidationError(
-      'EscrowCreate: Either Condition or FinishAfter must be specified',
+      'EscrowCreate: Either FinishAfter, Condition, or FinishFunction must be specified',
     )
   }
 

package/src/models/transactions/index.ts

@@ -33,7 +33,6 @@ export {
   AMMWithdrawFlagsInterface,
   AMMWithdraw,
 } from './AMMWithdraw'
-export { Batch } from './batch'
 export { CheckCancel } from './checkCancel'
 export { CheckCash } from './checkCash'
 export { CheckCreate } from './checkCreate'
@@ -100,8 +99,6 @@ export { SignerListSet } from './signerListSet'
 export { TicketCreate } from './ticketCreate'
 export { TrustSetFlagsInterface, TrustSetFlags, TrustSet } from './trustSet'
 export { UNLModify } from './UNLModify'
-export { PermissionedDomainSet } from './permissionedDomainSet'
-export { PermissionedDomainDelete } from './permissionedDomainDelete'
 export { XChainAddAccountCreateAttestation } from './XChainAddAccountCreateAttestation'
 export { XChainAddClaimAttestation } from './XChainAddClaimAttestation'
 export { XChainClaim } from './XChainClaim'
@@ -114,3 +111,6 @@ export {
   XChainModifyBridgeFlags,
   XChainModifyBridgeFlagsInterface,
 } from './XChainModifyBridge'
+
+export { PermissionedDomainSet } from './permissionedDomainSet'
+export { PermissionedDomainDelete } from './permissionedDomainDelete'

package/src/models/transactions/metadata.ts

@@ -88,8 +88,6 @@ export interface TransactionMetadataBase {
   delivered_amount?: Amount | MPTAmount | 'unavailable'
   TransactionIndex: number
   TransactionResult: string
-
-  ParentBatchID?: string
 }
 
 export type TransactionMetadata<T extends BaseTransaction = Transaction> =

package/src/models/transactions/offerCreate.ts

@@ -3,7 +3,7 @@ import { Amount } from '../common'
 
 import {
   BaseTransaction,
-  GlobalFlagsInterface,
+  GlobalFlags,
   validateBaseTransaction,
   isAmount,
 } from './common'
@@ -78,7 +78,7 @@ export enum OfferCreateFlags {
  * // }
  * ```
  */
-export interface OfferCreateFlagsInterface extends GlobalFlagsInterface {
+export interface OfferCreateFlagsInterface extends GlobalFlags {
   tfPassive?: boolean
   tfImmediateOrCancel?: boolean
   tfFillOrKill?: boolean

package/src/models/transactions/oracleSet.ts

@@ -1,5 +1,6 @@
 import { ValidationError } from '../../errors'
 import { PriceData } from '../common'
+import { isHex } from '../utils'
 
 import {
   BaseTransaction,
@@ -12,6 +13,8 @@ import {
 
 const PRICE_DATA_SERIES_MAX_LENGTH = 10
 const SCALE_MAX = 10
+const MINIMUM_ASSET_PRICE_LENGTH = 1
+const MAXIMUM_ASSET_PRICE_LENGTH = 16
 
 /**
  * Creates a new Oracle ledger entry or updates the fields of an existing one, using the Oracle ID.
@@ -82,7 +85,7 @@ export function validateOracleSet(tx: Record<string, unknown>): void {
 
   validateOptionalField(tx, 'AssetClass', isString)
 
-  // eslint-disable-next-line max-lines-per-function -- necessary to validate many fields
+  /* eslint-disable max-statements, max-lines-per-function -- necessary to validate many fields */
   validateRequiredField(tx, 'PriceDataSeries', (value) => {
     if (!Array.isArray(value)) {
       throw new ValidationError('OracleSet: PriceDataSeries must be an array')
@@ -142,14 +145,32 @@ export function validateOracleSet(tx: Record<string, unknown>): void {
         )
       }
 
-      if (
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- we are validating the type
-        'AssetPrice' in priceData.PriceData &&
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- we are validating the type
-        !isNumber(priceData.PriceData.AssetPrice)
-      ) {
-        throw new ValidationError('OracleSet: invalid field AssetPrice')
+      /* eslint-disable @typescript-eslint/no-unsafe-member-access, max-depth --
+      we need to validate priceData.PriceData.AssetPrice value */
+      if ('AssetPrice' in priceData.PriceData) {
+        if (!isNumber(priceData.PriceData.AssetPrice)) {
+          if (typeof priceData.PriceData.AssetPrice !== 'string') {
+            throw new ValidationError(
+              'OracleSet: Field AssetPrice must be a string or a number',
+            )
+          }
+          if (!isHex(priceData.PriceData.AssetPrice)) {
+            throw new ValidationError(
+              'OracleSet: Field AssetPrice must be a valid hex string',
+            )
+          }
+          if (
+            priceData.PriceData.AssetPrice.length <
+              MINIMUM_ASSET_PRICE_LENGTH ||
+            priceData.PriceData.AssetPrice.length > MAXIMUM_ASSET_PRICE_LENGTH
+          ) {
+            throw new ValidationError(
+              `OracleSet: Length of AssetPrice field must be between ${MINIMUM_ASSET_PRICE_LENGTH} and ${MAXIMUM_ASSET_PRICE_LENGTH} characters long`,
+            )
+          }
+        }
       }
+      /* eslint-enable @typescript-eslint/no-unsafe-member-access, max-depth */
 
       if (
         // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- we are validating the type
@@ -173,4 +194,5 @@ export function validateOracleSet(tx: Record<string, unknown>): void {
     }
     return true
   })
+  /* eslint-enable max-statements, max-lines-per-function */
 }

package/src/models/transactions/payment.ts

@@ -5,7 +5,7 @@ import { isFlagEnabled } from '../utils'
 import {
   BaseTransaction,
   isAmount,
-  GlobalFlagsInterface,
+  GlobalFlags,
   validateBaseTransaction,
   isAccount,
   validateRequiredField,
@@ -84,7 +84,7 @@ export enum PaymentFlags {
  * // }
  * ```
  */
-export interface PaymentFlagsInterface extends GlobalFlagsInterface {
+export interface PaymentFlagsInterface extends GlobalFlags {
   /**
    * Do not use the default path; only use paths included in the Paths field.
    * This is intended to force the transaction to take arbitrage opportunities.

package/src/models/transactions/paymentChannelClaim.ts

@@ -2,7 +2,7 @@ import { ValidationError } from '../../errors'
 
 import {
   BaseTransaction,
-  GlobalFlagsInterface,
+  GlobalFlags,
   validateBaseTransaction,
   validateCredentialsList,
   MAX_AUTHORIZED_CREDENTIALS,
@@ -73,8 +73,7 @@ export enum PaymentChannelClaimFlags {
  * // }
  * ```
  */
-export interface PaymentChannelClaimFlagsInterface
-  extends GlobalFlagsInterface {
+export interface PaymentChannelClaimFlagsInterface extends GlobalFlags {
   /**
    * Clear the channel's Expiration time. (Expiration is different from the
    * channel's immutable CancelAfter time.) Only the source address of the

package/src/models/transactions/transaction.ts

@@ -15,7 +15,6 @@ import { AMMDelete, validateAMMDelete } from './AMMDelete'
 import { AMMDeposit, validateAMMDeposit } from './AMMDeposit'
 import { AMMVote, validateAMMVote } from './AMMVote'
 import { AMMWithdraw, validateAMMWithdraw } from './AMMWithdraw'
-import { Batch, validateBatch } from './batch'
 import { CheckCancel, validateCheckCancel } from './checkCancel'
 import { CheckCash, validateCheckCash } from './checkCash'
 import { CheckCreate, validateCheckCreate } from './checkCreate'
@@ -133,7 +132,6 @@ export type SubmittableTransaction =
   | AMMWithdraw
   | AccountDelete
   | AccountSet
-  | Batch
   | CheckCancel
   | CheckCash
   | CheckCreate
@@ -309,19 +307,6 @@ export function validate(transaction: Record<string, unknown>): void {
       validateAccountSet(tx)
       break
 
-    case 'Batch':
-      validateBatch(tx)
-      // This is done here to avoid issues with dependency cycles
-
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- okay here
-      // @ts-expect-error -- already checked
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-call -- already checked above
-      tx.RawTransactions.forEach((innerTx: Record<string, unknown>) => {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- already checked above
-        validate(innerTx.RawTransaction as Record<string, unknown>)
-      })
-      break
-
     case 'CheckCancel':
       validateCheckCancel(tx)
       break

package/src/models/transactions/trustSet.ts

@@ -3,7 +3,7 @@ import { IssuedCurrencyAmount } from '../common'
 
 import {
   BaseTransaction,
-  GlobalFlagsInterface,
+  GlobalFlags,
   isAmount,
   validateBaseTransaction,
 } from './common'
@@ -77,7 +77,7 @@ export enum TrustSetFlags {
  * // }
  * ```
  */
-export interface TrustSetFlagsInterface extends GlobalFlagsInterface {
+export interface TrustSetFlagsInterface extends GlobalFlags {
   /**
    * Authorize the other party to hold currency issued by this account. (No
    * effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.

package/src/models/utils/flags.ts

@@ -8,8 +8,6 @@ import { AccountSetTfFlags } from '../transactions/accountSet'
 import { AMMClawbackFlags } from '../transactions/AMMClawback'
 import { AMMDepositFlags } from '../transactions/AMMDeposit'
 import { AMMWithdrawFlags } from '../transactions/AMMWithdraw'
-import { BatchFlags } from '../transactions/batch'
-import { GlobalFlags } from '../transactions/common'
 import { MPTokenAuthorizeFlags } from '../transactions/MPTokenAuthorize'
 import { MPTokenIssuanceCreateFlags } from '../transactions/MPTokenIssuanceCreate'
 import { MPTokenIssuanceSetFlags } from '../transactions/MPTokenIssuanceSet'
@@ -53,7 +51,6 @@ const txToFlag = {
   AMMClawback: AMMClawbackFlags,
   AMMDeposit: AMMDepositFlags,
   AMMWithdraw: AMMWithdrawFlags,
-  Batch: BatchFlags,
   MPTokenAuthorize: MPTokenAuthorizeFlags,
   MPTokenIssuanceCreate: MPTokenIssuanceCreateFlags,
   MPTokenIssuanceSet: MPTokenIssuanceSetFlags,
@@ -120,15 +117,7 @@ export function convertTxFlagsToNumber(tx: Transaction): number {
     }, 0)
   }
 
-  return Object.keys(tx.Flags).reduce((resultFlags, flag) => {
-    if (GlobalFlags[flag] == null) {
-      throw new ValidationError(
-        `Invalid flag ${flag}. Valid flags are ${JSON.stringify(GlobalFlags)}`,
-      )
-    }
-
-    return tx.Flags?.[flag] ? resultFlags | GlobalFlags[flag] : resultFlags
-  }, 0)
+  return 0
 }
 
 /**
@@ -159,21 +148,3 @@ export function parseTransactionFlags(tx: Transaction): object {
 
   return booleanFlagMap
 }
-
-/**
- * Determines whether a transaction has a certain flag enabled.
- *
- * @param tx The transaction.
- * @param flag The flag to check.
- * @returns Whether `flag` is enabled on `tx`.
- */
-export function hasFlag(tx: Transaction, flag: number): boolean {
-  if (tx.Flags == null) {
-    return false
-  }
-  if (typeof tx.Flags === 'number') {
-    return isFlagEnabled(tx.Flags, flag)
-  }
-  const txFlagNum = convertTxFlagsToNumber(tx)
-  return isFlagEnabled(txFlagNum, flag)
-}

package/src/sugar/autofill.ts

@@ -1,12 +1,10 @@
-/* eslint-disable max-lines -- lots of helper functions needed for autofill */
 import BigNumber from 'bignumber.js'
 import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
 
 import { type Client } from '..'
 import { ValidationError, XrplError } from '../errors'
 import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
-import { Batch, Payment, Transaction } from '../models/transactions'
-import { GlobalFlags } from '../models/transactions/common'
+import { Transaction } from '../models/transactions'
 import { xrpToDrops } from '../utils'
 
 import getFeeXrp from './getFeeXrp'
@@ -209,20 +207,6 @@ function convertToClassicAddress(tx: Transaction, fieldName: string): void {
   }
 }
 
-// Helper function to get the next valid sequence number for an account.
-async function getNextValidSequenceNumber(
-  client: Client,
-  account: string,
-): Promise<number> {
-  const request: AccountInfoRequest = {
-    command: 'account_info',
-    account,
-    ledger_index: 'current',
-  }
-  const data = await client.request(request)
-  return data.result.account_data.Sequence
-}
-
 /**
  * Sets the next valid sequence number for a transaction.
  *
@@ -235,8 +219,14 @@ export async function setNextValidSequenceNumber(
   client: Client,
   tx: Transaction,
 ): Promise<void> {
+  const request: AccountInfoRequest = {
+    command: 'account_info',
+    account: tx.Account,
+    ledger_index: 'current',
+  }
+  const data = await client.request(request)
   // eslint-disable-next-line no-param-reassign, require-atomic-updates -- param reassign is safe with no race condition
-  tx.Sequence = await getNextValidSequenceNumber(client, tx.Account)
+  tx.Sequence = data.result.account_data.Sequence
 }
 
 /**
@@ -284,16 +274,17 @@ export async function calculateFeePerTransactionType(
       scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
     )
     baseFee = product.dp(0, BigNumber.ROUND_CEIL)
-  } else if (
+  }
+  // EscrowCreate transaction with FinishFunction
+  if (tx.TransactionType === 'EscrowCreate' && tx.FinishFunction != null) {
+    baseFee = BigNumber.sum(baseFee, 1000)
+  }
+
+  if (
     tx.TransactionType === 'AccountDelete' ||
     tx.TransactionType === 'AMMCreate'
   ) {
     baseFee = await fetchAccountDeleteFee(client)
-  } else if (tx.TransactionType === 'Batch') {
-    baseFee = BigNumber.sum(
-      baseFee.times(2),
-      baseFee.times(tx.RawTransactions.length + (tx.BatchSigners?.length ?? 0)),
-    )
   }
 
   /*
@@ -372,119 +363,3 @@ export async function checkAccountDeleteBlockers(
     resolve()
   })
 }
-/**
- * Replaces Amount with DeliverMax if needed.
- *
- * @param tx - The transaction object.
- * @throws ValidationError if Amount and DeliverMax are both provided but do not match.
- */
-export function handleDeliverMax(tx: Payment): void {
-  // 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.DeliverMax != null) {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed here
-    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, no-param-reassign -- 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 -- needed here
-    if (tx.Amount != null && tx.Amount !== tx.DeliverMax) {
-      throw 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
-    // eslint-disable-next-line no-param-reassign -- needed here
-    delete tx.DeliverMax
-  }
-}
-
-/**
- * Autofills all the relevant `x` fields.
- *
- * @param client - The client object.
- * @param tx - The transaction object.
- * @returns A promise that resolves with void if there are no blockers, or rejects with an XrplError if there are blockers.
- */
-// eslint-disable-next-line complexity, max-lines-per-function, max-statements -- needed here, lots to check
-export async function autofillBatchTxn(
-  client: Client,
-  tx: Batch,
-): Promise<void> {
-  const accountSequences: Record<string, number> = {}
-
-  for await (const rawTxn of tx.RawTransactions) {
-    const txn = rawTxn.RawTransaction
-
-    // Flag processing
-    /* eslint-disable no-bitwise -- needed here for flag parsing */
-    if (txn.Flags == null) {
-      txn.Flags = GlobalFlags.tfInnerBatchTxn
-    } else if (typeof txn.Flags === 'number') {
-      if (!((txn.Flags & GlobalFlags.tfInnerBatchTxn) === 0)) {
-        txn.Flags |= GlobalFlags.tfInnerBatchTxn
-      }
-    } else if (!txn.Flags.tfInnerBatchTxn) {
-      txn.Flags.tfInnerBatchTxn = true
-    }
-    /* eslint-enable no-bitwise */
-
-    // Sequence processing
-    if (txn.Sequence == null && txn.TicketSequence == null) {
-      if (txn.Account in accountSequences) {
-        txn.Sequence = accountSequences[txn.Account]
-        accountSequences[txn.Account] += 1
-      } else {
-        const nextSequence = await getNextValidSequenceNumber(
-          client,
-          txn.Account,
-        )
-        const sequence =
-          txn.Account === tx.Account ? nextSequence + 1 : nextSequence
-        accountSequences[txn.Account] = sequence + 1
-        txn.Sequence = sequence
-      }
-    }
-
-    if (txn.Fee == null) {
-      txn.Fee = '0'
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- JS check
-    } else if (txn.Fee !== '0') {
-      throw new XrplError('Must have `Fee of "0" in inner Batch transaction.')
-    }
-
-    if (txn.SigningPubKey == null) {
-      txn.SigningPubKey = ''
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- JS check
-    } else if (txn.SigningPubKey !== '') {
-      throw new XrplError(
-        'Must have `SigningPubKey` of "" in inner Batch transaction.',
-      )
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS
-    if (txn.TxnSignature != null) {
-      throw new XrplError(
-        'Must not have `TxnSignature` in inner Batch transaction.',
-      )
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS
-    if (txn.Signers != null) {
-      throw new XrplError('Must not have `Signers` in inner Batch transaction.')
-    }
-
-    if (txn.NetworkID == null) {
-      txn.NetworkID = txNeedsNetworkID(client) ? client.networkID : undefined
-    }
-  }
-}

package/src/sugar/submit.ts

@@ -175,6 +175,7 @@ function isSigned(transaction: SubmittableTransaction | string): boolean {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we know that tx.Signers is an array of Signers
     const signers = tx.Signers as Signer[]
     for (const signer of signers) {
+      // eslint-disable-next-line max-depth -- necessary for checking if signer is signed
       if (
         // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- necessary check
         signer.Signer.SigningPubKey == null ||
@@ -282,7 +283,7 @@ export function getLastLedgerSequence(
   transaction: Transaction | string,
 ): number | null {
   const tx = typeof transaction === 'string' ? decode(transaction) : transaction
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- converts LastLedgerSeq to number if present.
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- converts LastLedgSeq to number if present.
   return tx.LastLedgerSequence as number | null
 }
 

package/src/utils/hashes/hashLedger.ts

@@ -12,8 +12,6 @@ import { APIVersion } from '../../models'
 import { LedgerEntry } from '../../models/ledger'
 import { LedgerVersionMap } from '../../models/ledger/Ledger'
 import { Transaction, TransactionMetadata } from '../../models/transactions'
-import { GlobalFlags } from '../../models/transactions/common'
-import { hasFlag } from '../../models/utils/flags'
 
 import HashPrefix from './HashPrefix'
 import sha512Half from './sha512Half'
@@ -68,7 +66,7 @@ function addLengthPrefix(hex: string): string {
  *
  * @param tx - A transaction to hash. Tx may be in binary blob form. Tx must be signed.
  * @returns A hash of tx.
- * @throws ValidationError if the Transaction is unsigned.
+ * @throws ValidationError if the Transaction is unsigned.\
  * @category Utilities
  */
 export function hashSignedTx(tx: Transaction | string): string {
@@ -86,8 +84,7 @@ export function hashSignedTx(tx: Transaction | string): string {
   if (
     txObject.TxnSignature === undefined &&
     txObject.Signers === undefined &&
-    txObject.SigningPubKey === undefined &&
-    !hasFlag(txObject, GlobalFlags.tfInnerBatchTxn)
+    txObject.SigningPubKey === undefined
   ) {
     throw new ValidationError('The transaction must be signed to hash it.')
   }