xrpl 3.1.0 → 4.0.0-mpt-beta

package/src/models/utils/flags.ts

@@ -1,6 +1,5 @@
 /* eslint-disable no-param-reassign -- param reassign is safe */
 /* eslint-disable no-bitwise -- flags require bitwise operations */
-
 import { ValidationError } from '../../errors'
 import {
   AccountRootFlagsInterface,
@@ -18,6 +17,9 @@ import { PaymentChannelClaimFlags } from '../transactions/paymentChannelClaim'
 import type { Transaction } from '../transactions/transaction'
 import { TrustSetFlags } from '../transactions/trustSet'
 import { XChainModifyBridgeFlags } from '../transactions/XChainModifyBridge'
+import { MPTokenAuthorizeFlags } from '../transactions/MPTokenAuthorize'
+import { MPTokenIssuanceCreateFlags } from '../transactions/MPTokenIssuanceCreate'
+import { MPTokenIssuanceSetFlags } from '../transactions/MPTokenIssuanceSet'
 
 import { isFlagEnabled } from '.'
 
@@ -49,6 +51,9 @@ const txToFlag = {
   AccountSet: AccountSetTfFlags,
   AMMDeposit: AMMDepositFlags,
   AMMWithdraw: AMMWithdrawFlags,
+  MPTokenAuthorize: MPTokenAuthorizeFlags,
+  MPTokenIssuanceCreate: MPTokenIssuanceCreateFlags,
+  MPTokenIssuanceSet: MPTokenIssuanceSetFlags,
   NFTokenCreateOffer: NFTokenCreateOfferFlags,
   NFTokenMint: NFTokenMintFlags,
   OfferCreate: OfferCreateFlags,
@@ -90,3 +95,30 @@ function convertFlagsToNumber(flags: GlobalFlags, flagEnum: any): number {
     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 {
+  setTransactionFlagsToNumber(tx)
+  if (typeof tx.Flags !== 'number' || !tx.Flags || tx.Flags === 0) {
+    return {}
+  }
+
+  const flags = tx.Flags
+  const flagsMap = {}
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- safe member access
+  const flagEnum = txToFlag[tx.TransactionType]
+  Object.values(flagEnum).forEach((flag) => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- safe member access
+    if (typeof flag === 'string' && isFlagEnabled(flags, flagEnum[flag])) {
+      flagsMap[flag] = true
+    }
+  })
+
+  return flagsMap
+}

package/src/sugar/autofill.ts

@@ -1,7 +1,7 @@
 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'
@@ -17,7 +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
 
 /**
  * Determines whether the source rippled version is not later than the target rippled version.
@@ -87,8 +86,7 @@ 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.
@@ -99,12 +97,8 @@ export function txNeedsNetworkID(client: Client): boolean {
     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
     }

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
 

package/src/sugar/submit.ts

@@ -10,7 +10,7 @@ import type {
 } from '..'
 import { ValidationError, XrplError } from '../errors'
 import { Signer } from '../models/common'
-import { TxRequest, TxResponse } from '../models/methods'
+import { TxResponse } from '../models/methods'
 import { BaseTransaction } from '../models/transactions/common'
 
 /** Approximate time for a ledger to close, in milliseconds */
@@ -129,7 +129,7 @@ export async function waitForFinalTransactionOutcome<
   }
 
   const txResponse = await client
-    .request<TxRequest, TxResponse<T>>({
+    .request({
       command: 'tx',
       transaction: txHash,
     })
@@ -153,7 +153,9 @@ export async function waitForFinalTransactionOutcome<
     })
 
   if (txResponse.result.validated) {
-    return txResponse
+    // TODO: resolve the type assertion below
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we know that txResponse is of type TxResponse
+    return txResponse as TxResponse<T>
   }
 
   return waitForFinalTransactionOutcome<T>(

package/src/utils/hashes/hashLedger.ts

@@ -8,8 +8,9 @@ import BigNumber from 'bignumber.js'
 import { decode, encode } from 'ripple-binary-codec'
 
 import { ValidationError, XrplError } from '../../errors'
-import type { Ledger } from '../../models/ledger'
+import { APIVersion } from '../../models'
 import { LedgerEntry } from '../../models/ledger'
+import { LedgerVersionMap } from '../../models/ledger/Ledger'
 import { Transaction, TransactionMetadata } from '../../models/transactions'
 
 import HashPrefix from './HashPrefix'
@@ -99,7 +100,9 @@ export function hashSignedTx(tx: Transaction | string): string {
  * @returns The hash of the ledger.
  * @category Utilities
  */
-export function hashLedgerHeader(ledgerHeader: Ledger): string {
+export function hashLedgerHeader(
+  ledgerHeader: LedgerVersionMap<APIVersion>,
+): string {
   const prefix = HashPrefix.LEDGER.toString(HEX).toUpperCase()
 
   const ledger =
@@ -158,7 +161,7 @@ export function hashStateTree(entries: LedgerEntry[]): string {
 }
 
 function computeTransactionHash(
-  ledger: Ledger,
+  ledger: LedgerVersionMap<APIVersion>,
   options: HashLedgerHeaderOptions,
 ): string {
   const { transaction_hash } = ledger
@@ -188,7 +191,7 @@ function computeTransactionHash(
 }
 
 function computeStateHash(
-  ledger: Ledger,
+  ledger: LedgerVersionMap<APIVersion>,
   options: HashLedgerHeaderOptions,
 ): string {
   const { account_hash } = ledger
@@ -222,7 +225,7 @@ function computeStateHash(
  * @category Utilities
  */
 function hashLedger(
-  ledger: Ledger,
+  ledger: LedgerVersionMap<APIVersion>,
   options: {
     computeTreeHashes?: boolean
   } = {},

package/src/utils/index.ts

@@ -23,6 +23,7 @@ import {
 } from 'ripple-binary-codec'
 import { verify as verifyKeypairSignature } from 'ripple-keypairs'
 
+import type { APIVersion } from '../models'
 import { LedgerEntry } from '../models/ledger'
 import { Response } from '../models/methods'
 import { PaymentChannelClaim } from '../models/transactions/paymentChannelClaim'
@@ -65,6 +66,7 @@ import {
 } from './timeConversion'
 import verifyPaymentChannelClaim from './verifyPaymentChannelClaim'
 import { xrpToDrops, dropsToXrp } from './xrpConversion'
+import { mptUint64ToHex } from './mptConversion'
 
 /**
  * Check if a secret is valid.
@@ -157,7 +159,7 @@ function isValidAddress(address: string): boolean {
  * @returns Whether the response has more pages of data.
  * @category Utilities
  */
-function hasNextPage(response: Response): boolean {
+function hasNextPage(response: Response<APIVersion>): boolean {
   // eslint-disable-next-line @typescript-eslint/dot-notation -- only checking if it exists
   return Boolean(response.result['marker'])
 }
@@ -228,4 +230,5 @@ export {
   getNFTokenID,
   parseNFTokenID,
   getXChainClaimID,
+  mptUint64ToHex,
 }

package/src/utils/mptConversion.ts

@@ -0,0 +1,61 @@
+import BigNumber from 'bignumber.js'
+import { ValidationError } from '../errors'
+
+const SANITY_CHECK = /^[0-9]+$/u
+
+/**
+ * Convert an unsigned 64-bit decimal string to hex string. Mostly used for the MaximumAmount field
+ * in MPTokenIssuanceCreate.
+ *
+ * @param numberToConvert - Non-negative number string.
+ * @returns Amount in hex string.
+ * @throws When amount is invalid.
+ * @category Utilities
+ *
+ * @example
+ * ```typescript
+ * const decimalString = mptUint64ToHex("1000");
+ * console.log(decimalString); // Output: "3e8"
+ *
+ * const hexString = mptUint64ToHex("0x3e8");
+ * console.log(hexString); // Output: "3e8"
+ * ```
+ */
+export function mptUint64ToHex(numberToConvert: string): string {
+  // convert to base 10 string first for inputs like scientific notation
+  const number = new BigNumber(numberToConvert).toString(10)
+
+  // check that the value is valid and actually a number
+  if (typeof numberToConvert === 'string' && number === 'NaN') {
+    throw new ValidationError(
+      `mptUint64ToHex: invalid value '${numberToConvert}', should be a string-encoded number.`,
+    )
+  }
+
+  // mpts are only whole units
+  if (number.includes('.')) {
+    throw new ValidationError(
+      `mptUint64ToHex: value '${numberToConvert}' has too many decimal places.`,
+    )
+  }
+  if (number.includes('-')) {
+    throw new ValidationError(
+      `mptUint64ToHex: value '${numberToConvert}' cannot be negative.`,
+    )
+  }
+
+  if (!SANITY_CHECK.exec(number)) {
+    throw new ValidationError(
+      `mptUint64ToHex: failed sanity check -` +
+        ` value '${numberToConvert}',` +
+        ` does not match (^[0-9]+$).`,
+    )
+  }
+
+  if (Number(BigInt(number) & BigInt('0x8000000000000000')) != 0)
+    throw new ValidationError(
+      `mptUint64ToHex: invalid value '${numberToConvert}', should be within 63-bit range.`,
+    )
+
+  return BigInt(number).toString(16)
+}