Issue a Multi-Purpose Token (MPT)

npm install xrpl

import {
  MPTokenIssuanceCreateFlags,
  MPTokenIssuanceCreateImmutableFlags,
  MPTokenIssuanceSetFlags,
  Client,
  encodeMPTokenMetadata,
  decodeMPTokenMetadata
} from 'xrpl'

// Connect to network and get a wallet
const client = new Client('wss://s.devnet.rippletest.net:51233')
await client.connect()

console.log('=== Funding new wallet from faucet...===')
const { wallet: issuer } = await client.fundWallet()
console.log(`Issuer address: ${issuer.address}`)

// Define metadata as JSON
const mptMetadata = {
  ticker: 'TBILL',
  name: 'T-Bill Yield Token',
  desc: 'A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.',
  icon: 'https://example.org/tbill-icon.png',
  asset_class: 'rwa',
  asset_subclass: 'treasury',
  issuer_name: 'Example Yield Co.',
  uris: [
    {
      uri: 'https://exampleyield.co/tbill',
      category: 'website',
      title: 'Product Page'
    },
    {
      uri: 'https://exampleyield.co/docs',
      category: 'docs',
      title: 'Yield Token Docs'
    }
  ],
  additional_info: {
    interest_rate: '5.00%',
    interest_type: 'variable',
    yield_source: 'U.S. Treasury Bills',
    maturity_date: '2045-06-30',
    cusip: '912796RX0'
  }
}

// Encode the metadata.
// The encodeMPTokenMetadata function shortens standard MPTokenMetadata
// field names to a compact key, then converts the JSON metadata object into a
// hex-encoded string, following the XLS-89 standard.
// https://xls.xrpl.org/xls/XLS-0089-multi-purpose-token-metadata-schema.html
console.log('\n=== Encoding metadata...===')
const mptMetadataHex = encodeMPTokenMetadata(mptMetadata)
console.log('Encoded mptMetadataHex: ', mptMetadataHex)

// Define the transaction, including other MPT parameters
const mptIssuanceCreate = {
  TransactionType: 'MPTokenIssuanceCreate',
  Account: issuer.address,
  AssetScale: 4,
  MaximumAmount: '50000000',
  TransferFee: 0,
  Flags:
    MPTokenIssuanceCreateFlags.tfMPTCanTransfer |
    MPTokenIssuanceCreateFlags.tfMPTCanLock,
  ImmutableFlags: MPTokenIssuanceCreateImmutableFlags.tifMPTCanClawback,
  MPTokenMetadata: mptMetadataHex
}

// Sign and submit the transaction
console.log('\n=== Sending MPTokenIssuanceCreate transaction...===')
console.log(JSON.stringify(mptIssuanceCreate, null, 2))
const submitResponse = await client.submitAndWait(mptIssuanceCreate, {
  wallet: issuer,
  autofill: true
})

// Check transaction results
console.log('\n=== Checking MPTokenIssuanceCreate results... ===')
if (submitResponse.result.meta.TransactionResult !== 'tesSUCCESS') {
  const resultCode = submitResponse.result.meta.TransactionResult
  console.warn(`Transaction failed with result code ${resultCode}.`)
  await client.disconnect()
  process.exit(1)
}

const issuanceId = submitResponse.result.meta.mpt_issuance_id
console.log(
  `\n- MPToken created successfully with issuance ID: ${issuanceId}`
)
// View the MPT issuance on the XRPL Explorer
console.log(`- Explorer URL: https://devnet.xrpl.org/mpt/${issuanceId}`)

// Look up MPT Issuance entry in the validated ledger
console.log('\n=== Confirming MPT Issuance metadata in the validated ledger... ===')
const ledgerEntryResponse = await client.request({
  command: 'ledger_entry',
  mpt_issuance: issuanceId,
  ledger_index: 'validated'
})

// Decode the metadata.
// The decodeMPTokenMetadata function takes a hex-encoded string representing MPT metadata,
// decodes it to a JSON object, and expands any compact field names to their full forms.
const metadataBlob = ledgerEntryResponse.result.node.MPTokenMetadata
const decodedMetadata = decodeMPTokenMetadata(metadataBlob)
console.log('Decoded MPT metadata:\n', decodedMetadata)

// Update the mutable properties, then make the metadata immutable.
// MPTokenMetadata and TransferFee were not declared immutable at issuance, so a
// single MPTokenIssuanceSet transaction can update both. Metadata updates
// replace the whole field, so encode the complete object, not just the changes.
const updatedMetadata = {
  ...mptMetadata,
  additional_info: { ...mptMetadata.additional_info, interest_rate: '4.75%' }
}

console.log('\n=== Sending MPTokenIssuanceSet transaction to update properties...===')
const mptIssuanceUpdate = {
  TransactionType: 'MPTokenIssuanceSet',
  Account: issuer.address,
  MPTokenIssuanceID: issuanceId,
  MPTokenMetadata: encodeMPTokenMetadata(updatedMetadata),
  // A non-zero TransferFee requires the Can Transfer flag, set at issuance.
  TransferFee: 10,
  // Enable Can Trade after issuance.
  Flags: MPTokenIssuanceSetFlags.tfMPTSetCanTrade,
  // The metadata update above still applies; immutability takes effect after it.
  // ImmutableFlags is additive, so tifMPTMetadata is added to the
  // tifMPTCanClawback bit declared at issuance rather than replacing it.
  ImmutableFlags: MPTokenIssuanceCreateImmutableFlags.tifMPTMetadata
}
console.log(JSON.stringify(mptIssuanceUpdate, null, 2))
const updateResponse = await client.submitAndWait(mptIssuanceUpdate, {
  wallet: issuer,
  autofill: true
})
if (updateResponse.result.meta.TransactionResult !== 'tesSUCCESS') {
  const resultCode = updateResponse.result.meta.TransactionResult
  console.warn(`Update failed with result code ${resultCode}.`)
  await client.disconnect()
  process.exit(1)
}

// Confirm the updated MPT Issuance entry
console.log('\n=== Confirming the updated MPT Issuance in the validated ledger... ===')
const updatedEntryResponse = await client.request({
  command: 'ledger_entry',
  mpt_issuance: issuanceId,
  ledger_index: 'validated'
})
const updatedNode = updatedEntryResponse.result.node
console.log('TransferFee:', updatedNode.TransferFee)
console.log('ImmutableFlags:', updatedNode.ImmutableFlags)
console.log('Decoded MPT metadata:\n', decodeMPTokenMetadata(updatedNode.MPTokenMetadata))