feat!: autoCost for transaction estimation and funding

[danielbate]

• Closes Introduce the autoCost helper for transaction requests #3535

Release notes

In this release, we:

• Added the autoCost method to easily estimate and fund transactions
• Migrated fundWithRequiredCoins -> autoCost for contract and script calls

Summary

Added a helper method to the ScriptTransactionRequest to easily estimate and fund a transaction. This allows consumers to easily bundle transactions before submission. This will form part of the optimisation docs in #3535.

// before
const txCost = await wallet.getTransactionCost(request);
request.gasLimit = txCost.gasUsed;
request.maxFee = txCost.maxFee;
await wallet.fund(request, txCost);

// after
await request.autoCost(wallet);

Breaking Changes

To be brought inline with autoCost, funding a contract and script call has been migrated from fundWithRequiredCoins to autoCost:

// before
const request: ScriptTransactionRequest = contract.functions.add(1).fundWithRequiredCoins();

// after
const request: ScriptTransactionRequest = contract.functions.add(1).autoCost(wallet);

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 3, 2025 6:00pm
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 6:00pm
ts-docs-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 6:00pm

[github-actions]

Coverage Report:

Lines	Branches	Functions	Statements
77.79%(+0.01%)	70.46%(+0.02%)	75.38%(+0.01%)	77.75%(+0.01%)

Changed Files:

Ok	File (✨=New File)	Lines	Branches	Functions	Statements
🔴	packages/account/src/providers/transaction-request/script-transaction-request.ts	50% (+6.42%)	64.28% (+5.95%)	42.1% (+3.22%)	48.88% (+6.38%)

[arboleya]

Surgical, minimal footprint. Well done. 🎯

[nedsalk]

Nice one 👍