xrpl/src/models/ledger/DepositPreauth.ts

A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser

import { AuthorizeCredential } from '../common'

import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'

/**
 * A DepositPreauth object tracks a preauthorization from one account to
 * another. DepositPreauth transactions create these objects.
 *
 * @category Ledger Entries
 */
export default interface DepositPreauth
  extends BaseLedgerEntry,
    HasPreviousTxnID {
  LedgerEntryType: 'DepositPreauth'
  /** The account that granted the preauthorization. */
  Account: string
  /**
   * A bit-map of boolean flags. No flags are defined for DepositPreauth
   * objects, so this value is always 0.
   */
  Flags: 0
  /**
   * A hint indicating which page of the sender's owner directory links to this
   * object, in case the directory consists of multiple pages.
   */
  OwnerNode: string
  /** The account that received the preauthorization. */
  Authorize?: string
  /** The credential(s) that received the preauthorization. */
  AuthorizeCredentials?: AuthorizeCredential[]
}