@fuel-ts/account 0.88.0 → 0.89.0

package/dist/index.js

@@ -2251,7 +2251,7 @@ var BaseTransactionRequest = class {
    * @param coin - Coin resource.
    */
   addCoinInput(coin) {
-    const { assetId, owner, amount, id, predicate } = coin;
+    const { assetId, owner, amount, id, predicate, predicateData } = coin;
     let witnessIndex;
     if (coin.predicate) {
       witnessIndex = 0;
@@ -2269,7 +2269,8 @@ var BaseTransactionRequest = class {
       assetId,
       txPointer: "0x00000000000000000000000000000000",
       witnessIndex,
-      predicate
+      predicate,
+      predicateData
     };
     this.pushInput(input);
     this.addChangeOutput(owner, assetId);
@@ -2281,7 +2282,7 @@ var BaseTransactionRequest = class {
    * @param message - Message resource.
    */
   addMessageInput(message) {
-    const { recipient, sender, amount, predicate, nonce, assetId } = message;
+    const { recipient, sender, amount, predicate, nonce, assetId, predicateData } = message;
     let witnessIndex;
     if (message.predicate) {
       witnessIndex = 0;
@@ -2298,7 +2299,8 @@ var BaseTransactionRequest = class {
       recipient: recipient.toB256(),
       amount,
       witnessIndex,
-      predicate
+      predicate,
+      predicateData
     };
     this.pushInput(input);
     this.addChangeOutput(recipient, assetId);
@@ -2500,23 +2502,13 @@ var BaseTransactionRequest = class {
     });
   }
   updatePredicateGasUsed(inputs) {
-    this.inputs.forEach((i) => {
-      let correspondingInput;
-      switch (i.type) {
-        case import_transactions7.InputType.Coin:
-          correspondingInput = inputs.find((x) => x.type === import_transactions7.InputType.Coin && x.owner === i.owner);
-          break;
-        case import_transactions7.InputType.Message:
-          correspondingInput = inputs.find(
-            (x) => x.type === import_transactions7.InputType.Message && x.sender === i.sender
-          );
-          break;
-        default:
-          return;
-      }
+    const inputsToExtractGasUsed = inputs.filter(isRequestInputResource);
+    this.inputs.filter(isRequestInputResource).forEach((i) => {
+      const owner = getRequestInputResourceOwner(i);
+      const correspondingInput = inputsToExtractGasUsed.find(
+        (x) => isRequestInputResourceFromOwner(x, import_address.Address.fromString(String(owner)))
+      );
       if (correspondingInput && "predicateGasUsed" in correspondingInput && (0, import_math8.bn)(correspondingInput.predicateGasUsed).gt(0)) {
-        i.predicate = correspondingInput.predicate;
-        i.predicateData = correspondingInput.predicateData;
         i.predicateGasUsed = correspondingInput.predicateGasUsed;
       }
     });
@@ -2849,6 +2841,13 @@ var ScriptTransactionRequest = class extends BaseTransactionRequest {
     }
     return this.outputs.length - 1;
   }
+  /**
+   * Calculates the maximum gas for the transaction.
+   *
+   * @param chainInfo - The chain information.
+   * @param minGas - The minimum gas.
+   * @returns the maximum gas.
+   */
   calculateMaxGas(chainInfo, minGas) {
     const { consensusParameters } = chainInfo;
     const {
@@ -3266,13 +3265,13 @@ function getReceiptsTransferOut(receipts) {
 }
 function getWithdrawFromFuelOperations({
   inputs,
-  receipts
+  receipts,
+  baseAssetId
 }) {
   const messageOutReceipts = getReceiptsMessageOut(receipts);
   const withdrawFromFuelOperations = messageOutReceipts.reduce(
     (prevWithdrawFromFuelOps, receipt) => {
-      const assetId = "0x0000000000000000000000000000000000000000000000000000000000000000";
-      const input = getInputFromAssetId(inputs, assetId);
+      const input = getInputFromAssetId(inputs, baseAssetId);
       if (input) {
         const inputAddress = getInputAccountAddress(input);
         const newWithdrawFromFuelOps = addOperation(prevWithdrawFromFuelOps, {
@@ -3289,7 +3288,7 @@ function getWithdrawFromFuelOperations({
           assetsSent: [
             {
               amount: receipt.amount,
-              assetId
+              assetId: baseAssetId
             }
           ]
         });
@@ -3485,7 +3484,8 @@ function getOperations({
   receipts,
   abiMap,
   rawPayload,
-  maxInputs
+  maxInputs,
+  baseAssetId
 }) {
   if (isTypeCreate(transactionType)) {
     return [
@@ -3504,7 +3504,7 @@ function getOperations({
         rawPayload,
         maxInputs
       }),
-      ...getWithdrawFromFuelOperations({ inputs, receipts })
+      ...getWithdrawFromFuelOperations({ inputs, receipts, baseAssetId })
     ];
   }
   return [...getPayProducerOperations(outputs)];
@@ -3640,7 +3640,8 @@ function assembleTransactionSummary(params) {
     maxInputs,
     gasCosts,
     maxGasPerTx,
-    gasPrice
+    gasPrice,
+    baseAssetId
   } = params;
   const gasUsed = getGasUsedFromReceipts(receipts);
   const rawPayload = (0, import_utils18.hexlify)(transactionBytes);
@@ -3651,7 +3652,8 @@ function assembleTransactionSummary(params) {
     receipts,
     rawPayload,
     abiMap,
-    maxInputs
+    maxInputs,
+    baseAssetId
   });
   const typeName = getTransactionTypeName(transaction.type);
   const tip = (0, import_math15.bn)(transaction.policies?.find((policy) => policy.type === import_transactions17.PolicyType.Tip)?.data);
@@ -3811,6 +3813,7 @@ var TransactionResponse = class {
     const { gasPerByte, gasPriceFactor, gasCosts, maxGasPerTx } = this.provider.getGasConfig();
     const gasPrice = await this.provider.getLatestGasPrice();
     const maxInputs = this.provider.getChain().consensusParameters.txParameters.maxInputs;
+    const baseAssetId = this.provider.getBaseAssetId();
     const transactionSummary = assembleTransactionSummary({
       id: this.id,
       receipts,
@@ -3823,7 +3826,8 @@ var TransactionResponse = class {
       maxInputs,
       gasCosts,
       maxGasPerTx,
-      gasPrice
+      gasPrice,
+      baseAssetId
     });
     return transactionSummary;
   }
@@ -4011,7 +4015,6 @@ var _Provider = class {
    * Constructor to initialize a Provider.
    *
    * @param url - GraphQL endpoint of the Fuel node
-   * @param chainInfo - Chain info of the Fuel node
    * @param options - Additional options for the provider
    * @hidden
    */
@@ -4034,10 +4037,14 @@ var _Provider = class {
     this.operations = this.createOperations();
     this.cache = options.cacheUtxo ? new MemoryCache(options.cacheUtxo) : void 0;
   }
+  /** @hidden */
   static clearChainAndNodeCaches() {
     _Provider.nodeInfoCache = {};
     _Provider.chainInfoCache = {};
   }
+  /**
+   * @hidden
+   */
   static getFetchFn(options) {
     const { retryOptions, timeout } = options;
     return autoRetryFetch(async (...args) => {
@@ -4053,8 +4060,11 @@ var _Provider = class {
   }
   /**
    * Creates a new instance of the Provider class. This is the recommended way to initialize a Provider.
+   *
    * @param url - GraphQL endpoint of the Fuel node
    * @param options - Additional options for the provider
+   *
+   * @returns A promise that resolves to a Provider instance.
    */
   static async create(url, options = {}) {
     const provider = new _Provider(url, options);
@@ -4063,6 +4073,8 @@ var _Provider = class {
   }
   /**
    * Returns the cached chainInfo for the current URL.
+   *
+   * @returns the chain information configuration.
    */
   getChain() {
     const chain = _Provider.chainInfoCache[this.url];
@@ -4076,6 +4088,8 @@ var _Provider = class {
   }
   /**
    * Returns the cached nodeInfo for the current URL.
+   *
+   * @returns the node information configuration.
    */
   getNode() {
     const node = _Provider.nodeInfoCache[this.url];
@@ -4107,6 +4121,9 @@ var _Provider = class {
   }
   /**
    * Updates the URL for the provider and fetches the consensus parameters for the new URL, if needed.
+   *
+   * @param url - The URL to connect to.
+   * @param options - Additional options for the provider.
    */
   async connect(url, options) {
     this.url = url;
@@ -4115,9 +4132,9 @@ var _Provider = class {
     await this.fetchChainAndNodeInfo();
   }
   /**
-   * Fetches both the chain and node information, saves it to the cache, and return it.
+   * Return the chain and node information.
    *
-   * @returns NodeInfo and Chain
+   * @returns A promise that resolves to the Chain and NodeInfo.
    */
   async fetchChainAndNodeInfo() {
     const chain = await this.fetchChain();
@@ -4128,6 +4145,9 @@ var _Provider = class {
       nodeInfo
     };
   }
+  /**
+   * @hidden
+   */
   static ensureClientVersionIsSupported(nodeInfo) {
     const { isMajorSupported, isMinorSupported, supportedVersion } = (0, import_versions.checkFuelCoreVersionCompatibility)(nodeInfo.nodeVersion);
     if (!isMajorSupported || !isMinorSupported) {
@@ -4143,6 +4163,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * Create GraphQL client and set operations.
    *
    * @returns The operation SDK object
+   * @hidden
    */
   createOperations() {
     const fetchFn = _Provider.getFetchFn(this.options);
@@ -4187,18 +4208,18 @@ Supported fuel-core version: ${supportedVersion}.`
     return nodeVersion;
   }
   /**
-   * Returns the block number.
+   * Returns the latest block number.
    *
-   * @returns A promise that resolves to the block number
+   * @returns A promise that resolves to the latest block number.
    */
   async getBlockNumber() {
     const { chain } = await this.operations.getChain();
     return (0, import_math17.bn)(chain.latestBlock.height, 10);
   }
   /**
-   * Returns the chain information.
-   * @param url - The URL of the Fuel node
-   * @returns NodeInfo object
+   * Returns the node information for the current provider network.
+   *
+   * @returns a promise that resolves to the node information.
    */
   async fetchNode() {
     const { nodeInfo } = await this.operations.getNodeInfo();
@@ -4213,9 +4234,9 @@ Supported fuel-core version: ${supportedVersion}.`
     return processedNodeInfo;
   }
   /**
-   * Fetches the `chainInfo` for the given node URL.
-   * @param url - The URL of the Fuel node
-   * @returns ChainInfo object
+   * Returns the chain information for the current provider network.
+   *
+   * @returns a promise that resolves to the chain information.
    */
   async fetchChain() {
     const { chain } = await this.operations.getChain();
@@ -4224,8 +4245,9 @@ Supported fuel-core version: ${supportedVersion}.`
     return processedChain;
   }
   /**
-   * Returns the chain ID
-   * @returns A promise that resolves to the chain ID number
+   * Returns the chain ID for the current provider network.
+   *
+   * @returns A promise that resolves to the chain ID number.
    */
   getChainId() {
     const {
@@ -4234,9 +4256,9 @@ Supported fuel-core version: ${supportedVersion}.`
     return chainId.toNumber();
   }
   /**
-   * Returns the base asset ID for the current provider network
+   * Returns the base asset ID for the current provider network.
    *
-   * @returns the base asset ID
+   * @returns the base asset ID.
    */
   getBaseAssetId() {
     const {
@@ -4251,6 +4273,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * the transaction will be mutated and those dependencies will be added.
    *
    * @param transactionRequestLike - The transaction request object.
+   * @param sendTransactionParams - The provider send transaction parameters (optional).
    * @returns A promise that resolves to the transaction response object.
    */
   // #region Provider-sendTransaction
@@ -4295,7 +4318,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * the transaction will be mutated and those dependencies will be added.
    *
    * @param transactionRequestLike - The transaction request object.
-   * @param utxoValidation - Additional provider call parameters.
+   * @param sendTransactionParams - The provider call parameters (optional).
    * @returns A promise that resolves to the call result object.
    */
   async call(transactionRequestLike, { utxoValidation, estimateTxDependencies = true } = {}) {
@@ -4315,6 +4338,8 @@ Supported fuel-core version: ${supportedVersion}.`
   /**
    * Verifies whether enough gas is available to complete transaction.
    *
+   * @template T - The type of the transaction request object.
+   *
    * @param transactionRequest - The transaction request object.
    * @returns A promise that resolves to the estimated transaction request object.
    */
@@ -4349,9 +4374,8 @@ Supported fuel-core version: ${supportedVersion}.`
    * If there are missing variable outputs,
    * `addVariableOutputs` is called on the transaction.
    *
-   *
    * @param transactionRequest - The transaction request object.
-   * @returns A promise.
+   * @returns A promise that resolves to the estimate transaction dependencies.
    */
   async estimateTxDependencies(transactionRequest) {
     if (transactionRequest.type === import_transactions20.TransactionType.Create) {
@@ -4464,6 +4488,14 @@ Supported fuel-core version: ${supportedVersion}.`
     }
     return results;
   }
+  /**
+   * Dry runs multiple transactions.
+   *
+   * @param transactionRequests - Array of transaction request objects.
+   * @param sendTransactionParams - The provider call parameters (optional).
+   *
+   * @returns A promise that resolves to an array of results for each transaction call.
+   */
   async dryRunMultipleTransactions(transactionRequests, { utxoValidation, estimateTxDependencies = true } = {}) {
     if (estimateTxDependencies) {
       return this.estimateMultipleTxDependencies(transactionRequests);
@@ -4534,6 +4566,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * the transaction will be mutated and those dependencies will be added
    *
    * @param transactionRequestLike - The transaction request object.
+   * @param estimateTxParams - The estimate transaction params (optional).
    * @returns A promise that resolves to the call result object.
    */
   async simulate(transactionRequestLike, { estimateTxDependencies = true } = {}) {
@@ -4558,14 +4591,9 @@ Supported fuel-core version: ${supportedVersion}.`
    * to set gasLimit and also reserve balance amounts
    * on the the transaction.
    *
-   * @privateRemarks
-   * The tolerance is add on top of the gasUsed calculated
-   * from the node, this create a safe margin costs like
-   * change states on transfer that don't occur on the dryRun
-   * transaction. The default value is 0.2 or 20%
-   *
    * @param transactionRequestLike - The transaction request object.
-   * @param tolerance - The tolerance to add on top of the gasUsed.
+   * @param transactionCostParams - The transaction cost parameters (optional).
+   *
    * @returns A promise that resolves to the transaction cost object.
    */
   async getTransactionCost(transactionRequestLike, { resourcesOwner, signatureCallback, quantitiesToContract = [] } = {}) {
@@ -4633,6 +4661,15 @@ Supported fuel-core version: ${supportedVersion}.`
       updateMaxFee
     };
   }
+  /**
+   * 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, transactionRequestLike, quantitiesToContract = []) {
     const ownerAddress = import_address3.Address.fromAddressOrString(owner);
     const transactionRequest = transactionRequestify((0, import_ramda3.clone)(transactionRequestLike));
@@ -4654,6 +4691,12 @@ Supported fuel-core version: ${supportedVersion}.`
   }
   /**
    * Returns coins for the given owner.
+   *
+   * @param owner - The address to get coins for.
+   * @param assetId - The asset ID of coins to get (optional).
+   * @param paginationArgs - Pagination arguments (optional).
+   *
+   * @returns A promise that resolves to the coins.
    */
   async getCoins(owner, assetId, paginationArgs) {
     const ownerAddress = import_address3.Address.fromAddressOrString(owner);
@@ -4676,8 +4719,8 @@ Supported fuel-core version: ${supportedVersion}.`
    * Returns resources for the given owner satisfying the spend query.
    *
    * @param owner - The address to get resources for.
-   * @param quantities - The quantities to get.
-   * @param excludedIds - IDs of excluded resources from the selection.
+   * @param quantities - The coin quantities to get.
+   * @param excludedIds - IDs of excluded resources from the selection (optional).
    * @returns A promise that resolves to the resources.
    */
   async getResourcesToSpend(owner, quantities, excludedIds) {
@@ -4732,7 +4775,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * Returns block matching the given ID or height.
    *
    * @param idOrHeight - ID or height of the block.
-   * @returns A promise that resolves to the block.
+   * @returns A promise that resolves to the block or null.
    */
   async getBlock(idOrHeight) {
     let variables;
@@ -4862,7 +4905,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * Returns balances for the given owner.
    *
    * @param owner - The address to get coins for.
-   * @param paginationArgs - Pagination arguments.
+   * @param paginationArgs - Pagination arguments (optional).
    * @returns A promise that resolves to the balances.
    */
   async getBalances(owner, paginationArgs) {
@@ -4881,7 +4924,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * Returns message for the given address.
    *
    * @param address - The address to get message from.
-   * @param paginationArgs - Pagination arguments.
+   * @param paginationArgs - Pagination arguments (optional).
    * @returns A promise that resolves to the messages.
    */
   async getMessages(address, paginationArgs) {
@@ -4912,8 +4955,8 @@ Supported fuel-core version: ${supportedVersion}.`
    *
    * @param transactionId - The transaction to get message from.
    * @param messageId - The message id from MessageOut receipt.
-   * @param commitBlockId - The commit block id.
-   * @param commitBlockHeight - The commit block height.
+   * @param commitBlockId - The commit block id (optional).
+   * @param commitBlockHeight - The commit block height (optional).
    * @returns A promise that resolves to the message proof.
    */
   async getMessageProof(transactionId, nonce, commitBlockId, commitBlockHeight) {
@@ -5001,10 +5044,21 @@ Supported fuel-core version: ${supportedVersion}.`
       data
     };
   }
+  /**
+   * Get the latest gas price from the node.
+   *
+   * @returns A promise that resolves to the latest gas price.
+   */
   async getLatestGasPrice() {
     const { latestGasPrice } = await this.operations.getLatestGasPrice();
     return (0, import_math17.bn)(latestGasPrice.gasPrice);
   }
+  /**
+   * Returns the estimate gas price for the given block horizon.
+   *
+   * @param blockHorizon - The block horizon to estimate gas price for.
+   * @returns A promise that resolves to the estimated gas price.
+   */
   async estimateGasPrice(blockHorizon) {
     const { estimateGasPrice } = await this.operations.estimateGasPrice({
       blockHorizon: String(blockHorizon)
@@ -5024,8 +5078,8 @@ Supported fuel-core version: ${supportedVersion}.`
   /**
    * Lets you produce blocks with custom timestamps and the block number of the last block produced.
    *
-   * @param amount - The amount of blocks to produce
-   * @param startTime - The UNIX timestamp (milliseconds) to set for the first produced block
+   * @param amount - The amount of blocks to produce.
+   * @param startTime - The UNIX timestamp (milliseconds) to set for the first produced block (optional).
    * @returns A promise that resolves to the block number of the last produced block.
    */
   async produceBlocks(amount, startTime) {
@@ -5035,6 +5089,12 @@ Supported fuel-core version: ${supportedVersion}.`
     });
     return (0, import_math17.bn)(latestBlockHeight);
   }
+  /**
+   * Get the transaction response for the given transaction ID.
+   *
+   * @param transactionId - The transaction ID to get the response for.
+   * @returns A promise that resolves to the transaction response.
+   */
   // eslint-disable-next-line @typescript-eslint/require-await
   async getTransactionResponse(transactionId) {
     return new TransactionResponse(transactionId, this);
@@ -5043,7 +5103,7 @@ Supported fuel-core version: ${supportedVersion}.`
    * Returns Message for given nonce.
    *
    * @param nonce - The nonce of the message to retrieve.
-   * @returns A promise that resolves to the Message object.
+   * @returns A promise that resolves to the Message object or null.
    */
   async getMessageByNonce(nonce) {
     const { message } = await this.operations.getMessageByNonce({ nonce });
@@ -5052,6 +5112,12 @@ Supported fuel-core version: ${supportedVersion}.`
     }
     return message;
   }
+  /**
+   * Get the relayed transaction for the given transaction ID.
+   *
+   * @param relayedTransactionId - The relayed transaction ID to get the response for.
+   * @returns A promise that resolves to the relayed transaction.
+   */
   async getRelayedTransactionStatus(relayedTransactionId) {
     const { relayedTransactionStatus } = await this.operations.getRelayedTransactionStatus({
       relayedTransactionId
@@ -5061,6 +5127,9 @@ Supported fuel-core version: ${supportedVersion}.`
     }
     return relayedTransactionStatus;
   }
+  /**
+   * @hidden
+   */
   extractDryRunError(transactionRequest, receipts, dryRunStatus) {
     const status = dryRunStatus;
     let logs = [];
@@ -5090,7 +5159,9 @@ cacheInputs_fn = function(inputs) {
     }
   });
 };
+/** @hidden */
 __publicField(Provider, "chainInfoCache", {});
+/** @hidden */
 __publicField(Provider, "nodeInfoCache", {});
 
 // src/providers/transaction-summary/get-transaction-summary.ts
@@ -5126,6 +5197,7 @@ async function getTransactionSummary(params) {
     }
   } = provider.getChain();
   const gasPrice = await provider.getLatestGasPrice();
+  const baseAssetId = provider.getBaseAssetId();
   const transactionInfo = assembleTransactionSummary({
     id: gqlTransaction.id,
     receipts,
@@ -5138,7 +5210,8 @@ async function getTransactionSummary(params) {
     maxInputs,
     gasCosts,
     maxGasPerTx,
-    gasPrice
+    gasPrice,
+    baseAssetId
   });
   return {
     gqlTransaction,
@@ -5153,6 +5226,7 @@ async function getTransactionSummaryFromRequest(params) {
   const transaction = transactionRequest.toTransaction();
   const transactionBytes = transactionRequest.toTransactionBytes();
   const gasPrice = await provider.getLatestGasPrice();
+  const baseAssetId = provider.getBaseAssetId();
   const transactionSummary = assembleTransactionSummary({
     receipts,
     transaction,
@@ -5163,7 +5237,8 @@ async function getTransactionSummaryFromRequest(params) {
     maxInputs,
     gasCosts,
     maxGasPerTx,
-    gasPrice
+    gasPrice,
+    baseAssetId
   });
   return transactionSummary;
 }
@@ -5179,6 +5254,7 @@ async function getTransactionsSummaries(params) {
     }
   } = provider.getChain();
   const gasPrice = await provider.getLatestGasPrice();
+  const baseAssetId = provider.getBaseAssetId();
   const transactions = edges.map((edge) => {
     const { node: gqlTransaction } = edge;
     const { id, rawPayload, status } = gqlTransaction;
@@ -5200,7 +5276,8 @@ async function getTransactionsSummaries(params) {
       maxInputs,
       gasCosts,
       maxGasPerTx,
-      gasPrice
+      gasPrice,
+      baseAssetId
     });
     const output = {
       gqlTransaction,
@@ -5386,12 +5463,16 @@ var Account = class extends import_interfaces.AbstractAccount {
    * The provider used to interact with the network.
    */
   _provider;
+  /**
+   * The connector for use with external wallets
+   */
   _connector;
   /**
    * Creates a new Account instance.
    *
    * @param address - The address of the account.
    * @param provider - A Provider instance  (optional).
+   * @param connector - A FuelConnector instance (optional).
    */
   constructor(address, provider, connector) {
     super();
@@ -5433,8 +5514,8 @@ var Account = class extends import_interfaces.AbstractAccount {
   /**
    * Retrieves resources satisfying the spend query for the account.
    *
-   * @param quantities - IDs of coins to exclude.
-   * @param excludedIds - IDs of resources to be excluded from the query.
+   * @param quantities - Quantities of resources to be obtained.
+   * @param excludedIds - IDs of resources to be excluded from the query (optional).
    * @returns A promise that resolves to an array of Resources.
    */
   async getResourcesToSpend(quantities, excludedIds) {
@@ -5443,7 +5524,7 @@ var Account = class extends import_interfaces.AbstractAccount {
   /**
    * Retrieves coins owned by the account.
    *
-   * @param assetId - The asset ID of the coins to retrieve.
+   * @param assetId - The asset ID of the coins to retrieve (optional).
    * @returns A promise that resolves to an array of Coins.
    */
   async getCoins(assetId) {
@@ -5496,7 +5577,7 @@ var Account = class extends import_interfaces.AbstractAccount {
   /**
    * Retrieves the balance of the account for the given asset.
    *
-   * @param assetId - The asset ID to check the balance for.
+   * @param assetId - The asset ID to check the balance for (optional).
    * @returns A promise that resolves to the balance amount.
    */
   async getBalance(assetId) {
@@ -5536,7 +5617,7 @@ var Account = class extends import_interfaces.AbstractAccount {
    * @typeParam T - The type of the TransactionRequest.
    * @param request - The transaction request to fund.
    * @param params - The estimated transaction parameters.
-   * @returns The funded transaction request.
+   * @returns A promise that resolves to the funded transaction request.
    */
   async fund(request, params) {
     const { addedSignatures, estimatedPredicates, requiredQuantities, updateMaxFee } = params;
@@ -5629,25 +5710,14 @@ var Account = class extends import_interfaces.AbstractAccount {
    *
    * @param destination - The address of the destination.
    * @param amount - The amount of coins to transfer.
-   * @param assetId - The asset ID of the coins to transfer.
-   * @param txParams - The transaction parameters (gasLimit, tip, maturity, maxFee, witnessLimit).
+   * @param assetId - The asset ID of the coins to transfer (optional).
+   * @param txParams - The transaction parameters (optional).
    * @returns A promise that resolves to the prepared transaction request.
    */
   async createTransfer(destination, amount, assetId, txParams = {}) {
     let request = new ScriptTransactionRequest(txParams);
-    const assetIdToTransfer = assetId ?? this.provider.getBaseAssetId();
-    request.addCoinOutput(import_address4.Address.fromAddressOrString(destination), amount, assetIdToTransfer);
-    const txCost = await this.provider.getTransactionCost(request, {
-      estimateTxDependencies: true,
-      resourcesOwner: this
-    });
-    request = this.validateGasLimitAndMaxFee({
-      transactionRequest: request,
-      gasUsed: txCost.gasUsed,
-      maxFee: txCost.maxFee,
-      txParams
-    });
-    await this.fund(request, txCost);
+    request = this.addTransfer(request, { destination, amount, assetId });
+    request = await this.estimateAndFundTransaction(request, txParams);
     return request;
   }
   /**
@@ -5655,28 +5725,69 @@ var Account = class extends import_interfaces.AbstractAccount {
    *
    * @param destination - The address of the destination.
    * @param amount - The amount of coins to transfer.
-   * @param assetId - The asset ID of the coins to transfer.
-   * @param txParams - The transaction parameters (gasLimit, maturity).
+   * @param assetId - The asset ID of the coins to transfer (optional).
+   * @param txParams - The transaction parameters (optional).
    * @returns A promise that resolves to the transaction response.
    */
   async transfer(destination, amount, assetId, txParams = {}) {
-    if ((0, import_math20.bn)(amount).lte(0)) {
-      throw new import_errors16.FuelError(
-        import_errors16.ErrorCode.INVALID_TRANSFER_AMOUNT,
-        "Transfer amount must be a positive number."
-      );
-    }
-    const assetIdToTransfer = assetId ?? this.provider.getBaseAssetId();
-    const request = await this.createTransfer(destination, amount, assetIdToTransfer, txParams);
+    const request = await this.createTransfer(destination, amount, assetId, txParams);
+    return this.sendTransaction(request, { estimateTxDependencies: false });
+  }
+  /**
+   * Transfers multiple amounts of a token to multiple recipients.
+   *
+   * @param transferParams - An array of `TransferParams` objects representing the transfers to be made.
+   * @param txParams - Optional transaction parameters.
+   * @returns A promise that resolves to a `TransactionResponse` object representing the transaction result.
+   */
+  async batchTransfer(transferParams, txParams = {}) {
+    let request = new ScriptTransactionRequest(txParams);
+    request = this.addBatchTransfer(request, transferParams);
+    request = await this.estimateAndFundTransaction(request, txParams);
     return this.sendTransaction(request, { estimateTxDependencies: false });
   }
+  /**
+   * Adds a transfer to the given transaction request.
+   *
+   * @param request - The script transaction request to add transfers to.
+   * @param transferParams - The object representing the transfer to be made.
+   * @returns The updated transaction request with the added transfer.
+   */
+  addTransfer(request, transferParams) {
+    const { destination, amount, assetId } = transferParams;
+    this.validateTransferAmount(amount);
+    request.addCoinOutput(
+      import_address4.Address.fromAddressOrString(destination),
+      amount,
+      assetId ?? this.provider.getBaseAssetId()
+    );
+    return request;
+  }
+  /**
+   * Adds multiple transfers to a script transaction request.
+   *
+   * @param request - The script transaction request to add transfers to.
+   * @param transferParams - An array of `TransferParams` objects representing the transfers to be made.
+   * @returns The updated script transaction request.
+   */
+  addBatchTransfer(request, transferParams) {
+    const baseAssetId = this.provider.getBaseAssetId();
+    transferParams.forEach(({ destination, amount, assetId }) => {
+      this.addTransfer(request, {
+        destination,
+        amount,
+        assetId: assetId ?? baseAssetId
+      });
+    });
+    return request;
+  }
   /**
    * Transfers coins to a contract address.
    *
    * @param contractId - The address of the contract.
    * @param amount - The amount of coins to transfer.
-   * @param assetId - The asset ID of the coins to transfer.
-   * @param txParams - The optional transaction parameters.
+   * @param assetId - The asset ID of the coins to transfer (optional).
+   * @param txParams - The transaction parameters (optional).
    * @returns A promise that resolves to the transaction response.
    */
   async transferToContract(contractId, amount, assetId, txParams = {}) {
@@ -5717,7 +5828,7 @@ var Account = class extends import_interfaces.AbstractAccount {
    *
    * @param recipient - Address of the recipient on the base chain.
    * @param amount - Amount of base asset.
-   * @param txParams - The optional transaction parameters.
+   * @param txParams - The transaction parameters (optional).
    * @returns A promise that resolves to the transaction response.
    */
   async withdrawToBaseLayer(recipient, amount, txParams = {}) {
@@ -5747,6 +5858,14 @@ var Account = class extends import_interfaces.AbstractAccount {
     await this.fund(request, txCost);
     return this.sendTransaction(request);
   }
+  /**
+   * Sign a message from the account via the connector.
+   *
+   * @param message - the message to sign.
+   * @returns a promise that resolves to the signature.
+   *
+   * @hidden
+   */
   async signMessage(message) {
     if (!this._connector) {
       throw new import_errors16.FuelError(import_errors16.ErrorCode.MISSING_CONNECTOR, "A connector is required to sign messages.");
@@ -5754,7 +5873,7 @@ var Account = class extends import_interfaces.AbstractAccount {
     return this._connector.signMessage(this.address.toString(), message);
   }
   /**
-   * Signs a transaction with the wallet's private key.
+   * Signs a transaction from the account via the connector..
    *
    * @param transactionRequestLike - The transaction request to sign.
    * @returns A promise that resolves to the signature of the transaction.
@@ -5772,6 +5891,7 @@ var Account = class extends import_interfaces.AbstractAccount {
    * Sends a transaction to the network.
    *
    * @param transactionRequestLike - The transaction request to be sent.
+   * @param sendTransactionParams - The provider send transaction parameters (optional).
    * @returns A promise that resolves to the transaction response.
    */
   async sendTransaction(transactionRequestLike, { estimateTxDependencies = true, awaitExecution } = {}) {
@@ -5793,6 +5913,7 @@ var Account = class extends import_interfaces.AbstractAccount {
    * Simulates a transaction.
    *
    * @param transactionRequestLike - The transaction request to be simulated.
+   * @param estimateTxParams - The estimate transaction params (optional).
    * @returns A promise that resolves to the call result.
    */
   async simulateTransaction(transactionRequestLike, { estimateTxDependencies = true } = {}) {
@@ -5802,6 +5923,31 @@ var Account = class extends import_interfaces.AbstractAccount {
     }
     return this.provider.simulate(transactionRequest, { estimateTxDependencies: false });
   }
+  /** @hidden * */
+  validateTransferAmount(amount) {
+    if ((0, import_math20.bn)(amount).lte(0)) {
+      throw new import_errors16.FuelError(
+        import_errors16.ErrorCode.INVALID_TRANSFER_AMOUNT,
+        "Transfer amount must be a positive number."
+      );
+    }
+  }
+  /** @hidden * */
+  async estimateAndFundTransaction(transactionRequest, txParams) {
+    let request = transactionRequest;
+    const txCost = await this.provider.getTransactionCost(request, {
+      resourcesOwner: this
+    });
+    request = this.validateGasLimitAndMaxFee({
+      transactionRequest: request,
+      gasUsed: txCost.gasUsed,
+      maxFee: txCost.maxFee,
+      txParams
+    });
+    request = await this.fund(request, txCost);
+    return request;
+  }
+  /** @hidden * */
   validateGasLimitAndMaxFee({
     gasUsed,
     maxFee,
@@ -6105,6 +6251,8 @@ var BaseWalletUnlocked = class extends Account {
    * Populates the witness signature for a transaction and sends it to the network using `provider.sendTransaction`.
    *
    * @param transactionRequestLike - The transaction request to send.
+   * @param estimateTxDependencies - Whether to estimate the transaction dependencies.
+   * @param awaitExecution - Whether to wait for the transaction to be executed.
    * @returns A promise that resolves to the TransactionResponse object.
    */
   async sendTransaction(transactionRequestLike, { estimateTxDependencies = false, awaitExecution } = {}) {
@@ -6136,6 +6284,12 @@ var BaseWalletUnlocked = class extends Account {
       }
     );
   }
+  /**
+   * Encrypts an unlocked wallet with a password.
+   *
+   * @param password - the password to encrypt the wallet with.
+   * @returns - the encrypted wallet.
+   */
   async encrypt(password) {
     return encryptKeystoreWallet(this.privateKey, this.address, password);
   }
@@ -9413,7 +9567,8 @@ var Predicate = class extends Account {
     );
     return resources.map((resource) => ({
       ...resource,
-      predicate: (0, import_utils37.hexlify)(this.bytes)
+      predicate: (0, import_utils37.hexlify)(this.bytes),
+      predicateData: (0, import_utils37.hexlify)(this.getPredicateData())
     }));
   }
   /**