xahau.js/packages/xrpl/src/models/transactions/uriTokenCancelSellOffer.ts

import { ValidationError } from '../../errors'

import { BaseTransaction, validateBaseTransaction } from './common'

/**
 * Map of flags to boolean values representing {@link URITokenCancelSellOffer} transaction
 * flags.
 *
 * @category Transaction Flags
 *
 * @example
 * ```typescript
 * const tx: URITokenCancelSellOffer = {
 * Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
 * URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
 * TransactionType: 'URITokenCancelSellOffer',
 * }
 *
 * // Autofill the tx to see how flags actually look compared to the interface usage.
 * const autofilledTx = await client.autofill(tx)
 * console.log(autofilledTx)
 * // {
 * // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
 * // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
 * // TransactionType: 'URITokenCancelSellOffer',
 * // Sequence: 21970384,
 * // Fee: '12',
 * // LastLedgerSequence: 21970404
 * // }
 * ```
 */

/**
 * An URITokenCancelSellOffer transaction is effectively a limit order . It defines an
 * intent to exchange currencies, and creates an Offer object if not completely.
 * Fulfilled when placed. Offers can be partially fulfilled.
 *
 * @category Transaction Models
 */
export interface URITokenCancelSellOffer extends BaseTransaction {
  TransactionType: 'URITokenCancelSellOffer'
  /**
   * Identifies the URITokenID of the NFToken object that the
   * offer references.
   */
  URITokenID: string
}

/**
 * Verify the form and type of an URITokenCancelSellOffer at runtime.
 *
 * @param tx - An URITokenCancelSellOffer Transaction.
 * @throws When the URITokenCancelSellOffer is Malformed.
 */
export function validateURITokenCancelSellOffer(
  tx: Record<string, unknown>,
): void {
  validateBaseTransaction(tx)

  if (tx.URITokenID == null) {
    throw new ValidationError(
      'URITokenCancelSellOffer: missing field URITokenID',
    )
  }
}