xrpl 2.10.0 → 2.11.0

package/src/models/ledger/AccountRoot.ts

@@ -0,0 +1,217 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The AccountRoot object type describes a single account, its settings, and
+ * XRP balance.
+ *
+ * @category Ledger Entries
+ */
+export default interface AccountRoot extends BaseLedgerEntry {
+  LedgerEntryType: 'AccountRoot'
+  /** The identifying (classic) address of this account. */
+  Account: string
+  /** The account's current XRP balance in drops, represented as a string. */
+  Balance: string
+  /** A bit-map of boolean flags enabled for this account. */
+  Flags: number
+  /**
+   * The number of objects this account owns in the ledger, which contributes
+   * to its owner reserve.
+   */
+  OwnerCount: number
+  /**
+   * The identifying hash of the transaction that most recently modified this
+   * object.
+   */
+  PreviousTxnID: string
+  /**
+   * The index of the ledger that contains the transaction that most recently
+   * modified this object.
+   */
+  PreviousTxnLgrSeq: number
+  /** The sequence number of the next valid transaction for this account. */
+  Sequence: number
+  /**
+   * The identifying hash of the transaction most recently sent by this
+   * account. This field must be enabled to use the AccountTxnID transaction
+   * field. To enable it, send an AccountSet transaction with the.
+   * `asfAccountTxnID` flag enabled.
+   */
+  AccountTxnID?: string
+  /**
+   * A domain associated with this account. In JSON, this is the hexadecimal
+   * for the ASCII representation of the domain.
+   */
+  Domain?: string
+  /** The md5 hash of an email address. */
+  EmailHash?: string
+  /**
+   * A public key that may be used to send encrypted messages to this account
+   * in JSON, uses hexadecimal.
+   */
+  MessageKey?: string
+  /**
+   * The address of a key pair that can be used to sign transactions for this
+   * account instead of the master key. Use a SetRegularKey transaction to
+   * change this value.
+   */
+  RegularKey?: string
+  /**
+   * How many Tickets this account owns in the ledger. This is updated
+   * automatically to ensure that the account stays within the hard limit of 250.
+   * Tickets at a time.
+   */
+  TicketCount?: number
+  /**
+   * How many significant digits to use for exchange rates of Offers involving
+   * currencies issued by this address. Valid values are 3 to 15, inclusive.
+   */
+  TickSize?: number
+  /**
+   * A transfer fee to charge other users for sending currency issued by this
+   * account to each other.
+   */
+  TransferRate?: number
+  /** An arbitrary 256-bit value that users can set. */
+  WalletLocator?: string
+  /** Total NFTokens this account's issued that have been burned. This number is always equal or less than MintedNFTokens. */
+  BurnedNFTokens?: number
+  /** The sequence that the account first minted an NFToken */
+  FirstNFTSequence: number
+  /** Total NFTokens have been minted by and on behalf of this account. */
+  MintedNFTokens?: number
+  /** Another account that can mint NFTokens on behalf of this account. */
+  NFTokenMinter?: string
+}
+
+/**
+ * A boolean map of AccountRootFlags for simplified code checking AccountRoot settings.
+ * For submitting settings flags to the ledger, use AccountRootFlags instead.
+ */
+export interface AccountRootFlagsInterface {
+  /**
+   * The account has used its free SetRegularKey transaction.
+   */
+  lsfPasswordSpent?: boolean
+  /**
+   * Requires incoming payments to specify a Destination Tag.
+   */
+  lsfRequireDestTag?: boolean
+  /**
+   * This account must individually approve other users for those users to hold this account's issued currencies.
+   */
+  lsfRequireAuth?: boolean
+  /**
+   * Client applications should not send XRP to this account. Not enforced by rippled.
+   */
+  lsfDisallowXRP?: boolean
+  /**
+   * Disallows use of the master key to sign transactions for this account.
+   */
+  lsfDisableMaster?: boolean
+  /**
+   * This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.
+   */
+  lsfNoFreeze?: boolean
+  /**
+   * All assets issued by this address are frozen.
+   */
+  lsfGlobalFreeze?: boolean
+  /**
+   * Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.
+   */
+  lsfDefaultRipple?: boolean
+  /**
+   * This account can only receive funds from transactions it sends, and from preauthorized accounts.
+   * (It has DepositAuth enabled.)
+   */
+  lsfDepositAuth?: boolean
+  /**
+   * This account is an Automated Market Maker (AMM) instance.
+   */
+  lsfAMM?: boolean
+  /**
+   * Disallow incoming NFTOffers from other accounts.
+   */
+  lsfDisallowIncomingNFTokenOffer?: boolean
+  /**
+   * Disallow incoming Checks from other accounts.
+   */
+  lsfDisallowIncomingCheck?: boolean
+  /**
+   * Disallow incoming PayChannels from other accounts.
+   */
+  lsfDisallowIncomingPayChan?: boolean
+  /**
+   * Disallow incoming Trustlines from other accounts.
+   */
+  lsfDisallowIncomingTrustline?: boolean
+  /**
+   * This address can claw back issued IOUs. Once enabled, cannot be disabled.
+   */
+  lsfAllowTrustLineClawback?: boolean
+}
+
+export enum AccountRootFlags {
+  /**
+   * The account has used its free SetRegularKey transaction.
+   */
+  lsfPasswordSpent = 0x00010000,
+  /**
+   * Requires incoming payments to specify a Destination Tag.
+   */
+  lsfRequireDestTag = 0x00020000,
+  /**
+   * This account must individually approve other users for those users to hold this account's issued currencies.
+   */
+  lsfRequireAuth = 0x00040000,
+  /**
+   * Client applications should not send XRP to this account. Not enforced by rippled.
+   */
+  lsfDisallowXRP = 0x00080000,
+  /**
+   * Disallows use of the master key to sign transactions for this account.
+   */
+  lsfDisableMaster = 0x00100000,
+  /**
+   * This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.
+   */
+  lsfNoFreeze = 0x00200000,
+  /**
+   * All assets issued by this address are frozen.
+   */
+  lsfGlobalFreeze = 0x00400000,
+  /**
+   * Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.
+   */
+  lsfDefaultRipple = 0x00800000,
+  /**
+   * This account can only receive funds from transactions it sends, and from preauthorized accounts.
+   * (It has DepositAuth enabled.)
+   */
+  lsfDepositAuth = 0x01000000,
+  /**
+   * This account is an Automated Market Maker (AMM) instance.
+   */
+  lsfAMM = 0x02000000,
+  /**
+   * Disallow incoming NFTOffers from other accounts.
+   */
+  lsfDisallowIncomingNFTokenOffer = 0x04000000,
+  /**
+   * Disallow incoming Checks from other accounts.
+   */
+  lsfDisallowIncomingCheck = 0x08000000,
+  /**
+   * Disallow incoming PayChannels from other accounts.
+   */
+  lsfDisallowIncomingPayChan = 0x10000000,
+  /**
+   * Disallow incoming Trustlines from other accounts.
+   */
+  lsfDisallowIncomingTrustline = 0x20000000,
+  /**
+   * This address can claw back issued IOUs. Once enabled, cannot be disabled.
+   */
+  lsfAllowTrustLineClawback = 0x80000000,
+}

package/src/models/ledger/Amendments.ts

@@ -0,0 +1,45 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The unique id for the Amendments object https://xrpl.org/amendments-object.html#amendments-id-format
+ */
+export const AMENDMENTS_ID =
+  '7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4'
+
+export interface Majority {
+  Majority: {
+    /** The Amendment ID of the pending amendment. */
+    Amendment: string
+    /**
+     * The `close_time` field of the ledger version where this amendment most
+     * recently gained a majority.
+     */
+    CloseTime: number
+  }
+}
+
+/**
+ * The Amendments object type contains a list of Amendments that are currently
+ * active.
+ *
+ * @category Ledger Entries
+ */
+export default interface Amendments extends BaseLedgerEntry {
+  LedgerEntryType: 'Amendments'
+  /**
+   * Array of 256-bit amendment IDs for all currently-enabled amendments. If
+   * omitted, there are no enabled amendments.
+   */
+  Amendments?: string[]
+  /**
+   * Array of objects describing the status of amendments that have majority
+   * support but are not yet enabled. If omitted, there are no pending
+   * amendments with majority support.
+   */
+  Majorities?: Majority[]
+  /**
+   * A bit-map of boolean flags. No flags are defined for the Amendments object
+   * type, so this value is always 0.
+   */
+  Flags: 0
+}

package/src/models/ledger/BaseLedgerEntry.ts

@@ -0,0 +1,3 @@
+export default interface BaseLedgerEntry {
+  index: string
+}

package/src/models/ledger/Check.ts

@@ -0,0 +1,70 @@
+import { Amount } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * A Check object describes a check, similar to a paper personal check, which
+ * can be cashed by its destination to get money from its sender.
+ *
+ * @category Ledger Entries
+ */
+export default interface Check extends BaseLedgerEntry {
+  LedgerEntryType: 'Check'
+  /** The sender of the Check. Cashing the Check debits this address's balance. */
+  Account: string
+  /**
+   * The intended recipient of the Check. Only this address can cash the Check,
+   * using a CheckCash transaction.
+   */
+  Destination: string
+  /**
+   * A bit-map of boolean flags. No flags are defined for Checks, 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 identifying hash of the transaction that most recently modified this
+   * object.
+   */
+  PreviousTxnID: string
+  /**
+   * The index of the ledger that contains the transaction that most recently
+   * modified this object.
+   */
+  PreviousTxnLgrSeq: number
+  /**
+   * The maximum amount of currency this Check can debit the sender. If the
+   * Check is successfully cashed, the destination is credited in the same
+   * currency for up to this amount.
+   */
+  SendMax: Amount
+  /** The sequence number of the CheckCreate transaction that created this check. */
+  Sequence: number
+  /**
+   * A hint indicating which page of the destination's owner directory links to
+   * this object, in case the directory consists of multiple pages.
+   */
+  DestinationNode?: string
+  /**
+   * An arbitrary tag to further specify the destination for this Check, such
+   * as a hosted recipient at the destination address.
+   */
+  DestinationTag?: number
+  /** Indicates the time after which this Check is considered expired. */
+  Expiration?: number
+  /**
+   * Arbitrary 256-bit hash provided by the sender as a specific reason or
+   * identifier for this Check.
+   */
+  InvoiceID?: string
+  /**
+   * An arbitrary tag to further specify the source for this Check, such as a
+   * hosted recipient at the sender's address.
+   */
+  SourceTag?: number
+}

package/src/models/ledger/DepositPreauth.ts

@@ -0,0 +1,35 @@
+import BaseLedgerEntry 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 {
+  LedgerEntryType: 'DepositPreauth'
+  /** The account that granted the preauthorization. */
+  Account: string
+  /** The account that received the preauthorization. */
+  Authorize: 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 identifying hash of the transaction that most recently modified this
+   * object.
+   */
+  PreviousTxnID: string
+  /**
+   * The index of the ledger that contains the transaction that most recently
+   * modified this object.
+   */
+  PreviousTxnLgrSeq: number
+}

package/src/models/ledger/DirectoryNode.ts

@@ -0,0 +1,46 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The DirectoryNode object type provides a list of links to other objects in
+ * the ledger's state tree.
+ *
+ * @category Ledger Entries
+ */
+export default interface DirectoryNode extends BaseLedgerEntry {
+  LedgerEntryType: 'DirectoryNode'
+  /**
+   * A bit-map of boolean flags enabled for this directory. Currently, the
+   * protocol defines no flags for DirectoryNode objects.
+   */
+  Flags: number
+  /** The ID of root object for this directory. */
+  RootIndex: string
+  /** The contents of this Directory: an array of IDs of other objects. */
+  Indexes: string[]
+  /**
+   * If this Directory consists of multiple pages, this ID links to the next
+   * object in the chain, wrapping around at the end.
+   */
+  IndexNext?: number
+  /**
+   * If this Directory consists of multiple pages, this ID links to the
+   * previous object in the chain, wrapping around at the beginning.
+   */
+  IndexPrevious?: number
+  /** The address of the account that owns the objects in this directory. */
+  Owner?: string
+  /**
+   * The currency code of the TakerPays amount from the offers in this
+   * directory.
+   */
+  TakerPaysCurrency?: string
+  /** The issuer of the TakerPays amount from the offers in this directory. */
+  TakerPaysIssuer?: string
+  /**
+   * The currency code of the TakerGets amount from the offers in this
+   * directory.
+   */
+  TakerGetsCurrency?: string
+  /** The issuer of the TakerGets amount from the offers in this directory. */
+  TakerGetsIssuer?: string
+}

package/src/models/ledger/Escrow.ts

@@ -0,0 +1,74 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The Escrow object type represents a held payment of XRP waiting to be
+ * executed or canceled.
+ *
+ * @category Ledger Entries
+ */
+export default interface Escrow extends BaseLedgerEntry {
+  LedgerEntryType: 'Escrow'
+  /**
+   * The address of the owner (sender) of this held payment. This is the
+   * account that provided the XRP, and gets it back if the held payment is
+   * canceled.
+   */
+  Account: string
+  /**
+   * The destination address where the XRP is paid if the held payment is
+   * successful.
+   */
+  Destination: string
+  /** The amount of XRP, in drops, to be delivered by the held payment. */
+  Amount: string
+  /**
+   * A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
+   * EscrowFinish transaction must contain a fulfillment that satisfies this
+   * condition.
+   */
+  Condition?: string
+  /**
+   * The time after which this Escrow is considered expired.
+   */
+  CancelAfter?: number
+  /**
+   * The time, in seconds, since the Ripple Epoch, after which this held payment
+   * can be finished. Any EscrowFinish transaction before this time fails.
+   */
+  FinishAfter?: number
+  /**
+   * A bit-map of boolean flags. No flags are defined for the Escrow type, so
+   * this value is always 0.
+   */
+  Flags: number
+  /**
+   * An arbitrary tag to further specify the source for this held payment, such
+   * as a hosted recipient at the owner's address.
+   */
+  SourceTag?: number
+  /**
+   * An arbitrary tag to further specify the destination for this held payment,
+   * such as a hosted recipient at the destination address.
+   */
+  DestinationTag?: number
+  /**
+   * A hint indicating which page of the owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+  /**
+   * A hint indicating which page of the destination's owner directory links to
+   * this object, in case the directory consists of multiple pages.
+   */
+  DestinationNode?: string
+  /**
+   * The identifying hash of the transaction that most recently modified this
+   * object.
+   */
+  PreviousTxnID: string
+  /**
+   * The index of the ledger that contains the transaction that most recently
+   * modified this object.
+   */
+  PreviousTxnLgrSeq: number
+}

package/src/models/ledger/FeeSettings.ts

@@ -0,0 +1,52 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The unique id for the FeeSettings object https://xrpl.org/feesettings.html#feesettings-id-format
+ */
+export const FEE_SETTINGS_ID =
+  '4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651'
+
+export interface FeeSettingsPreAmendmentFields {
+  /** The transaction cost of the "reference transaction" in drops of XRP as hexadecimal. */
+  BaseFee: string
+  /** The BaseFee translated into "fee units". */
+  ReferenceFeeUnits: number
+  /** The base reserve for an account in the XRP Ledger, as drops of XRP. */
+  ReserveBase: number
+  /** The incremental owner reserve for owning objects, as drops of XRP. */
+  ReserveIncrement: number
+}
+
+export interface FeeSettingsPostAmendmentFields {
+  /** The transaction cost of the "reference transaction" in drops of XRP as hexadecimal. */
+  BaseFeeDrops: string
+  /** The base reserve for an account in the XRP Ledger, as drops of XRP. */
+  ReserveBaseDrops: string
+  /** The incremental owner reserve for owning objects, as drops of XRP. */
+  ReserveIncrementDrops: string
+}
+
+export interface FeeSettingsBase extends BaseLedgerEntry {
+  LedgerEntryType: 'FeeSettings'
+  /**
+   * A bit-map of boolean flags for this object. No flags are defined for this type.
+   */
+  Flags: 0
+}
+
+/**
+ * The FeeSettings object type contains the current base transaction cost and
+ * reserve amounts as determined by fee voting.
+ *
+ * The fields will be based on the status of the `XRPFees` amendment.
+ * - Before: {@link FeeSettingsPreAmendmentFields}
+ * - After: {@link FeeSettingsPostAmendmentFields}
+ *
+ * @interface
+ *
+ * @category Ledger Entries
+ */
+type FeeSettings = FeeSettingsBase &
+  (FeeSettingsPreAmendmentFields | FeeSettingsPostAmendmentFields)
+
+export default FeeSettings

package/src/models/ledger/Ledger.ts

@@ -0,0 +1,65 @@
+import { Transaction, TransactionMetadata } from '../transactions'
+
+import LedgerEntry from './LedgerEntry'
+
+/**
+ * A ledger is a block of transactions and shared state data. It has a unique
+ * header that describes its contents using cryptographic hashes.
+ *
+ * @category Ledger Entries
+ */
+export default interface Ledger {
+  /** The SHA-512Half of this ledger's state tree information. */
+  account_hash: string
+  /** All the state information in this ledger. */
+  accountState?: LedgerEntry[]
+  /** A bit-map of flags relating to the closing of this ledger. */
+  close_flags: number
+  /**
+   * The approximate time this ledger version closed, as the number of seconds
+   * since the Ripple Epoch of 2000-01-01 00:00:00. This value is rounded based
+   * on the close_time_resolution.
+   */
+  close_time: number
+  /**
+   * The approximate time this ledger was closed, in human-readable format.
+   * Always uses the UTC time zone.
+   */
+  close_time_human: string
+  /**
+   * An integer in the range [2,120] indicating the maximum number of seconds
+   * by which the close_time could be rounded.
+   */
+  close_time_resolution: number
+  /** Whether or not this ledger has been closed. */
+  closed: boolean
+  /**
+   * The SHA-512Half of this ledger version. This serves as a unique identifier
+   * for this ledger and all its contents.
+   */
+  ledger_hash: string
+  /**
+   * The ledger index of the ledger. Some API methods display this as a quoted
+   * integer; some display it as a native JSON number.
+   */
+  ledger_index: string
+  /** The approximate time at which the previous ledger was closed. */
+  parent_close_time: number
+  /**
+   * Unique identifying hash of the ledger that came immediately before this
+   * one.
+   */
+  parent_hash: string
+  /** Total number of XRP drops in the network, as a quoted integer. */
+  total_coins: string
+  /** Hash of the transaction information included in this ledger, as hex. */
+  transaction_hash: string
+  /**
+   * Transactions applied in this ledger version. By default, members are the
+   * transactions' identifying Hash strings. If the request specified expand as
+   * true, members are full representations of the transactions instead, in
+   * either JSON or binary depending on whether the request specified binary
+   * as true.
+   */
+  transactions?: Array<Transaction & { metaData?: TransactionMetadata }>
+}

package/src/models/ledger/LedgerEntry.ts

@@ -0,0 +1,34 @@
+import AccountRoot from './AccountRoot'
+import Amendments from './Amendments'
+import AMM from './AMM'
+import Check from './Check'
+import DepositPreauth from './DepositPreauth'
+import DirectoryNode from './DirectoryNode'
+import Escrow from './Escrow'
+import FeeSettings from './FeeSettings'
+import LedgerHashes from './LedgerHashes'
+import NegativeUNL from './NegativeUNL'
+import Offer from './Offer'
+import PayChannel from './PayChannel'
+import RippleState from './RippleState'
+import SignerList from './SignerList'
+import Ticket from './Ticket'
+
+type LedgerEntry =
+  | AccountRoot
+  | Amendments
+  | AMM
+  | Check
+  | DepositPreauth
+  | DirectoryNode
+  | Escrow
+  | FeeSettings
+  | LedgerHashes
+  | NegativeUNL
+  | Offer
+  | PayChannel
+  | RippleState
+  | SignerList
+  | Ticket
+
+export default LedgerEntry

package/src/models/ledger/LedgerHashes.ts

@@ -0,0 +1,24 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The LedgerHashes objects exist to make it possible to look up a previous
+ * ledger's hash with only the current ledger version and at most one lookup of
+ * a previous ledger version.
+ *
+ * @category Ledger Entries
+ */
+export default interface LedgerHashes extends BaseLedgerEntry {
+  LedgerEntryType: 'LedgerHashes'
+  /** The Ledger Index of the last entry in this object's Hashes array. */
+  LastLedgerSequence?: number
+  /**
+   * An array of up to 256 ledger hashes. The contents depend on which sub-type
+   * of LedgerHashes object this is.
+   */
+  Hashes: string[]
+  /**
+   * A bit-map of boolean flags for this object. No flags are defined for this
+   * type.
+   */
+  Flags: number
+}

package/src/models/ledger/NFTokenOffer.ts

@@ -0,0 +1,16 @@
+import { Amount } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+export interface NFTokenOffer extends BaseLedgerEntry {
+  LedgerEntryType: 'NFTokenOffer'
+  Amount: Amount
+  Destination?: string
+  Expiration: number
+  Flags: number
+  NFTokenOfferNode?: string
+  Owner: string
+  OwnerNode?: string
+  PreviousTxnID: string
+  PreviousTxnLgrSeq: number
+}