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).
+
 ### Fixed
 * Better error handling/error messages for serialization/deserialization errors.
 

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/ripple-binary-codec/test/fixtures/codec-fixtures.json

@@ -4868,6 +4868,36 @@
         "TxnSignature": "AACD31A04CAE14670FC483A1382F393AA96B49C84479B58067F049FBD772999325667A6AA2520A63756EE84F3657298815019DD56A1AECE796B08535C4009C08",
         "URI": "6469645F6578616D706C65"
       }
+    },
+    {
+      "binary": "1200332FFFFFFFFF2033000004D2750B6469645F6578616D706C65701C0863757272656E6379701D0870726F7669646572811401476926B590BA3245F63C829116A0A3AF7F382DF018E020301700000000000001E2041003011A0000000000000000000000000000000000000000021A0000000000000000000000005553440000000000E1F1",
+      "json": {
+        "TransactionType": "OracleSet",
+        "Account": "rfmDuhDyLGgx94qiwf3YF8BUV5j6KSvE8",
+        "OracleDocumentID": 1234,
+        "LastUpdateTime": 4294967295,
+        "PriceDataSeries": [
+          {
+            "PriceData": {
+              "BaseAsset": "XRP",
+              "QuoteAsset": "USD",
+              "AssetPrice": "00000000000001E2",
+              "Scale": 3
+            }
+          }
+        ],
+        "Provider": "70726F7669646572",
+        "URI": "6469645F6578616D706C65",
+        "AssetClass": "63757272656E6379"
+      }
+    },
+    {
+      "binary": "1200342033000004D2811401476926B590BA3245F63C829116A0A3AF7F382D",
+      "json": {
+        "TransactionType": "OracleDelete",
+        "Account": "rfmDuhDyLGgx94qiwf3YF8BUV5j6KSvE8",
+        "OracleDocumentID": 1234
+      }
     }
   ],
   "ledgerData": [{

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/common/index.ts

@@ -155,3 +155,36 @@ export interface XChainBridge {
   IssuingChainDoor: string
   IssuingChainIssue: Currency
 }
+
+/**
+ * A PriceData object represents the price information for a token pair.
+ *
+ */
+export interface PriceData {
+  PriceData: {
+    /**
+     * The primary asset in a trading pair. Any valid identifier, such as a stock symbol, bond CUSIP, or currency code is allowed.
+     * For example, in the BTC/USD pair, BTC is the base asset; in 912810RR9/BTC, 912810RR9 is the base asset.
+     */
+    BaseAsset: string
+
+    /**
+     * The quote asset in a trading pair. The quote asset denotes the price of one unit of the base asset. For example, in the
+     * BTC/USD pair,BTC is the base asset; in 912810RR9/BTC, 912810RR9 is the base asset.
+     */
+    QuoteAsset: string
+
+    /**
+     * The asset price after applying the Scale precision level. It's not included if the last update transaction didn't include
+     * the BaseAsset/QuoteAsset pair.
+     */
+    AssetPrice?: number | string
+
+    /**
+     * The scaling factor to apply to an asset price. For example, if Scale is 6 and original price is 0.155, then the scaled
+     * price is 155000. Valid scale ranges are 0-10. It's not included if the last update transaction didn't include the
+     * BaseAsset/QuoteAsset pair.
+     */
+    Scale?: number
+  }
+}

packages/xrpl/src/models/ledger/LedgerEntry.ts

@@ -10,6 +10,7 @@ import FeeSettings from './FeeSettings'
 import LedgerHashes from './LedgerHashes'
 import NegativeUNL from './NegativeUNL'
 import Offer from './Offer'
+import Oracle from './Oracle'
 import PayChannel from './PayChannel'
 import RippleState from './RippleState'
 import SignerList from './SignerList'
@@ -30,6 +31,7 @@ type LedgerEntry =
   | LedgerHashes
   | NegativeUNL
   | Offer
+  | Oracle
   | PayChannel
   | RippleState
   | SignerList
@@ -52,6 +54,7 @@ type LedgerEntryFilter =
   | 'nft_offer'
   | 'nft_page'
   | 'offer'
+  | 'oracle'
   | 'payment_channel'
   | 'signer_list'
   | 'state'