Support for Dynamic MPTs (XLS-94D)

.ci-config/rippled.cfg

@@ -193,6 +193,7 @@ Batch
 PermissionedDEX
 TokenEscrow
 SingleAssetVault
+DynamicMPT
 
 # This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
 [voting]

.github/workflows/nodejs.yml

@@ -122,8 +122,11 @@ jobs:
           fetch-depth: 0
 
       - name: Run docker in background
+        id: run-docker
         run: |
           docker run --detach --rm -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a"
+          CONTAINER_ID=$(docker ps -aqf "name=rippled-service")
+          echo "docker-container-id=$CONTAINER_ID" >> $GITHUB_OUTPUT
 
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
@@ -154,6 +157,17 @@ jobs:
 
       - run: npm run build
 
+      - name: Check if Docker container is running
+        id: check-docker-container
+        run: |
+          if ! docker ps | grep -q rippled-service; then
+            echo "INFO: Currently running docker containers:"
+            docker ps
+            echo "ERROR: rippled-service Docker container is not running"
+            exit 1
+          fi
+          docker inspect ${{ steps.run-docker.outputs.docker-container-id }}
+
       - name: Run integration test
         run: npm run test:integration
 
@@ -181,8 +195,11 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Run docker in background
+        id: run-docker
         run: |
           docker run --detach --rm -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a"
+          CONTAINER_ID=$(docker ps -aqf "name=rippled-service")
+          echo "docker-container-id=$CONTAINER_ID" >> $GITHUB_OUTPUT
 
       - name: Setup npm version 10
         run: |
@@ -208,6 +225,17 @@ jobs:
 
       - run: npm run build
 
+      - name: Check if Docker container is running
+        id: check-docker-container
+        run: |
+          if ! docker ps | grep -q rippled-service; then
+            echo "INFO: Currently running docker containers:"
+            docker ps
+            echo "ERROR: rippled-service Docker container is not running"
+            exit 1
+          fi
+          docker inspect ${{ steps.run-docker.outputs.docker-container-id }}
+
       - name: Run integration test
         run: npm run test:browser
 

packages/ripple-binary-codec/src/enums/definitions.json

@@ -680,6 +680,16 @@
         "type": "UInt32"
       }
     ],
+    [
+      "MutableFlags",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 53,
+        "type": "UInt32"
+      }
+    ],
     [
       "IndexNext",
       {

packages/xrpl/HISTORY.md

@@ -4,6 +4,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 
 ## Unreleased
 
+### Added
+* Support for `Dynamic MPT` (XLS-94D)
+
 ### Fixed
 * Fix incorrect type checking in `validateVaultCreate` that prevented vault creation with MPT as an asset.
 

packages/xrpl/src/models/ledger/LedgerEntry.ts

@@ -10,6 +10,7 @@ import DirectoryNode from './DirectoryNode'
 import Escrow from './Escrow'
 import FeeSettings from './FeeSettings'
 import LedgerHashes from './LedgerHashes'
+import { MPTokenIssuance } from './MPTokenIssuance'
 import NegativeUNL from './NegativeUNL'
 import Offer from './Offer'
 import Oracle from './Oracle'
@@ -46,6 +47,7 @@ type LedgerEntry =
   | Vault
   | XChainOwnedClaimID
   | XChainOwnedCreateAccountClaimID
+  | MPTokenIssuance
 
 type LedgerEntryFilter =
   | 'account'

packages/xrpl/src/models/ledger/MPTokenIssuance.ts

@@ -11,4 +11,92 @@ export interface MPTokenIssuance extends BaseLedgerEntry, HasPreviousTxnID {
   MPTokenMetadata?: string
   OwnerNode?: string
   LockedAmount?: string
+  DomainID?: string
+  MutableFlags: number
+}
+
+export interface MPTokenIssuanceFlagsInterface {
+  lsfMPTLocked?: boolean
+  lsfMPTCanLock?: boolean
+  lsfMPTRequireAuth?: boolean
+  lsfMPTCanEscrow?: boolean
+  lsfMPTCanTrade?: boolean
+  lsfMPTCanTransfer?: boolean
+  lsfMPTCanClawback?: boolean
+
+  /**
+   * Indicates flag lsfMPTCanLock can be changed
+   */
+  lsmfMPTCanMutateCanLock?: boolean
+  /**
+   * Indicates flag lsfMPTRequireAuth can be changed
+   */
+  lsmfMPTCanMutateRequireAuth?: boolean
+  /**
+   * Indicates flag lsfMPTCanEscrow can be changed
+   */
+  lsmfMPTCanMutateCanEscrow?: boolean
+  /**
+   * Indicates flag lsfMPTCanTrade can be changed
+   */
+  lsmfMPTCanMutateCanTrade?: boolean
+  /**
+   * Indicates flag lsfMPTCanTransfer can be changed
+   */
+  lsmfMPTCanMutateCanTransfer?: boolean
+  /**
+   * Indicates flag lsfMPTCanClawback can be changed
+   */
+  lsmfMPTCanMutateCanClawback?: boolean
+  /**
+   * Allows field MPTokenMetadata to be modified
+   */
+  lsmfMPTCanMutateMetadata?: boolean
+  /**
+   * Allows field TransferFee to be modified
+   */
+  lsmfMPTCanMutateTransferFee?: boolean
+}
+
+export enum MPTokenIssuanceFlags {
+  lsfMPTLocked = 0x00000001,
+  lsfMPTCanLock = 0x00000002,
+  lsfMPTRequireAuth = 0x00000004,
+  lsfMPTCanEscrow = 0x00000008,
+  lsfMPTCanTrade = 0x00000010,
+  lsfMPTCanTransfer = 0x00000020,
+  lsfMPTCanClawback = 0x00000040,
+
+  /**
+   * Indicates flag lsfMPTCanLock can be changed
+   */
+  lsmfMPTCanMutateCanLock = 0x00000002,
+  /**
+   * Indicates flag lsfMPTRequireAuth can be changed
+   */
+  lsmfMPTCanMutateRequireAuth = 0x00000004,
+  /**
+   * Indicates flag lsfMPTCanEscrow can be changed
+   */
+  lsmfMPTCanMutateCanEscrow = 0x00000008,
+  /**
+   * Indicates flag lsfMPTCanTrade can be changed
+   */
+  lsmfMPTCanMutateCanTrade = 0x00000010,
+  /**
+   * Indicates flag lsfMPTCanTransfer can be changed
+   */
+  lsmfMPTCanMutateCanTransfer = 0x00000020,
+  /**
+   * Indicates flag lsfMPTCanClawback can be changed
+   */
+  lsmfMPTCanMutateCanClawback = 0x00000040,
+  /**
+   * Allows field MPTokenMetadata to be modified
+   */
+  lsmfMPTCanMutateMetadata = 0x00010000,
+  /**
+   * Allows field TransferFee to be modified
+   */
+  lsmfMPTCanMutateTransferFee = 0x00020000,
 }

packages/xrpl/src/models/transactions/MPTokenIssuanceCreate.ts

@@ -16,7 +16,7 @@ import type { TransactionMetadataBase } from './metadata'
 
 // 2^63 - 1
 const MAX_AMT = '9223372036854775807'
-const MAX_TRANSFER_FEE = 50000
+export const MAX_TRANSFER_FEE = 50000
 
 /**
  * Transaction Flags for an MPTokenIssuanceCreate Transaction.
@@ -53,8 +53,54 @@ export enum MPTokenIssuanceCreateFlags {
    * to clawback value from individual holders.
    */
   tfMPTCanClawback = 0x00000040,
+
+  /**
+   * If set, Indicates flag lsfMPTCanLock can be changed.
+   */
+  tmfMPTCanMutateCanLock = 0x00000002,
+  /**
+   * If set, Indicates flag lsfMPTRequireAuth can be changed
+   */
+  tmfMPTCanMutateRequireAuth = 0x00000004,
+  /**
+   * If set, Indicates flag lsfMPTCanEscrow can be changed.
+   */
+  tmfMPTCanMutateCanEscrow = 0x00000008,
+  /**
+   * If set, Indicates flag lsfMPTCanTrade can be changed.
+   */
+  tmfMPTCanMutateCanTrade = 0x00000010,
+  /**
+   * If set, Indicates flag lsfMPTCanTransfer can be changed.
+   */
+  tmfMPTCanMutateCanTransfer = 0x00000020,
+  /**
+   * If set, Indicates flag lsfMPTCanClawback can be changed.
+   */
+  tmfMPTCanMutateCanClawback = 0x00000040,
+  /**
+   * If set, Allows field MPTokenMetadata to be modified.
+   */
+  tmfMPTCanMutateMetadata = 0x00010000,
+  /**
+   * If set, Allows field TransferFee to be modified.
+   */
+  tmfMPTCanMutateTransferFee = 0x00020000,
 }
 
+/* eslint-disable no-bitwise -- Need bitwise operations to replicate rippled behavior */
+export const tmfMPTokenIssuanceCreateMutableMask = ~(
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateCanLock |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateRequireAuth |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateCanEscrow |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateCanTrade |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateCanTransfer |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateCanClawback |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateMetadata |
+  MPTokenIssuanceCreateFlags.tmfMPTCanMutateTransferFee
+)
+/* eslint-enable no-bitwise */
+
 /**
  * Map of flags to boolean values representing {@link MPTokenIssuanceCreate} transaction
  * flags.
@@ -63,12 +109,68 @@ export enum MPTokenIssuanceCreateFlags {
  */
 export interface MPTokenIssuanceCreateFlagsInterface
   extends GlobalFlagsInterface {
+  /**
+   * If set, indicates that the MPT can be locked both individually and globally.
+   * If not set, the MPT cannot be locked in any way.
+   */
   tfMPTCanLock?: boolean
+  /**
+   * If set, indicates that individual holders must be authorized.
+   * This enables issuers to limit who can hold their assets.
+   */
   tfMPTRequireAuth?: boolean
+  /**
+   * If set, indicates that individual holders can place their balances into an escrow.
+   */
   tfMPTCanEscrow?: boolean
+  /**
+   * If set, indicates that individual holders can trade their balances
+   *  using the XRP Ledger DEX or AMM.
+   */
   tfMPTCanTrade?: boolean
+  /**
+   * If set, indicates that tokens may be transferred to other accounts
+   *  that are not the issuer.
+   */
   tfMPTCanTransfer?: boolean
+  /**
+   * If set, indicates that the issuer may use the Clawback transaction
+   * to clawback value from individual holders.
+   */
   tfMPTCanClawback?: boolean
+
+  /**
+   * If set, Indicates flag lsfMPTCanLock can be changed.
+   */
+  tmfMPTCanMutateCanLock?: boolean
+  /**
+   * If set, Indicates flag lsfMPTRequireAuth can be changed.
+   */
+  tmfMPTCanMutateRequireAuth?: boolean
+  /**
+   * If set, Indicates flag lsfMPTCanEscrow can be changed.
+   */
+  tmfMPTCanMutateCanEscrow?: boolean
+  /**
+   * If set, Indicates flag lsfMPTCanTrade can be changed.
+   */
+  tmfMPTCanMutateCanTrade?: boolean
+  /**
+   * If set, Indicates flag lsfMPTCanTransfer can be changed.
+   */
+  tmfMPTCanMutateCanTransfer?: boolean
+  /**
+   * If set, Indicates flag lsfMPTCanClawback can be changed.
+   */
+  tmfMPTCanMutateCanClawback?: boolean
+  /**
+   * If set, Allows field MPTokenMetadata to be modified.
+   */
+  tmfMPTCanMutateMetadata?: boolean
+  /**
+   * If set, Allows field TransferFee to be modified.
+   */
+  tmfMPTCanMutateTransferFee?: boolean
 }
 
 /**
@@ -120,13 +222,14 @@ export interface MPTokenIssuanceCreate extends BaseTransaction {
   MPTokenMetadata?: string
 
   Flags?: number | MPTokenIssuanceCreateFlagsInterface
+  MutableFlags?: number
 }
 
 export interface MPTokenIssuanceCreateMetadata extends TransactionMetadataBase {
   mpt_issuance_id?: string
 }
 
-/* eslint-disable max-lines-per-function -- Not needed to reduce function */
+/* eslint-disable max-lines-per-function, max-statements -- Not needed to reduce function */
 /**
  * Verify the form and type of an MPTokenIssuanceCreate at runtime.
  *
@@ -141,6 +244,17 @@ export function validateMPTokenIssuanceCreate(
   validateOptionalField(tx, 'MPTokenMetadata', isString)
   validateOptionalField(tx, 'TransferFee', isNumber)
   validateOptionalField(tx, 'AssetScale', isNumber)
+  validateOptionalField(tx, 'MutableFlags', isNumber)
+
+  if (
+    tx.MutableFlags != null &&
+    // eslint-disable-next-line no-bitwise -- Need bitwise operations to replicate rippled behavior
+    tx.MutableFlags & tmfMPTokenIssuanceCreateMutableMask
+  ) {
+    throw new ValidationError(
+      'MPTokenIssuanceCreate: Invalid MutableFlags value',
+    )
+  }
 
   if (
     typeof tx.MPTokenMetadata === 'string' &&
@@ -202,4 +316,4 @@ export function validateMPTokenIssuanceCreate(
     }
   }
 }
-/* eslint-enable max-lines-per-function */
+/* eslint-enable max-lines-per-function, max-statements */