ci(release): v0.98.0 @ master

[fuel-service-user]

Summary

In this release, we:

• Added method fromInstance to the Predicate class
• Added auto-detection for the user's package manager of choice for create fuels
• Made Provider constructor public and sync again
• Added support for --fuel-core-port flag in fuels init command
• Added a frictionless subscription endpoint for submitting transactions and obtaining it's status
• Added the autoCost method to easily estimate and fund transactions
• Migrated fundWithRequiredCoins -> autoCost for contract and script calls
• Improved speed in assembling result for settled transactions
• Added a guard to sendTransaction to ensure that we prevent implicit asset burns
• Fixed an issue when using multiple paths (or globals) in fuels init
• Improved validation and handling of unsafe integers in BigNumberCoder
• Upgraded fuel-core to 0.40.2
• Removed unused operations from OperationName enum
• Remove receipts deprecated properties
• Removed all receipt coders
• Removed all instances of Bech32 address format in favour of B256
• Removed the AbstractAddress in favour of the Address class
• Improved Getting Started docs and repo README, focusing on Mainnet

Breaking

• Features
  • #3514 - Making provider initialization sync again, by @arboleya
  • #3539 - autoCost for transaction estimation and funding, by @danielbate
  • #3559 - Remove redundant gas price call for tx summary, by @danielbate
  • #3540 - Prevent implicit asset burn, by @petertonysmith94
• Chores
  • #3553 - Remove unused operations, by @Torres-ssf
  • #3552 - Remove receipts deprecated properties, by @Torres-ssf
  • #3551 - Remove receipt coders, by @Torres-ssf
  • #3548 - Remove deprecated submitAndAwait operation, by @nedsalk
  • #3493 - Remove Bech32 address, by @petertonysmith94
  • #3492 - Redistributed the @fuel-ts/interfaces package, by @petertonysmith94

---

Features

• #3432 - Added method to duplicate predicate, by @YaTut1901
• #3503 - Auto-detect package manager in create fuels, by @Dhaiwat10
• #3531 - Add support for --fuel-core-port flag in fuels init, by @nedsalk
• #3541 - Implement sendAndAwaitStatus subscription, by @danielbate
• #3487 - Added onBeforeSend hook to the connector interface, by @petertonysmith94

Fixes

• #3486 - Adjust test ui script in package's json, by @arboleya
• #3510 - Adjust paths and globals in fuels init, by @arboleya
• #3491 - Validation and handling of unsafe integers, by @petertonysmith94
• #3537 - Resolve punycode deprecation notice, by @petertonysmith94
• #3528 - Usage of providerUrl in fuels dev command, by @nedsalk
• #3508 - Unable to kill fuels dev with pnpm, by @petertonysmith94

Chores

• #3511 - Bumped @fuels/* deps to 0.36.1, by @petertonysmith94
• #3449 - Dependency pinning and auditing, by @danielbate
• #3470 - Upgrade fuel-core to 0.40.2, by @Torres-ssf
• #3550 - Added useBaseAssetId hook to templates, by @petertonysmith94
• #3556 - Removing obsolete Provider.create method, by @arboleya
• #3554 - Remove unused deps + update knip config, by @maschad

Docs

• #3500 - Improving getting started docs for mainnet, by @arboleya

---

Migration Notes

Features

#3514 - Making provider initialization sync again

1. Provider Instantiation

• Going from async to sync

// before
const provider = await Provider.create(NETWORK_URL);

// after
const provider = new Provider(NETWORK_URL);

2. Provider methods

• The following methods are now async

// before
provider.getNode();
provider.getChain();
provider.getChainId();
provider.getBaseAssetId();
provider.getGasConfig();
provider.validateTransaction();

// after
await provider.getNode();
await provider.getChain();
await provider.getChainId();
await provider.getBaseAssetId();
await provider.getGasConfig();
await provider.validateTransaction();

3. TransferParams and ContractTransferParams

• Property assetId is now required by TransferParams and ContractTransferParams

export type TransferParams = {
  destination: string | AbstractAddress;
  amount: BigNumberish;
-  assetId?: BytesLike;
+  assetId: BytesLike;
};

export type ContractTransferParams = {
  contractId: string | AbstractAddress;
  amount: BigNumberish;
-  assetId?: BytesLike;
+  assetId: BytesLike;
};

4. Transaction Response

• The constructor now requires a chainId

// before
new TransactionResponse('0x..', provider);

// after
new TransactionResponse('0x..', provider, chainId);

#3539 - autoCost for transaction estimation and funding

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();

#3559 - Remove redundant gas price call for tx summary

• calculateTXFeeForSummary and subsequently the CalculateTXFeeForSummaryParams no longer accept a totalFee property. If you have the totalFee, then there is no need to call the calculateTxFeeForSummary() function.

// before
const totalFee = bn(..):
calculateTXFeeForSummary({ ..., totalFee } as CalculateTXFeeForSummaryParams);

// after
calculateTXFeeForSummary({ ... } as CalculateTXFeeForSummaryParams);

#3540 - Prevent implicit asset burn

// before
const transactionRequest = new ScriptTransactionRequest();
transactionRequest.inputs.push({ ... });

// since outputs weren't added, assets would be burned
await sender.sendTransaction(transactionRequest);

// after
const transactionRequest = new ScriptTransactionRequest();
transactionRequest.inputs.push({ ... });

// now, an error will be thrown unless `enableAssetBurn`is true,
// in which case, assets can still be burned
await sender.sendTransaction(transactionRequest, {
  enableAssetBurn: true,
});

Chores

#3553 - Remove unused operations

The following operations have been removed from the OperationName enum, as they were never used to assemble operations:

• OperationName.mint
• OperationName.predicatecall
• OperationName.script
• OperationName.sent

#3552 - Remove receipts deprecated properties

All receipts deprecated properties were removed:

// before
ReceiptCall.from

ReceiptLog.val0
ReceiptLog.val1
ReceiptLog.val2
ReceiptLog.val3

ReceiptLogData.val0
ReceiptLogData.val1

ReceiptTransfer.from

ReceiptTransferOut.from

// after
ReceiptCall.id

ReceiptLog.ra
ReceiptLog.rb
ReceiptLog.rc
ReceiptLog.rd

ReceiptLogData.ra
ReceiptLogData.rb

ReceiptTransfer.id

ReceiptTransferOut.id

#3551 - Remove receipt coders

All previously deprecated receipt coders have been removed. These classes were barely used aside from a few internal helpers, which were converted to utility functions.

// before
const messageId = ReceiptMessageOutCoder.getMessageId({
  sender,
  recipient,
  nonce,
  amount,
  data,
});

const assetId = ReceiptMintCoder.getAssetId(contractId, subId);

const assetId = ReceiptBurnCoder.getAssetId(contractId, subId);

// after
import { getMessageId, getAssetId } from 'fuels'

const messageId = getMessageId({
  sender,
  recipient,
  nonce,
  amount,
  data,
});

const assetId = getAssetId(contractId, subId);

#3548 - Remove deprecated submitAndAwait operation

• submitAndAwait operation was removed

After being deprecated since #3101, we have removed this operation altogether. Please use the submitAndAwaitStatus method instead which gives the same results as submitAndAwait. If you are interested in the deprecation/removal reasons, please refer to FuelLabs/fuel-core#2108.

// before
const response = await provider.operations.submitAndAwait(txRequest);

// after
const response = await provider.operations.submitAndAwaitStatus(txRequest);

#3493 - Remove Bech32 address

• We no longer support Bech32 addresses

// before
import { Address, Bech32Address } from "fuels";

const bech32Address: Bech32Address = "fuel1234";
const address = new Address(bech32Address);

// after
import { Address, B256Address } from "fuels";

const b256Address: B256Address = "0x1234";
const address = new Address(b256Address);

• Removed INVALID_BECH32_ADDRESS error code.

• Removed associated Bech32 helper functions.

  • normalizeBech32
  • isBech32
  • toB256
  • getBytesFromBech32
  • toBech32
  • clearFirst12BytesFromB256

#3492 - Redistributed the @fuel-ts/interfaces package

• Removed the AbstractAddress class; use the Address class instead.

// before
import { AbstractAddress } from 'fuels';

// after
import { Address } from 'fuels';

• Removed the @fuel-ts/interfaces package; use the fuels package instead.

// before
import { BytesLike } from '@fuel-ts/interfaces'

// after
import { BytesLike } from 'fuels'

[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 10, 2025 0:57am
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2025 0:57am
ts-docs-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2025 0:57am

[github-actions]

Coverage Report:

Lines	Branches	Functions	Statements
77.03%(+0%)	70.58%(-0.04%)	75.14%(+0%)	77.04%(+0%)

Changed Files:

Ok	File (✨=New File)	Lines	Branches	Functions	Statements
🔴	packages/account/src/providers/transaction-request/transaction-request.ts	88.57% (+0%)	76.71% (-1.37%)	84% (+0%)	88.81% (+0%)