xrpl 1.0.0-mpt-beta

package/src/models/ledger/AccountRoot.ts

@@ -0,0 +1,213 @@
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The AccountRoot object type describes a single account, its settings, and
+ * XRP balance.
+ *
+ * @category Ledger Entries
+ */
+export default interface AccountRoot extends BaseLedgerEntry, HasPreviousTxnID {
+  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 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
+  /**
+   * The ledger entry ID of the corresponding AMM ledger entry.
+   * Set during account creation; cannot be modified.
+   * If present, indicates that this is a special AMM AccountRoot; always omitted on non-AMM accounts.
+   */
+  AMMID?: 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,47 @@
+import { BaseLedgerEntry, MissingPreviousTxnID } 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,
+    MissingPreviousTxnID {
+  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,27 @@
+export interface BaseLedgerEntry {
+  index: string
+}
+
+export interface HasPreviousTxnID {
+  /**
+   * 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
+}
+
+export interface MissingPreviousTxnID {
+  /**
+   * This field is missing on this object but is present on most other returned objects.
+   */
+  PreviousTxnID: never
+  /**
+   * This field is missing on this object but is present on most other returned objects.
+   */
+  PreviousTxnLgrSeq: never
+}

package/src/models/ledger/Bridge.ts

@@ -0,0 +1,72 @@
+import { Amount, XChainBridge } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * A Bridge objects represents a cross-chain bridge and includes information about
+ * the door accounts, assets, signature rewards, and the minimum account create
+ * amount.
+ *
+ * @category Ledger Entries
+ */
+export default interface Bridge extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Bridge'
+
+  /** The door account that owns the bridge. */
+  Account: string
+
+  /**
+   * The total amount, in XRP, to be rewarded for providing a signature for
+   * cross-chain transfer or for signing for the cross-chain reward. This amount
+   * will be split among the signers.
+   */
+  SignatureReward: Amount
+
+  /**
+   * The door accounts and assets of the bridge this object correlates to.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The value of the next XChainClaimID to be created.
+   */
+  XChainClaimID: string
+
+  /**
+   * A counter used to order the execution of account create transactions. It is
+   * incremented every time a successful {@link XChainAccountCreateCommit}
+   * transaction is run for the source chain.
+   */
+  XChainAccountCreateCount: string
+
+  /**
+   * A counter used to order the execution of account create transactions. It is
+   * incremented every time a {@link XChainAccountCreateCommit} transaction is
+   * "claimed" on the destination chain. When the "claim" transaction is run on
+   * the destination chain, the XChainAccountClaimCount must match the value that
+   * the XChainAccountCreateCount had at the time the XChainAccountClaimCount was
+   * run on the source chain. This orders the claims so that they run in the same
+   * order that the XChainAccountCreateCommit transactions ran on the source chain,
+   * to prevent transaction replay.
+   */
+  XChainAccountClaimCount: string
+
+  /**
+   * The minimum amount, in XRP, required for an {@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?: string
+
+  /**
+   * A bit-map of boolean flags. No flags are defined for Bridges, 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
+}

package/src/models/ledger/Check.ts

@@ -0,0 +1,70 @@
+import { Amount } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } 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, HasPreviousTxnID {
+  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/DID.ts

@@ -0,0 +1,22 @@
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+// TODO: add docs
+
+/**
+ * @category Ledger Entries
+ */
+export default interface DID extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'DID'
+
+  Account: string
+
+  Data: string
+
+  DIDDocument: string
+
+  URI: string
+
+  Flags: 0
+
+  OwnerNode: string
+}

package/src/models/ledger/DepositPreauth.ts

@@ -0,0 +1,27 @@
+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
+  /** 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
+}

package/src/models/ledger/DirectoryNode.ts

@@ -0,0 +1,48 @@
+import { BaseLedgerEntry, MissingPreviousTxnID } 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,
+    MissingPreviousTxnID {
+  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,64 @@
+import { BaseLedgerEntry, HasPreviousTxnID } 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, HasPreviousTxnID {
+  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
+}

package/src/models/ledger/FeeSettings.ts

@@ -0,0 +1,52 @@
+import { BaseLedgerEntry, MissingPreviousTxnID } 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, MissingPreviousTxnID {
+  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