chore!: refactored the getTransactionCost method

.changeset/short-sheep-divide.md

@@ -0,0 +1,8 @@
+---
+"@fuel-ts/account": minor
+"@fuel-ts/interfaces": minor
+"@fuel-ts/contract": minor
+"@fuel-ts/program": minor
+---
+
+chore!: refactored the `getTransactionCost` method

apps/docs-snippets/src/guide/cookbook/custom-transactions-contract-calls.test.ts

@@ -52,7 +52,7 @@ describe('Custom Transactions from Contract Calls', () => {
     // Add coin output for the recipient
     transactionRequest.addCoinOutput(receiverWallet.address, amountToRecipient, baseAssetId);
 
-    const txCost = await senderWallet.provider.getTransactionCost(transactionRequest);
+    const txCost = await senderWallet.getTransactionCost(transactionRequest);
 
     transactionRequest.gasLimit = txCost.gasUsed;
     transactionRequest.maxFee = txCost.maxFee;

apps/docs-snippets/src/guide/cookbook/signing-transactions.test.ts

@@ -102,9 +102,8 @@ describe('Signing transactions', () => {
 
     // Add witnesses including the signer
     // Estimate the predicate inputs
-    const txCost = await provider.getTransactionCost(request, {
+    const txCost = await predicate.getTransactionCost(request, {
       signatureCallback: (tx) => tx.addAccountWitnesses(signer),
-      resourcesOwner: predicate,
     });
 
     request.updatePredicateGasUsed(txCost.estimatedPredicates);

apps/docs-snippets/src/guide/encoding/encode-and-decode.test.ts

@@ -71,7 +71,7 @@ describe('encode and decode', () => {
     request.scriptData = encodedArguments;
 
     // Now we can build out the rest of the transaction and then fund it
-    const txCost = await wallet.provider.getTransactionCost(request);
+    const txCost = await wallet.getTransactionCost(request);
     request.maxFee = txCost.maxFee;
     request.gasLimit = txCost.gasUsed;
     await wallet.fund(request, txCost);

apps/docs-snippets/src/guide/predicates/interacting-with-predicates.test.ts

@@ -1,4 +1,4 @@
-import type { Provider, WalletUnlocked } from 'fuels';
+import type { WalletUnlocked } from 'fuels';
 import { ScriptTransactionRequest, bn, Predicate, BN } from 'fuels';
 import { seedTestWallet } from 'fuels/test-utils';
 
@@ -15,7 +15,6 @@ describe(__filename, () => {
   let wallet: WalletUnlocked;
   let receiver: WalletUnlocked;
   let baseAssetId: string;
-  let provider: Provider;
   let predicate: Predicate<[string]>;
 
   const { abiContents: abi, binHexlified: bin } = getDocsSnippetsForcProject(
@@ -27,7 +26,6 @@ describe(__filename, () => {
   beforeAll(async () => {
     wallet = await getTestWallet();
     receiver = await getTestWallet();
-    provider = wallet.provider;
 
     baseAssetId = wallet.provider.getBaseAssetId();
 
@@ -65,9 +63,7 @@ describe(__filename, () => {
     const transactionRequest = new ScriptTransactionRequest({ gasLimit: 2000, maxFee: bn(0) });
     transactionRequest.addCoinOutput(receiver.address, 100, baseAssetId);
 
-    const txCost = await provider.getTransactionCost(transactionRequest, {
-      resourcesOwner: predicate,
-    });
+    const txCost = await predicate.getTransactionCost(transactionRequest);
 
     transactionRequest.gasLimit = txCost.gasUsed;
     transactionRequest.maxFee = txCost.maxFee;
@@ -91,9 +87,7 @@ describe(__filename, () => {
     const transactionRequest = new ScriptTransactionRequest({ gasLimit: 2000, maxFee: bn(0) });
     transactionRequest.addCoinOutput(receiver.address, 1000000, baseAssetId);
 
-    const txCost = await provider.getTransactionCost(transactionRequest, {
-      resourcesOwner: predicate,
-    });
+    const txCost = await predicate.getTransactionCost(transactionRequest);
 
     transactionRequest.gasLimit = txCost.gasUsed;
     transactionRequest.maxFee = txCost.maxFee;

apps/docs-snippets/src/guide/scripts/script-custom-transaction.test.ts

@@ -79,7 +79,7 @@ describe(__filename, () => {
     const quantities = [coinQuantityfy([1000, ASSET_A]), coinQuantityfy([500, ASSET_B])];
 
     // 5. Calculate the transaction fee
-    const txCost = await provider.getTransactionCost(request, { quantitiesToContract: quantities });
+    const txCost = await wallet.getTransactionCost(request, { quantitiesToContract: quantities });
 
     request.gasLimit = txCost.gasUsed;
     request.maxFee = txCost.maxFee;

apps/docs-snippets/src/guide/transactions/transaction-response.test.ts

@@ -54,7 +54,7 @@ describe('Transaction Response', () => {
     transactionRequest.setData(scriptAbi, scriptMainFunctionArguments);
 
     // Fund the transaction
-    const txCost = await provider.getTransactionCost(transactionRequest);
+    const txCost = await wallet.getTransactionCost(transactionRequest);
 
     transactionRequest.maxFee = txCost.maxFee;
     transactionRequest.gasLimit = txCost.gasUsed;
@@ -79,7 +79,7 @@ describe('Transaction Response', () => {
     });
     transactionRequest.setData(scriptAbi, scriptMainFunctionArguments);
 
-    const txCost = await provider.getTransactionCost(transactionRequest);
+    const txCost = await wallet.getTransactionCost(transactionRequest);
 
     transactionRequest.maxFee = txCost.maxFee;
     transactionRequest.gasLimit = txCost.gasUsed;

apps/docs-snippets/src/guide/wallets/signing.test.ts

@@ -54,7 +54,7 @@ describe(__filename, () => {
 
     request.addCoinOutput(Address.fromRandom(), 1000, baseAssetId);
 
-    const txCost = await provider.getTransactionCost(request);
+    const txCost = await wallet.getTransactionCost(request);
 
     request.gasLimit = txCost.gasUsed;
     request.maxFee = txCost.maxFee;
@@ -85,7 +85,7 @@ describe(__filename, () => {
 
     request.addCoinOutput(Address.fromRandom(), 1000, baseAssetId);
 
-    const txCost = await provider.getTransactionCost(request);
+    const txCost = await wallet.getTransactionCost(request);
 
     request.gasLimit = txCost.gasUsed;
     request.maxFee = txCost.maxFee;

apps/docs-snippets/src/utils.ts

@@ -34,7 +34,7 @@ export const getTestWallet = async (seedQuantities?: CoinQuantityLike[]) => {
     .forEach(({ amount, assetId }) => request.addCoinOutput(testWallet.address, amount, assetId));
 
   // get the cost of the transaction
-  const txCost = await genesisWallet.provider.getTransactionCost(request);
+  const txCost = await testWallet.getTransactionCost(request);
 
   request.gasLimit = txCost.gasUsed;
   request.maxFee = txCost.maxFee;

packages/account/src/account.test.ts

@@ -483,7 +483,7 @@ describe('Account', () => {
       [amount, assetIdB],
     ]);
 
-    const txCost = await sender.provider.getTransactionCost(request);
+    const txCost = await sender.getTransactionCost(request);
 
     request.gasLimit = txCost.gasUsed;
     request.maxFee = txCost.maxFee;

packages/account/src/account.ts

@@ -29,6 +29,7 @@
   GetMessagesResponse,
   GetBalancesResponse,
   Coin,
+  TransactionCostParams,
 } from './providers';
 import {
   withdrawScript,
@@ -42,6 +43,7 @@
   isRequestInputCoin,
   isRequestInputResource,
 } from './providers/transaction-request/helpers';
+import { mergeQuantities } from './providers/utils/merge-quantities';
 import { assembleTransferToContractScript } from './utils/formatTransferToContractScriptData';
 
 export type TxParamsType = Pick<
@@ -436,8 +438,7 @@
 
     request.addContractInputAndOutput(contractAddress);
 
-    const txCost = await this.provider.getTransactionCost(request, {
-      resourcesOwner: this,
+    const txCost = await this.getTransactionCost(request, {
       quantitiesToContract: [{ amount: bn(amount), assetId: String(assetIdToTransfer) }],
     });
 
@@ -486,7 +487,7 @@
     let request = new ScriptTransactionRequest(params);
     const quantitiesToContract = [{ amount: bn(amount), assetId: baseAssetId }];
 
-    const txCost = await this.provider.getTransactionCost(request, { quantitiesToContract });
+    const txCost = await this.getTransactionCost(request, { quantitiesToContract });
 
     request = this.validateGasLimitAndMaxFee({
       transactionRequest: request,
@@ -500,6 +501,35 @@
     return this.sendTransaction(request);
   }
 
+  async getTransactionCost(
+    transactionRequestLike: TransactionRequestLike,
+    { signatureCallback, quantitiesToContract = [] }: TransactionCostParams = {}
+  ): Promise<TransactionCost> {
+    const txRequestClone = clone(transactionRequestify(transactionRequestLike));
+    const baseAssetId = this.provider.getBaseAssetId();
+
+    // Fund with fake UTXOs to avoid not enough funds error
+    // Getting coin quantities from amounts being transferred
+    const coinOutputsQuantities = txRequestClone.getCoinOutputsQuantities();
+    // Combining coin quantities from amounts being transferred and forwarding to contracts
+    const requiredQuantities = mergeQuantities(coinOutputsQuantities, quantitiesToContract);
+    // An arbitrary amount of the base asset is added to cover the transaction fee during dry runs
+    const transactionFeeForDryRun = [{ assetId: baseAssetId, amount: bn('100000000000000000') }];
+    const resources = this.generateFakeResources(
+      mergeQuantities(requiredQuantities, transactionFeeForDryRun)
+    );
+    txRequestClone.addResources(resources);
+
+    const txCost = await this.provider.getTransactionCost(txRequestClone, {
+      signatureCallback,
+    });
+
+    return {
+      ...txCost,
+      requiredQuantities,
+    };
+  }
+
   /**
    * Sign a message from the account via the connector.
    *
@@ -607,9 +637,7 @@
     txParams: TxParamsType
   ) {
     let request = transactionRequest;
-    const txCost = await this.provider.getTransactionCost(request, {
-      resourcesOwner: this,
-    });
+    const txCost = await this.getTransactionCost(request);
     request = this.validateGasLimitAndMaxFee({
       transactionRequest: request,
       gasUsed: txCost.gasUsed,

packages/account/src/providers/provider.test.ts

@@ -1075,13 +1075,15 @@ Supported fuel-core version: ${mock.supportedVersion}.`
   // TODO: validate if this test still makes sense
   it.skip('should ensure estimated fee values on getTransactionCost are never 0', async () => {
     using launched = await setupTestProviderAndWallets();
-    const { provider } = launched;
+    const {
+      wallets: [wallet],
+    } = launched;
     const request = new ScriptTransactionRequest();
 
     // forcing calculatePriceWithFactor to return 0
     const calculateGasFeeMock = vi.spyOn(gasMod, 'calculateGasFee').mockReturnValue(bn(0));
 
-    const { minFee, maxFee } = await provider.getTransactionCost(request);
+    const { minFee, maxFee } = await wallet.getTransactionCost(request);
 
     expect(calculateGasFeeMock).toHaveBeenCalled();
 
@@ -1099,7 +1101,6 @@ Supported fuel-core version: ${mock.supportedVersion}.`
     const methodCalls = [
       () => provider.getBalance(b256Str, baseAssetId),
       () => provider.getCoins(b256Str),
-      () => provider.getResourcesForTransaction(b256Str, new ScriptTransactionRequest()),
       () => provider.getResourcesToSpend(b256Str, []),
       () => provider.getContractBalance(b256Str, baseAssetId),
       () => provider.getBalances(b256Str),

packages/account/src/providers/provider.ts

@@ -1,6 +1,6 @@
 import { Address } from '@fuel-ts/address';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
-import type { AbstractAccount, AbstractAddress, BytesLike } from '@fuel-ts/interfaces';
+import type { AbstractAddress, BytesLike } from '@fuel-ts/interfaces';
 import { BN, bn } from '@fuel-ts/math';
 import type { Transaction } from '@fuel-ts/transactions';
 import {
@@ -17,8 +17,6 @@ import { GraphQLClient } from 'graphql-request';
 import type { GraphQLResponse } from 'graphql-request/src/types';
 import { clone } from 'ramda';
 
-import type { Predicate } from '../predicate';
-
 import { getSdk as getOperationsSdk } from './__generated__/operations';
 import type {
   GqlChainInfoFragment,
@@ -62,7 +60,6 @@ import {
 } from './utils';
 import type { RetryOptions } from './utils/auto-retry-fetch';
 import { autoRetryFetch } from './utils/auto-retry-fetch';
-import { mergeQuantities } from './utils/merge-quantities';
 
 const MAX_RETRIES = 10;
 
@@ -336,11 +333,6 @@ export type EstimateTransactionParams = {
 };
 
 export type TransactionCostParams = EstimateTransactionParams & {
-  /**
-   * The account that will provide the resources for the transaction.
-   */
-  resourcesOwner?: AbstractAccount;
-
   /**
    * The quantities to forward to the contract.
    */
@@ -1131,40 +1123,18 @@ Supported fuel-core version: ${supportedVersion}.`
    */
   async getTransactionCost(
     transactionRequestLike: TransactionRequestLike,
-    { resourcesOwner, signatureCallback, quantitiesToContract = [] }: TransactionCostParams = {}
-  ): Promise<TransactionCost> {
+    { signatureCallback }: TransactionCostParams = {}
+  ): Promise<Omit<TransactionCost, 'requiredQuantities'>> {
     const txRequestClone = clone(transactionRequestify(transactionRequestLike));
     const isScriptTransaction = txRequestClone.type === TransactionType.Script;
-    const baseAssetId = this.getBaseAssetId();
     const updateMaxFee = txRequestClone.maxFee.eq(0);
-    // Fund with fake UTXOs to avoid not enough funds error
-    // Getting coin quantities from amounts being transferred
-    const coinOutputsQuantities = txRequestClone.getCoinOutputsQuantities();
-    // Combining coin quantities from amounts being transferred and forwarding to contracts
-    const allQuantities = mergeQuantities(coinOutputsQuantities, quantitiesToContract);
-    // Funding transaction with fake utxos
-    txRequestClone.fundWithFakeUtxos(allQuantities, baseAssetId, resourcesOwner?.address);
 
-    /**
-     * Estimate predicates gasUsed
-     */
     // Remove gasLimit to avoid gasLimit when estimating predicates
     if (isScriptTransaction) {
       txRequestClone.gasLimit = bn(0);
     }
 
-    /**
-     * The fake utxos added above can be from a predicate
-     * If the resources owner is a predicate,
-     * we need to populate the resources with the predicate's data
-     * so that predicate estimation can happen.
-     */
-    if (resourcesOwner && 'populateTransactionPredicateData' in resourcesOwner) {
-      (resourcesOwner as Predicate<[]>).populateTransactionPredicateData(txRequestClone);
-    }
-
     const signedRequest = clone(txRequestClone) as ScriptTransactionRequest;
-
     let addedSignatures = 0;
     if (signatureCallback && isScriptTransaction) {
       const lengthBefore = signedRequest.witnesses.length;
@@ -1213,7 +1183,6 @@ Supported fuel-core version: ${supportedVersion}.`
     }
 
     return {
-      requiredQuantities: allQuantities,
       receipts,
       gasUsed,
       gasPrice,
@@ -1230,48 +1199,6 @@ Supported fuel-core version: ${supportedVersion}.`
     };
   }
 
-  /**
-   * Get the required quantities and associated resources for a transaction.
-   *
-   * @param owner - address to add resources from.
-   * @param transactionRequestLike - transaction request to populate resources for.
-   * @param quantitiesToContract - quantities for the contract (optional).
-   *
-   * @returns a promise resolving to the required quantities for the transaction.
-   */
-  async getResourcesForTransaction(
-    owner: string | AbstractAddress,
-    transactionRequestLike: TransactionRequestLike,
-    quantitiesToContract: CoinQuantity[] = []
-  ) {
-    const ownerAddress = Address.fromAddressOrString(owner);
-    const transactionRequest = transactionRequestify(clone(transactionRequestLike));
-    const transactionCost = await this.getTransactionCost(transactionRequest, {
-      quantitiesToContract,
-    });
-
-    // Add the required resources to the transaction from the owner
-    transactionRequest.addResources(
-      await this.getResourcesToSpend(ownerAddress, transactionCost.requiredQuantities)
-    );
-    // Refetch transaction costs with the new resources
-    // TODO: we could find a way to avoid fetch estimatePredicates again, by returning the transaction or
-    // returning a specific gasUsed by the predicate.
-    // Also for the dryRun we could have the same issue as we are going to run twice the dryRun and the
-    // estimateTxDependencies as we don't have access to the transaction, maybe returning the transaction would
-    // be better.
-    const { requiredQuantities, ...txCost } = await this.getTransactionCost(transactionRequest, {
-      quantitiesToContract,
-    });
-    const resources = await this.getResourcesToSpend(ownerAddress, requiredQuantities);
-
-    return {
-      resources,
-      requiredQuantities,
-      ...txCost,
-    };
-  }
-
   /**
    * Returns coins for the given owner.
    *

packages/account/src/test-utils/seedTestWallet.ts

@@ -28,7 +28,7 @@ export const seedTestWallet = async (
     })
   );
 
-  const txCost = await genesisWallet.provider.getTransactionCost(request);
+  const txCost = await genesisWallet.getTransactionCost(request);
 
   request.gasLimit = txCost.gasUsed;
   request.maxFee = txCost.maxFee;