Merge branch 'main' into genDocs

Author: ckeshava

.ci-config/rippled.cfg

@@ -184,3 +184,9 @@ fixReducedOffersV2
 DeepFreeze
 DynamicNFT
 PermissionedDomains
+
+# This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
+[voting]
+reference_fee = 200           # 200 drops
+account_reserve = 20000000   # 20 XRP
+owner_reserve = 5000000      # 5 XRP

packages/ripple-binary-codec/HISTORY.md

@@ -3,7 +3,8 @@
 ## Unreleased
 
 ### Fixed
-- add `MPTAmount` support in `Issue` (rippled internal type)
+* add `MPTCurrency` support in `Issue` (rippled internal type)
+* Throw an error during serialization if a field is unknown, rather than silently throwing it away.
 
 ## 2.3.0 (2025-2-13)
 

packages/ripple-binary-codec/src/types/st-object.ts

@@ -116,14 +116,25 @@ class STObject extends SerializedType {
       return Object.assign(acc, handled ?? { [key]: val })
     }, {})
 
-    let sorted = Object.keys(xAddressDecoded)
-      .map((f: string): FieldInstance => definitions.field[f] as FieldInstance)
-      .filter(
-        (f: FieldInstance): boolean =>
-          f !== undefined &&
-          xAddressDecoded[f.name] !== undefined &&
-          f.isSerialized,
+    function isValidFieldInstance(
+      f: FieldInstance | undefined,
+    ): f is FieldInstance {
+      return (
+        f !== undefined &&
+        xAddressDecoded[f.name] !== undefined &&
+        f.isSerialized
       )
+    }
+
+    let sorted = Object.keys(xAddressDecoded)
+      .map((f: string): FieldInstance | undefined => {
+        if (!(f in definitions.field)) {
+          if (f[0] === f[0].toLowerCase()) return undefined
+          throw new Error(`Field ${f} is not defined in the definitions`)
+        }
+        return definitions.field[f] as FieldInstance
+      })
+      .filter(isValidFieldInstance)
       .sort((a, b) => {
         return a.ordinal - b.ordinal
       })

packages/ripple-binary-codec/test/definitions.test.ts

@@ -34,8 +34,8 @@ describe('encode and decode using new types as a parameter', function () {
   it('can encode and decode a new Field', function () {
     const tx = { ...txJson, NewFieldDefinition: 10 }
 
-    // Before updating the types, undefined fields will be ignored on encode
-    expect(decode(encode(tx))).not.toEqual(tx)
+    // Before updating the types, undefined fields will throw an error
+    expect(() => encode(tx)).toThrow()
 
     // Normally this would be generated directly from rippled with something like `server_definitions`.
     // Added here to make it easier to see what is actually changing in the definitions.json file.
@@ -72,8 +72,8 @@ describe('encode and decode using new types as a parameter', function () {
       ],
     }
 
-    // Before updating the types, undefined fields will be ignored on encode
-    expect(decode(encode(tx))).not.toEqual(tx)
+    // Before updating the types, undefined fields will throw an error
+    expect(() => encode(tx)).toThrow()
 
     // Normally this would be generated directly from rippled with something like `server_definitions`.
     // Added here to make it easier to see what is actually changing in the definitions.json file.
@@ -141,8 +141,8 @@ describe('encode and decode using new types as a parameter', function () {
       },
     ])
 
-    // Test that before updating the types this tx fails to decode correctly. Note that undefined fields are ignored on encode.
-    expect(decode(encode(tx))).not.toEqual(tx)
+    // Test that before updating the types this tx fails to decode correctly. Note that undefined fields will throw an error.
+    expect(() => encode(tx)).toThrow()
 
     class NewType extends UInt32 {
       // Should be the same as UInt32

packages/ripple-binary-codec/test/tx-encode-decode.test.ts

@@ -116,4 +116,13 @@ describe('encoding and decoding tx_json', function () {
       encode(my_tx)
     }).toThrow()
   })
+
+  it('throws when there is an unknown field', function () {
+    const my_tx = Object.assign({}, tx_json, {
+      BadField: 1,
+    })
+    expect(() => {
+      encode(my_tx)
+    }).toThrow()
+  })
 })

packages/xrpl/HISTORY.md

@@ -12,6 +12,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 * `OracleSet` transaction accepts hexadecimal string values for `AssetPrice` field
 * `TransactionStream` model includes `hash` field in APIv2
 * `TransactionStream` model includes `close_time_iso` field only for APIv2
+* Adds `MPTCurrency` type
 
 ## 4.2.0 (2025-2-13)
 
@@ -41,6 +42,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 * `TransactionStream` model supports APIv2
 * `TransactionStream` model includes `close_time_iso` field
 * `Ledger` model includes `close_time_iso` field
+* Remove hard-coded reference to 10 drops as the reference transaction cost. Ensure tests passed for all transaction fee scenarios and `AMMCreate` transaction fee calculation is correct in case `owner_reserve` increases.
 
 ## 4.0.0 (2024-07-15)
 

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

@@ -14,7 +14,11 @@ export interface IssuedCurrency {
   issuer: string
 }
 
-export type Currency = IssuedCurrency | XRP
+export interface MPTCurrency {
+  mpt_issuance_id: string
+}
+
+export type Currency = IssuedCurrency | MPTCurrency | XRP
 
 export interface IssuedCurrencyAmount extends IssuedCurrency {
   value: string

packages/xrpl/src/sugar/autofill.ts

@@ -230,13 +230,13 @@ export async function setNextValidSequenceNumber(
 }
 
 /**
- * Fetches the account deletion fee from the server state using the provided client.
+ * Fetches the owner reserve fee from the server state using the provided client.
  *
  * @param client - The client object used to make the request.
- * @returns A Promise that resolves to the account deletion fee as a BigNumber.
- * @throws {Error} Throws an error if the account deletion fee cannot be fetched.
+ * @returns A Promise that resolves to the owner reserve fee as a BigNumber.
+ * @throws {Error} Throws an error if the owner reserve fee cannot be fetched.
  */
-async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
+async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
   const response = await client.request({ command: 'server_state' })
   const fee = response.result.state.validated_ledger?.reserve_inc
 
@@ -260,45 +260,43 @@ export async function calculateFeePerTransactionType(
   tx: Transaction,
   signersCount = 0,
 ): Promise<void> {
-  // netFee is usually 0.00001 XRP (10 drops)
   const netFeeXRP = await getFeeXrp(client)
   const netFeeDrops = xrpToDrops(netFeeXRP)
   let baseFee = new BigNumber(netFeeDrops)
 
   // EscrowFinish Transaction with Fulfillment
   if (tx.TransactionType === 'EscrowFinish' && tx.Fulfillment != null) {
     const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
-    // 10 drops × (33 + (Fulfillment size in bytes / 16))
-    const product = new BigNumber(
+    // BaseFee × (33 + (Fulfillment size in bytes / 16))
+    baseFee = new BigNumber(
       // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
       scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
     )
-    baseFee = product.dp(0, BigNumber.ROUND_CEIL)
   }
 
-  if (
-    tx.TransactionType === 'AccountDelete' ||
-    tx.TransactionType === 'AMMCreate'
-  ) {
-    baseFee = await fetchAccountDeleteFee(client)
+  const isSpecialTxCost = ['AccountDelete', 'AMMCreate'].includes(
+    tx.TransactionType,
+  )
+
+  if (isSpecialTxCost) {
+    baseFee = await fetchOwnerReserveFee(client)
   }
 
   /*
    * Multi-signed Transaction
-   * 10 drops × (1 + Number of Signatures Provided)
+   * BaseFee × (1 + Number of Signatures Provided)
    */
   if (signersCount > 0) {
     baseFee = BigNumber.sum(baseFee, scaleValue(netFeeDrops, 1 + signersCount))
   }
 
   const maxFeeDrops = xrpToDrops(client.maxFeeXRP)
-  const totalFee =
-    tx.TransactionType === 'AccountDelete'
-      ? baseFee
-      : BigNumber.min(baseFee, maxFeeDrops)
+  const totalFee = isSpecialTxCost
+    ? baseFee
+    : BigNumber.min(baseFee, maxFeeDrops)
 
   // Round up baseFee and return it as a string
-  // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers -- param reassign is safe, base 10 magic num
+  // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers, require-atomic-updates -- safe reassignment.
   tx.Fee = totalFee.dp(0, BigNumber.ROUND_CEIL).toString(10)
 }
 

packages/xrpl/test/integration/requests/ammInfo.test.ts

@@ -37,7 +37,6 @@ describe('AMMInfo', function () {
     assert.equal(amm.amount, '1250')
     assert.deepEqual(amm.amount2, {
       currency: asset2.currency,
-      // @ts-expect-error: asset2.issuer should be defined at this point
       issuer: asset2.issuer,
       value: '250',
     })

packages/xrpl/test/integration/requests/fee.test.ts

@@ -1,7 +1,9 @@
+import BigNumber from 'bignumber.js'
 import { assert } from 'chai'
 import omit from 'lodash/omit'
 
-import { FeeRequest } from '../../../src'
+import { FeeRequest, xrpToDrops } from '../../../src'
+import getFeeXrp from '../../../src/sugar/getFeeXrp'
 import serverUrl from '../serverUrl'
 import {
   setupClient,
@@ -26,17 +28,21 @@ describe('fee', function () {
       const request: FeeRequest = {
         command: 'fee',
       }
+      const referenceFee = xrpToDrops(await getFeeXrp(testContext.client, 1))
+      const MEDIAN_FEE_MULTIPLIER = 500
       const response = await testContext.client.request(request)
       const expected = {
         id: 0,
         result: {
           current_ledger_size: '0',
           current_queue_size: '0',
           drops: {
-            base_fee: '10',
-            median_fee: '5000',
-            minimum_fee: '10',
-            open_ledger_fee: '10',
+            base_fee: referenceFee,
+            median_fee: new BigNumber(referenceFee)
+              .times(MEDIAN_FEE_MULTIPLIER)
+              .toString(),
+            minimum_fee: referenceFee,
+            open_ledger_fee: referenceFee,
           },
           expected_ledger_size: '1000',
           ledger_current_index: 2925,

packages/xrpl/test/integration/setup.ts

@@ -4,11 +4,12 @@ import {
   AMMDeposit,
   AMMDepositFlags,
   Client,
-  Currency,
+  IssuedCurrency,
   SignerListSet,
   Wallet,
   XChainBridge,
   XChainCreateBridge,
+  XRP,
 } from '../../src'
 
 import serverUrl from './serverUrl'
@@ -24,8 +25,8 @@ export interface TestAMMPool {
   issuerWallet: Wallet
   lpWallet: Wallet
   testWallet: Wallet
-  asset: Currency
-  asset2: Currency
+  asset: XRP
+  asset2: IssuedCurrency
 }
 
 interface TestBridge {

packages/xrpl/test/integration/transactions/ammCreate.test.ts

@@ -36,7 +36,6 @@ describe('AMMCreate', function () {
     assert.equal(amm.amount, '250')
     assert.deepEqual(amm.amount2, {
       currency: asset2.currency,
-      // @ts-expect-error: asset2.issuer should be defined at this point
       issuer: asset2.issuer,
       value: '250',
     })

packages/xrpl/test/integration/transactions/ammDeposit.test.ts

@@ -102,7 +102,6 @@ describe('AMMDeposit', function () {
       Amount: '100',
       Amount2: {
         currency: asset2.currency,
-        // @ts-expect-error: asset2.issuer should be defined at this point
         issuer: asset2.issuer,
         value: '100',
       },

packages/xrpl/test/integration/transactions/ammWithdraw.test.ts

@@ -110,7 +110,6 @@ describe('AMMWithdraw', function () {
       Amount: '50',
       Amount2: {
         currency: asset2.currency,
-        // @ts-expect-error: asset2.issuer should be defined at this point
         issuer: asset2.issuer,
         value: '50',
       },

packages/xrpl/test/integration/transactions/payment.test.ts

@@ -13,15 +13,20 @@ import {
   teardownClient,
   type XrplIntegrationTestContext,
 } from '../setup'
-import { generateFundedWallet, testTransaction } from '../utils'
+import {
+  fetchAccountReserveFee,
+  generateFundedWallet,
+  testTransaction,
+} from '../utils'
 
 // how long before each test case times out
 const TIMEOUT = 20000
 
 describe('Payment', function () {
   let testContext: XrplIntegrationTestContext
   let paymentTx: Payment
-  const AMOUNT = '10000000'
+  let amount: string
+  const DEFAULT_AMOUNT = '10000000'
   // This wallet is used for DeliverMax related tests
   let senderWallet: Wallet
 
@@ -31,14 +36,17 @@ describe('Payment', function () {
     paymentTx = {
       TransactionType: 'Payment',
       Account: senderWallet.classicAddress,
-      Amount: AMOUNT,
+      Amount: amount,
       Destination: 'rfkE1aSy9G8Upk4JssnwBxhEv5p4mn2KTy',
     }
   })
 
   beforeAll(async () => {
     testContext = await setupClient(serverUrl)
     senderWallet = await generateFundedWallet(testContext.client)
+    // Make sure the amount sent satisfies minimum reserve requirement to fund an account.
+    amount =
+      (await fetchAccountReserveFee(testContext.client)) ?? DEFAULT_AMOUNT
   })
   afterAll(async () => teardownClient(testContext))
 
@@ -66,7 +74,7 @@ describe('Payment', function () {
       )
 
       assert.equal(result.result.engine_result_code, 0)
-      assert.equal((result.result.tx_json as Payment).Amount, AMOUNT)
+      assert.equal((result.result.tx_json as Payment).Amount, amount)
     },
     TIMEOUT,
   )
@@ -86,7 +94,7 @@ describe('Payment', function () {
       )
 
       assert.equal(result.result.engine_result_code, 0)
-      assert.equal((result.result.tx_json as Payment).Amount, AMOUNT)
+      assert.equal((result.result.tx_json as Payment).Amount, amount)
     },
     TIMEOUT,
   )
@@ -104,7 +112,7 @@ describe('Payment', function () {
       )
 
       assert.equal(result.result.engine_result_code, 0)
-      assert.equal((result.result.tx_json as Payment).Amount, AMOUNT)
+      assert.equal((result.result.tx_json as Payment).Amount, amount)
     },
     TIMEOUT,
   )

packages/xrpl/test/integration/transactions/xchainClaim.test.ts

@@ -9,6 +9,7 @@ import {
   XChainCreateClaimID,
   xrpToDrops,
 } from '../../../src'
+import getFeeXrp from '../../../src/sugar/getFeeXrp'
 import serverUrl from '../serverUrl'
 import {
   setupBridge,
@@ -39,6 +40,7 @@ describe('XChainCreateBridge', function () {
       const destination = await generateFundedWallet(testContext.client)
       const otherChainSource = Wallet.generate()
       const amount = xrpToDrops(10)
+      const netFee = xrpToDrops(await getFeeXrp(testContext.client))
 
       const claimIdTx: XChainCreateClaimID = {
         TransactionType: 'XChainCreateClaimID',
@@ -103,7 +105,10 @@ describe('XChainCreateBridge', function () {
       )
       assert.equal(
         finalBalance,
-        initialBalance + Number(amount) - Number(signatureReward) - 12,
+        initialBalance +
+          Number(amount) -
+          Number(signatureReward) -
+          Number(netFee),
         "The destination's balance should not change yet",
       )
     },