feat: add Price Oracles support

.ci-config/rippled.cfg

@@ -170,3 +170,11 @@ fixNFTokenRemint
 # 2.0.0 Amendments
 XChainBridge
 DID
+# 2.2.0-b3 Amendments
+fixNFTokenReserve
+fixInnerObjTemplate
+fixAMMOverflowOffer
+PriceOracle
+fixEmptyDID
+fixXChainRewardRounding
+fixPreviousTxnID

.github/workflows/nodejs.yml

@@ -4,7 +4,7 @@
 name: Node.js CI
 
 env:
-  RIPPLED_DOCKER_IMAGE: rippleci/rippled:2.0.0-b4
+  RIPPLED_DOCKER_IMAGE: rippleci/rippled:2.2.0-b3
 
 on:
   push:

CONTRIBUTING.md

@@ -90,7 +90,7 @@ This should be run from the `xrpl.js` top level folder (one above the `packages`
 ```bash
 npm run build
 # sets up the rippled standalone Docker container - you can skip this step if you already have it set up
-docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/opt/ripple/etc/ --platform linux/amd64 rippleci/rippled:2.0.0-b3 /opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg
+docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/opt/ripple/etc/ --platform linux/amd64 rippleci/rippled:2.2.0-b3 /opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg
 npm run test:browser
 ```
 

packages/ripple-binary-codec/HISTORY.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Added
+* Support for the Price Oracles amendment (XLS-47).
+
 ## 2.0.0 (2024-02-01)
 
 ### BREAKING CHANGES

packages/ripple-binary-codec/src/enums/definitions.json

@@ -23,6 +23,7 @@
     "UInt512": 23,
     "Issue": 24,
     "XChainBridge": 25,
+    "Currency": 26,
     "Transaction": 10001,
     "LedgerEntry": 10002,
     "Validation": 10003,
@@ -51,6 +52,7 @@
     "NFTokenOffer": 55,
     "AMM": 121,
     "DID": 73,
+    "Oracle": 128,
     "Any": -3,
     "Child": -2,
     "Nickname": 110,
@@ -208,6 +210,16 @@
         "type": "UInt8"
       }
     ],
+    [
+      "Scale",
+      {
+        "nth": 4,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt8"
+      }
+    ],
     [
       "TickSize",
       {
@@ -498,6 +510,16 @@
         "type": "UInt32"
       }
     ],
+    [
+      "LastUpdateTime",
+      {
+        "nth": 15,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
     [
       "HighQualityIn",
       {
@@ -828,6 +850,16 @@
         "type": "UInt32"
       }
     ],
+    [
+      "OracleDocumentID",
+      {
+        "nth": 51,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
     [
       "IndexNext",
       {
@@ -1028,6 +1060,16 @@
         "type": "UInt64"
       }
     ],
+    [
+      "AssetPrice",
+      {
+        "nth": 23,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt64"
+      }
+    ],
     [
       "EmailHash",
       {
@@ -1918,6 +1960,26 @@
         "type": "Blob"
       }
     ],
+    [
+      "AssetClass",
+      {
+        "nth": 28,
+        "isVLEncoded": true,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Blob"
+      }
+    ],
+    [
+      "Provider",
+      {
+        "nth": 29,
+        "isVLEncoded": true,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Blob"
+      }
+    ],
     [
       "Account",
       {
@@ -2128,6 +2190,26 @@
         "type": "PathSet"
       }
     ],
+    [
+      "BaseAsset",
+      {
+        "nth": 1,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Currency"
+      }
+    ],
+    [
+      "QuoteAsset",
+      {
+        "nth": 2,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Currency"
+      }
+    ],
     [
       "LockingChainIssue",
       {
@@ -2458,6 +2540,16 @@
         "type": "STObject"
       }
     ],
+    [
+      "PriceData",
+      {
+        "nth": 32,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "STObject"
+      }
+    ],
     [
       "Signers",
       {
@@ -2628,6 +2720,16 @@
         "type": "STArray"
       }
     ],
+    [
+      "PriceDataSeries",
+      {
+        "nth": 24,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "STArray"
+      }
+    ],
     [
       "AuthAccounts",
       {
@@ -2656,6 +2758,7 @@
     "telWRONG_NETWORK": -386,
     "telREQUIRES_NETWORK_ID": -385,
     "telNETWORK_ID_MAKES_TX_NON_CANONICAL": -384,
+    "telENV_RPC_FAILED": -383,
 
     "temMALFORMED": -299,
     "temBAD_AMOUNT": -298,
@@ -2703,6 +2806,8 @@
     "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256,
     "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
     "temEMPTY_DID": -254,
+    "temARRAY_EMPTY": -253,
+    "temARRAY_TOO_LARGE": -252,
 
     "tefFAILURE": -199,
     "tefALREADY": -198,
@@ -2739,7 +2844,6 @@
     "terQUEUED": -89,
     "terPRE_TICKET": -88,
     "terNO_AMM": -87,
-    "terSUBMITTED": -86,
 
     "tesSUCCESS": 0,
 
@@ -2815,7 +2919,11 @@
     "tecXCHAIN_SELF_COMMIT": 184,
     "tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 185,
     "tecXCHAIN_CREATE_ACCOUNT_DISABLED": 186,
-    "tecEMPTY_DID": 187
+    "tecEMPTY_DID": 187,
+    "tecINVALID_UPDATE_TIME": 188,
+    "tecTOKEN_PAIR_NOT_FOUND": 189,
+    "tecARRAY_EMPTY": 190,
+    "tecARRAY_TOO_LARGE": 191
   },
   "TRANSACTION_TYPES": {
     "Invalid": -1,
@@ -2864,6 +2972,8 @@
     "XChainCreateBridge": 48,
     "DIDSet": 49,
     "DIDDelete": 50,
+    "OracleSet": 51,
+    "OracleDelete": 52,
     "EnableAmendment": 100,
     "SetFee": 101,
     "UNLModify": 102

packages/xrpl/HISTORY.md

@@ -6,6 +6,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 ### BREAKING CHANGES
 * Small fix in the API to use a new flag name `tfNoDirectRipple` instead of the existing flag name `tfNoRippleDirect`
 
+### Added
+* Support for the Price Oracles amendment (XLS-47).
+
 ### Fixed
 * Typo in `Channel` type `source_tab` -> `source_tag`
 * Fix `client.requestAll` to handle filters better

packages/xrpl/src/models/methods/getAggregatePrice.ts

@@ -0,0 +1,69 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+export interface Oracle {
+  account: string
+  oracle_document_id: number
+}
+
+/**
+ * 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'
+
+  base_asset: string
+
+  quote_asset: string
+
+  oracles: Oracle[]
+
+  trim?: number
+
+  trim_threshold?: number
+}
+
+/**
+ * Response expected from an {@link GetAggregatePriceRequest}.
+ *
+ * @category Responses
+ */
+export interface GetAggregatePriceResponse extends BaseResponse {
+  result: {
+    entire_set: {
+      mean: string
+      size: number
+      standard_deviation: number
+    }
+
+    trimmed_set: {
+      mean: string
+      size: number
+      standard_deviation: number
+    }
+
+    time: number
+
+    /**
+     * 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
+
+    /**
+     * 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
+  }
+}

packages/xrpl/src/models/methods/index.ts

@@ -66,6 +66,10 @@ import {
   GatewayBalancesRequest,
   GatewayBalancesResponse,
 } from './gatewayBalances'
+import {
+  GetAggregatePriceRequest,
+  GetAggregatePriceResponse,
+} from './getAggregatePrice'
 import {
   LedgerBinary,
   LedgerModifiedOfferCreateTransaction,
@@ -210,6 +214,8 @@ type Request =
   | NFTHistoryRequest
   // AMM methods
   | AMMInfoRequest
+  // Price Oracle methods
+  | GetAggregatePriceRequest
 
 /**
  * @category Responses
@@ -264,6 +270,8 @@ type Response =
   | NFTHistoryResponse
   // AMM methods
   | AMMInfoResponse
+  // Price Oracle methods
+  | GetAggregatePriceResponse
 
 export type RequestResponseMap<T> = T extends AccountChannelsRequest
   ? AccountChannelsResponse
@@ -285,6 +293,8 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
   ? AMMInfoResponse
   : T extends GatewayBalancesRequest
   ? GatewayBalancesResponse
+  : T extends GetAggregatePriceRequest
+  ? GetAggregatePriceResponse
   : T extends NoRippleCheckRequest
   ? NoRippleCheckResponse
   : // NOTE: The order of these LedgerRequest types is important
@@ -473,6 +483,8 @@ export {
   GatewayBalance,
   GatewayBalancesRequest,
   GatewayBalancesResponse,
+  GetAggregatePriceRequest,
+  GetAggregatePriceResponse,
   NoRippleCheckRequest,
   NoRippleCheckResponse,
   // ledger methods

packages/xrpl/src/models/transactions/index.ts

@@ -58,6 +58,8 @@ export {
   OfferCreateFlagsInterface,
   OfferCreate,
 } from './offerCreate'
+export { OracleDelete } from './oracleDelete'
+export { OracleSet } from './oracleSet'
 export { PaymentFlags, PaymentFlagsInterface, Payment } from './payment'
 export {
   PaymentChannelClaimFlags,