xrpl 1.0.0-mpt-beta

package/src/models/methods/ledger.ts

@@ -0,0 +1,259 @@
+import { Ledger } from '../ledger'
+import { LedgerEntryFilter } from '../ledger/LedgerEntry'
+import { Transaction, TransactionAndMetadata } from '../transactions'
+import { TransactionMetadata } from '../transactions/metadata'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponse}.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": false,
+ *  "transactions": false,
+ *  "expand": false,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequest extends BaseRequest, LookupByLedgerRequest {
+  command: 'ledger'
+  /**
+   * Admin required If true, return full information on the entire ledger.
+   * Ignored if you did not specify a ledger version. Defaults to false.
+   */
+  full?: boolean
+  /**
+   * Admin required. If true, return information on accounts in the ledger.
+   * Ignored if you did not specify a ledger version. Defaults to false.
+   */
+  accounts?: boolean
+  /**
+   * If true, return information on transactions in the specified ledger
+   * version. Defaults to false. Ignored if you did not specify a ledger
+   * version.
+   */
+  transactions?: boolean
+  /**
+   * Provide full JSON-formatted information for transaction/account
+   * information instead of only hashes. Defaults to false. Ignored unless you
+   * request transactions, accounts, or both.
+   */
+  expand?: boolean
+  /**
+   * If true, include owner_funds field in the metadata of OfferCreate
+   * transactions in the response. Defaults to false. Ignored unless
+   * transactions are included and expand is true.
+   */
+  owner_funds?: boolean
+  /**
+   * If true, and transactions and expand are both also true, return
+   * transaction information in binary format (hexadecimal string) instead of
+   * JSON format.
+   */
+  binary?: boolean
+  /**
+   * If true, and the command is requesting the current ledger, includes an
+   * array of queued transactions in the results.
+   */
+  queue?: boolean
+  /**
+   * If included, filter results to include only this type of ledger object.
+   */
+  type?: LedgerEntryFilter
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponseExpanded}. Will return full JSON-formatted transaction data instead of string hashes.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": false,
+ *  "transactions": false,
+ *  "expand": true,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedTransactionsOnly extends LedgerRequest {
+  expand: true
+  transactions: true
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponseExpanded}. Will return full JSON-formatted `accountState` data instead of string hashes.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": true,
+ *  "transactions": false,
+ *  "expand": true,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedAccountsOnly extends LedgerRequest {
+  expand: true
+  accounts: true
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponseExpanded}. Will return full JSON-formatted `accountState` and `transactions`
+ * data instead of string hashes.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": true,
+ *  "transactions": true,
+ *  "expand": true,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedAccountsAndTransactions
+  extends LedgerRequest {
+  expand: true
+  accounts: true
+  transactions: true
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponse}. Will return binary (hexadecimal string) format
+ * instead of JSON or string hashes for `transactions` data.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": true,
+ *  "transactions": true,
+ *  "expand": true,
+ *  "owner_funds": false,
+ *  "binary": true
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedTransactionsBinary extends LedgerRequest {
+  expand: true
+  transactions: true
+  binary: true
+}
+
+/**
+ * Special case transaction definition when the request contains `owner_funds: true`.
+ */
+export interface LedgerModifiedOfferCreateTransaction {
+  transaction: Transaction
+  metadata: TransactionMetadata & { owner_funds: string }
+}
+
+export interface LedgerQueueData {
+  account: string
+  tx:
+    | TransactionAndMetadata
+    | LedgerModifiedOfferCreateTransaction
+    | { tx_blob: string }
+  retries_remaining: number
+  preflight_result: string
+  last_result?: string
+  auth_change?: boolean
+  fee?: string
+  fee_level?: string
+  max_spend_drops?: string
+}
+
+export interface LedgerBinary
+  extends Omit<Omit<Ledger, 'transactions'>, 'accountState'> {
+  accountState?: string[]
+  transactions?: string[]
+}
+
+interface LedgerResponseBase {
+  /** Unique identifying hash of the entire ledger. */
+  ledger_hash: string
+  /** The Ledger Index of this ledger. */
+  ledger_index: number
+  /**
+   * If true, this is a validated ledger version. If omitted or set to false,
+   * this ledger's data is not final.
+   */
+  queue_data?: Array<LedgerQueueData | string>
+  /**
+   * Array of objects describing queued transactions, in the same order as
+   * the queue. If the request specified expand as true, members contain full
+   * representations of the transactions, in either JSON or binary depending
+   * on whether the request specified binary as true.
+   */
+  validated?: boolean
+}
+
+interface LedgerResponseResult extends LedgerResponseBase {
+  /** The complete header data of this {@link Ledger}. */
+  ledger: LedgerBinary
+}
+
+/**
+ * Response expected from a {@link LedgerRequest}.
+ * This is the default request response, triggered when `expand` and `binary` are both false.
+ *
+ * @category Responses
+ */
+export interface LedgerResponse extends BaseResponse {
+  result: LedgerResponseResult
+}
+
+interface LedgerResponseExpandedResult extends LedgerResponseBase {
+  /** The complete header data of this {@link Ledger}. */
+  ledger: Ledger
+}
+
+/**
+ * Response expected from a {@link LedgerRequest} when the request contains `expanded` is true. See {@link LedgerRequestExpanded}.
+ * This response will contain full JSON-formatted data instead of string hashes.
+ * The response will contain either `accounts` or `transactions` or both.
+ * `binary` will be missing altogether.
+ *
+ * @category Responses
+ */
+export interface LedgerResponseExpanded extends BaseResponse {
+  result: LedgerResponseExpandedResult
+}

package/src/models/methods/ledgerClosed.ts

@@ -0,0 +1,32 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+/**
+ * The ledger_closed method returns the unique identifiers of the most recently
+ * closed ledger. Expects a response in the form of a {@link
+ * LedgerClosedResponse}.
+ *
+ * @example
+ *  *
+ * ```ts
+ * const ledgerClosed: LedgerClosedRequest = {
+ *   "command": "ledger_closed"
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerClosedRequest extends BaseRequest {
+  command: 'ledger_closed'
+}
+
+/**
+ * The response expected from a {@link LedgerClosedRequest}.
+ *
+ * @category Responses
+ */
+export interface LedgerClosedResponse extends BaseResponse {
+  result: {
+    ledger_hash: string
+    ledger_index: number
+  }
+}

package/src/models/methods/ledgerCurrent.ts

@@ -0,0 +1,31 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+/**
+ * The ledger_current method returns the unique identifiers of the current
+ * in-progress ledger. Expects a response in the form of a {@link
+ * LedgerCurrentResponse}.
+ *
+ * @example
+ * ```ts
+ * const ledgerCurrent: LedgerCurrentRequest = {
+ *   "command": "ledger_current"
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerCurrentRequest extends BaseRequest {
+  command: 'ledger_current'
+}
+
+/**
+ * Response expected from a {@link LedgerCurrentRequest}.
+ *
+ * @category Responses
+ */
+export interface LedgerCurrentResponse extends BaseResponse {
+  result: {
+    /** The ledger index of this ledger version. */
+    ledger_current_index: number
+  }
+}

package/src/models/methods/ledgerData.ts

@@ -0,0 +1,82 @@
+import { LedgerEntry, LedgerEntryFilter } from '../ledger'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The `ledger_data` method retrieves contents of the specified ledger. You can
+ * iterate through several calls to retrieve the entire contents of a single
+ * ledger version.
+ *
+ * @example
+ * ```ts
+ * const ledgerData: LedgerDataRequest = {
+ *   "id": 2,
+ *   "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
+ *   "command": "ledger_data",
+ *   "limit": 5,
+ *   "binary": true
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerDataRequest extends BaseRequest, LookupByLedgerRequest {
+  command: 'ledger_data'
+  /**
+   * If set to true, return ledger objects as hashed hex strings instead of
+   * JSON.
+   */
+  binary?: boolean
+  /**
+   * Limit the number of ledger objects to retrieve. The server is not required
+   * to honor this value.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
+  /**
+   * If included, filter results to include only this type of ledger object.
+   */
+  type?: LedgerEntryFilter
+}
+
+export type LedgerDataLabeledLedgerEntry = {
+  ledgerEntryType: string
+} & LedgerEntry
+
+export interface LedgerDataBinaryLedgerEntry {
+  data: string
+}
+
+export type LedgerDataLedgerState = { index: string } & (
+  | LedgerDataBinaryLedgerEntry
+  | LedgerDataLabeledLedgerEntry
+)
+
+/**
+ * The response expected from a {@link LedgerDataRequest}.
+ *
+ * @category Responses
+ */
+export interface LedgerDataResponse extends BaseResponse {
+  result: {
+    /** The ledger index of this ledger version. */
+    ledger_index: number
+    /** Unique identifying hash of this ledger version. */
+    ledger_hash: string
+    /**
+     * Array of JSON objects containing data from the ledger's state tree,
+     * as defined below.
+     */
+    state: LedgerDataLedgerState[]
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off.
+     */
+    marker?: unknown
+    validated?: boolean
+  }
+}

package/src/models/methods/ledgerEntry.ts

@@ -0,0 +1,208 @@
+import { Currency, XChainBridge } from '../common'
+import { LedgerEntry } from '../ledger'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The `ledger_entry` method returns a single ledger object from the XRP Ledger
+ * in its raw format. Expects a response in the form of a {@link
+ * LedgerEntryResponse}.
+ *
+ * @example
+ * ```ts
+ * const ledgerEntry: LedgerEntryRequest = {
+ *   command: "ledger_entry",
+ *   ledger_index: 60102302,
+ *   index: "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4"
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
+  command: 'ledger_entry'
+  /**
+   * Retrieve an Automated Market Maker (AMM) object from the ledger.
+   * This is similar to amm_info method, but the ledger_entry version returns only the ledger entry as stored.
+   */
+  amm?: {
+    asset: {
+      currency: string
+      issuer?: string
+    }
+    asset2: {
+      currency: string
+      issuer?: string
+    }
+  }
+
+  /**
+   * If true, return the requested ledger object's contents as a hex string in
+   * the XRP Ledger's binary format. Otherwise, return data in JSON format. The
+   * default is false.
+   */
+  binary?: boolean
+
+  /*
+   * Only one of the following properties should be defined in a single request
+   * https://xrpl.org/ledger_entry.html.
+   *
+   * Retrieve any type of ledger object by its unique ID.
+   */
+  index?: string
+
+  /**
+   * Retrieve an AccountRoot object by its address. This is roughly equivalent
+   * to the an {@link AccountInfoRequest}.
+   */
+  account_root?: string
+
+  /** The object ID of a Check object to retrieve. */
+  check?: string
+
+  /**
+   * Specify a DepositPreauth object to retrieve. If a string, must be the
+   * object ID of the DepositPreauth object, as hexadecimal. If an object,
+   * requires owner and authorized sub-fields.
+   */
+  deposit_preauth?:
+    | {
+        /** The account that provided the preauthorization. */
+        owner: string
+        /** The account that received the preauthorization. */
+        authorized: string
+      }
+    | string
+
+  /**
+   * Specify a DID object to retrieve. If a string, must be the
+   * object ID of the DID object, as hexadecimal, or the account ID.
+   */
+  did?: string
+
+  /**
+   * The DirectoryNode to retrieve. If a string, must be the object ID of the
+   * directory, as hexadecimal. If an object, requires either `dir_root` o
+   * Owner as a sub-field, plus optionally a `sub_index` sub-field.
+   */
+  directory?:
+    | {
+        /** If provided, jumps to a later "page" of the DirectoryNode. */
+        sub_index?: number
+        /** Unique index identifying the directory to retrieve, as a hex string. */
+        dir_root?: string
+        /** Unique address of the account associated with this directory. */
+        owner?: string
+      }
+    | string
+
+  /**
+   * The Escrow object to retrieve. If a string, must be the object ID of the
+   * escrow, as hexadecimal. If an object, requires owner and seq sub-fields.
+   */
+  escrow?:
+    | {
+        /** The owner (sender) of the Escrow object. */
+        owner: string
+        /** Sequence Number of the transaction that created the Escrow object. */
+        seq: number
+      }
+    | string
+
+  /**
+   * The Offer object to retrieve. If a string, interpret as the unique object
+   * ID to the Offer. If an object, requires the sub-fields `account` and `seq`
+   * to uniquely identify the offer.
+   */
+  offer?:
+    | {
+        /** The account that placed the offer. */
+        account: string
+        /** Sequence Number of the transaction that created the Offer object. */
+        seq: number
+      }
+    | string
+
+  /** The object ID of a PayChannel object to retrieve. */
+  payment_channel?: string
+
+  /**
+   * Object specifying the RippleState (trust line) object to retrieve. The
+   * accounts and currency sub-fields are required to uniquely specify the
+   * rippleState entry to retrieve.
+   */
+  ripple_state?: {
+    /**
+     * 2-length array of account Addresses, defining the two accounts linked by
+     * this RippleState object.
+     */
+    accounts: string[]
+    /** Currency Code of the RippleState object to retrieve. */
+    currency: string
+  }
+
+  /**
+   * The Ticket object to retrieve. If a string, must be the object ID of the
+   * Ticket, as hexadecimal. If an object, the `owner` and `ticket_sequence`
+   * sub-fields are required to uniquely specify the Ticket entry.
+   */
+  ticket?:
+    | {
+        /** The owner of the Ticket object. */
+        owner: string
+        /** The Ticket Sequence number of the Ticket entry to retrieve. */
+        ticket_sequence: number
+      }
+    | string
+
+  /**
+   * Must be the object ID of the NFToken page, as hexadecimal
+   */
+  nft_page?: string
+
+  bridge_account?: string
+
+  bridge?: XChainBridge
+
+  xchain_owned_claim_id?:
+    | {
+        locking_chain_door: string
+        locking_chain_issue: Currency
+        issuing_chain_door: string
+        issuing_chain_issue: Currency
+        xchain_owned_claim_id: string | number
+      }
+    | string
+
+  xchain_owned_create_account_claim_id?:
+    | {
+        locking_chain_door: string
+        locking_chain_issue: Currency
+        issuing_chain_door: string
+        issuing_chain_issue: Currency
+        xchain_owned_create_account_claim_id: string | number
+      }
+    | string
+}
+
+/**
+ * Response expected from a {@link LedgerEntryRequest}.
+ *
+ * @category Responses
+ */
+export interface LedgerEntryResponse<T = LedgerEntry> extends BaseResponse {
+  result: {
+    /** The unique ID of this ledger object. */
+    index: string
+    /** The ledger index of the ledger that was used when retrieving this data. */
+    ledger_current_index: number
+    /**
+     * Object containing the data of this ledger object, according to the
+     * ledger format.
+     */
+    node?: T
+    /** The binary representation of the ledger object, as hexadecimal. */
+    node_binary?: string
+    validated?: boolean
+  }
+}

package/src/models/methods/manifest.ts

@@ -0,0 +1,54 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+/**
+ * The `manifest` method reports the current "manifest" information for a given
+ * validator public key. The "manifest" is the public portion of that
+ * validator's configured token. Expects a response in the form of a {@link
+ * ManifestResponse}.
+ *
+ * @example
+ * ```ts
+ * const manifest: ManifestRequest = {
+ *  "command": "manifest",
+ *  "public_key": "nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsfkezhhda3p"
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface ManifestRequest extends BaseRequest {
+  command: 'manifest'
+  /**
+   * The base58-encoded public key of the validator to look up. This can be the
+   * master public key or ephemeral public key.
+   */
+  public_key: string
+}
+
+/**
+ * Response expected from a {@link ManifestRequest}.
+ *
+ * @category Responses
+ */
+export interface ManifestResponse extends BaseResponse {
+  result: {
+    /**
+     * The data contained in this manifest. Omitted if the server does not have
+     *  A manifest for the public_key from the request.
+     */
+    details?: {
+      domain: string
+      ephemeral_key: string
+      master_key: string
+      seq: number
+    }
+    /**
+     * The full manifest data in base64 format. This data is serialized to
+     * binary before being base64-encoded. Omitted if the server does not have a
+     * manifest for the public_key from the request.
+     */
+    manifest?: string
+    /** The public_key from the request. */
+    requested: string
+  }
+}

package/src/models/methods/nftBuyOffers.ts

@@ -0,0 +1,37 @@
+import { NFTOffer } from '../common'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The `nft_buy_offers` method retrieves all of buy offers for the specified
+ * NFToken.
+ *
+ * @category Requests
+ */
+export interface NFTBuyOffersRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'nft_buy_offers'
+  /**
+   * The unique identifier of an NFToken. The request returns buy offers for this NFToken.
+   */
+  nft_id: string
+}
+
+/**
+ * Response expected from an {@link NFTBuyOffersRequest}.
+ *
+ * @category Responses
+ */
+export interface NFTBuyOffersResponse extends BaseResponse {
+  result: {
+    /**
+     * A list of buy offers for the specified NFToken.
+     */
+    offers: NFTOffer[]
+    /**
+     * The token ID of the NFToken to which these offers pertain.
+     */
+    nft_id: string
+  }
+}