@fuel-ts/account 0.0.0-rc-1356-20240522164420 → 0.0.0-rc-1356-20240523144307

package/dist/test-utils.global.js

@@ -43001,6 +43001,13 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
       }
       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 {
@@ -44083,7 +44090,6 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
      * 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
      */
@@ -44106,10 +44112,14 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
       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) => {
@@ -44125,8 +44135,11 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
     }
     /**
      * 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);
@@ -44135,6 +44148,8 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
     }
     /**
      * Returns the cached chainInfo for the current URL.
+     *
+     * @returns the chain information configuration.
      */
     getChain() {
       const chain = _Provider.chainInfoCache[this.url];
@@ -44148,6 +44163,8 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
     }
     /**
      * Returns the cached nodeInfo for the current URL.
+     *
+     * @returns the node information configuration.
      */
     getNode() {
       const node = _Provider.nodeInfoCache[this.url];
@@ -44179,6 +44196,9 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
     }
     /**
      * 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;
@@ -44187,9 +44207,9 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
       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();
@@ -44200,6 +44220,9 @@ ${PANIC_DOC_URL}#variant.${statusReason}`;
         nodeInfo
       };
     }
+    /**
+     * @hidden
+     */
     static ensureClientVersionIsSupported(nodeInfo) {
       const { isMajorSupported, isMinorSupported, supportedVersion } = checkFuelCoreVersionCompatibility(nodeInfo.nodeVersion);
       if (!isMajorSupported || !isMinorSupported) {
@@ -44215,6 +44238,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);
@@ -44259,18 +44283,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 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();
@@ -44285,9 +44309,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();
@@ -44296,8 +44320,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 {
@@ -44306,9 +44331,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 {
@@ -44323,6 +44348,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
@@ -44367,7 +44393,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 } = {}) {
@@ -44387,6 +44413,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.
      */
@@ -44421,9 +44449,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 === TransactionType.Create) {
@@ -44536,6 +44563,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);
@@ -44606,6 +44641,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 } = {}) {
@@ -44630,14 +44666,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 = [] } = {}) {
@@ -44705,6 +44736,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 = Address.fromAddressOrString(owner);
       const transactionRequest = transactionRequestify(clone_default(transactionRequestLike));
@@ -44726,6 +44766,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 = Address.fromAddressOrString(owner);
@@ -44748,8 +44794,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) {
@@ -44804,7 +44850,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;
@@ -44934,7 +44980,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) {
@@ -44953,7 +44999,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) {
@@ -44984,8 +45030,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) {
@@ -45073,10 +45119,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 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)
@@ -45096,8 +45153,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) {
@@ -45107,6 +45164,12 @@ Supported fuel-core version: ${supportedVersion}.`
       });
       return 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);
@@ -45115,7 +45178,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 });
@@ -45124,6 +45187,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
@@ -45133,6 +45202,9 @@ Supported fuel-core version: ${supportedVersion}.`
       }
       return relayedTransactionStatus;
     }
+    /**
+     * @hidden
+     */
     extractDryRunError(transactionRequest, receipts, dryRunStatus) {
       const status = dryRunStatus;
       let logs = [];
@@ -45162,7 +45234,9 @@ Supported fuel-core version: ${supportedVersion}.`
       }
     });
   };
+  /** @hidden */
   __publicField(Provider, "chainInfoCache", {});
+  /** @hidden */
   __publicField(Provider, "nodeInfoCache", {});
 
   // src/providers/chains.ts
@@ -45280,12 +45354,16 @@ Supported fuel-core version: ${supportedVersion}.`
      * 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();
@@ -45327,8 +45405,8 @@ Supported fuel-core version: ${supportedVersion}.`
     /**
      * 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) {
@@ -45337,7 +45415,7 @@ Supported fuel-core version: ${supportedVersion}.`
     /**
      * 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) {
@@ -45390,7 +45468,7 @@ Supported fuel-core version: ${supportedVersion}.`
     /**
      * 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) {
@@ -45430,7 +45508,7 @@ Supported fuel-core version: ${supportedVersion}.`
      * @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;
@@ -45523,8 +45601,8 @@ Supported fuel-core version: ${supportedVersion}.`
      *
      * @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 = {}) {
@@ -45538,8 +45616,8 @@ Supported fuel-core version: ${supportedVersion}.`
      *
      * @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 = {}) {
@@ -45599,8 +45677,8 @@ Supported fuel-core version: ${supportedVersion}.`
      *
      * @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 = {}) {
@@ -45641,7 +45719,7 @@ Supported fuel-core version: ${supportedVersion}.`
      *
      * @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 = {}) {
@@ -45671,7 +45749,14 @@ Supported fuel-core version: ${supportedVersion}.`
       await this.fund(request, txCost);
       return this.sendTransaction(request);
     }
-    /** @hidden * */
+    /**
+     * 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 FuelError(ErrorCode.MISSING_CONNECTOR, "A connector is required to sign messages.");
@@ -45679,7 +45764,7 @@ Supported fuel-core version: ${supportedVersion}.`
       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.
@@ -45697,6 +45782,7 @@ Supported fuel-core version: ${supportedVersion}.`
      * 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 } = {}) {
@@ -45718,6 +45804,7 @@ Supported fuel-core version: ${supportedVersion}.`
      * 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 } = {}) {
@@ -47356,6 +47443,8 @@ Supported fuel-core version: ${supportedVersion}.`
      * 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 } = {}) {
@@ -47387,6 +47476,12 @@ Supported fuel-core version: ${supportedVersion}.`
         }
       );
     }
+    /**
+     * 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);
     }