xrpl 2.10.0 → 2.12.0-beta.0

package/src/models/methods/gatewayBalances.ts

@@ -0,0 +1,85 @@
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The gateway_balances command calculates the total balances issued by a given
+ * account, optionally excluding amounts held by operational addresses. Expects
+ * a response in the form of a {@link GatewayBalancesResponse}.
+ *
+ * @example
+ * ```ts
+ * const gatewayBalances: GatewayBalanceRequest = {
+ *   "id": "example_gateway_balances_1",
+ *   "command": "gateway_balances",
+ *   "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
+ *   "strict": true,
+ *   "hotwallet": ["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],
+ *   "ledger_index": "validated"
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface GatewayBalancesRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'gateway_balances'
+  /** The Address to check. This should be the issuing address. */
+  account: string
+  /**
+   * If true, only accept an address or public key for the account parameter.
+   * Defaults to false.
+   */
+  strict?: boolean
+  /**
+   * An operational address to exclude from the balances issued, or an array of
+   * Such addresses.
+   */
+  hotwallet?: string | string[]
+}
+
+export interface GatewayBalance {
+  currency: string
+  value: string
+}
+
+/**
+ * Expected response from a {@link GatewayBalancesRequest}.
+ *
+ * @category Responses
+ */
+export interface GatewayBalancesResponse extends BaseResponse {
+  result: {
+    /** The address of the account that issued the balances. */
+    account: string
+    /**
+     * Total amounts issued to addresses not excluded, as a map of currencies
+     * to the total value issued.
+     */
+    obligations?: { [currency: string]: string }
+    /**
+     * Amounts issued to the hotwallet addresses from the request. The keys are
+     * addresses and the values are arrays of currency amounts they hold.
+     */
+    balances?: { [address: string]: GatewayBalance[] }
+    /**
+     * Total amounts held that are issued by others. In the recommended
+     * configuration, the issuing address should have none.
+     */
+    assets?: { [address: string]: GatewayBalance[] }
+    /**
+     * The identifying hash of the ledger version 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_current_index?: number
+    /**
+     * The ledger index of the current in-progress ledger version, which was
+     * used to retrieve this information.
+     */
+    ledger_index?: number
+  }
+}

package/src/models/methods/index.ts

@@ -0,0 +1,391 @@
+/* eslint-disable max-lines -- There is a lot to export */
+import {
+  AccountChannelsRequest,
+  AccountChannelsResponse,
+  Channel,
+} from './accountChannels'
+import {
+  AccountCurrenciesRequest,
+  AccountCurrenciesResponse,
+} from './accountCurrencies'
+import {
+  AccountInfoAccountFlags,
+  AccountInfoRequest,
+  AccountInfoResponse,
+  AccountQueueData,
+  AccountQueueTransaction,
+} from './accountInfo'
+import {
+  AccountLinesRequest,
+  AccountLinesResponse,
+  AccountLinesTrustline,
+} from './accountLines'
+import {
+  AccountNFToken,
+  AccountNFTsRequest,
+  AccountNFTsResponse,
+} from './accountNFTs'
+import {
+  AccountObject,
+  AccountObjectsRequest,
+  AccountObjectsResponse,
+  AccountObjectType,
+} from './accountObjects'
+import {
+  AccountOffer,
+  AccountOffersRequest,
+  AccountOffersResponse,
+} from './accountOffers'
+import {
+  AccountTxRequest,
+  AccountTxResponse,
+  AccountTxTransaction,
+} from './accountTx'
+import { AMMInfoRequest, AMMInfoResponse } from './ammInfo'
+import {
+  BaseRequest,
+  BaseResponse,
+  ErrorResponse,
+  ResponseWarning,
+} from './baseMethod'
+import {
+  BookOffersRequest,
+  BookOffer,
+  BookOffersResponse,
+  BookOfferCurrency,
+} from './bookOffers'
+import { ChannelVerifyRequest, ChannelVerifyResponse } from './channelVerify'
+import {
+  DepositAuthorizedRequest,
+  DepositAuthorizedResponse,
+} from './depositAuthorized'
+import { FeeRequest, FeeResponse } from './fee'
+import {
+  GatewayBalance,
+  GatewayBalancesRequest,
+  GatewayBalancesResponse,
+} from './gatewayBalances'
+import {
+  LedgerBinary,
+  LedgerModifiedOfferCreateTransaction,
+  LedgerQueueData,
+  LedgerRequest,
+  LedgerResponse,
+} from './ledger'
+import { LedgerClosedRequest, LedgerClosedResponse } from './ledgerClosed'
+import { LedgerCurrentRequest, LedgerCurrentResponse } from './ledgerCurrent'
+import {
+  LedgerDataBinaryLedgerEntry,
+  LedgerDataLabeledLedgerEntry,
+  LedgerDataLedgerState,
+  LedgerDataRequest,
+  LedgerDataResponse,
+} from './ledgerData'
+import { LedgerEntryRequest, LedgerEntryResponse } from './ledgerEntry'
+import { ManifestRequest, ManifestResponse } from './manifest'
+import { NFTBuyOffersRequest, NFTBuyOffersResponse } from './nftBuyOffers'
+import {
+  NFTHistoryRequest,
+  NFTHistoryResponse,
+  NFTHistoryTransaction,
+} from './nftHistory'
+import { NFTInfoRequest, NFTInfoResponse } from './nftInfo'
+import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers'
+import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck'
+import {
+  PathFindRequest,
+  PathFindCloseRequest,
+  PathFindCreateRequest,
+  PathFindStatusRequest,
+  PathFindResponse,
+  PathFindPathOption,
+} from './pathFind'
+import { PingRequest, PingResponse } from './ping'
+import { RandomRequest, RandomResponse } from './random'
+import {
+  RipplePathFindPathOption,
+  RipplePathFindRequest,
+  RipplePathFindResponse,
+  SourceCurrencyAmount,
+} from './ripplePathFind'
+import {
+  JobType,
+  ServerInfoRequest,
+  ServerInfoResponse,
+  ServerState,
+  StateAccounting,
+  StateAccountingFinal,
+} from './serverInfo'
+import { ServerStateRequest, ServerStateResponse } from './serverState'
+import { SubmitRequest, SubmitResponse } from './submit'
+import {
+  SubmitMultisignedRequest,
+  SubmitMultisignedResponse,
+} from './submitMultisigned'
+import {
+  BooksSnapshot,
+  ConsensusStream,
+  LedgerStream,
+  LedgerStreamResponse,
+  OrderBookStream,
+  PathFindStream,
+  PeerStatusStream,
+  Stream,
+  SubscribeBook,
+  SubscribeRequest,
+  SubscribeResponse,
+  TransactionStream,
+  ValidationStream,
+} from './subscribe'
+import {
+  TransactionEntryRequest,
+  TransactionEntryResponse,
+} from './transactionEntry'
+import { TxRequest, TxResponse } from './tx'
+import {
+  UnsubscribeBook,
+  UnsubscribeRequest,
+  UnsubscribeResponse,
+} from './unsubscribe'
+/**
+ * @category Requests
+ */
+type Request =
+  // account methods
+  | AccountChannelsRequest
+  | AccountCurrenciesRequest
+  | AccountInfoRequest
+  | AccountLinesRequest
+  | AccountNFTsRequest
+  | AccountObjectsRequest
+  | AccountOffersRequest
+  | AccountTxRequest
+  | GatewayBalancesRequest
+  | NoRippleCheckRequest
+  // ledger methods
+  | LedgerRequest
+  | LedgerClosedRequest
+  | LedgerCurrentRequest
+  | LedgerDataRequest
+  | LedgerEntryRequest
+  // transaction methods
+  | SubmitRequest
+  | SubmitMultisignedRequest
+  | TransactionEntryRequest
+  | TxRequest
+  // path and order book methods
+  | BookOffersRequest
+  | DepositAuthorizedRequest
+  | PathFindRequest
+  | RipplePathFindRequest
+  // payment channel methods
+  | ChannelVerifyRequest
+  // subscription methods
+  | SubscribeRequest
+  | UnsubscribeRequest
+  // server info methods
+  | FeeRequest
+  | ManifestRequest
+  | ServerInfoRequest
+  | ServerStateRequest
+  // utility methods
+  | PingRequest
+  | RandomRequest
+  // NFT methods
+  | NFTBuyOffersRequest
+  | NFTSellOffersRequest
+  // clio only methods
+  | NFTInfoRequest
+  | NFTHistoryRequest
+  // AMM methods
+  | AMMInfoRequest
+
+/**
+ * @category Responses
+ */
+type Response =
+  // account methods
+  | AccountChannelsResponse
+  | AccountCurrenciesResponse
+  | AccountInfoResponse
+  | AccountLinesResponse
+  | AccountNFTsResponse
+  | AccountObjectsResponse
+  | AccountOffersResponse
+  | AccountTxResponse
+  | GatewayBalancesResponse
+  | NoRippleCheckResponse
+  // ledger methods
+  | LedgerResponse
+  | LedgerClosedResponse
+  | LedgerCurrentResponse
+  | LedgerDataResponse
+  | LedgerEntryResponse
+  // transaction methods
+  | SubmitResponse
+  | SubmitMultisignedResponse
+  | TransactionEntryResponse
+  | TxResponse
+  // path and order book methods
+  | BookOffersResponse
+  | DepositAuthorizedResponse
+  | PathFindResponse
+  | RipplePathFindResponse
+  // payment channel methods
+  | ChannelVerifyResponse
+  // subscription methods
+  | SubscribeResponse
+  | UnsubscribeResponse
+  // server info methods
+  | FeeResponse
+  | ManifestResponse
+  | ServerInfoResponse
+  | ServerStateResponse
+  // utility methods
+  | PingResponse
+  | RandomResponse
+  // NFT methods
+  | NFTBuyOffersResponse
+  | NFTSellOffersResponse
+  // clio only methods
+  | NFTInfoResponse
+  | NFTHistoryResponse
+  // AMM methods
+  | AMMInfoResponse
+
+export {
+  // Allow users to define their own requests and responses.  This is useful for releasing experimental versions
+  BaseRequest,
+  BaseResponse,
+  Request,
+  Response,
+  ResponseWarning,
+  // account methods with types
+  Channel,
+  AccountChannelsRequest,
+  AccountChannelsResponse,
+  AccountCurrenciesRequest,
+  AccountCurrenciesResponse,
+  AccountInfoAccountFlags,
+  AccountInfoRequest,
+  AccountInfoResponse,
+  AccountQueueData,
+  AccountQueueTransaction,
+  AccountLinesRequest,
+  AccountLinesResponse,
+  AccountLinesTrustline,
+  AccountNFToken,
+  AccountNFTsRequest,
+  AccountNFTsResponse,
+  AccountObject,
+  AccountObjectType,
+  AccountObjectsRequest,
+  AccountObjectsResponse,
+  AccountOffer,
+  AccountOffersRequest,
+  AccountOffersResponse,
+  AccountTxRequest,
+  AccountTxResponse,
+  AccountTxTransaction,
+  GatewayBalance,
+  GatewayBalancesRequest,
+  GatewayBalancesResponse,
+  NoRippleCheckRequest,
+  NoRippleCheckResponse,
+  // ledger methods
+  LedgerRequest,
+  LedgerResponse,
+  LedgerQueueData,
+  LedgerBinary,
+  LedgerModifiedOfferCreateTransaction,
+  LedgerClosedRequest,
+  LedgerClosedResponse,
+  LedgerCurrentRequest,
+  LedgerCurrentResponse,
+  LedgerDataRequest,
+  LedgerDataLabeledLedgerEntry,
+  LedgerDataBinaryLedgerEntry,
+  LedgerDataResponse,
+  LedgerDataLedgerState,
+  LedgerEntryRequest,
+  LedgerEntryResponse,
+  // transaction methods with types
+  SubmitRequest,
+  SubmitResponse,
+  SubmitMultisignedRequest,
+  SubmitMultisignedResponse,
+  TransactionEntryRequest,
+  TransactionEntryResponse,
+  TxRequest,
+  TxResponse,
+  // path and order book methods with types
+  BookOffersRequest,
+  BookOffer,
+  BookOfferCurrency,
+  BookOffersResponse,
+  DepositAuthorizedRequest,
+  DepositAuthorizedResponse,
+  PathFindRequest,
+  PathFindCreateRequest,
+  PathFindCloseRequest,
+  PathFindPathOption,
+  PathFindStatusRequest,
+  PathFindResponse,
+  RipplePathFindPathOption,
+  RipplePathFindRequest,
+  RipplePathFindResponse,
+  SourceCurrencyAmount,
+  // payment channel methods
+  ChannelVerifyRequest,
+  ChannelVerifyResponse,
+  // Subscribe methods/streams with types
+  SubscribeRequest,
+  SubscribeResponse,
+  SubscribeBook,
+  Stream,
+  BooksSnapshot,
+  LedgerStream,
+  LedgerStreamResponse,
+  ValidationStream,
+  TransactionStream,
+  PathFindStream,
+  PeerStatusStream,
+  OrderBookStream,
+  ConsensusStream,
+  UnsubscribeRequest,
+  UnsubscribeResponse,
+  UnsubscribeBook,
+  // server info methods with types
+  FeeRequest,
+  FeeResponse,
+  ManifestRequest,
+  ManifestResponse,
+  ServerInfoRequest,
+  ServerInfoResponse,
+  ServerStateRequest,
+  ServerStateResponse,
+  JobType,
+  ServerState,
+  StateAccountingFinal,
+  StateAccounting,
+  // utility methods
+  PingRequest,
+  PingResponse,
+  RandomRequest,
+  RandomResponse,
+  ErrorResponse,
+  // NFT methods
+  NFTBuyOffersRequest,
+  NFTBuyOffersResponse,
+  NFTSellOffersRequest,
+  NFTSellOffersResponse,
+  // clio only methods
+  NFTInfoRequest,
+  NFTInfoResponse,
+  NFTHistoryRequest,
+  NFTHistoryResponse,
+  NFTHistoryTransaction,
+  // AMM methods
+  AMMInfoRequest,
+  AMMInfoResponse,
+}

package/src/models/methods/ledger.ts

@@ -0,0 +1,125 @@
+import { Ledger } from '../ledger'
+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
+}
+
+/**
+ * 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[]
+}
+
+/**
+ * Response expected from a {@link LedgerRequest}.
+ *
+ * @category Responses
+ */
+export interface LedgerResponse extends BaseResponse {
+  result: {
+    /** The complete header data of this {@link Ledger}. */
+    ledger: Ledger | LedgerBinary
+    /** 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
+  }
+}

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
+  }
+}