xrpl 3.0.0 → 4.0.0

package/src/models/methods/accountChannels.ts

@@ -1,17 +1,80 @@
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
 
+/**
+ * Represents a payment channel in the XRP Ledger.
+ */
 export interface Channel {
+  /** The owner of the channel, as an Address. */
   account: string
+
+  /** The total amount of XRP, in drops allocated to this channel. */
   amount: string
+
+  /**
+   * The total amount of XRP, in drops, paid out from this channel,
+   * as of the ledger version used. (You can calculate the amount of
+   * XRP left in the channel by subtracting balance from amount.)
+   */
   balance: string
+
+  /**
+   * A unique ID for this channel, as a 64-character hexadecimal string.
+   * This is also the ID of the channel object in the ledger's state data.
+   */
   channel_id: string
+
+  /**
+   * The destination account of the channel, as an Address.
+   * Only this account can receive the XRP in the channel while it is open.
+   */
   destination_account: string
+
+  /**
+   * The number of seconds the payment channel must stay open after the owner
+   * of the channel requests to close it.
+   */
   settle_delay: number
+
+  /**
+   * The public key for the payment channel in the XRP Ledger's base58 format.
+   * Signed claims against this channel must be redeemed with the matching key pair.
+   */
   public_key?: string
+
+  /**
+   * The public key for the payment channel in hexadecimal format, if one was
+   * specified at channel creation. Signed claims against this channel must be
+   * redeemed with the matching key pair.
+   */
   public_key_hex?: string
+
+  /**
+   * Time, in seconds since the Ripple Epoch, when this channel is set to expire.
+   * This expiration date is mutable. If this is before the close time of the most
+   * recent validated ledger, the channel is expired.
+   */
   expiration?: number
+
+  /**
+   * Time, in seconds since the Ripple Epoch, of this channel's immutable expiration,
+   * if one was specified at channel creation. If this is before the close time of the
+   * most recent validated ledger, the channel is expired.
+   */
   cancel_after?: number
-  source_tab?: number
+
+  /**
+   * A 32-bit unsigned integer to use as a source tag for payments through this payment channel,
+   * if one was specified at channel creation. This indicates the payment channel's originator or
+   * other purpose at the source account. Conventionally, if you bounce payments from this channel,
+   * you should specify this value in the DestinationTag of the return payment.
+   */
+  source_tag?: number
+
+  /**
+   * A 32-bit unsigned integer to use as a destination tag for payments through this channel,
+   * if one was specified at channel creation. This indicates the payment channel's beneficiary
+   * or other purpose at the destination account.
+   */
   destination_tag?: number
 }
 

package/src/models/methods/accountInfo.ts

@@ -1,3 +1,4 @@
+import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
 import { AccountRoot, SignerList } from '../ledger'
 
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
@@ -133,23 +134,13 @@ export interface AccountInfoAccountFlags {
   allowTrustLineClawback: boolean
 }
 
-/**
- * Response expected from an {@link AccountInfoRequest}.
- *
- * @category Responses
- */
-export interface AccountInfoResponse extends BaseResponse {
+interface BaseAccountInfoResponse 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[] }
-
+    account_data: AccountRoot
     /**
      * A map of account flags parsed out.  This will only be available for rippled nodes 1.11.0 and higher.
      */
@@ -180,3 +171,58 @@ export interface AccountInfoResponse extends BaseResponse {
     validated?: boolean
   }
 }
+
+/**
+ * Response expected from a {@link AccountInfoRequest}.
+ *
+ * @category Responses
+ */
+export interface AccountInfoResponse extends BaseAccountInfoResponse {
+  result: BaseAccountInfoResponse['result'] & {
+    /**
+     * If requested, 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.
+     */
+    signer_lists?: SignerList[]
+  }
+}
+
+/**
+ * Response expected from a {@link AccountInfoRequest} using API version 1.
+ *
+ * @category ResponsesV1
+ */
+export interface AccountInfoV1Response extends BaseAccountInfoResponse {
+  result: BaseAccountInfoResponse['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: BaseAccountInfoResponse['result']['account_data'] & {
+      /**
+       * 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.
+       * Quirk: In API version 1, this field is nested under account_data. For this method,
+       * Clio implements the API version 2 behavior where is field is not nested under account_data.
+       */
+      signer_lists?: SignerList[]
+    }
+  }
+}
+
+/**
+ * Type to map between the API version and the response type.
+ *
+ * @category Responses
+ */
+export type AccountInfoVersionResponseMap<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Version extends typeof RIPPLED_API_V1
+  ? AccountInfoV1Response
+  : AccountInfoResponse

package/src/models/methods/accountTx.ts

@@ -1,4 +1,10 @@
-import { ResponseOnlyTxInfo } from '../common'
+import {
+  APIVersion,
+  DEFAULT_API_VERSION,
+  RIPPLED_API_V1,
+  RIPPLED_API_V2,
+  ResponseOnlyTxInfo,
+} from '../common'
 import { Transaction, TransactionMetadata } from '../transactions'
 
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
@@ -49,7 +55,9 @@ export interface AccountTxRequest extends BaseRequest, LookupByLedgerRequest {
   marker?: unknown
 }
 
-export interface AccountTxTransaction {
+export interface AccountTxTransaction<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> {
   /** The ledger index of the ledger version that included this transaction. */
   ledger_index: number
   /**
@@ -58,7 +66,15 @@ export interface AccountTxTransaction {
    */
   meta: string | TransactionMetadata
   /** JSON object defining the transaction. */
-  tx?: Transaction & ResponseOnlyTxInfo
+  tx_json?: Version extends typeof RIPPLED_API_V2
+    ? Transaction & ResponseOnlyTxInfo
+    : never
+  /** JSON object defining the transaction in rippled API v1. */
+  tx?: Version extends typeof RIPPLED_API_V1
+    ? Transaction & ResponseOnlyTxInfo
+    : never
+  /** The hash of the transaction. */
+  hash?: Version extends typeof RIPPLED_API_V2 ? string : never
   /** Unique hashed String representing the transaction. */
   tx_blob?: string
   /**
@@ -69,11 +85,11 @@ export interface AccountTxTransaction {
 }
 
 /**
- * Expected response from an {@link AccountTxRequest}.
- *
- * @category Responses
+ * Base interface for account transaction responses.
  */
-export interface AccountTxResponse extends BaseResponse {
+interface AccountTxResponseBase<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends BaseResponse {
   result: {
     /** Unique Address identifying the related account. */
     account: string
@@ -98,7 +114,7 @@ export interface AccountTxResponse extends BaseResponse {
      * Array of transactions matching the request's criteria, as explained
      * below.
      */
-    transactions: AccountTxTransaction[]
+    transactions: Array<AccountTxTransaction<Version>>
     /**
      * If included and set to true, the information in this response comes from
      * a validated ledger version. Otherwise, the information is subject to
@@ -107,3 +123,28 @@ export interface AccountTxResponse extends BaseResponse {
     validated?: boolean
   }
 }
+
+/**
+ * Expected response from an {@link AccountTxRequest}.
+ *
+ * @category Responses
+ */
+export type AccountTxResponse = AccountTxResponseBase
+
+/**
+ * Expected response from an {@link AccountTxRequest} with `api_version` set to 1.
+ *
+ * @category ResponsesV1
+ */
+export type AccountTxV1Response = AccountTxResponseBase<typeof RIPPLED_API_V1>
+
+/**
+ * Type to map between the API version and the response type.
+ *
+ * @category Responses
+ */
+export type AccountTxVersionResponseMap<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Version extends typeof RIPPLED_API_V1
+  ? AccountTxV1Response
+  : AccountTxResponse

package/src/models/methods/feature.ts

@@ -0,0 +1,68 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+export interface FeatureAllRequest extends BaseRequest {
+  command: 'feature'
+
+  feature?: never
+}
+
+export interface FeatureOneRequest extends BaseRequest {
+  command: 'feature'
+
+  feature: string
+}
+
+/**
+ * The `feature` command returns information about amendments this server knows about, including whether they are enabled.
+ * Returns an {@link FeatureResponse}.
+ *
+ * @category Requests
+ */
+export type FeatureRequest = FeatureAllRequest | FeatureOneRequest
+
+export interface FeatureAllResponse extends BaseResponse {
+  result: {
+    features: Record<
+      string,
+      {
+        /*
+         * Whether this amendment is currently enabled in the latest ledger.
+         */
+        enabled: boolean
+
+        /*
+         * The human-readable name for this amendment, if known.
+         */
+        name: string
+
+        supported: boolean
+      }
+    >
+  }
+}
+
+export interface FeatureOneResponse extends BaseResponse {
+  result: Record<
+    string,
+    {
+      /*
+       * Whether this amendment is currently enabled in the latest ledger.
+       */
+      enabled: boolean
+
+      /*
+       * The human-readable name for this amendment, if known.
+       */
+      name: string
+
+      supported: boolean
+    }
+  >
+}
+
+/**
+ * Response expected from an {@link FeatureRequest}.
+ *
+ * @category Responses
+ */
+export type FeatureResponse = FeatureAllResponse | FeatureOneResponse

package/src/models/methods/getAggregatePrice.ts

@@ -0,0 +1,119 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+/**
+ * The `get_aggregate_price` method retrieves the aggregate price of specified Oracle objects,
+ * returning three price statistics: mean, median, and trimmed mean.
+ * Returns an {@link GetAggregatePriceResponse}.
+ *
+ * @category Requests
+ */
+export interface GetAggregatePriceRequest extends BaseRequest {
+  command: 'get_aggregate_price'
+
+  /**
+   * The currency code of the asset to be priced.
+   */
+  base_asset: string
+
+  /**
+   * The currency code of the asset to quote the price of the base asset.
+   */
+  quote_asset: string
+
+  /**
+   * The oracle identifier.
+   */
+  oracles: Array<{
+    /**
+     * The XRPL account that controls the Oracle object.
+     */
+    account: string
+
+    /**
+     * A unique identifier of the price oracle for the Account
+     */
+    oracle_document_id: string | number
+  }>
+
+  /**
+   * The percentage of outliers to trim. Valid trim range is 1-25. If included, the API returns statistics for the trimmed mean.
+   */
+  trim?: number
+
+  /**
+   * Defines a time range in seconds for filtering out older price data. Default value is 0, which doesn't filter any data.
+   */
+  trim_threshold?: number
+}
+
+/**
+ * Response expected from an {@link GetAggregatePriceRequest}.
+ *
+ * @category Responses
+ */
+export interface GetAggregatePriceResponse extends BaseResponse {
+  result: {
+    /**
+     * The statistics from the collected oracle prices.
+     */
+    entire_set: {
+      /**
+       * The simple mean.
+       */
+      mean: string
+
+      /**
+       * The size of the data set to calculate the mean.
+       */
+      size: number
+
+      /**
+       * The standard deviation.
+       */
+      standard_deviation: string
+    }
+
+    /**
+     * The trimmed statistics from the collected oracle prices. Only appears if the trim field was specified in the request.
+     */
+    trimmed_set?: {
+      /**
+       * The simple mean of the trimmed data.
+       */
+      mean: string
+
+      /**
+       * The size of the data to calculate the trimmed mean.
+       */
+      size: number
+
+      /**
+       * The standard deviation of the trimmed data.
+       */
+      standard_deviation: string
+    }
+
+    /**
+     * The median of the collected oracle prices.
+     */
+    median: string
+
+    /**
+     * The most recent timestamp out of all LastUpdateTime values.
+     */
+    time: number
+
+    /**
+     * The ledger index of the ledger version that was used to generate this
+     * response.
+     */
+    ledger_current_index: number
+
+    /**
+     * 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
+  }
+}