@fuel-ts/account 0.0.0-rc-1356-20240520180710 → 0.0.0-rc-2333-20240520181329

package/dist/account.d.ts

@@ -3,7 +3,13 @@ import type { AbstractAddress, BytesLike } from '@fuel-ts/interfaces';
 import type { BigNumberish, BN } from '@fuel-ts/math';
 import type { FuelConnector } from './connectors';
 import type { TransactionRequestLike, CallResult, TransactionRequest, Coin, CoinQuantityLike, CoinQuantity, Message, Resource, ExcludeResourcesOption, Provider, ScriptTransactionRequestLike, ProviderSendTxParams, TransactionResponse, EstimateTransactionParams, TransactionCost } from './providers';
+import { ScriptTransactionRequest } from './providers';
 export type TxParamsType = Pick<ScriptTransactionRequestLike, 'gasLimit' | 'tip' | 'maturity' | 'maxFee' | 'witnessLimit'>;
+export type TransferParams = {
+    destination: string | AbstractAddress;
+    amount: BigNumberish;
+    assetId?: BytesLike;
+};
 export type EstimatedTxParams = Pick<TransactionCost, 'estimatedPredicates' | 'addedSignatures' | 'requiredQuantities' | 'updateMaxFee'>;
 /**
  * `Account` provides an abstraction for interacting with accounts or wallets on the network.
@@ -125,6 +131,30 @@ export declare class Account extends AbstractAccount {
     assetId?: BytesLike, 
     /** Tx Params */
     txParams?: TxParamsType): Promise<TransactionResponse>;
+    /**
+     * 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.
+     */
+    batchTransfer(transferParams: TransferParams[], txParams?: TxParamsType): Promise<TransactionResponse>;
+    /**
+     * 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: ScriptTransactionRequest, transferParams: TransferParams): ScriptTransactionRequest;
+    /**
+     * 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: ScriptTransactionRequest, transferParams: TransferParams[]): ScriptTransactionRequest;
     /**
      * Transfers coins to a contract address.
      *
@@ -158,6 +188,7 @@ export declare class Account extends AbstractAccount {
     amount: BigNumberish, 
     /** Tx Params */
     txParams?: TxParamsType): Promise<TransactionResponse>;
+    /** @hidden * */
     signMessage(message: string): Promise<string>;
     /**
      * Signs a transaction with the wallet's private key.
@@ -180,6 +211,11 @@ export declare class Account extends AbstractAccount {
      * @returns A promise that resolves to the call result.
      */
     simulateTransaction(transactionRequestLike: TransactionRequestLike, { estimateTxDependencies }?: EstimateTransactionParams): Promise<CallResult>;
+    /** @hidden * */
+    private validateTransferAmount;
+    /** @hidden * */
+    private estimateAndFundTransaction;
+    /** @hidden * */
     private validateGasLimitAndMaxFee;
 }
 //# sourceMappingURL=account.d.ts.map

package/dist/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAKtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EACV,sBAAsB,EACtB,UAAU,EACV,kBAAkB,EAClB,IAAI,EACJ,gBAAgB,EAChB,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,sBAAsB,EACtB,QAAQ,EACR,4BAA4B,EAC5B,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EAChB,MAAM,aAAa,CAAC;AAerB,MAAM,MAAM,YAAY,GAAG,IAAI,CAC7B,4BAA4B,EAC5B,UAAU,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,cAAc,CAC5D,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,eAAe,EACf,qBAAqB,GAAG,iBAAiB,GAAG,oBAAoB,GAAG,cAAc,CAClF,CAAC;AAGF;;GAEG;AACH,qBAAa,OAAQ,SAAQ,eAAe;IAC1C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC;IAE/B,SAAS,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IAErC;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,GAAG,eAAe,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,aAAa;IAO7F;;;;;;OAMG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAMvB;IAED;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ;IAKrC;;;;;;OAMG;IACG,mBAAmB,CACvB,UAAU,EAAE,gBAAgB,EAAE,CAAC,8BAA8B,EAC7D,WAAW,CAAC,EAAE,sBAAsB,GACnC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAItB;;;;;OAKG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IA6BpD;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IA6BvC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;IAMlD;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IA6B5C;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,SAAS,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC;IA4G3F;;;;;;;;OAQG;IACG,cAAc;IAClB,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,eAAe;IACrC,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,CAAC,EAAE,SAAS;IACnB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAqB9B;;;;;;;;OAQG;IACG,QAAQ;IACZ,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,eAAe;IACrC,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,CAAC,EAAE,SAAS;IACnB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAY/B;;;;;;;;OAQG;IACG,kBAAkB;IACtB,uBAAuB;IACvB,UAAU,EAAE,MAAM,GAAG,eAAe;IACpC,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,CAAC,EAAE,SAAS;IACnB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAyC/B;;;;;;;OAOG;IACG,mBAAmB;IACvB,iDAAiD;IACjD,SAAS,EAAE,MAAM,GAAG,eAAe;IACnC,2BAA2B;IAC3B,MAAM,EAAE,YAAY;IACpB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAmCzB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnD;;;;;OAKG;IACG,eAAe,CAAC,sBAAsB,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUtF;;;;;OAKG;IACG,eAAe,CACnB,sBAAsB,EAAE,sBAAsB,EAC9C,EAAE,sBAA6B,EAAE,cAAc,EAAE,GAAE,oBAAyB,GAC3E,OAAO,CAAC,mBAAmB,CAAC;IAgB/B;;;;;OAKG;IACG,mBAAmB,CACvB,sBAAsB,EAAE,sBAAsB,EAC9C,EAAE,sBAA6B,EAAE,GAAE,yBAA8B,GAChE,OAAO,CAAC,UAAU,CAAC;IAQtB,OAAO,CAAC,yBAAyB;CAiClC"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAKtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EACV,sBAAsB,EACtB,UAAU,EACV,kBAAkB,EAClB,IAAI,EACJ,gBAAgB,EAChB,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,sBAAsB,EACtB,QAAQ,EACR,4BAA4B,EAC5B,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,wBAAwB,EAGzB,MAAM,aAAa,CAAC;AASrB,MAAM,MAAM,YAAY,GAAG,IAAI,CAC7B,4BAA4B,EAC5B,UAAU,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,cAAc,CAC5D,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,GAAG,eAAe,CAAC;IACtC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,eAAe,EACf,qBAAqB,GAAG,iBAAiB,GAAG,oBAAoB,GAAG,cAAc,CAClF,CAAC;AAGF;;GAEG;AACH,qBAAa,OAAQ,SAAQ,eAAe;IAC1C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC;IAE/B,SAAS,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IAErC;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,GAAG,eAAe,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,aAAa;IAO7F;;;;;;OAMG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAMvB;IAED;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ;IAKrC;;;;;;OAMG;IACG,mBAAmB,CACvB,UAAU,EAAE,gBAAgB,EAAE,CAAC,8BAA8B,EAC7D,WAAW,CAAC,EAAE,sBAAsB,GACnC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAItB;;;;;OAKG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IA6BpD;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IA6BvC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;IAMlD;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IA6B5C;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,SAAS,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC;IA4G3F;;;;;;;;OAQG;IACG,cAAc;IAClB,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,eAAe;IACrC,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,CAAC,EAAE,SAAS;IACnB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAO9B;;;;;;;;OAQG;IACG,QAAQ;IACZ,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,eAAe;IACrC,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,CAAC,EAAE,SAAS;IACnB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAK/B;;;;;;OAMG;IACG,aAAa,CACjB,cAAc,EAAE,cAAc,EAAE,EAChC,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,cAAc;IAW7E;;;;;;OAMG;IACH,gBAAgB,CAAC,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,cAAc,EAAE;IAYpF;;;;;;;;OAQG;IACG,kBAAkB;IACtB,uBAAuB;IACvB,UAAU,EAAE,MAAM,GAAG,eAAe;IACpC,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,CAAC,EAAE,SAAS;IACnB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAyC/B;;;;;;;OAOG;IACG,mBAAmB;IACvB,iDAAiD;IACjD,SAAS,EAAE,MAAM,GAAG,eAAe;IACnC,2BAA2B;IAC3B,MAAM,EAAE,YAAY;IACpB,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAmC/B,gBAAgB;IACV,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnD;;;;;OAKG;IACG,eAAe,CAAC,sBAAsB,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUtF;;;;;OAKG;IACG,eAAe,CACnB,sBAAsB,EAAE,sBAAsB,EAC9C,EAAE,sBAA6B,EAAE,cAAc,EAAE,GAAE,oBAAyB,GAC3E,OAAO,CAAC,mBAAmB,CAAC;IAgB/B;;;;;OAKG;IACG,mBAAmB,CACvB,sBAAsB,EAAE,sBAAsB,EAC9C,EAAE,sBAA6B,EAAE,GAAE,yBAA8B,GAChE,OAAO,CAAC,UAAU,CAAC;IAQtB,gBAAgB;IAChB,OAAO,CAAC,sBAAsB;IAS9B,gBAAgB;YACF,0BAA0B;IAkBxC,gBAAgB;IAChB,OAAO,CAAC,yBAAyB;CAiClC"}

package/dist/index.global.js

@@ -29985,13 +29985,6 @@ This unreleased fuel-core build may include features and updates not yet support
   };
   var DateTime = _DateTime;
   __publicField3(DateTime, "TAI64_NULL", "");
-  function sleep(time) {
-    return new Promise((resolve) => {
-      setTimeout(() => {
-        resolve(true);
-      }, time);
-    });
-  }
   function isDefined(value) {
     return value !== void 0;
   }
@@ -38334,6 +38327,15 @@ ${MessageCoinFragmentDoc}`;
     return normalize2(clone_default(root));
   }
 
+  // src/providers/utils/sleep.ts
+  function sleep(time) {
+    return new Promise((resolve) => {
+      setTimeout(() => {
+        resolve(true);
+      }, time);
+    });
+  }
+
   // src/providers/utils/extract-tx-error.ts
   var assemblePanicError = (statusReason) => {
     let errorMessage = `The transaction reverted with reason: "${statusReason}".`;
@@ -42028,19 +42030,8 @@ Supported fuel-core version: ${supportedVersion}.`
      */
     async createTransfer(destination, amount, assetId, txParams = {}) {
       let request = new ScriptTransactionRequest(txParams);
-      const assetIdToTransfer = assetId ?? this.provider.getBaseAssetId();
-      request.addCoinOutput(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;
     }
     /**
@@ -42053,16 +42044,57 @@ Supported fuel-core version: ${supportedVersion}.`
      * @returns A promise that resolves to the transaction response.
      */
     async transfer(destination, amount, assetId, txParams = {}) {
-      if (bn(amount).lte(0)) {
-        throw new FuelError(
-          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(
+        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.
      *
@@ -42140,6 +42172,7 @@ Supported fuel-core version: ${supportedVersion}.`
       await this.fund(request, txCost);
       return this.sendTransaction(request);
     }
+    /** @hidden * */
     async signMessage(message) {
       if (!this._connector) {
         throw new FuelError(ErrorCode.MISSING_CONNECTOR, "A connector is required to sign messages.");
@@ -42195,6 +42228,31 @@ Supported fuel-core version: ${supportedVersion}.`
       }
       return this.provider.simulate(transactionRequest, { estimateTxDependencies: false });
     }
+    /** @hidden * */
+    validateTransferAmount(amount) {
+      if (bn(amount).lte(0)) {
+        throw new FuelError(
+          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,