@fuel-ts/account 0.88.1 → 0.89.1

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.
@@ -17,12 +23,16 @@ export declare class Account extends AbstractAccount {
      * The provider used to interact with the network.
      */
     protected _provider?: Provider;
+    /**
+     * The connector for use with external wallets
+     */
     protected _connector?: FuelConnector;
     /**
      * 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: string | AbstractAddress, provider?: Provider, connector?: FuelConnector);
     /**
@@ -49,15 +59,15 @@ export declare class Account extends 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.
      */
-    getResourcesToSpend(quantities: CoinQuantityLike[] /** IDs of coins to exclude */, excludedIds?: ExcludeResourcesOption): Promise<Resource[]>;
+    getResourcesToSpend(quantities: CoinQuantityLike[], excludedIds?: ExcludeResourcesOption): Promise<Resource[]>;
     /**
      * 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.
      */
     getCoins(assetId?: BytesLike): Promise<Coin[]>;
@@ -70,7 +80,7 @@ export declare class Account extends 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.
      */
     getBalance(assetId?: BytesLike): Promise<BN>;
@@ -86,7 +96,7 @@ export declare class Account extends 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.
      */
     fund<T extends TransactionRequest>(request: T, params: EstimatedTxParams): Promise<T>;
     /**
@@ -94,73 +104,75 @@ export declare class Account extends 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.
      */
-    createTransfer(
-    /** Address of the destination */
-    destination: string | AbstractAddress, 
-    /** Amount of coins */
-    amount: BigNumberish, 
-    /** Asset ID of coins */
-    assetId?: BytesLike, 
-    /** Tx Params */
-    txParams?: TxParamsType): Promise<TransactionRequest>;
+    createTransfer(destination: string | AbstractAddress, amount: BigNumberish, assetId?: BytesLike, txParams?: TxParamsType): Promise<TransactionRequest>;
     /**
      * Transfers coins to a destination address.
      *
      * @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.
      */
-    transfer(
-    /** Address of the destination */
-    destination: string | AbstractAddress, 
-    /** Amount of coins */
-    amount: BigNumberish, 
-    /** Asset ID of coins */
-    assetId?: BytesLike, 
-    /** Tx Params */
-    txParams?: TxParamsType): Promise<TransactionResponse>;
+    transfer(destination: string | AbstractAddress, amount: BigNumberish, assetId?: BytesLike, 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.
      *
      * @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.
      */
-    transferToContract(
-    /** Contract address */
-    contractId: string | AbstractAddress, 
-    /** Amount of coins */
-    amount: BigNumberish, 
-    /** Asset ID of coins */
-    assetId?: BytesLike, 
-    /** Tx Params */
-    txParams?: TxParamsType): Promise<TransactionResponse>;
+    transferToContract(contractId: string | AbstractAddress, amount: BigNumberish, assetId?: BytesLike, txParams?: TxParamsType): Promise<TransactionResponse>;
     /**
      * Withdraws an amount of the base asset to the base chain.
      *
      * @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.
      */
-    withdrawToBaseLayer(
-    /** Address of the recipient on the base chain */
-    recipient: string | AbstractAddress, 
-    /** Amount of base asset */
-    amount: BigNumberish, 
-    /** Tx Params */
-    txParams?: TxParamsType): Promise<TransactionResponse>;
+    withdrawToBaseLayer(recipient: string | AbstractAddress, amount: BigNumberish, txParams?: TxParamsType): Promise<TransactionResponse>;
+    /**
+     * Sign a message from the account via the connector.
+     *
+     * @param message - the message to sign.
+     * @returns a promise that resolves to the signature.
+     *
+     * @hidden
+     */
     signMessage(message: string): Promise<string>;
     /**
-     * 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.
@@ -170,6 +182,7 @@ export declare class Account extends 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.
      */
     sendTransaction(transactionRequestLike: TransactionRequestLike, { estimateTxDependencies, awaitExecution }?: ProviderSendTxParams): Promise<TransactionResponse>;
@@ -177,9 +190,15 @@ export declare class Account extends 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.
      */
     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;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IAErC;;;;;;OAMG;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,EAC9B,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,CAClB,WAAW,EAAE,MAAM,GAAG,eAAe,EACrC,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,SAAS,EACnB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAO9B;;;;;;;;OAQG;IACG,QAAQ,CACZ,WAAW,EAAE,MAAM,GAAG,eAAe,EACrC,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,SAAS,EACnB,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,CACtB,UAAU,EAAE,MAAM,GAAG,eAAe,EACpC,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,SAAS,EACnB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAyC/B;;;;;;;OAOG;IACG,mBAAmB,CACvB,SAAS,EAAE,MAAM,GAAG,eAAe,EACnC,MAAM,EAAE,YAAY,EACpB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;IAmC/B;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnD;;;;;OAKG;IACG,eAAe,CAAC,sBAAsB,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUtF;;;;;;OAMG;IACG,eAAe,CACnB,sBAAsB,EAAE,sBAAsB,EAC9C,EAAE,sBAA6B,EAAE,cAAc,EAAE,GAAE,oBAAyB,GAC3E,OAAO,CAAC,mBAAmB,CAAC;IAgB/B;;;;;;OAMG;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"}