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, { 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;

apps/docs/src/guide/contracts/cost-estimation.md

@@ -1,10 +1,10 @@
 # Estimating Contract Call Cost
 
-The `getTransactionCost` function provided by the [Provider](../../api/Account/Provider.md) allows you to estimate the cost of a specific contract call. The return type, `TransactionCost`, is an object containing relevant information for the estimation:
+The `getTransactionCost` function provided by the [Account](../../api/Account/Account.md) allows you to estimate the cost of a specific contract call. The return type, `TransactionCost`, is an object containing relevant information for the estimation:
 
 <<< @/../../../packages/account/src/providers/provider.ts#cost-estimation-1{ts:line-numbers}
 
-The following example demonstrate how to get the estimated transaction cost for:
+The following example demonstrates how to get the estimated transaction cost for:
 
 ## 1. Single contract call transaction:
 

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 @@ import type {
   GetMessagesResponse,
   GetBalancesResponse,
   Coin,
+  TransactionCostParams,
 } from './providers';
 import {
   withdrawScript,
@@ -42,6 +43,7 @@ import {
   isRequestInputCoin,
   isRequestInputResource,
 } from './providers/transaction-request/helpers';
+import { mergeQuantities } from './providers/utils/merge-quantities';
 import { assembleTransferToContractScript } from './utils/formatTransferToContractScriptData';
 
 export type TxParamsType = Pick<
@@ -436,9 +438,8 @@ export class Account extends AbstractAccount {
 
     request.addContractInputAndOutput(contractAddress);
 
-    const txCost = await this.provider.getTransactionCost(request, {
-      resourcesOwner: this,
-      quantitiesToContract: [{ amount: bn(amount), assetId: String(assetIdToTransfer) }],
+    const txCost = await this.getTransactionCost(request, {
+      quantities: [{ amount: bn(amount), assetId: String(assetIdToTransfer) }],
     });
 
     request = this.validateGasLimitAndMaxFee({
@@ -484,9 +485,9 @@ export class Account extends AbstractAccount {
 
     const baseAssetId = this.provider.getBaseAssetId();
     let request = new ScriptTransactionRequest(params);
-    const quantitiesToContract = [{ amount: bn(amount), assetId: baseAssetId }];
+    const quantities = [{ amount: bn(amount), assetId: baseAssetId }];
 
-    const txCost = await this.provider.getTransactionCost(request, { quantitiesToContract });
+    const txCost = await this.getTransactionCost(request, { quantities });
 
     request = this.validateGasLimitAndMaxFee({
       transactionRequest: request,
@@ -500,6 +501,45 @@ export class Account extends AbstractAccount {
     return this.sendTransaction(request);
   }
 
+  /**
+   * Returns a transaction cost to enable user
+   * to set gasLimit and also reserve balance amounts
+   * on the transaction.
+   *
+   * @param transactionRequestLike - The transaction request object.
+   * @param transactionCostParams - The transaction cost parameters (optional).
+   *
+   * @returns A promise that resolves to the transaction cost object.
+   */
+  async getTransactionCost(
+    transactionRequestLike: TransactionRequestLike,
+    { signatureCallback, quantities = [] }: 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, quantities);
+    // 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 +647,7 @@ export class Account extends AbstractAccount {
     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

@@ -1076,14 +1076,15 @@ Supported fuel-core version: ${mock.supportedVersion}.`
     using launched = await setupTestProviderAndWallets({
       nodeOptions: { args: ['--min-gas-price', '0'] },
     });
-    const { provider } = launched;
+    const {
+      wallets: [wallet],
+    } = launched;
 
     const request = new ScriptTransactionRequest();
 
-    const { minFee, maxFee, gasPrice } = await provider.getTransactionCost(request);
+    const { minFee, maxFee, gasPrice } = await wallet.getTransactionCost(request);
 
     expect(gasPrice.eq(0)).toBeTruthy();
-
     expect(maxFee.eq(0)).not.toBeTruthy();
     expect(minFee.eq(0)).not.toBeTruthy();
   });
@@ -1098,7 +1099,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),