feat!: remove redundant gas price call for tx summary

.changeset/short-bears-fry.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/account": patch
+---
+
+feat: remove redundant gas price call for tx summary

packages/account/src/providers/transaction-response/transaction-response.ts

@@ -36,6 +36,7 @@ import type Provider from '../provider';
 import type { JsonAbisFromAllCalls, TransactionRequest } from '../transaction-request';
 import { assembleTransactionSummary } from '../transaction-summary/assemble-transaction-summary';
 import { processGqlReceipt } from '../transaction-summary/receipt';
+import { processGraphqlStatus } from '../transaction-summary/status';
 import type { TransactionSummary, GqlTransaction, AbiMap } from '../transaction-summary/types';
 import { extractTxError } from '../utils';
 
@@ -299,7 +300,11 @@ export class TransactionResponse {
 
     const { gasPerByte, gasPriceFactor, gasCosts, maxGasPerTx } =
       await this.provider.getGasConfig();
-    const gasPrice = await this.provider.getLatestGasPrice();
+
+    // If we have the total fee, we do not need to refetch the gas price
+    const { totalFee } = processGraphqlStatus(this.status ?? this.gqlTransaction?.status);
+    const gasPrice = totalFee ? bn(0) : await this.provider.getLatestGasPrice();
+
     const maxInputs = (await this.provider.getChain()).consensusParameters.txParameters.maxInputs;
     const baseAssetId = await this.provider.getBaseAssetId();
 
@@ -317,6 +322,7 @@ export class TransactionResponse {
       maxGasPerTx,
       gasPrice,
       baseAssetId,
+      totalFee,
     });
 
     return transactionSummary;

packages/account/src/providers/transaction-summary/assemble-transaction-summary.test.ts

@@ -56,7 +56,8 @@ describe('TransactionSummary', () => {
   const runTest = (
     status: GraphqlTransactionStatus,
     expected: Record<string, unknown>,
-    baseAssetId: string
+    baseAssetId: string,
+    calculateTransactionFeeCalls = 1
   ) => {
     const { calculateTransactionFee } = mockCalculateTransactionFee();
 
@@ -77,7 +78,7 @@ describe('TransactionSummary', () => {
     });
 
     expect(transactionSummary).toMatchObject(expected);
-    expect(calculateTransactionFee).toHaveBeenCalledTimes(1);
+    expect(calculateTransactionFee).toHaveBeenCalledTimes(calculateTransactionFeeCalls);
   };
 
   it('should assemble transaction summary just fine (SUCCESS)', async () => {
@@ -104,7 +105,7 @@ describe('TransactionSummary', () => {
       type: expect.any(String),
     };
 
-    runTest(MOCK_SUCCESS_STATUS, expected, await provider.getBaseAssetId());
+    runTest(MOCK_SUCCESS_STATUS, expected, await provider.getBaseAssetId(), 0);
   });
 
   it('should assemble transaction summary just fine (FAILURE)', async () => {
@@ -131,7 +132,7 @@ describe('TransactionSummary', () => {
       type: expect.any(String),
     };
 
-    runTest(MOCK_FAILURE_STATUS, expected, await provider.getBaseAssetId());
+    runTest(MOCK_FAILURE_STATUS, expected, await provider.getBaseAssetId(), 0);
   });
 
   it('should assemble transaction summary just fine (SUBMITTED)', async () => {

packages/account/src/providers/transaction-summary/assemble-transaction-summary.ts

@@ -35,6 +35,7 @@ export interface AssembleTransactionSummaryParams {
   maxGasPerTx: BN;
   gasPrice: BN;
   baseAssetId: string;
+  totalFee?: BN;
 }
 
 /** @hidden */
@@ -55,6 +56,7 @@ export function assembleTransactionSummary<TTransactionType = void>(
     maxGasPerTx,
     gasPrice,
     baseAssetId,
+    totalFee,
   } = params;
 
   const gasUsed = getGasUsedFromReceipts(receipts);
@@ -76,23 +78,32 @@ export function assembleTransactionSummary<TTransactionType = void>(
 
   const tip = bn(transaction.policies?.find((policy) => policy.type === PolicyType.Tip)?.data);
 
-  const { isStatusFailure, isStatusPending, isStatusSuccess, blockId, status, time, totalFee } =
-    processGraphqlStatus(gqlTransactionStatus);
-
-  const fee = calculateTXFeeForSummary({
-    totalFee,
-    gasPrice,
-    rawPayload,
-    tip,
-    consensusParameters: {
-      gasCosts,
-      maxGasPerTx,
-      feeParams: {
-        gasPerByte,
-        gasPriceFactor,
+  const {
+    isStatusFailure,
+    isStatusPending,
+    isStatusSuccess,
+    blockId,
+    status,
+    time,
+    totalFee: totalFeeFromStatus,
+  } = processGraphqlStatus(gqlTransactionStatus);
+
+  const fee =
+    totalFee ??
+    totalFeeFromStatus ??
+    calculateTXFeeForSummary({
+      gasPrice,
+      rawPayload,
+      tip,
+      consensusParameters: {
+        gasCosts,
+        maxGasPerTx,
+        feeParams: {
+          gasPerByte,
+          gasPriceFactor,
+        },
       },
-    },
-  });
+    });
 
   const mintedAssets = extractMintedAssetsFromReceipts(receipts);
   const burnedAssets = extractBurnedAssetsFromReceipts(receipts);

packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts

@@ -25,7 +25,6 @@ export type CalculateTXFeeForSummaryParams = {
   gasPrice: BN;
   rawPayload: string;
   tip: BN;
-  totalFee?: BN;
   consensusParameters: Pick<ConsensusParameters, 'gasCosts'> & {
     feeParams: FeeParams;
     maxGasPerTx: BN;
@@ -37,18 +36,9 @@ export const calculateTXFeeForSummary = (params: CalculateTXFeeForSummaryParams)
     gasPrice,
     rawPayload,
     tip,
-    totalFee,
     consensusParameters: { gasCosts, feeParams, maxGasPerTx },
   } = params;
 
-  /**
-   * If totalFee is provided it means that the TX was already processed and we could extract the fee
-   * from its status
-   */
-  if (totalFee) {
-    return totalFee;
-  }
-
   const gasPerByte = bn(feeParams.gasPerByte);
   const gasPriceFactor = bn(feeParams.gasPriceFactor);
 

packages/account/src/providers/transaction-summary/get-transaction-summary.ts

@@ -3,6 +3,7 @@
 import { TransactionCoder } from '@fuel-ts/transactions';
 import { arrayify } from '@fuel-ts/utils';
 
+import { processGraphqlStatus } from '../..';
 import type {
   GqlGetTransactionsByOwnerQueryVariables,
   GqlReceiptFragment,
@@ -61,7 +62,10 @@
     },
   } = await provider.getChain();
 
-  const gasPrice = await provider.getLatestGasPrice();
+  // If we have the total fee, we do not need to refetch the gas price
+  const { totalFee } = processGraphqlStatus(gqlTransaction.status);
+  const gasPrice = totalFee ? bn(0) : await provider.getLatestGasPrice();
+
   const baseAssetId = await provider.getBaseAssetId();
 
   const transactionInfo = assembleTransactionSummary<TTransactionType>({
@@ -78,6 +82,7 @@
     maxGasPerTx,
     gasPrice,
     baseAssetId,
+    totalFee,
   });
 
   return {

packages/fuel-gauge/src/transaction-response.test.ts

@@ -306,4 +306,54 @@ describe('TransactionResponse', () => {
       );
     }
   );
+
+  it('builds response and awaits result [uses fee from status]', async () => {
+    using launched = await launchTestNode();
+
+    const {
+      provider,
+      wallets: [genesisWallet],
+    } = launched;
+
+    const getLatestGasPriceSpy = vi.spyOn(provider, 'getLatestGasPrice');
+
+    const request = new ScriptTransactionRequest();
+    request.addCoinOutput(Wallet.generate(), 100, await provider.getBaseAssetId());
+    await request.autoCost(genesisWallet);
+
+    const tx = await genesisWallet.sendTransaction(request);
+    const result = await tx.waitForResult();
+
+    // fee is used from the success status, latest gas price not needed
+    expect(getLatestGasPriceSpy).toHaveBeenCalledTimes(0);
+    expect(result.fee.toNumber()).toBeGreaterThan(0);
+    expect(result.id).toBe(tx.id);
+  });
+
+  it('builds response and assembles result [fetches gas price then uses fee]', async () => {
+    using launched = await launchTestNode();
+
+    const {
+      provider,
+      wallets: [genesisWallet],
+    } = launched;
+
+    const getLatestGasPriceSpy = vi.spyOn(provider, 'getLatestGasPrice');
+
+    const request = new ScriptTransactionRequest();
+    request.addCoinOutput(Wallet.generate(), 100, await provider.getBaseAssetId());
+    await request.autoCost(genesisWallet);
+
+    const tx = await genesisWallet.sendTransaction(request);
+    const result = await tx.assembleResult();
+
+    // tx has not settled so response will fetch the gas price
+    expect(getLatestGasPriceSpy).toHaveBeenCalledTimes(1);
+    expect(result.id).toBe(tx.id);
+
+    const finalisedResult = await tx.waitForResult();
+    expect(finalisedResult.fee.toNumber()).toBeGreaterThan(0);
+    expect(getLatestGasPriceSpy).toHaveBeenCalledTimes(1);
+    expect(finalisedResult.id).toBe(tx.id);
+  });
 });