xrpl 2.9.1 → 2.11.0

package/src/models/methods/accountInfo.ts

@@ -0,0 +1,182 @@
+import { AccountRoot, SignerList } from '../ledger'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The `account_info` command retrieves information about an account, its
+ * activity, and its XRP balance. All information retrieved is relative to a
+ * particular version of the ledger. Returns an {@link AccountInfoResponse}.
+ *
+ * @category Requests
+ */
+export interface AccountInfoRequest extends BaseRequest, LookupByLedgerRequest {
+  command: 'account_info'
+  /** A unique identifier for the account, most commonly the account's address. */
+  account: string
+  /**
+   * Whether to get info about this account's queued transactions. Can only be
+   * used when querying for the data from the current open ledger. Not available
+   * from servers in Reporting Mode.
+   */
+  queue?: boolean
+  /**
+   * Request SignerList objects associated with this account.
+   */
+  signer_lists?: boolean
+  /**
+   * 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
+}
+
+export interface AccountQueueTransaction {
+  /**
+   * Whether this transaction changes this address's ways of authorizing
+   * transactions.
+   */
+  auth_change: boolean
+  /** The Transaction Cost of this transaction, in drops of XRP. */
+  fee: string
+  /**
+   * The transaction cost of this transaction, relative to the minimum cost for
+   * this type of transaction, in fee levels.
+   */
+  fee_level: string
+  /** The maximum amount of XRP, in drops, this transaction could send or destroy. */
+  max_spend_drops: string
+  /** The Sequence Number of this transaction. */
+  seq: number
+}
+
+export interface AccountQueueData {
+  /** Number of queued transactions from this address. */
+  txn_count: number
+  /**
+   * Whether a transaction in the queue changes this address's ways of
+   * authorizing transactions. If true, this address can queue no further
+   * transactions until that transaction has been executed or dropped from the
+   * queue.
+   */
+  auth_change_queued?: boolean
+  /** The lowest Sequence Number among transactions queued by this address. */
+  lowest_sequence?: number
+  /** The highest Sequence Number among transactions queued by this address. */
+  highest_sequence?: number
+  /**
+   * Integer amount of drops of XRP that could be debited from this address if
+   * every transaction in the queue consumes the maximum amount of XRP possible.
+   */
+  max_spend_drops_total?: string
+  /** Information about each queued transaction from this address. */
+  transactions?: AccountQueueTransaction[]
+}
+
+export interface AccountInfoAccountFlags {
+  /**
+   * Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.
+   */
+  defaultRipple: boolean
+  /**
+   * This account can only receive funds from transactions it sends, and from preauthorized accounts.
+   * (It has DepositAuth enabled.)
+   */
+  depositAuth: boolean
+  /**
+   * Disallows use of the master key to sign transactions for this account.
+   */
+  disableMasterKey: boolean
+  /**
+   * Disallow incoming Checks from other accounts.
+   */
+  disallowIncomingCheck?: boolean
+  /**
+   * Disallow incoming NFTOffers from other accounts. Part of the DisallowIncoming amendment.
+   */
+  disallowIncomingNFTokenOffer?: boolean
+  /**
+   * Disallow incoming PayChannels from other accounts. Part of the DisallowIncoming amendment.
+   */
+  disallowIncomingPayChan?: boolean
+  /**
+   * Disallow incoming Trustlines from other accounts. Part of the DisallowIncoming amendment.
+   */
+  disallowIncomingTrustline?: boolean
+  /**
+   * Client applications should not send XRP to this account. Not enforced by rippled.
+   */
+  disallowIncomingXRP: boolean
+  /**
+   * All assets issued by this address are frozen.
+   */
+  globalFreeze: boolean
+  /**
+   * This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.
+   */
+  noFreeze: boolean
+  /**
+   * The account has used its free SetRegularKey transaction.
+   */
+  passwordSpent: boolean
+  /**
+   * This account must individually approve other users for those users to hold this account's issued currencies.
+   */
+  requireAuthorization: boolean
+  /**
+   * Requires incoming payments to specify a Destination Tag.
+   */
+  requireDestinationTag: boolean
+  /**
+   * This address can claw back issued IOUs. Once enabled, cannot be disabled.
+   */
+  allowTrustLineClawback: boolean
+}
+
+/**
+ * Response expected from an {@link AccountInfoRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountInfoResponse extends BaseResponse {
+  result: {
+    /**
+     * The AccountRoot ledger object with this account's information, as stored
+     * in the ledger.
+     * If requested, also includes Array of SignerList ledger objects
+     * associated with this account for Multi-Signing. Since an account can own
+     * at most one SignerList, this array must have exactly one member if it is
+     * present.
+     */
+    account_data: AccountRoot & { signer_lists?: SignerList[] }
+
+    /**
+     * A map of account flags parsed out.  This will only be available for rippled nodes 1.11.0 and higher.
+     */
+    account_flags?: AccountInfoAccountFlags
+    /**
+     * The ledger index of the current in-progress ledger, which was used when
+     * retrieving this information.
+     */
+    ledger_current_index?: number
+    /**
+     * The ledger index of the ledger version used when retrieving this
+     * information. The information does not contain any changes from ledger
+     * versions newer than this one.
+     */
+    ledger_index?: number
+    /**
+     * Information about queued transactions sent by this account. This
+     * information describes the state of the local rippled server, which may be
+     * different from other servers in the peer-to-peer XRP Ledger network. Some
+     * fields may be omitted because the values are calculated "lazily" by the
+     * queuing mechanism.
+     */
+    queue_data?: AccountQueueData
+    /**
+     * True if this data is from a validated ledger version; if omitted or set
+     * to false, this data is not final.
+     */
+    validated?: boolean
+  }
+}

package/src/models/methods/accountLines.ts

@@ -0,0 +1,137 @@
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+export interface AccountLinesTrustline {
+  /** The unique Address of the counterparty to this trust line. */
+  account: string
+  /**
+   * Representation of the numeric balance currently held against this line. A
+   * positive balance means that the perspective account holds value; a negative
+   * Balance means that the perspective account owes value.
+   */
+  balance: string
+  /** A Currency Code identifying what currency this trust line can hold. */
+  currency: string
+  /**
+   * The maximum amount of the given currency that this account is willing to
+   * owe the peer account.
+   */
+  limit: string
+  /**
+   * The maximum amount of currency that the issuer account is willing to owe
+   * the perspective account.
+   */
+  limit_peer: string
+  /**
+   * Rate at which the account values incoming balances on this trust line, as
+   * a ratio of this value per 1 billion units. (For example, a value of 500
+   * million represents a 0.5:1 ratio.) As a special case, 0 is treated as a
+   * 1:1 ratio.
+   */
+  quality_in: number
+  /**
+   * Rate at which the account values outgoing balances on this trust line, as
+   * a ratio of this value per 1 billion units. (For example, a value of 500
+   * million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1
+   * ratio.
+   */
+  quality_out: number
+  /**
+   * If true, this account has enabled the No Ripple flag for this trust line.
+   * If present and false, this account has disabled the No Ripple flag, but,
+   * because the account also has the Default Ripple flag enabled, that is not
+   * considered the default state. If omitted, the account has the No Ripple
+   * flag disabled for this trust line and Default Ripple disabled.
+   */
+  no_ripple?: boolean
+  /**
+   * If true, the peer account has enabled the No Ripple flag for this trust
+   * line. If present and false, this account has disabled the No Ripple flag,
+   * but, because the account also has the Default Ripple flag enabled, that is
+   * not considered the default state. If omitted, the account has the No Ripple
+   * flag disabled for this trust line and Default Ripple disabled.
+   */
+  no_ripple_peer?: boolean
+  /** If true, this account has authorized this trust line. The default is false. */
+  authorized?: boolean
+  /** If true, the peer account has authorized this trust line. The default is false. */
+  peer_authorized?: boolean
+  /** If true, this account has frozen this trust line. The default is false. */
+  freeze?: boolean
+  /**
+   * If true, the peer account has frozen this trust line. The default is
+   * false.
+   */
+  freeze_peer?: boolean
+}
+
+/**
+ * The account_lines method returns information about an account's trust lines,
+ *  including balances in all non-XRP currencies and assets. All information
+ * retrieved is relative to a particular version of the ledger. Expects an
+ * {@link AccountLinesResponse}.
+ *
+ * @category Requests
+ */
+export interface AccountLinesRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'account_lines'
+  /** A unique identifier for the account, most commonly the account's Address. */
+  account: string
+  /**
+   * The Address of a second account. If provided, show only lines of trust
+   * connecting the two accounts.
+   */
+  peer?: string
+  /**
+   * Limit the number of trust lines to retrieve. The server is not required to
+   * honor this value. Must be within the inclusive range 10 to 400.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
+}
+
+/**
+ * Response expected from an {@link AccountLinesRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountLinesResponse extends BaseResponse {
+  result: {
+    /**
+     * Unique Address of the account this request corresponds to. This is the
+     * "perspective account" for purpose of the trust lines.
+     */
+    account: string
+    /**
+     * Array of trust line objects. If the number of trust lines is large, only
+     * returns up to the limit at a time.
+     */
+    lines: AccountLinesTrustline[]
+    /**
+     * The ledger index of the current open ledger, which was used when
+     * retrieving this information.
+     */
+    ledger_current_index?: number
+    /**
+     * The ledger index of the ledger version that was used when retrieving
+     * this data.
+     */
+    ledger_index?: number
+    /**
+     * The identifying hash the ledger version that was used when retrieving
+     * this data.
+     */
+    ledger_hash?: string
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off. Omitted when there are
+     * No additional pages after this one.
+     */
+    marker?: unknown
+  }
+}

package/src/models/methods/accountNFTs.ts

@@ -0,0 +1,72 @@
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The `account_nfts` method retrieves all of the NFTs currently owned by the
+ * specified account.
+ *
+ * @category Requests
+ */
+export interface AccountNFTsRequest extends BaseRequest, LookupByLedgerRequest {
+  command: 'account_nfts'
+  /**
+   * The unique identifier of an account, typically the account's address. The
+   * request returns NFTs owned by this account.
+   */
+  account: string
+  /**
+   * Limit the number of NFTokens to retrieve.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
+}
+
+/**
+ * One NFToken that might be returned from an {@link AccountNFTsRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountNFToken {
+  Flags: number
+  Issuer: string
+  NFTokenID: string
+  NFTokenTaxon: number
+  URI?: string
+  nft_serial: number
+}
+
+/**
+ * Response expected from an {@link AccountNFTsRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountNFTsResponse extends BaseResponse {
+  result: {
+    /**
+     * The account requested.
+     */
+    account: string
+    /**
+     * A list of NFTs owned by the specified account.
+     */
+    account_nfts: AccountNFToken[]
+    /**
+     * The ledger index of the current open ledger, which was used when
+     * retrieving this information.
+     */
+    ledger_current_index: number
+    /** If true, this data comes from a validated ledger. */
+    validated: boolean
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off. Omitted when there are
+     * No additional pages after this one.
+     */
+    marker?: unknown
+    /** The limit that was used to fulfill this request. */
+    limit?: number
+  }
+}

package/src/models/methods/accountObjects.ts

@@ -0,0 +1,120 @@
+import {
+  Check,
+  DepositPreauth,
+  Escrow,
+  Offer,
+  PayChannel,
+  RippleState,
+  SignerList,
+  Ticket,
+} from '../ledger'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+export type AccountObjectType =
+  | 'check'
+  | 'deposit_preauth'
+  | 'escrow'
+  | 'nft_offer'
+  | 'offer'
+  | 'payment_channel'
+  | 'signer_list'
+  | 'state'
+  | 'ticket'
+
+/**
+ * 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
+ * balances, see the account_lines method instead. Expects a response in the
+ * form of an {@link AccountObjectsResponse}.
+ *
+ * @category Requests
+ */
+export interface AccountObjectsRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'account_objects'
+  /** A unique identifier for the account, most commonly the account's address. */
+  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
+  /**
+   * If true, the response only includes objects that would block this account
+   * from being deleted. The default is false.
+   */
+  deletion_blockers_only?: boolean
+  /**
+   * The maximum number of objects to include in the results. Must be within
+   * the inclusive range 10 to 400 on non-admin connections. The default is 200.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
+}
+
+/**
+ * Account Objects can be a Check, a DepositPreauth, an Escrow, an Offer, a
+ * PayChannel, a SignerList, a Ticket, or a RippleState.
+ */
+export type AccountObject =
+  | Check
+  | DepositPreauth
+  | Escrow
+  | Offer
+  | PayChannel
+  | SignerList
+  | RippleState
+  | Ticket
+
+/**
+ * Response expected from an {@link AccountObjectsRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountObjectsResponse extends BaseResponse {
+  result: {
+    /** Unique Address of the account this request corresponds to. */
+    account: string
+    /**
+     * Array of objects owned by this account. Each object is in its raw
+     * ledger format.
+     */
+    account_objects: AccountObject[]
+    /**
+     * The identifying hash of the ledger that was used to generate this
+     * response.
+     */
+    ledger_hash?: string
+    /**
+     * The ledger index of the ledger version that was used to generate this
+     * response.
+     */
+    ledger_index?: number
+    /**
+     * The ledger index of the current in-progress ledger version, which was
+     * used to generate this response.
+     */
+    ledger_current_index?: number
+    /** The limit that was used in this request, if any. */
+    limit?: number
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off. Omitted when there are
+     * no additional pages after this one.
+     */
+    marker?: string
+    /**
+     * If included and set to true, the information in this response comes from
+     * a validated ledger version. Otherwise, the information is subject to
+     * change.
+     */
+    validated?: boolean
+  }
+}

package/src/models/methods/accountOffers.ts

@@ -0,0 +1,100 @@
+import { Amount } from '../common'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The account_offers method retrieves a list of offers made by a given account
+ * that are outstanding as of a particular ledger version. Expects a response in
+ * the form of a {@link AccountOffersResponse}.
+ *
+ * @category Requests
+ */
+export interface AccountOffersRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'account_offers'
+  /** A unique identifier for the account, most commonly the account's Address. */
+  account: string
+  /**
+   * Limit the number of transactions to retrieve. The server is not required
+   * to honor this value. Must be within the inclusive range 10 to 400.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
+  /**
+   * 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
+}
+
+export interface AccountOffer {
+  /** Options set for this offer entry as bit-flags. */
+  flags: number
+  /** Sequence number of the transaction that created this entry. */
+  seq: number
+  /**
+   * The amount the account placing this Offer receives.
+   */
+  taker_gets: Amount
+  /**
+   * The amount the account placing this Offer pays.
+   */
+  taker_pays: Amount
+  /**
+   * The exchange rate of the Offer, as the ratio of the original taker_pays
+   * divided by the original taker_gets. When executing offers, the offer with
+   * the most favorable (lowest) quality is consumed first; offers with the same
+   * quality are executed from oldest to newest.
+   */
+  quality: string
+  /**
+   * A time after which this offer is considered unfunded, as the number of
+   * seconds since the Ripple Epoch. See also: Offer Expiration.
+   */
+  expiration?: number
+}
+
+/**
+ * Response expected from an {@link AccountOffersRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountOffersResponse extends BaseResponse {
+  result: {
+    /** Unique Address identifying the account that made the offers. */
+    account: string
+    /**
+     * Array of objects, where each object represents an offer made by this
+     * account that is outstanding as of the requested ledger version. If the
+     * number of offers is large, only returns up to limit at a time.
+     */
+    offers?: AccountOffer[]
+    /**
+     * The ledger index of the current in-progress ledger version, which was
+     * used when retrieving this data.
+     */
+    ledger_current_index?: number
+    /**
+     * The ledger index of the ledger version that was used when retrieving
+     * this data, as requested.
+     */
+    ledger_index?: number
+    /**
+     * The identifying hash of the ledger version that was used when retrieving
+     * this data.
+     */
+    ledger_hash?: string
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off. Omitted when there are
+     * no pages of information after this one.
+     */
+    marker?: unknown
+  }
+}