xrpl 4.0.0 → 4.0.1-mpt-beta

package/src/models/transactions/transaction.ts

@@ -90,6 +90,19 @@ import {
   XChainModifyBridge,
   validateXChainModifyBridge,
 } from './XChainModifyBridge'
+import { MPTokenAuthorize, validateMPTokenAuthorize } from './MPTokenAuthorize'
+import {
+  MPTokenIssuanceCreate,
+  validateMPTokenIssuanceCreate,
+} from './MPTokenIssuanceCreate'
+import {
+  MPTokenIssuanceDestroy,
+  validateMPTokenIssuanceDestroy,
+} from './MPTokenIssuanceDestroy'
+import {
+  MPTokenIssuanceSet,
+  validateMPTokenIssuanceSet,
+} from './MPTokenIssuanceSet'
 
 /**
  * Transactions that can be submitted by clients
@@ -115,6 +128,10 @@ export type SubmittableTransaction =
   | EscrowCancel
   | EscrowCreate
   | EscrowFinish
+  | MPTokenAuthorize
+  | MPTokenIssuanceCreate
+  | MPTokenIssuanceDestroy
+  | MPTokenIssuanceSet
   | NFTokenAcceptOffer
   | NFTokenBurn
   | NFTokenCancelOffer
@@ -306,6 +323,22 @@ export function validate(transaction: Record<string, unknown>): void {
       validateEscrowFinish(tx)
       break
 
+    case 'MPTokenAuthorize':
+      validateMPTokenAuthorize(tx)
+      break
+
+    case 'MPTokenIssuanceCreate':
+      validateMPTokenIssuanceCreate(tx)
+      break
+
+    case 'MPTokenIssuanceDestroy':
+      validateMPTokenIssuanceDestroy(tx)
+      break
+
+    case 'MPTokenIssuanceSet':
+      validateMPTokenIssuanceSet(tx)
+      break
+
     case 'NFTokenAcceptOffer':
       validateNFTokenAcceptOffer(tx)
       break

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/utils/index.ts

@@ -66,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.
@@ -229,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)
+}