feat: allow passing gasPrice to getTransactionCost

[danielbate]

Release notes

In this release, we:

• Allowed passing gasPrice to getTransactionCost functions to reduce possible network calls

Summary

In the Fuel Wallet, a user can set a custom gas limit or tip for a transaction. It then checks if that changes the fee. If it has, it will re-estimate and fund the transaction.

This leads to two gas price fetches. One in the initial fee calculation, and one in the re-estimation.

By allowing the getTransactionCost to take a gasPrice parameter, we can reduce the number of network calls for this flow.

The expected flow could then look like so:

// Some user input that could change the fee
const tip = userInput.tip;
transactionRequest.tip = tip;

// Calculate the new fee, also fetches and returns the gas price
const { maxFee, gasPrice } = await provider.estimateTxGasAndFee({
    transactionRequest,
});

// Check if the fee has increased and if so, re-estimate and re-fund
if (maxFee.gt(transactionRequest.maxFee)) {
    const cost = await wallet.getTransactionCost(proposedTxRequest, {
        estimateTxDependencies: true,
        gasPrice, // passing this means we will not fetch gas price again
    });
    await wallet.fund(proposedTxRequest, { cost });
}

Checklist

• All changes are covered by tests (or not applicable)
• All changes are documented (or not applicable)
• I reviewed the entire PR myself (preferably, on GH UI)
• I described all Breaking Changes (or there's none)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2025 0:26am
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2025 0:26am
ts-docs-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2025 0:26am

[github-actions]

Coverage Report:

Lines	Branches	Functions	Statements
77.05%(+0.01%)	70.65%(+0.01%)	75.1%(+0%)	77.05%(+0.01%)

Changed Files:

Ok	File (✨=New File)	Lines	Branches	Functions	Statements
🔴	packages/account/src/providers/provider.ts	68.46% (-0.09%)	59% (+0.54%)	69.89% (+0%)	68.2% (-0.08%)

[danielbate]

Thoughts on breaking change and having a single object parameter?