xrpl 2.9.1 → 2.11.0

package/src/models/ledger/NFTokenPage.ts

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

package/src/models/ledger/NegativeUNL.ts

@@ -0,0 +1,34 @@
+import BaseLedgerEntry 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 {
+  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,52 @@
+import { Amount } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+export default interface Offer extends BaseLedgerEntry {
+  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 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
+}
+
+export enum OfferFlags {
+  lsfPassive = 0x00010000,
+  lsfSell = 0x00020000,
+}

package/src/models/ledger/PayChannel.ts

@@ -0,0 +1,107 @@
+import BaseLedgerEntry 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 {
+  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
+  /**
+   * 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.
+   */
+  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,88 @@
+import { IssuedCurrencyAmount } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The RippleState object type connects two accounts in a single currency.
+ *
+ * @category Ledger Entries
+ */
+export default interface RippleState extends BaseLedgerEntry {
+  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
+  /**
+   * 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.
+   */
+  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,56 @@
+import { SignerEntry } from '../common'
+
+import BaseLedgerEntry 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 {
+  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.
+   */
+  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,36 @@
+import BaseLedgerEntry 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 {
+  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 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/index.ts

@@ -0,0 +1,58 @@
+import AccountRoot, {
+  AccountRootFlags,
+  AccountRootFlagsInterface,
+} from './AccountRoot'
+import Amendments, { Majority, AMENDMENTS_ID } from './Amendments'
+import Check from './Check'
+import DepositPreauth from './DepositPreauth'
+import DirectoryNode from './DirectoryNode'
+import Escrow from './Escrow'
+import FeeSettings, {
+  FeeSettingsPreAmendmentFields,
+  FeeSettingsPostAmendmentFields,
+  FEE_SETTINGS_ID,
+} from './FeeSettings'
+import Ledger from './Ledger'
+import LedgerEntry from './LedgerEntry'
+import LedgerHashes from './LedgerHashes'
+import NegativeUNL, { NEGATIVE_UNL_ID } from './NegativeUNL'
+import { NFTokenOffer } from './NFTokenOffer'
+import { NFToken, NFTokenPage } from './NFTokenPage'
+import Offer, { OfferFlags } from './Offer'
+import PayChannel from './PayChannel'
+import RippleState, { RippleStateFlags } from './RippleState'
+import SignerList, { SignerListFlags } from './SignerList'
+import Ticket from './Ticket'
+
+export {
+  AccountRoot,
+  AccountRootFlags,
+  AccountRootFlagsInterface,
+  AMENDMENTS_ID,
+  Amendments,
+  Check,
+  DepositPreauth,
+  DirectoryNode,
+  Escrow,
+  FEE_SETTINGS_ID,
+  FeeSettings,
+  FeeSettingsPreAmendmentFields,
+  FeeSettingsPostAmendmentFields,
+  Ledger,
+  LedgerEntry,
+  LedgerHashes,
+  Majority,
+  NEGATIVE_UNL_ID,
+  NegativeUNL,
+  NFTokenOffer,
+  NFTokenPage,
+  NFToken,
+  Offer,
+  OfferFlags,
+  PayChannel,
+  RippleState,
+  RippleStateFlags,
+  SignerList,
+  SignerListFlags,
+  Ticket,
+}

package/src/models/methods/accountChannels.ts

@@ -0,0 +1,93 @@
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+export interface Channel {
+  account: string
+  amount: string
+  balance: string
+  channel_id: string
+  destination_account: string
+  settle_delay: number
+  public_key?: string
+  public_key_hex?: string
+  expiration?: number
+  cancel_after?: number
+  source_tab?: number
+  destination_tag?: number
+}
+
+/**
+ * The account_channels method returns information about an account's Payment
+ * Channels. This includes only channels where the specified account is the
+ * channel's source, not the destination. (A channel's "source" and "owner" are
+ * the same.) All information retrieved is relative to a particular version of
+ * the ledger. Returns an {@link AccountChannelsResponse}.
+ *
+ * @category Requests
+ */
+export interface AccountChannelsRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'account_channels'
+  /**
+   * The unique identifier of an account, typically the account's address. The
+   * request returns channels where this account is the channel's owner/source.
+   *
+   */
+  account: string
+  /**
+   * The unique identifier of an account, typically the account's address. If
+   * provided, filter results to payment channels whose destination is this
+   * account.
+   */
+  destination_account?: string
+  /**
+   * Limit the number of transactions to retrieve. Cannot be less than 10 or
+   * more than 400. The default is 200.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
+}
+
+/**
+ * The expected response from an {@link AccountChannelsRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountChannelsResponse extends BaseResponse {
+  result: {
+    /**
+     * The address of the source/owner of the payment channels. This
+     * corresponds to the account field of the request.
+     */
+    account: string
+    /** Payment channels owned by this account. */
+    channels: Channel[]
+    /**
+     * The identifying hash of the ledger version used to generate this
+     * response.
+     */
+    ledger_hash: string
+    /** The ledger index of the ledger version used to generate this response. */
+    ledger_index: number
+    /**
+     * If true, the information in this response comes from a validated ledger
+     * version. Otherwise, the information is subject to change.
+     */
+    validated?: boolean
+    /**
+     * The limit to how many channel objects were actually returned by this
+     * request.
+     */
+    limit?: number
+    /**
+     * Server-defined value for pagination. Pass this to the next call to
+     * resume getting results where this call left off. Omitted when there are
+     * no additional pages after this one.
+     */
+    marker?: unknown
+  }
+}

package/src/models/methods/accountCurrencies.ts

@@ -0,0 +1,45 @@
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The `account_currencies` command retrieves a list of currencies that an
+ * account can send or receive, based on its trust lines. Expects an
+ * {@link AccountCurrenciesResponse}.
+ *
+ * @category Requests
+ */
+export interface AccountCurrenciesRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'account_currencies'
+  /** A unique identifier for the account, most commonly the account's address. */
+  account: string
+  /**
+   * If true, then the account field only accepts a public key or XRP Ledger
+   * address. Otherwise, account can be a secret or passphrase (not
+   * recommended). The default is false.
+   */
+  strict?: boolean
+}
+
+/**
+ * The expected response from an {@link AccountCurrenciesRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountCurrenciesResponse extends BaseResponse {
+  result: {
+    /**
+     * The identifying hash of the ledger version used to retrieve this data,
+     * as hex.
+     */
+    ledger_hash?: string
+    /** The ledger index of the ledger version used to retrieve this data. */
+    ledger_index: number
+    /** Array of Currency Codes for currencies that this account can receive. */
+    receive_currencies: string[]
+    /** Array of Currency Codes for currencies that this account can send. */
+    send_currencies: string[]
+    /** If true, this data comes from a validated ledger. */
+    validated: boolean
+  }
+}