xrpl 1.0.0-mpt-beta

package/src/models/transactions/NFTokenMint.ts

@@ -0,0 +1,138 @@
+import { ValidationError } from '../../errors'
+import { isHex } from '../utils'
+
+import {
+  Account,
+  BaseTransaction,
+  GlobalFlags,
+  isAccount,
+  validateBaseTransaction,
+  validateOptionalField,
+} from './common'
+import type { TransactionMetadataBase } from './metadata'
+
+/**
+ * Transaction Flags for an NFTokenMint Transaction.
+ *
+ * @category Transaction Flags
+ */
+export enum NFTokenMintFlags {
+  /**
+   * If set, indicates that the minted token may be burned by the issuer even
+   * if the issuer does not currently hold the token. The current holder of
+   * the token may always burn it.
+   */
+  tfBurnable = 0x00000001,
+  /**
+   * If set, indicates that the token may only be offered or sold for XRP.
+   */
+  tfOnlyXRP = 0x00000002,
+  /**
+   * If set, indicates that the issuer wants a trustline to be automatically
+   * created.
+   */
+  tfTrustLine = 0x00000004,
+  /**
+   * If set, indicates that this NFT can be transferred. This flag has no
+   * effect if the token is being transferred from the issuer or to the
+   * issuer.
+   */
+  tfTransferable = 0x00000008,
+}
+
+/**
+ * Map of flags to boolean values representing {@link NFTokenMint} transaction
+ * flags.
+ *
+ * @category Transaction Flags
+ */
+export interface NFTokenMintFlagsInterface extends GlobalFlags {
+  tfBurnable?: boolean
+  tfOnlyXRP?: boolean
+  tfTrustLine?: boolean
+  tfTransferable?: boolean
+}
+
+/**
+ * The NFTokenMint transaction creates an NFToken object and adds it to the
+ * relevant NFTokenPage object of the minter. If the transaction is
+ * successful, the newly minted token will be owned by the minter account
+ * specified by the transaction.
+ */
+export interface NFTokenMint extends BaseTransaction {
+  TransactionType: 'NFTokenMint'
+  /**
+   * Indicates the taxon associated with this token. The taxon is generally a
+   * value chosen by the minter of the token and a given taxon may be used for
+   * multiple tokens. The implementation reserves taxon identifiers greater
+   * than or equal to 2147483648 (0x80000000). If you have no use for this
+   * field, set it to 0.
+   */
+  NFTokenTaxon: number
+  /**
+   * Indicates the account that should be the issuer of this token. This value
+   * is optional and should only be specified if the account executing the
+   * transaction is not the `Issuer` of the `NFToken` object. If it is
+   * present, the `MintAccount` field in the `AccountRoot` of the `Issuer`
+   * field must match the `Account`, otherwise the transaction will fail.
+   */
+  Issuer?: Account
+  /**
+   * Specifies the fee charged by the issuer for secondary sales of the Token,
+   * if such sales are allowed. Valid values for this field are between 0 and
+   * 50000 inclusive, allowing transfer rates between 0.000% and 50.000% in
+   * increments of 0.001%. This field must NOT be present if the
+   * `tfTransferable` flag is not set.
+   */
+  TransferFee?: number
+  /**
+   * URI that points to the data and/or metadata associated with the NFT.
+   * This field need not be an HTTP or HTTPS URL; it could be an IPFS URI, a
+   * magnet link, immediate data encoded as an RFC2379 "data" URL, or even an
+   * opaque issuer-specific encoding. The URI is NOT checked for validity, but
+   * the field is limited to a maximum length of 256 bytes.
+   *
+   * This field must be hex-encoded. You can use `convertStringToHex` to
+   * convert this field to the proper encoding.
+   *
+   * This field must not be an empty string. Omit it from the transaction or
+   * set to `undefined` value if you do not use it.
+   */
+  URI?: string | null
+  Flags?: number | NFTokenMintFlagsInterface
+}
+
+export interface NFTokenMintMetadata extends TransactionMetadataBase {
+  // rippled 1.11.0 or later
+  nftoken_id?: string
+}
+
+/**
+ * Verify the form and type of an NFTokenMint at runtime.
+ *
+ * @param tx - An NFTokenMint Transaction.
+ * @throws When the NFTokenMint is Malformed.
+ */
+export function validateNFTokenMint(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  if (tx.Account === tx.Issuer) {
+    throw new ValidationError(
+      'NFTokenMint: Issuer must not be equal to Account',
+    )
+  }
+
+  validateOptionalField(tx, 'Issuer', isAccount)
+
+  if (typeof tx.URI === 'string' && tx.URI === '') {
+    throw new ValidationError('NFTokenMint: URI must not be empty string')
+  }
+
+  if (typeof tx.URI === 'string' && !isHex(tx.URI)) {
+    throw new ValidationError('NFTokenMint: URI must be in hex format')
+  }
+
+  if (tx.NFTokenTaxon == null) {
+    throw new ValidationError('NFTokenMint: missing field NFTokenTaxon')
+  }
+}

package/src/models/transactions/UNLModify.ts

@@ -0,0 +1,22 @@
+import { BaseTransaction } from './common'
+
+/**
+ * Mark a change to the Negative UNL.
+ *
+ * @category Pseudo Transaction Models
+ */
+export interface UNLModify extends BaseTransaction {
+  TransactionType: 'UNLModify'
+  /**
+   * The ledger index where this pseudo-transaction appears.
+   * This distinguishes the pseudo-transaction from other occurrences of the same change.
+   */
+  LedgerSequence: number
+  /**
+   * If 0, this change represents removing a validator from the Negative UNL.
+   * If 1, this change represents adding a validator to the Negative UNL.
+   */
+  UNLModifyDisabling: 0 | 1
+  /** The validator to add or remove, as identified by its master public key. */
+  UNLModifyValidator: string
+}

package/src/models/transactions/XChainAccountCreateCommit.ts

@@ -0,0 +1,69 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateRequiredField,
+  isAccount,
+  Account,
+} from './common'
+
+/**
+ * The XChainAccountCreateCommit transaction creates a new account on one of the
+ * chains a bridge connects, which serves as the bridge entrance for that chain.
+ *
+ * WARNING: This transaction should only be executed if the witness attestations
+ * will be reliably delivered to the destination chain. If the signatures aren't
+ * delivered, then account creation will be blocked until attestations are received.
+ * This can be used maliciously; to disable this transaction on XRP-XRP bridges,
+ * the bridge's MinAccountCreateAmount shouldn't be present.
+ *
+ * @category Transaction Models
+ */
+export interface XChainAccountCreateCommit extends BaseTransaction {
+  TransactionType: 'XChainAccountCreateCommit'
+
+  /**
+   * The bridge to create accounts for.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The amount, in XRP, to be used to reward the witness servers for providing
+   * signatures. This must match the amount on the {@link Bridge} ledger object.
+   */
+  SignatureReward: Amount
+
+  /**
+   * The destination account on the destination chain.
+   */
+  Destination: Account
+
+  /**
+   * The amount, in XRP, to use for account creation. This must be greater than or
+   * equal to the MinAccountCreateAmount specified in the {@link Bridge} ledger object.
+   */
+  Amount: Amount
+}
+
+/**
+ * Verify the form and type of an XChainAccountCreateCommit at runtime.
+ *
+ * @param tx - An XChainAccountCreateCommit Transaction.
+ * @throws When the XChainAccountCreateCommit is malformed.
+ */
+export function validateXChainAccountCreateCommit(
+  tx: Record<string, unknown>,
+): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateRequiredField(tx, 'Destination', isAccount)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+}

package/src/models/transactions/XChainAddAccountCreateAttestation.ts

@@ -0,0 +1,123 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainAddAccountCreateAttestation transaction provides an attestation
+ * from a witness server that a {@link XChainAccountCreateCommit} transaction
+ * occurred on the other chain.
+ *
+ * @category Transaction Models
+ */
+export interface XChainAddAccountCreateAttestation extends BaseTransaction {
+  TransactionType: 'XChainAddAccountCreateAttestation'
+
+  /**
+   * The amount committed by the {@link XChainAccountCreateCommit} transaction
+   * on the source chain.
+   */
+  Amount: Amount
+
+  /**
+   * The account that should receive this signer's share of the SignatureReward.
+   */
+  AttestationRewardAccount: Account
+
+  /**
+   * The account on the door account's signer list that is signing the transaction.
+   */
+  AttestationSignerAccount: Account
+
+  /**
+   * The destination account for the funds on the destination chain.
+   */
+  Destination: Account
+
+  /**
+   * The account on the source chain that submitted the {@link XChainAccountCreateCommit}
+   * transaction that triggered the event associated with the attestation.
+   */
+  OtherChainSource: Account
+
+  /**
+   * The public key used to verify the signature.
+   */
+  PublicKey: string
+
+  /**
+   * The signature attesting to the event on the other chain.
+   */
+  Signature: string
+
+  /**
+   * The signature reward paid in the {@link XChainAccountCreateCommit} transaction.
+   */
+  SignatureReward: Amount
+
+  /**
+   * A boolean representing the chain where the event occurred.
+   */
+  WasLockingChainSend: 0 | 1
+
+  /**
+   * The counter that represents the order that the claims must be processed in.
+   */
+  XChainAccountCreateCount: number | string
+
+  /**
+   * The bridge associated with the attestation.
+   */
+  XChainBridge: XChainBridge
+}
+
+/**
+ * Verify the form and type of an XChainAddAccountCreateAttestation at runtime.
+ *
+ * @param tx - An XChainAddAccountCreateAttestation Transaction.
+ * @throws When the XChainAddAccountCreateAttestation is malformed.
+ */
+export function validateXChainAddAccountCreateAttestation(
+  tx: Record<string, unknown>,
+): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+
+  validateRequiredField(tx, 'AttestationRewardAccount', isAccount)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isAccount)
+
+  validateRequiredField(tx, 'Destination', isAccount)
+
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
+
+  validateRequiredField(tx, 'PublicKey', isString)
+
+  validateRequiredField(tx, 'Signature', isString)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateRequiredField(
+    tx,
+    'WasLockingChainSend',
+    (inp) => inp === 0 || inp === 1,
+  )
+
+  validateRequiredField(
+    tx,
+    'XChainAccountCreateCount',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+}

package/src/models/transactions/XChainAddClaimAttestation.ts

@@ -0,0 +1,117 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainAddClaimAttestation transaction provides proof from a witness server,
+ * attesting to an {@link XChainCommit} transaction.
+ *
+ * @category Transaction Models
+ */
+export interface XChainAddClaimAttestation extends BaseTransaction {
+  TransactionType: 'XChainAddClaimAttestation'
+
+  /**
+   * The amount committed by the {@link XChainCommit} transaction on the source chain.
+   */
+  Amount: Amount
+
+  /**
+   * The account that should receive this signer's share of the SignatureReward.
+   */
+  AttestationRewardAccount: Account
+
+  /**
+   * The account on the door account's signer list that is signing the transaction.
+   */
+  AttestationSignerAccount: Account
+
+  /**
+   * The destination account for the funds on the destination chain (taken from
+   * the {@link XChainCommit} transaction).
+   */
+  Destination?: Account
+
+  /**
+   * The account on the source chain that submitted the {@link XChainCommit}
+   * transaction that triggered the event associated with the attestation.
+   */
+  OtherChainSource: Account
+
+  /**
+   * The public key used to verify the attestation signature.
+   */
+  PublicKey: string
+
+  /**
+   * The signature attesting to the event on the other chain.
+   */
+  Signature: string
+
+  /**
+   * A boolean representing the chain where the event occurred.
+   */
+  WasLockingChainSend: 0 | 1
+
+  /**
+   * The bridge to use to transfer funds.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The XChainClaimID associated with the transfer, which was included in the
+   * {@link XChainCommit} transaction.
+   */
+  XChainClaimID: number | string
+}
+
+/**
+ * Verify the form and type of an XChainAddClaimAttestation at runtime.
+ *
+ * @param tx - An XChainAddClaimAttestation Transaction.
+ * @throws When the XChainAddClaimAttestation is malformed.
+ */
+export function validateXChainAddClaimAttestation(
+  tx: Record<string, unknown>,
+): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+
+  validateRequiredField(tx, 'AttestationRewardAccount', isAccount)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isAccount)
+
+  validateOptionalField(tx, 'Destination', isAccount)
+
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
+
+  validateRequiredField(tx, 'PublicKey', isString)
+
+  validateRequiredField(tx, 'Signature', isString)
+
+  validateRequiredField(
+    tx,
+    'WasLockingChainSend',
+    (inp) => inp === 0 || inp === 1,
+  )
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+}

package/src/models/transactions/XChainClaim.ts

@@ -0,0 +1,79 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainClaim transaction completes a cross-chain transfer of value. It
+ * allows a user to claim the value on the destination chain - the equivalent
+ * of the value locked on the source chain.
+ *
+ * @category Transaction Models
+ */
+export interface XChainClaim extends BaseTransaction {
+  TransactionType: 'XChainClaim'
+
+  /**
+   * The bridge to use for the transfer.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The unique integer ID for the cross-chain transfer that was referenced in the
+   * corresponding {@link XChainCommit} transaction.
+   */
+  XChainClaimID: number | string
+
+  /**
+   * The destination account on the destination chain. It must exist or the
+   * transaction will fail. However, if the transaction fails in this case, the
+   * sequence number and collected signatures won't be destroyed, and the
+   * transaction can be rerun with a different destination.
+   */
+  Destination: Account
+
+  /**
+   * An integer destination tag.
+   */
+  DestinationTag?: number
+
+  /**
+   * The amount to claim on the destination chain. This must match the amount
+   * attested to on the attestations associated with this XChainClaimID.
+   */
+  Amount: Amount
+}
+
+/**
+ * Verify the form and type of an XChainClaim at runtime.
+ *
+ * @param tx - An XChainClaim Transaction.
+ * @throws When the XChainClaim is malformed.
+ */
+export function validateXChainClaim(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateRequiredField(tx, 'Destination', isAccount)
+
+  validateOptionalField(tx, 'DestinationTag', isNumber)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+}

package/src/models/transactions/XChainCommit.ts

@@ -0,0 +1,76 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainCommit is the second step in a cross-chain transfer. It puts assets
+ * into trust on the locking chain so that they can be wrapped on the issuing
+ * chain, or burns wrapped assets on the issuing chain so that they can be returned
+ * on the locking chain.
+ *
+ * @category Transaction Models
+ */
+export interface XChainCommit extends BaseTransaction {
+  TransactionType: 'XChainCommit'
+
+  /**
+   * The bridge to use to transfer funds.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The unique integer ID for a cross-chain transfer. This must be acquired on
+   * the destination chain (via a {@link XChainCreateClaimID} transaction) and
+   * checked from a validated ledger before submitting this transaction. If an
+   * incorrect sequence number is specified, the funds will be lost.
+   */
+  XChainClaimID: number | string
+
+  /**
+   * The destination account on the destination chain. If this is not specified,
+   * the account that submitted the {@link XChainCreateClaimID} transaction on the
+   * destination chain will need to submit a {@link XChainClaim} transaction to
+   * claim the funds.
+   */
+  OtherChainDestination?: Account
+
+  /**
+   * The asset to commit, and the quantity. This must match the door account's
+   * LockingChainIssue (if on the locking chain) or the door account's
+   * IssuingChainIssue (if on the issuing chain).
+   */
+  Amount: Amount
+}
+
+/**
+ * Verify the form and type of an XChainCommit at runtime.
+ *
+ * @param tx - An XChainCommit Transaction.
+ * @throws When the XChainCommit is malformed.
+ */
+export function validateXChainCommit(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateOptionalField(tx, 'OtherChainDestination', isAccount)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+}

package/src/models/transactions/XChainCreateBridge.ts

@@ -0,0 +1,56 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainCreateBridge transaction creates a new {@link Bridge} ledger object
+ * and defines a new cross-chain bridge entrance on the chain that the transaction
+ * is submitted on. It includes information about door accounts and assets for the
+ * bridge.
+ *
+ * @category Transaction Models
+ */
+export interface XChainCreateBridge extends BaseTransaction {
+  TransactionType: 'XChainCreateBridge'
+
+  /**
+   * The bridge (door accounts and assets) to create.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The total amount to pay the witness servers for their signatures. This amount
+   * will be split among the signers.
+   */
+  SignatureReward: Amount
+
+  /**
+   * The minimum amount, in XRP, required for a {@link XChainAccountCreateCommit}
+   * transaction. If this isn't present, the {@link XChainAccountCreateCommit}
+   * transaction will fail. This field can only be present on XRP-XRP bridges.
+   */
+  MinAccountCreateAmount?: Amount
+}
+
+/**
+ * Verify the form and type of an XChainCreateBridge at runtime.
+ *
+ * @param tx - An XChainCreateBridge Transaction.
+ * @throws When the XChainCreateBridge is malformed.
+ */
+export function validateXChainCreateBridge(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateOptionalField(tx, 'MinAccountCreateAmount', isAmount)
+}