xrpl 1.0.0-mpt-beta

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. Admin only. */
+  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,62 @@
+import AccountRoot from './AccountRoot'
+import Amendments from './Amendments'
+import AMM from './AMM'
+import Bridge from './Bridge'
+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'
+import XChainOwnedClaimID from './XChainOwnedClaimID'
+import XChainOwnedCreateAccountClaimID from './XChainOwnedCreateAccountClaimID'
+
+type LedgerEntry =
+  | AccountRoot
+  | Amendments
+  | AMM
+  | Bridge
+  | Check
+  | DepositPreauth
+  | DirectoryNode
+  | Escrow
+  | FeeSettings
+  | LedgerHashes
+  | NegativeUNL
+  | Offer
+  | PayChannel
+  | RippleState
+  | SignerList
+  | Ticket
+  | XChainOwnedClaimID
+  | XChainOwnedCreateAccountClaimID
+
+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

@@ -0,0 +1,26 @@
+import { BaseLedgerEntry, MissingPreviousTxnID } 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,
+    MissingPreviousTxnID {
+  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,14 @@
+import { Amount } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+export interface NFTokenOffer extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'NFTokenOffer'
+  Amount: Amount
+  Destination?: string
+  Expiration: number
+  Flags: number
+  NFTokenOfferNode?: string
+  Owner: string
+  OwnerNode?: string
+}

package/src/models/ledger/NFTokenPage.ts

@@ -0,0 +1,18 @@
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+export interface NFToken {
+  NFToken: {
+    Flags: number
+    Issuer: string
+    NFTokenID: string
+    NFTokenTaxon: number
+    URI?: string
+  }
+}
+
+export interface NFTokenPage extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'NFTokenPage'
+  NextPageMin?: string
+  NFTokens: NFToken[]
+  PreviousPageMin?: string
+}

package/src/models/ledger/NegativeUNL.ts

@@ -0,0 +1,36 @@
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The unique id for the nUNL object https://xrpl.org/negativeunl.html#negativeunl-id-format
+ */
+export const NEGATIVE_UNL_ID =
+  '2E8A59AA9D3B5B186B0B9E0F62E6C02587CA74A4D778938E957B6357D364B244'
+
+/**
+ * The NegativeUNL object type contains the current status of the Negative UNL,
+ * a list of trusted validators currently believed to be offline.
+ *
+ * @category Ledger Entries
+ */
+export default interface NegativeUNL
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
+  LedgerEntryType: 'NegativeUNL'
+  /**
+   * A list of trusted validators that are currently disabled.
+   */
+  DisabledValidators?: Array<{
+    FirstLedgerSequence: number
+    PublicKey: string
+  }>
+  /**
+   * The public key of a trusted validator that is scheduled to be disabled in
+   * the next flag ledger.
+   */
+  ValidatorToDisable?: string
+  /**
+   * The public key of a trusted validator in the Negative UNL that is
+   * scheduled to be re-enabled in the next flag ledger.
+   */
+  ValidatorToReEnable?: string
+}

package/src/models/ledger/Offer.ts

@@ -0,0 +1,42 @@
+import { Amount } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+export default interface Offer extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Offer'
+  /** A bit-map of boolean flags enabled for this Offer. */
+  Flags: number
+  /** The address of the account that placed this Offer. */
+  Account: string
+  /**
+   * The Sequence value of the OfferCreate transaction that created this Offer
+   * object. Used in combination with the Account to identify this Offer.
+   */
+  Sequence: number
+  /** The remaining amount and type of currency requested by the Offer creator. */
+  TakerPays: Amount
+  /**
+   * The remaining amount and type of currency being provided by the Offer
+   * creator.
+   */
+  TakerGets: Amount
+  /** The ID of the Offer Directory that links to this Offer. */
+  BookDirectory: string
+  /**
+   * A hint indicating which page of the Offer Directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  BookNode: string
+  /**
+   * A hint indicating which page of the Owner Directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+  /** The time this Offer expires, in seconds since the Ripple Epoch. */
+  Expiration?: number
+}
+
+export enum OfferFlags {
+  lsfPassive = 0x00010000,
+  lsfSell = 0x00020000,
+}

package/src/models/ledger/PayChannel.ts

@@ -0,0 +1,97 @@
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The PayChannel object type represents a payment channel. Payment channels
+ * enable small, rapid off-ledger payments of XRP that can be later reconciled
+ * with the consensus ledger. A payment channel holds a balance of XRP that can
+ * only be paid out to a specific destination address until the channel is
+ * closed.
+ *
+ * @category Ledger Entries
+ */
+export default interface PayChannel extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'PayChannel'
+  /**
+   * The source address that owns this payment channel. This comes from the
+   * sending address of the transaction that created the channel.
+   */
+  Account: string
+  /**
+   * The destination address for this payment channel. While the payment
+   * channel is open, this address is the only one that can receive XRP from the
+   * channel. This comes from the Destination field of the transaction that
+   * created the channel.
+   */
+  Destination: string
+  /**
+   * Total XRP, in drops, that has been allocated to this channel. This
+   * includes XRP that has been paid to the destination address. This is
+   * initially set by the transaction that created the channel and can be
+   * increased if the source address sends a PaymentChannelFund transaction.
+   */
+  Amount: string
+  /**
+   * Total XRP, in drops, already paid out by the channel. The difference
+   * between this value and the Amount field is how much XRP can still be paid
+   * to the destination address with PaymentChannelClaim transactions. If the
+   * channel closes, the remaining difference is returned to the source address.
+   */
+  Balance: string
+  /**
+   * Public key, in hexadecimal, of the key pair that can be used to sign
+   * claims against this channel. This can be any valid secp256k1 or Ed25519
+   * public key. This is set by the transaction that created the channel and
+   * must match the public key used in claims against the channel. The channel
+   * source address can also send XRP from this channel to the destination
+   * without signed claims.
+   */
+  PublicKey: string
+  /**
+   * Number of seconds the source address must wait to close the channel if
+   * it still has any XRP in it. Smaller values mean that the destination
+   * address has less time to redeem any outstanding claims after the source
+   * address requests to close the channel. Can be any value that fits in a
+   * 32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that
+   * creates the channel.
+   */
+  SettleDelay: number
+  /**
+   * A hint indicating which page of the source address's owner directory links
+   * to this object, in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+  /**
+   * A bit-map of boolean flags enabled for this payment channel. Currently,
+   * the protocol defines no flags for PayChannel objects.
+   */
+  Flags: number
+  /**
+   * The mutable expiration time for this payment channel, in seconds since the
+   * Ripple Epoch. The channel is expired if this value is present and smaller
+   * than the previous ledger's close_time field. See Setting Channel Expiration
+   * for more details.
+   */
+  Expiration?: number
+  /**
+   * The immutable expiration time for this payment channel, in seconds since
+   * the Ripple Epoch. This channel is expired if this value is present and
+   * smaller than the previous ledger's close_time field. This is optionally
+   * set by the transaction that created the channel, and cannot be changed.
+   */
+  CancelAfter?: number
+  /**
+   * An arbitrary tag to further specify the source for this payment channel
+   * useful for specifying a hosted recipient at the owner's address.
+   */
+  SourceTag?: number
+  /**
+   * An arbitrary tag to further specify the destination for this payment
+   * channel, such as a hosted recipient at the destination address.
+   */
+  DestinationTag?: 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
+}

package/src/models/ledger/RippleState.ts

@@ -0,0 +1,78 @@
+import { IssuedCurrencyAmount } from '../common'
+
+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, HasPreviousTxnID {
+  LedgerEntryType: 'RippleState'
+  /** A bit-map of boolean options enabled for this object. */
+  Flags: number
+  /**
+   * The balance of the trust line, from the perspective of the low account. A
+   * negative balance indicates that the low account has issued currency to the
+   * high account. The issuer is always the neutral value ACCOUNT_ONE.
+   */
+  Balance: IssuedCurrencyAmount
+  /**
+   * The limit that the low account has set on the trust line. The issuer is
+   * the address of the low account that set this limit.
+   */
+  LowLimit: IssuedCurrencyAmount
+  /**
+   * The limit that the high account has set on the trust line. The issuer is
+   * the address of the high account that set this limit.
+   */
+  HighLimit: IssuedCurrencyAmount
+  /**
+   * A hint indicating which page of the low account's owner directory links to
+   * this object, in case the directory consists of multiple pages.
+   */
+  LowNode?: string
+  /**
+   * A hint indicating which page of the high account's owner directory links
+   * to this object, in case the directory consists of multiple pages.
+   */
+  HighNode?: string
+  /**
+   * The inbound quality set by the low account, as an integer in the implied
+   * ratio LowQualityIn:1,000,000,000. As a special case, the value 0 is
+   * equivalent to 1 billion, or face value.
+   */
+  LowQualityIn?: number
+  /**
+   * The outbound quality set by the low account, as an integer in the implied
+   * ratio LowQualityOut:1,000,000,000. As a special case, the value 0 is
+   * equivalent to 1 billion, or face value.
+   */
+  LowQualityOut?: number
+  /**
+   * The inbound quality set by the high account, as an integer in the implied
+   * ratio HighQualityIn:1,000,000,000. As a special case, the value 0 is
+   * equivalent to 1 billion, or face value.
+   */
+  HighQualityIn?: number
+  /**
+   * The outbound quality set by the high account, as an integer in the implied
+   * ratio HighQualityOut:1,000,000,000. As a special case, the value 0 is
+   * equivalent to 1 billion, or face value.
+   */
+  HighQualityOut?: number
+}
+
+export enum RippleStateFlags {
+  // True, if entry counts toward reserve.
+  lsfLowReserve = 0x00010000,
+  lsfHighReserve = 0x00020000,
+  lsfLowAuth = 0x00040000,
+  lsfHighAuth = 0x00080000,
+  lsfLowNoRipple = 0x00100000,
+  lsfHighNoRipple = 0x00200000,
+  // True, low side has set freeze flag
+  lsfLowFreeze = 0x00400000,
+  // True, high side has set freeze flag
+  lsfHighFreeze = 0x00800000,
+}

package/src/models/ledger/SignerList.ts

@@ -0,0 +1,46 @@
+import { SignerEntry } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The SignerList object type represents a list of parties that, as a group,
+ * are authorized to sign a transaction in place of an individual account. You
+ * can create, replace, or remove a signer list using a SignerListSet
+ * transaction.
+ *
+ * @category Ledger Entries
+ */
+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
+  /**
+   * A hint indicating which page of the owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+  /**
+   * An array of Signer Entry objects representing the parties who are part of
+   * this signer list.
+   */
+  SignerEntries: SignerEntry[]
+  /**
+   * An ID for this signer list. Currently always set to 0. If a future
+   * amendment allows multiple signer lists for an account, this may change.
+   */
+  SignerListID: number
+  /**
+   * A target number for signer weights. To produce a valid signature for the
+   * owner of this SignerList, the signers must provide valid signatures whose
+   * weights sum to this value or more.
+   */
+  SignerQuorum: number
+}
+
+export enum SignerListFlags {
+  // True, uses only one OwnerCount
+  lsfOneOwnerCount = 0x00010000,
+}

package/src/models/ledger/Ticket.ts

@@ -0,0 +1,26 @@
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The Ticket object type represents a Ticket, which tracks an account sequence
+ * number that has been set aside for future use. You can create new tickets
+ * with a TicketCreate transaction.
+ *
+ * @category Ledger Entries
+ */
+export default interface Ticket extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Ticket'
+  /** The account that owns this Ticket. */
+  Account: string
+  /**
+   * A bit-map of Boolean flags enabled for this Ticket. Currently, there are
+   * no flags defined for Tickets.
+   */
+  Flags: number
+  /**
+   * A hint indicating which page of the owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+  /** The Sequence Number this Ticket sets aside. */
+  TicketSequence: number
+}

package/src/models/ledger/XChainOwnedClaimID.ts

@@ -0,0 +1,81 @@
+import { Amount } from 'ripple-binary-codec/dist/types'
+
+import { XChainBridge } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * An XChainOwnedClaimID object represents one cross-chain transfer of value
+ * and includes information of the account on the source chain that locks or
+ * burns the funds on the source chain.
+ *
+ * @category Ledger Entries
+ */
+export default interface XChainOwnedClaimID
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
+  LedgerEntryType: 'XChainOwnedClaimID'
+
+  /** The account that checked out this unique claim ID value. */
+  Account: string
+
+  /**
+   * The door accounts and assets of the bridge this object correlates to.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The unique sequence number for a cross-chain transfer.
+   */
+  XChainClaimID: string
+
+  /**
+   * The account that must send the corresponding {@link XChainCommit} on the
+   * source chain. The destination may be specified in the {@link XChainCommit}
+   * transaction, which means that if the OtherChainSource isn't specified,
+   * another account can try to specify a different destination and steal the
+   * funds. This also allows tracking only a single set of signatures, since we
+   * know which account will send the {@link XChainCommit} transaction.
+   */
+  OtherChainSource: string
+
+  /**
+   * Attestations collected from the witness servers. This includes the parameters
+   * needed to recreate the message that was signed, including the amount, which
+   * chain (locking or issuing), optional destination, and reward account for that
+   * signature.
+   */
+  XChainClaimAttestations: Array<{
+    // TODO: add docs
+    XChainClaimProofSig: {
+      Amount: Amount
+
+      AttestationRewardAccount: string
+
+      AttestationSignerAccount: string
+
+      Destination?: string
+
+      PublicKey: string
+
+      WasLockingChainSend: 0 | 1
+    }
+  }>
+
+  /**
+   * The total amount to pay the witness servers for their signatures. It must be at
+   * least the value of the SignatureReward in the {@link Bridge} ledger object.
+   */
+  SignatureReward: string
+
+  /**
+   * A bit-map of boolean flags. No flags are defined for XChainOwnedClaimIDs,
+   * 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/XChainOwnedCreateAccountClaimID.ts

@@ -0,0 +1,65 @@
+import { XChainBridge } from '../common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The XChainOwnedCreateAccountClaimID ledger object is used to collect attestations
+ * for creating an account via a cross-chain transfer.
+ *
+ * @category Ledger Entries
+ */
+export default interface XChainOwnedCreateAccountClaimID
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
+  LedgerEntryType: 'XChainOwnedCreateAccountClaimID'
+
+  /** The account that owns this object. */
+  Account: string
+
+  /**
+   * The door accounts and assets of the bridge this object correlates to.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * An integer that determines the order that accounts created through
+   * cross-chain transfers must be performed. Smaller numbers must execute
+   * before larger numbers.
+   */
+  XChainAccountCreateCount: number
+
+  /**
+   * Attestations collected from the witness servers. This includes the parameters
+   * needed to recreate the message that was signed, including the amount, destination,
+   * signature reward amount, and reward account for that signature. With the
+   * exception of the reward account, all signatures must sign the message created with
+   * common parameters.
+   */
+  XChainCreateAccountAttestations: Array<{
+    // TODO: add docs
+    XChainCreateAccountProofSig: {
+      Amount: string
+
+      AttestationRewardAccount: string
+
+      AttestationSignerAccount: string
+
+      Destination: string
+
+      PublicKey: string
+
+      WasLockingChainSend: 0 | 1
+    }
+  }>
+
+  /**
+   * A bit-map of boolean flags. No flags are defined for,
+   * XChainOwnedCreateAccountClaimIDs, 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
+}