Adjustments for fee voting

.ci-config/rippled.cfg

@@ -178,3 +178,9 @@ PriceOracle
 fixEmptyDID
 fixXChainRewardRounding
 fixPreviousTxnID
+
+# 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

CONTRIBUTING.md

@@ -64,7 +64,7 @@ From the top-level xrpl.js folder (one level above `packages`), run the followin
 ```bash
 npm install
 # 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-b4 /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 build
 npm run test:integration
 ```

packages/xrpl/HISTORY.md

@@ -11,6 +11,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/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/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/transactions/payment.test.ts

@@ -7,15 +7,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
 
@@ -25,14 +30,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))
 
@@ -60,7 +68,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,
   )
@@ -80,7 +88,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,
   )
@@ -98,7 +106,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",
       )
     },

packages/xrpl/test/integration/utils.ts

@@ -1,3 +1,4 @@
+import BigNumber from 'bignumber.js'
 import { assert } from 'chai'
 import omit from 'lodash/omit'
 import throttle from 'lodash/throttle'
@@ -444,3 +445,16 @@ export async function createAMMPool(client: Client): Promise<{
     asset2,
   }
 }
+
+export async function fetchAccountReserveFee(
+  client: Client,
+): Promise<string | null> {
+  const response = await client.request({ command: 'server_state' })
+  const fee = response.result.state.validated_ledger?.reserve_base
+
+  if (fee == null) {
+    return null
+  }
+
+  return new BigNumber(fee).dp(0, BigNumber.ROUND_CEIL).toString(10)
+}