xrpl 2.12.0 → 2.14.0

package/src/models/ledger/Bridge.ts

@@ -1,6 +1,6 @@
 import { Amount, XChainBridge } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * A Bridge objects represents a cross-chain bridge and includes information about
@@ -9,7 +9,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Bridge extends BaseLedgerEntry {
+export default interface Bridge extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Bridge'
 
   /** The door account that owns the bridge. */
@@ -22,13 +22,6 @@ export default interface Bridge extends BaseLedgerEntry {
    */
   SignatureReward: Amount
 
-  /**
-   * 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
-
   /**
    * The door accounts and assets of the bridge this object correlates to.
    */
@@ -58,6 +51,13 @@ export default interface Bridge extends BaseLedgerEntry {
    */
   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.
@@ -69,16 +69,4 @@ export default interface Bridge extends BaseLedgerEntry {
    * 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/Check.ts

@@ -1,6 +1,6 @@
 import { Amount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * A Check object describes a check, similar to a paper personal check, which
@@ -8,7 +8,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Check extends BaseLedgerEntry {
+export default interface Check extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Check'
   /** The sender of the Check. Cashing the Check debits this address's balance. */
   Account: string

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

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * A DepositPreauth object tracks a preauthorization from one account to
@@ -6,7 +6,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface DepositPreauth extends BaseLedgerEntry {
+export default interface DepositPreauth
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
   LedgerEntryType: 'DepositPreauth'
   /** The account that granted the preauthorization. */
   Account: string
@@ -22,14 +24,4 @@ export default interface DepositPreauth extends BaseLedgerEntry {
    * 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

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The DirectoryNode object type provides a list of links to other objects in
@@ -6,7 +6,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface DirectoryNode extends BaseLedgerEntry {
+export default interface DirectoryNode
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'DirectoryNode'
   /**
    * A bit-map of boolean flags enabled for this directory. Currently, the

package/src/models/ledger/Escrow.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The Escrow object type represents a held payment of XRP waiting to be
@@ -6,7 +6,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Escrow extends BaseLedgerEntry {
+export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Escrow'
   /**
    * The address of the owner (sender) of this held payment. This is the
@@ -61,14 +61,4 @@ export default interface Escrow extends BaseLedgerEntry {
    * 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

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The unique id for the FeeSettings object https://xrpl.org/feesettings.html#feesettings-id-format
@@ -26,7 +26,7 @@ export interface FeeSettingsPostAmendmentFields {
   ReserveIncrementDrops: string
 }
 
-export interface FeeSettingsBase extends BaseLedgerEntry {
+export interface FeeSettingsBase extends BaseLedgerEntry, MissingPreviousTxnID {
   LedgerEntryType: 'FeeSettings'
   /**
    * A bit-map of boolean flags for this object. No flags are defined for this type.

package/src/models/ledger/Ledger.ts

@@ -1,6 +1,10 @@
-import { Transaction, TransactionMetadata } from '../transactions'
+import {
+  PseudoTransaction,
+  Transaction,
+  TransactionMetadata,
+} from '../transactions'
 
-import LedgerEntry from './LedgerEntry'
+import { LedgerEntry } from './LedgerEntry'
 
 /**
  * A ledger is a block of transactions and shared state data. It has a unique
@@ -61,5 +65,7 @@ export default interface Ledger {
    * either JSON or binary depending on whether the request specified binary
    * as true.
    */
-  transactions?: Array<Transaction & { metaData?: TransactionMetadata }>
+  transactions?: Array<
+    (Transaction | PseudoTransaction) & { metaData?: TransactionMetadata }
+  >
 }

package/src/models/ledger/LedgerEntry.ts

@@ -37,4 +37,26 @@ type LedgerEntry =
   | XChainOwnedClaimID
   | XChainOwnedCreateAccountClaimID
 
-export default LedgerEntry
+type LedgerEntryFilter =
+  | 'account'
+  | 'amendments'
+  | 'amm'
+  | 'bridge'
+  | 'check'
+  | 'deposit_preauth'
+  | 'did'
+  | 'directory'
+  | 'escrow'
+  | 'fee'
+  | 'hashes'
+  | 'nft_offer'
+  | 'nft_page'
+  | 'offer'
+  | 'payment_channel'
+  | 'signer_list'
+  | 'state'
+  | 'ticket'
+  | 'xchain_owned_create_account_claim_id'
+  | 'xchain_owned_claim_id'
+
+export { LedgerEntry, LedgerEntryFilter }

package/src/models/ledger/LedgerHashes.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The LedgerHashes objects exist to make it possible to look up a previous
@@ -7,7 +7,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface LedgerHashes extends BaseLedgerEntry {
+export default interface LedgerHashes
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'LedgerHashes'
   /** The Ledger Index of the last entry in this object's Hashes array. */
   LastLedgerSequence?: number

package/src/models/ledger/NFTokenOffer.ts

@@ -1,8 +1,8 @@
 import { Amount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
-export interface NFTokenOffer extends BaseLedgerEntry {
+export interface NFTokenOffer extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'NFTokenOffer'
   Amount: Amount
   Destination?: string
@@ -11,6 +11,4 @@ export interface NFTokenOffer extends BaseLedgerEntry {
   NFTokenOfferNode?: string
   Owner: string
   OwnerNode?: string
-  PreviousTxnID: string
-  PreviousTxnLgrSeq: number
 }

package/src/models/ledger/NFTokenPage.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 export interface NFToken {
   NFToken: {
@@ -10,11 +10,9 @@ export interface NFToken {
   }
 }
 
-export interface NFTokenPage extends BaseLedgerEntry {
+export interface NFTokenPage extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'NFTokenPage'
   NextPageMin?: string
   NFTokens: NFToken[]
   PreviousPageMin?: string
-  PreviousTxnID?: string
-  PreviousTxnLgrSeq?: number
 }

package/src/models/ledger/NegativeUNL.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The unique id for the nUNL object https://xrpl.org/negativeunl.html#negativeunl-id-format
@@ -12,7 +12,9 @@ export const NEGATIVE_UNL_ID =
  *
  * @category Ledger Entries
  */
-export default interface NegativeUNL extends BaseLedgerEntry {
+export default interface NegativeUNL
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'NegativeUNL'
   /**
    * A list of trusted validators that are currently disabled.

package/src/models/ledger/Offer.ts

@@ -1,8 +1,8 @@
 import { Amount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
-export default interface Offer extends BaseLedgerEntry {
+export default interface Offer extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Offer'
   /** A bit-map of boolean flags enabled for this Offer. */
   Flags: number
@@ -32,16 +32,6 @@ export default interface Offer extends BaseLedgerEntry {
    * 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 time this Offer expires, in seconds since the Ripple Epoch. */
   Expiration?: number
 }

package/src/models/ledger/PayChannel.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The PayChannel object type represents a payment channel. Payment channels
@@ -9,7 +9,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface PayChannel extends BaseLedgerEntry {
+export default interface PayChannel extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'PayChannel'
   /**
    * The source address that owns this payment channel. This comes from the
@@ -60,16 +60,6 @@ export default interface PayChannel extends BaseLedgerEntry {
    * 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
   /**
    * A bit-map of boolean flags enabled for this payment channel. Currently,
    * the protocol defines no flags for PayChannel objects.

package/src/models/ledger/RippleState.ts

@@ -1,13 +1,13 @@
 import { IssuedCurrencyAmount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The RippleState object type connects two accounts in a single currency.
  *
  * @category Ledger Entries
  */
-export default interface RippleState extends BaseLedgerEntry {
+export default interface RippleState extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'RippleState'
   /** A bit-map of boolean options enabled for this object. */
   Flags: number
@@ -27,16 +27,6 @@ export default interface RippleState extends BaseLedgerEntry {
    * the address of the high account that set this limit.
    */
   HighLimit: IssuedCurrencyAmount
-  /**
-   * 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
   /**
    * A hint indicating which page of the low account's owner directory links to
    * this object, in case the directory consists of multiple pages.

package/src/models/ledger/SignerList.ts

@@ -1,6 +1,6 @@
 import { SignerEntry } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The SignerList object type represents a list of parties that, as a group,
@@ -10,23 +10,13 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface SignerList extends BaseLedgerEntry {
+export default interface SignerList extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'SignerList'
   /**
    * A bit-map of Boolean flags enabled for this signer list. For more
    * information, see SignerList Flags.
    */
   Flags: 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
   /**
    * A hint indicating which page of the owner directory links to this object,
    * in case the directory consists of multiple pages.

package/src/models/ledger/Ticket.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The Ticket object type represents a Ticket, which tracks an account sequence
@@ -7,7 +7,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Ticket extends BaseLedgerEntry {
+export default interface Ticket extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Ticket'
   /** The account that owns this Ticket. */
   Account: string
@@ -21,16 +21,6 @@ export default interface Ticket extends BaseLedgerEntry {
    * 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 Sequence Number this Ticket sets aside. */
   TicketSequence: number
 }

package/src/models/ledger/XChainOwnedClaimID.ts

@@ -2,7 +2,7 @@ import { Amount } from 'ripple-binary-codec/dist/types'
 
 import { XChainBridge } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * An XChainOwnedClaimID object represents one cross-chain transfer of value
@@ -11,7 +11,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface XChainOwnedClaimID extends BaseLedgerEntry {
+export default interface XChainOwnedClaimID
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
   LedgerEntryType: 'XChainOwnedClaimID'
 
   /** The account that checked out this unique claim ID value. */
@@ -76,14 +78,4 @@ export default interface XChainOwnedClaimID extends BaseLedgerEntry {
    * 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/XChainOwnedCreateAccountClaimID.ts

@@ -1,6 +1,6 @@
 import { XChainBridge } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The XChainOwnedCreateAccountClaimID ledger object is used to collect attestations
@@ -9,7 +9,8 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  * @category Ledger Entries
  */
 export default interface XChainOwnedCreateAccountClaimID
-  extends BaseLedgerEntry {
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
   LedgerEntryType: 'XChainOwnedCreateAccountClaimID'
 
   /** The account that owns this object. */
@@ -61,14 +62,4 @@ export default interface XChainOwnedCreateAccountClaimID
    * 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/index.ts

@@ -7,6 +7,7 @@ import AMM, { VoteSlot } from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import DepositPreauth from './DepositPreauth'
+import DID from './DID'
 import DirectoryNode from './DirectoryNode'
 import Escrow from './Escrow'
 import FeeSettings, {
@@ -15,7 +16,7 @@ import FeeSettings, {
   FEE_SETTINGS_ID,
 } from './FeeSettings'
 import Ledger from './Ledger'
-import LedgerEntry from './LedgerEntry'
+import { LedgerEntry, LedgerEntryFilter } from './LedgerEntry'
 import LedgerHashes from './LedgerHashes'
 import NegativeUNL, { NEGATIVE_UNL_ID } from './NegativeUNL'
 import { NFTokenOffer } from './NFTokenOffer'
@@ -39,12 +40,14 @@ export {
   Check,
   DepositPreauth,
   DirectoryNode,
+  DID,
   Escrow,
   FEE_SETTINGS_ID,
   FeeSettings,
   FeeSettingsPreAmendmentFields,
   FeeSettingsPostAmendmentFields,
   Ledger,
+  LedgerEntryFilter,
   LedgerEntry,
   LedgerHashes,
   Majority,

package/src/models/methods/accountObjects.ts

@@ -1,35 +1,12 @@
-import {
-  AMM,
-  Bridge,
-  Check,
-  DepositPreauth,
-  Escrow,
-  Offer,
-  PayChannel,
-  RippleState,
-  SignerList,
-  Ticket,
-  XChainOwnedClaimID,
-  XChainOwnedCreateAccountClaimID,
-} from '../ledger'
+import { Amendments, FeeSettings, LedgerHashes } from '../ledger'
+import { LedgerEntry, LedgerEntryFilter } from '../ledger/LedgerEntry'
 
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
 
-export type AccountObjectType =
-  | 'amm'
-  | 'bridge'
-  | 'check'
-  | 'deposit_preauth'
-  | 'escrow'
-  | 'nft_offer'
-  | 'offer'
-  | 'payment_channel'
-  | 'signer_list'
-  | 'state'
-  | 'ticket'
-  | 'xchain_owned_create_account_claim_id'
-  | 'xchain_owned_claim_id'
-
+export type AccountObjectType = Exclude<
+  LedgerEntryFilter,
+  'amendments' | 'fee' | 'hashes'
+>
 /**
  * The account_objects command returns the raw ledger format for all objects
  * owned by an account. For a higher-level view of an account's trust lines and
@@ -46,8 +23,6 @@ export interface AccountObjectsRequest
   account: string
   /**
    * If included, filter results to include only this type of ledger object.
-   * The valid types are: Check , DepositPreauth, Escrow, Offer, PayChannel,
-   * SignerList, Ticket, and RippleState (trust line).
    */
   type?: AccountObjectType
   /**
@@ -71,19 +46,10 @@ export interface AccountObjectsRequest
  * Account Objects can be a Check, a DepositPreauth, an Escrow, an Offer, a
  * PayChannel, a SignerList, a Ticket, or a RippleState.
  */
-export type AccountObject =
-  | AMM
-  | Bridge
-  | Check
-  | DepositPreauth
-  | Escrow
-  | Offer
-  | PayChannel
-  | SignerList
-  | RippleState
-  | Ticket
-  | XChainOwnedClaimID
-  | XChainOwnedCreateAccountClaimID
+export type AccountObject = Exclude<
+  LedgerEntry,
+  Amendments | FeeSettings | LedgerHashes
+>
 
 /**
  * Response expected from an {@link AccountObjectsRequest}.