xrpl 2.14.1 → 2.14.2

package/src/models/utils/flags.ts

@@ -1,15 +1,16 @@
-/* eslint-disable no-param-reassign -- param reassign is safe */
 /* eslint-disable no-bitwise -- flags require bitwise operations */
-
 import { ValidationError } from '../../errors'
 import {
   AccountRootFlagsInterface,
   AccountRootFlags,
 } from '../ledger/AccountRoot'
 import { AccountSetTfFlags } from '../transactions/accountSet'
+import { AMMClawbackFlags } from '../transactions/AMMClawback'
 import { AMMDepositFlags } from '../transactions/AMMDeposit'
 import { AMMWithdrawFlags } from '../transactions/AMMWithdraw'
-import { GlobalFlags } from '../transactions/common'
+import { MPTokenAuthorizeFlags } from '../transactions/MPTokenAuthorize'
+import { MPTokenIssuanceCreateFlags } from '../transactions/MPTokenIssuanceCreate'
+import { MPTokenIssuanceSetFlags } from '../transactions/MPTokenIssuanceSet'
 import { NFTokenCreateOfferFlags } from '../transactions/NFTokenCreateOffer'
 import { NFTokenMintFlags } from '../transactions/NFTokenMint'
 import { OfferCreateFlags } from '../transactions/offerCreate'
@@ -47,8 +48,12 @@ export function parseAccountRootFlags(
 
 const txToFlag = {
   AccountSet: AccountSetTfFlags,
+  AMMClawback: AMMClawbackFlags,
   AMMDeposit: AMMDepositFlags,
   AMMWithdraw: AMMWithdrawFlags,
+  MPTokenAuthorize: MPTokenAuthorizeFlags,
+  MPTokenIssuanceCreate: MPTokenIssuanceCreateFlags,
+  MPTokenIssuanceSet: MPTokenIssuanceSetFlags,
   NFTokenCreateOffer: NFTokenCreateOfferFlags,
   NFTokenMint: NFTokenMintFlags,
   OfferCreate: OfferCreateFlags,
@@ -58,35 +63,88 @@ const txToFlag = {
   XChainModifyBridge: XChainModifyBridgeFlags,
 }
 
+function isTxToFlagKey(
+  transactionType: string,
+): transactionType is keyof typeof txToFlag {
+  return transactionType in txToFlag
+}
+
 /**
  * Sets a transaction's flags to its numeric representation.
  *
+ * @deprecated
+ * This utility function is deprecated.
+ * Use convertTxFlagsToNumber() instead and use the returned value to modify the Transaction.Flags from the caller.
+ *
  * @param tx - A transaction to set its flags to its numeric representation.
  */
 export function setTransactionFlagsToNumber(tx: Transaction): void {
-  if (tx.Flags == null) {
-    tx.Flags = 0
-    return
+  // eslint-disable-next-line no-console -- intended deprecation warning
+  console.warn(
+    'This function is deprecated. Use convertTxFlagsToNumber() instead and use the returned value to modify the Transaction.Flags from the caller.',
+  )
+
+  if (tx.Flags) {
+    // eslint-disable-next-line no-param-reassign -- intended param reassign in setter, retain old functionality for compatibility
+    tx.Flags = convertTxFlagsToNumber(tx)
+  }
+}
+
+/**
+ * Returns a Transaction's Flags as its numeric representation.
+ *
+ * @param tx - A Transaction to parse Flags for
+ * @returns A numerical representation of a Transaction's Flags
+ */
+export function convertTxFlagsToNumber(tx: Transaction): number {
+  if (!tx.Flags) {
+    return 0
   }
   if (typeof tx.Flags === 'number') {
-    return
+    return tx.Flags
   }
 
-  tx.Flags = txToFlag[tx.TransactionType]
-    ? convertFlagsToNumber(tx.Flags, txToFlag[tx.TransactionType])
-    : 0
+  if (isTxToFlagKey(tx.TransactionType)) {
+    const flagEnum = txToFlag[tx.TransactionType]
+    return Object.keys(tx.Flags).reduce((resultFlags, flag) => {
+      if (flagEnum[flag] == null) {
+        throw new ValidationError(
+          `Invalid flag ${flag}. Valid flags are ${JSON.stringify(flagEnum)}`,
+        )
+      }
+
+      return tx.Flags?.[flag] ? resultFlags | flagEnum[flag] : resultFlags
+    }, 0)
+  }
+
+  return 0
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any -- added ValidationError check for flagEnum
-function convertFlagsToNumber(flags: GlobalFlags, flagEnum: any): number {
-  return Object.keys(flags).reduce((resultFlags, flag) => {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- safe member access
-    if (flagEnum[flag] == null) {
-      throw new ValidationError(
-        `flag ${flag} doesn't exist in flagEnum: ${JSON.stringify(flagEnum)}`,
-      )
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- safe member access
-    return flags[flag] ? resultFlags | flagEnum[flag] : resultFlags
-  }, 0)
+/**
+ * Convert a Transaction flags property into a map for easy interpretation.
+ *
+ * @param tx - A transaction to parse flags for.
+ * @returns A map with all flags as booleans.
+ */
+export function parseTransactionFlags(tx: Transaction): object {
+  const flags = convertTxFlagsToNumber(tx)
+  if (flags === 0) {
+    return {}
+  }
+
+  const booleanFlagMap = {}
+
+  if (isTxToFlagKey(tx.TransactionType)) {
+    const transactionTypeFlags = txToFlag[tx.TransactionType]
+    Object.values(transactionTypeFlags).forEach((flag) => {
+      if (
+        typeof flag === 'string' &&
+        isFlagEnabled(flags, transactionTypeFlags[flag])
+      ) {
+        booleanFlagMap[flag] = true
+      }
+    })
+  }
+
+  return booleanFlagMap
 }

package/src/models/utils/index.ts

@@ -1,4 +1,5 @@
 const HEX_REGEX = /^[0-9A-Fa-f]+$/u
+export const INTEGER_SANITY_CHECK = /^[0-9]+$/u
 
 /**
  * Verify that all fields of an object are in fields.

package/src/sugar/autofill.ts

@@ -1,11 +1,10 @@
 import BigNumber from 'bignumber.js'
 import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
 
-import type { Client } from '..'
+import { type Client } from '..'
 import { ValidationError, XrplError } from '../errors'
 import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
 import { Transaction } from '../models/transactions'
-import { setTransactionFlagsToNumber } from '../models/utils/flags'
 import { xrpToDrops } from '../utils'
 
 import getFeeXrp from './getFeeXrp'
@@ -18,84 +17,6 @@ const LEDGER_OFFSET = 20
 // Mainnet and testnet are exceptions. More context: https://github.com/XRPLF/rippled/pull/4370
 const RESTRICTED_NETWORKS = 1024
 const REQUIRED_NETWORKID_VERSION = '1.11.0'
-const HOOKS_TESTNET_ID = 21338
-interface ClassicAccountAndTag {
-  classicAccount: string
-  tag: number | false | undefined
-}
-
-/**
- * Autofills fields in a transaction. This will set `Sequence`, `Fee`,
- * `lastLedgerSequence` according to the current state of the server this Client
- * is connected to. It also converts all X-Addresses to classic addresses and
- * flags interfaces into numbers.
- *
- * @example
- *
- * ```ts
- * const { Client } = require('xrpl')
- *
- * const client = new Client('wss://s.altnet.rippletest.net:51233')
- *
- * async function createAndAutofillTransaction() {
- *   const transaction = {
- *     TransactionType: 'Payment',
- *     Account: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
- *     Destination: 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59',
- *     Amount: '10000000' // 10 XRP in drops (1/1,000,000th of an XRP)
- *   }
- *
- *   try {
- *     const autofilledTransaction = await client.autofill(transaction)
- *     console.log(autofilledTransaction)
- *   } catch (error) {
- *     console.error(`Failed to autofill transaction: ${error}`)
- *   }
- * }
- *
- * createAndAutofillTransaction()
- * ```
- *
- * Autofill helps fill in fields which should be included in a transaction, but can be determined automatically
- * such as `LastLedgerSequence` and `Fee`. If you override one of the fields `autofill` changes, your explicit
- * values will be used instead. By default, this is done as part of `submit` and `submitAndWait` when you pass
- * in an unsigned transaction along with your wallet to be submitted.
- *
- * @param this - A client.
- * @param transaction - A {@link Transaction} in JSON format
- * @param signersCount - The expected number of signers for this transaction.
- * Only used for multisigned transactions.
- * @returns The autofilled transaction.
- */
-async function autofill<T extends Transaction>(
-  this: Client,
-  transaction: T,
-  signersCount?: number,
-): Promise<T> {
-  const tx = { ...transaction }
-
-  setValidAddresses(tx)
-
-  setTransactionFlagsToNumber(tx)
-  const promises: Array<Promise<void>> = []
-  if (tx.NetworkID == null) {
-    tx.NetworkID = txNeedsNetworkID(this) ? this.networkID : undefined
-  }
-  if (tx.Sequence == null) {
-    promises.push(setNextValidSequenceNumber(this, tx))
-  }
-  if (tx.Fee == null) {
-    promises.push(calculateFeePerTransactionType(this, tx, signersCount))
-  }
-  if (tx.LastLedgerSequence == null) {
-    promises.push(setLatestValidatedLedgerSequence(this, tx))
-  }
-  if (tx.TransactionType === 'AccountDelete') {
-    promises.push(checkAccountDeleteBlockers(this, tx))
-  }
-
-  return Promise.all(promises).then(() => tx)
-}
 
 /**
  * Determines whether the source rippled version is not later than the target rippled version.
@@ -165,24 +86,19 @@ function isNotLaterRippledVersion(source: string, target: string): boolean {
 
 /**
  * Determine if the transaction required a networkID to be valid.
- * Transaction needs networkID if later than restricted ID and either the network is hooks testnet
- * or build version is >= 1.11.0
+ * Transaction needs networkID if later than restricted ID and build version is >= 1.11.0
  *
  * @param client -- The connected client.
  * @returns True if required networkID, false otherwise.
  */
-function txNeedsNetworkID(client: Client): boolean {
+export function txNeedsNetworkID(client: Client): boolean {
   if (
     client.networkID !== undefined &&
     client.networkID > RESTRICTED_NETWORKS
   ) {
     if (
-      (client.buildVersion &&
-        isNotLaterRippledVersion(
-          REQUIRED_NETWORKID_VERSION,
-          client.buildVersion,
-        )) ||
-      client.networkID === HOOKS_TESTNET_ID
+      client.buildVersion &&
+      isNotLaterRippledVersion(REQUIRED_NETWORKID_VERSION, client.buildVersion)
     ) {
       return true
     }
@@ -190,7 +106,17 @@ function txNeedsNetworkID(client: Client): boolean {
   return false
 }
 
-function setValidAddresses(tx: Transaction): void {
+interface ClassicAccountAndTag {
+  classicAccount: string
+  tag: number | false | undefined
+}
+
+/**
+ * Sets valid addresses for the transaction.
+ *
+ * @param tx - The transaction object.
+ */
+export function setValidAddresses(tx: Transaction): void {
   validateAccountAddress(tx, 'Account', 'SourceTag')
   // eslint-disable-next-line @typescript-eslint/dot-notation -- Destination can exist on Transaction
   if (tx['Destination'] != null) {
@@ -206,6 +132,14 @@ function setValidAddresses(tx: Transaction): void {
   convertToClassicAddress(tx, 'RegularKey')
 }
 
+/**
+ * Validates the account address in a transaction object.
+ *
+ * @param tx - The transaction object.
+ * @param accountField - The field name for the account address in the transaction object.
+ * @param tagField - The field name for the tag in the transaction object.
+ * @throws {ValidationError} If the tag field does not match the tag of the account address.
+ */
 function validateAccountAddress(
   tx: Transaction,
   accountField: string,
@@ -227,6 +161,14 @@ function validateAccountAddress(
   }
 }
 
+/**
+ * Retrieves the classic account and tag from an account address.
+ *
+ * @param Account - The account address.
+ * @param [expectedTag] - The expected tag for the account address.
+ * @returns The classic account and tag.
+ * @throws {ValidationError} If the address includes a tag that does not match the tag specified in the transaction.
+ */
 function getClassicAccountAndTag(
   Account: string,
   expectedTag?: number,
@@ -249,6 +191,12 @@ function getClassicAccountAndTag(
   }
 }
 
+/**
+ * Converts the specified field of a transaction object to a classic address format.
+ *
+ * @param tx - The transaction object.
+ * @param fieldName - The name of the field to convert.export
+ */
 function convertToClassicAddress(tx: Transaction, fieldName: string): void {
   // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- assignment is safe
   const account = tx[fieldName]
@@ -259,7 +207,15 @@ function convertToClassicAddress(tx: Transaction, fieldName: string): void {
   }
 }
 
-async function setNextValidSequenceNumber(
+/**
+ * Sets the next valid sequence number for a transaction.
+ *
+ * @param client - The client object used for making requests.
+ * @param tx - The transaction object for which the sequence number needs to be set.
+ * @returns A Promise that resolves when the sequence number is set.
+ * @throws {Error} If there is an error retrieving the account information.
+ */
+export async function setNextValidSequenceNumber(
   client: Client,
   tx: Transaction,
 ): Promise<void> {
@@ -273,7 +229,14 @@ async function setNextValidSequenceNumber(
   tx.Sequence = data.result.account_data.Sequence
 }
 
-async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
+/**
+ * Fetches the account deletion fee from the server state using the provided client.
+ *
+ * @param client - The client object used to make the request.
+ * @returns A Promise that resolves to the account deletion fee as a BigNumber.
+ * @throws {Error} Throws an error if the account deletion fee cannot be fetched.
+ */
+async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
   const response = await client.request({ command: 'server_state' })
   const fee = response.result.state.validated_ledger?.reserve_inc
 
@@ -284,7 +247,15 @@ async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
   return new BigNumber(fee)
 }
 
-async function calculateFeePerTransactionType(
+/**
+ * Calculates the fee per transaction type.
+ *
+ * @param client - The client object.
+ * @param tx - The transaction object.
+ * @param [signersCount=0] - The number of signers (default is 0). Only used for multisigning.
+ * @returns A promise that resolves with void. Modifies the `tx` parameter to give it the calculated fee.
+ */
+export async function calculateFeePerTransactionType(
   client: Client,
   tx: Transaction,
   signersCount = 0,
@@ -309,7 +280,7 @@ async function calculateFeePerTransactionType(
     tx.TransactionType === 'AccountDelete' ||
     tx.TransactionType === 'AMMCreate'
   ) {
-    baseFee = await fetchOwnerReserveFee(client)
+    baseFee = await fetchAccountDeleteFee(client)
   }
 
   /*
@@ -331,11 +302,25 @@ async function calculateFeePerTransactionType(
   tx.Fee = totalFee.dp(0, BigNumber.ROUND_CEIL).toString(10)
 }
 
+/**
+ * Scales the given value by multiplying it with the provided multiplier.
+ *
+ * @param value - The value to be scaled.
+ * @param multiplier - The multiplier to scale the value.
+ * @returns The scaled value as a string.
+ */
 function scaleValue(value, multiplier): string {
   return new BigNumber(value).times(multiplier).toString()
 }
 
-async function setLatestValidatedLedgerSequence(
+/**
+ * Sets the latest validated ledger sequence for the transaction.
+ *
+ * @param client - The client object.
+ * @param tx - The transaction object.
+ * @returns A promise that resolves with void. Modifies the `tx` parameter setting `LastLedgerSequence`.
+ */
+export async function setLatestValidatedLedgerSequence(
   client: Client,
   tx: Transaction,
 ): Promise<void> {
@@ -344,7 +329,14 @@ async function setLatestValidatedLedgerSequence(
   tx.LastLedgerSequence = ledgerSequence + LEDGER_OFFSET
 }
 
-async function checkAccountDeleteBlockers(
+/**
+ * Checks for any blockers that prevent the deletion of an account.
+ *
+ * @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.
+ */
+export async function checkAccountDeleteBlockers(
   client: Client,
   tx: Transaction,
 ): Promise<void> {
@@ -367,5 +359,3 @@ async function checkAccountDeleteBlockers(
     resolve()
   })
 }
-
-export default autofill

package/src/sugar/balances.ts

@@ -1,123 +1,15 @@
-import flatMap from 'lodash/flatMap'
+import { AccountLinesTrustline, Balance } from '../models'
 
-import type { Balance, Client } from '..'
-import {
-  AccountLinesRequest,
-  AccountLinesTrustline,
-  LedgerIndex,
-  AccountInfoRequest,
-} from '../models'
-import { dropsToXrp } from '../utils'
-
-function formatBalances(trustlines: AccountLinesTrustline[]): Balance[] {
+/**
+ * Formats an array of trustlines into an array of balances.
+ *
+ * @param trustlines - The array of trustlines to format.
+ * @returns An array of balances, each containing the value, currency, and issuer.
+ */
+export function formatBalances(trustlines: AccountLinesTrustline[]): Balance[] {
   return trustlines.map((trustline) => ({
     value: trustline.balance,
     currency: trustline.currency,
     issuer: trustline.account,
   }))
 }
-
-/**
- * Get the XRP balance for an account.
- *
- * @example
- * ```ts
- * const client = new Client(wss://s.altnet.rippletest.net:51233)
- * const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
- * console.log(balance)
- * /// '200'
- * ```
- *
- * @param this - Client.
- * @param address - Address of the account to retrieve XRP balance.
- * @param options - Options to include for getting the XRP balance.
- * @param options.ledger_index - Retrieve the account balances at a given
- * ledger_index.
- * @param options.ledger_hash - Retrieve the account balances at the ledger with
- * a given ledger_hash.
- * @returns The XRP balance of the account (as a string).
- */
-async function getXrpBalance(
-  this: Client,
-  address: string,
-  options: {
-    ledger_hash?: string
-    ledger_index?: LedgerIndex
-  } = {},
-): Promise<string> {
-  const xrpRequest: AccountInfoRequest = {
-    command: 'account_info',
-    account: address,
-    ledger_index: options.ledger_index ?? 'validated',
-    ledger_hash: options.ledger_hash,
-  }
-  const response = await this.request(xrpRequest)
-  return dropsToXrp(response.result.account_data.Balance)
-}
-
-/**
- * Get XRP/non-XRP balances for an account.
- *
- * @param this - Client.
- * @param address - Address of the account to retrieve balances for.
- * @param options - Allows the client to specify a ledger_hash, ledger_index,
- * filter by peer, and/or limit number of balances.
- * @param options.ledger_index - Retrieve the account balances at a given
- * ledger_index.
- * @param options.ledger_hash - Retrieve the account balances at the ledger with
- * a given ledger_hash.
- * @param options.peer - Filter balances by peer.
- * @param options.limit - Limit number of balances to return.
- * @returns An array of XRP/non-XRP balances for the given account.
- */
-// eslint-disable-next-line max-lines-per-function -- Longer definition is required for end users to see the definition.
-async function getBalances(
-  this: Client,
-  address: string,
-  options: {
-    ledger_hash?: string
-    ledger_index?: LedgerIndex
-    peer?: string
-    limit?: number
-  } = {},
-): Promise<
-  Array<{ value: string; currency: string; issuer?: string | undefined }>
-> {
-  const balances: Balance[] = []
-
-  // get XRP balance
-  let xrpPromise: Promise<string> = Promise.resolve('')
-  if (!options.peer) {
-    xrpPromise = this.getXrpBalance(address, {
-      ledger_hash: options.ledger_hash,
-      ledger_index: options.ledger_index,
-    })
-  }
-
-  // get non-XRP balances
-  const linesRequest: AccountLinesRequest = {
-    command: 'account_lines',
-    account: address,
-    ledger_index: options.ledger_index ?? 'validated',
-    ledger_hash: options.ledger_hash,
-    peer: options.peer,
-    limit: options.limit,
-  }
-  const linesPromise = this.requestAll(linesRequest)
-
-  // combine results
-  await Promise.all([xrpPromise, linesPromise]).then(
-    ([xrpBalance, linesResponses]) => {
-      const accountLinesBalance = flatMap(linesResponses, (response) =>
-        formatBalances(response.result.lines),
-      )
-      if (xrpBalance !== '') {
-        balances.push({ currency: 'XRP', value: xrpBalance })
-      }
-      balances.push(...accountLinesBalance)
-    },
-  )
-  return balances.slice(0, options.limit)
-}
-
-export { getXrpBalance, getBalances }

package/src/sugar/getFeeXrp.ts

@@ -1,6 +1,6 @@
 import BigNumber from 'bignumber.js'
 
-import type { Client } from '..'
+import { type Client } from '..'
 import { XrplError } from '../errors'
 
 const NUM_DECIMAL_PLACES = 6
@@ -20,8 +20,11 @@ export default async function getFeeXrp(
 ): Promise<string> {
   const feeCushion = cushion ?? client.feeCushion
 
-  const serverInfo = (await client.request({ command: 'server_info' })).result
-    .info
+  const serverInfo = (
+    await client.request({
+      command: 'server_info',
+    })
+  ).result.info
 
   const baseFee = serverInfo.validated_ledger?.base_fee_xrp