@fuel-ts/account 0.76.3 → 0.78.0

package/dist/index.js

@@ -231,7 +231,7 @@ var import_transactions17 = require("@fuel-ts/transactions");
 var import_utils22 = require("@fuel-ts/utils");
 var import_versions = require("@fuel-ts/versions");
 var import_utils23 = require("@noble/curves/abstract/utils");
-var import_ethers2 = require("ethers");
+var import_ethers = require("ethers");
 var import_graphql_request = require("graphql-request");
 var import_ramda3 = require("ramda");
 
@@ -296,6 +296,9 @@ var TransactionStatusFragmentFragmentDoc = import_graphql_tag.default`
     time
     reason
   }
+  ... on SqueezedOutStatus {
+    reason
+  }
 }
     `;
 var TransactionFragmentFragmentDoc = import_graphql_tag.default`
@@ -1073,7 +1076,16 @@ var _FuelGraphqlSubscriber = class {
       if (!text.startsWith("data:")) {
         continue;
       }
-      const { data, errors } = JSON.parse(text.split("data:")[1]);
+      let data;
+      let errors;
+      try {
+        ({ data, errors } = JSON.parse(text.replace(/^data:/, "")));
+      } catch (e) {
+        throw new import_errors.FuelError(
+          import_errors.ErrorCode.STREAM_PARSING_ERROR,
+          `Error while parsing stream data response: ${text}`
+        );
+      }
       if (Array.isArray(errors)) {
         throw new import_errors.FuelError(
           import_errors.FuelError.CODES.INVALID_REQUEST,
@@ -1827,13 +1839,27 @@ var BaseTransactionRequest = class {
     this.outputs.push(output);
     return this.outputs.length - 1;
   }
+  /**
+   * @hidden
+   *
+   * Pushes a witness to the list and returns the index
+   *
+   * @param signature - The signature to add to the witness.
+   * @returns The index of the created witness.
+   */
+  addWitness(signature) {
+    this.witnesses.push(signature);
+    return this.witnesses.length - 1;
+  }
   /**
    * @hidden
    *
    * Creates an empty witness without any side effects and returns the index
+   *
+   * @returns The index of the created witness.
    */
-  createWitness() {
-    this.witnesses.push((0, import_utils9.concat)([import_configs6.ZeroBytes32, import_configs6.ZeroBytes32]));
+  addEmptyWitness() {
+    this.addWitness((0, import_utils9.concat)([import_configs6.ZeroBytes32, import_configs6.ZeroBytes32]));
     return this.witnesses.length - 1;
   }
   /**
@@ -1862,6 +1888,21 @@ var BaseTransactionRequest = class {
     }
     this.witnesses[index] = witness;
   }
+  /**
+   * Helper function to add an external signature to the transaction.
+   *
+   * @param account - The account/s to sign to the transaction.
+   * @returns The transaction with the signature witness added.
+   */
+  async addAccountWitnesses(account) {
+    const accounts = Array.isArray(account) ? account : [account];
+    await Promise.all(
+      accounts.map(async (acc) => {
+        this.addWitness(await acc.signTransaction(this));
+      })
+    );
+    return this;
+  }
   /**
    * Gets the coin inputs for a transaction.
    *
@@ -1927,7 +1968,7 @@ var BaseTransactionRequest = class {
     } else {
       witnessIndex = this.getCoinInputWitnessIndexByOwner(owner);
       if (typeof witnessIndex !== "number") {
-        witnessIndex = this.createWitness();
+        witnessIndex = this.addEmptyWitness();
       }
     }
     const input = {
@@ -1939,7 +1980,7 @@ var BaseTransactionRequest = class {
       txPointer: "0x00000000000000000000000000000000",
       witnessIndex,
       predicate: predicate?.bytes,
-      predicateData: predicate?.predicateData
+      predicateData: predicate?.predicateDataBytes
     };
     this.pushInput(input);
     this.addChangeOutput(owner, assetId);
@@ -1961,7 +2002,7 @@ var BaseTransactionRequest = class {
     } else {
       witnessIndex = this.getCoinInputWitnessIndexByOwner(recipient);
       if (typeof witnessIndex !== "number") {
-        witnessIndex = this.createWitness();
+        witnessIndex = this.addEmptyWitness();
       }
     }
     const input = {
@@ -1972,7 +2013,7 @@ var BaseTransactionRequest = class {
       amount,
       witnessIndex,
       predicate: predicate?.bytes,
-      predicateData: predicate?.predicateData
+      predicateData: predicate?.predicateDataBytes
     };
     this.pushInput(input);
     this.addChangeOutput(recipient, assetId);
@@ -2219,7 +2260,6 @@ var import_hasher = require("@fuel-ts/hasher");
 var import_math7 = require("@fuel-ts/math");
 var import_transactions6 = require("@fuel-ts/transactions");
 var import_utils11 = require("@fuel-ts/utils");
-var import_ethers = require("ethers");
 var import_ramda2 = require("ramda");
 function hashTransaction(transactionRequest, chainId) {
   const transaction = transactionRequest.toTransaction();
@@ -2282,7 +2322,7 @@ function hashTransaction(transactionRequest, chainId) {
   transaction.witnesses = [];
   const chainIdBytes = (0, import_hasher.uint64ToBytesBE)(chainId);
   const concatenatedData = (0, import_utils11.concat)([chainIdBytes, new import_transactions6.TransactionCoder().encode(transaction)]);
-  return (0, import_ethers.sha256)(concatenatedData);
+  return (0, import_hasher.sha256)(concatenatedData);
 }
 
 // src/providers/transaction-request/storage-slot.ts
@@ -3483,6 +3523,12 @@ var TransactionResponse = class {
       transactionId: this.id
     });
     for await (const { statusChange } of subscription) {
+      if (statusChange.type === "SqueezedOutStatus") {
+        throw new import_errors12.FuelError(
+          import_errors12.ErrorCode.TRANSACTION_SQUEEZED_OUT,
+          `Transaction Squeezed Out with reason: ${statusChange.reason}`
+        );
+      }
       if (statusChange.type !== "SubmittedStatus") {
         break;
       }
@@ -3660,14 +3706,15 @@ var _Provider = class {
   }
   static getFetchFn(options) {
     const { retryOptions, timeout } = options;
-    return autoRetryFetch((...args) => {
-      if (options.fetch) {
-        return options.fetch(...args);
-      }
+    return autoRetryFetch(async (...args) => {
       const url = args[0];
       const request = args[1];
       const signal = timeout ? AbortSignal.timeout(timeout) : void 0;
-      return fetch(url, { ...request, signal });
+      let fullRequest = { ...request, signal };
+      if (options.requestMiddleware) {
+        fullRequest = await options.requestMiddleware(fullRequest);
+      }
+      return options.fetch ? options.fetch(url, fullRequest, options) : fetch(url, fullRequest);
     }, retryOptions);
   }
   /**
@@ -3801,7 +3848,7 @@ var _Provider = class {
       name,
       consensusParameters: { chainId }
     } = await this.getChain();
-    const network = new import_ethers2.Network(name, chainId.toNumber());
+    const network = new import_ethers.Network(name, chainId.toNumber());
     return Promise.resolve(network);
   }
   /**
@@ -3873,6 +3920,12 @@ var _Provider = class {
     if (awaitExecution) {
       const subscription = this.operations.submitAndAwait({ encodedTransaction });
       for await (const { submitAndAwait } of subscription) {
+        if (submitAndAwait.type === "SqueezedOutStatus") {
+          throw new import_errors13.FuelError(
+            import_errors13.ErrorCode.TRANSACTION_SQUEEZED_OUT,
+            `Transaction Squeezed Out with reason: ${submitAndAwait.reason}`
+          );
+        }
         if (submitAndAwait.type !== "SubmittedStatus") {
           break;
         }
@@ -4036,7 +4089,8 @@ var _Provider = class {
   async getTransactionCost(transactionRequestLike, forwardingQuantities = [], {
     estimateTxDependencies = true,
     estimatePredicates = true,
-    resourcesOwner
+    resourcesOwner,
+    signatureCallback
   } = {}) {
     const txRequestClone = (0, import_ramda3.clone)(transactionRequestify(transactionRequestLike));
     const chainInfo = this.getChain();
@@ -4055,6 +4109,9 @@ var _Provider = class {
       }
       await this.estimatePredicates(txRequestClone);
     }
+    if (signatureCallback && isScriptTransaction) {
+      await signatureCallback(txRequestClone);
+    }
     const minGas = txRequestClone.calculateMinGas(chainInfo);
     const maxGas = txRequestClone.calculateMaxGas(chainInfo, minGas);
     let receipts = [];
@@ -5004,6 +5061,12 @@ var Account = class extends import_interfaces.AbstractAccount {
    * @returns A promise that resolves to the transaction response.
    */
   async transfer(destination, amount, assetId = import_configs11.BaseAssetId, txParams = {}) {
+    if ((0, import_math17.bn)(amount).lte(0)) {
+      throw new import_errors15.FuelError(
+        import_errors15.ErrorCode.INVALID_TRANSFER_AMOUNT,
+        "Transfer amount must be a positive number."
+      );
+    }
     const request = await this.createTransfer(destination, amount, assetId, txParams);
     return this.sendTransaction(request, { estimateTxDependencies: false });
   }
@@ -5017,6 +5080,12 @@ var Account = class extends import_interfaces.AbstractAccount {
    * @returns A promise that resolves to the transaction response.
    */
   async transferToContract(contractId, amount, assetId = import_configs11.BaseAssetId, txParams = {}) {
+    if ((0, import_math17.bn)(amount).lte(0)) {
+      throw new import_errors15.FuelError(
+        import_errors15.ErrorCode.INVALID_TRANSFER_AMOUNT,
+        "Transfer amount must be a positive number."
+      );
+    }
     const contractAddress = import_address4.Address.fromAddressOrString(contractId);
     const { minGasPrice } = this.provider.getGasConfig();
     const params = { gasPrice: minGasPrice, ...txParams };
@@ -5090,6 +5159,21 @@ var Account = class extends import_interfaces.AbstractAccount {
     }
     return this._connector.signMessage(this.address.toString(), message);
   }
+  /**
+   * Signs a transaction with the wallet's private key.
+   *
+   * @param transactionRequestLike - The transaction request to sign.
+   * @returns A promise that resolves to the signature of the transaction.
+   */
+  async signTransaction(transactionRequestLike) {
+    if (!this._connector) {
+      throw new import_errors15.FuelError(
+        import_errors15.ErrorCode.MISSING_CONNECTOR,
+        "A connector is required to sign transactions."
+      );
+    }
+    return this._connector.signTransaction(this.address.toString(), transactionRequestLike);
+  }
   /**
    * Sends a transaction to the network.
    *
@@ -5400,7 +5484,7 @@ var BaseWalletUnlocked = class extends Account {
    */
   async signTransaction(transactionRequestLike) {
     const transactionRequest = transactionRequestify(transactionRequestLike);
-    const chainId = this.provider.getChain().consensusParameters.chainId.toNumber();
+    const chainId = this.provider.getChainId();
     const hashedTransaction = transactionRequest.getTransactionId(chainId);
     const signature = await this.signer().sign(hashedTransaction);
     return (0, import_utils30.hexlify)(signature);
@@ -5463,15 +5547,17 @@ __publicField(BaseWalletUnlocked, "defaultPath", "m/44'/1179993420'/0'/0/0");
 
 // src/hdwallet/hdwallet.ts
 var import_errors19 = require("@fuel-ts/errors");
+var import_hasher6 = require("@fuel-ts/hasher");
 var import_math19 = require("@fuel-ts/math");
 var import_utils34 = require("@fuel-ts/utils");
-var import_ethers5 = require("ethers");
+var import_ethers3 = require("ethers");
 
 // src/mnemonic/mnemonic.ts
 var import_crypto3 = require("@fuel-ts/crypto");
 var import_errors18 = require("@fuel-ts/errors");
+var import_hasher5 = require("@fuel-ts/hasher");
 var import_utils32 = require("@fuel-ts/utils");
-var import_ethers4 = require("ethers");
+var import_ethers2 = require("ethers");
 
 // src/wordlists/words/english.ts
 var english = [
@@ -7533,8 +7619,8 @@ var Language = /* @__PURE__ */ ((Language2) => {
 
 // src/mnemonic/utils.ts
 var import_errors17 = require("@fuel-ts/errors");
+var import_hasher4 = require("@fuel-ts/hasher");
 var import_utils31 = require("@fuel-ts/utils");
-var import_ethers3 = require("ethers");
 function toUtf8Bytes(stri) {
   const str = stri.normalize("NFKD");
   const result = [];
@@ -7601,7 +7687,7 @@ function entropyToMnemonicIndices(entropy) {
     }
   }
   const checksumBits = entropy.length / 4;
-  const checksum = (0, import_utils31.arrayify)((0, import_ethers3.sha256)(entropy))[0] & getUpperMask(checksumBits);
+  const checksum = (0, import_utils31.arrayify)((0, import_hasher4.sha256)(entropy))[0] & getUpperMask(checksumBits);
   indices[indices.length - 1] <<= checksumBits;
   indices[indices.length - 1] |= checksum >> 8 - checksumBits;
   return indices;
@@ -7628,7 +7714,7 @@ function mnemonicWordsToEntropy(words, wordlist) {
   const entropyBits = 32 * words.length / 3;
   const checksumBits = words.length / 3;
   const checksumMask = getUpperMask(checksumBits);
-  const checksum = (0, import_utils31.arrayify)((0, import_ethers3.sha256)(entropy.slice(0, entropyBits / 8)))[0] & checksumMask;
+  const checksum = (0, import_utils31.arrayify)((0, import_hasher4.sha256)(entropy.slice(0, entropyBits / 8)))[0] & checksumMask;
   if (checksum !== (entropy[entropy.length - 1] & checksumMask)) {
     throw new import_errors17.FuelError(
       import_errors17.ErrorCode.INVALID_CHECKSUM,
@@ -7725,7 +7811,7 @@ var Mnemonic = class {
     assertMnemonic(getWords(phrase));
     const phraseBytes = toUtf8Bytes(getPhrase(phrase));
     const salt = toUtf8Bytes(`mnemonic${passphrase}`);
-    return (0, import_ethers4.pbkdf2)(phraseBytes, salt, 2048, 64, "sha512");
+    return (0, import_ethers2.pbkdf2)(phraseBytes, salt, 2048, 64, "sha512");
   }
   /**
    * @param phrase - Mnemonic phrase composed by words from the provided wordlist
@@ -7787,7 +7873,7 @@ var Mnemonic = class {
         `Seed length should be between 16 and 64 bytes, but received ${seedArray.length} bytes.`
       );
     }
-    return (0, import_utils32.arrayify)((0, import_ethers4.computeHmac)("sha512", MasterSecret, seedArray));
+    return (0, import_utils32.arrayify)((0, import_ethers2.computeHmac)("sha512", MasterSecret, seedArray));
   }
   /**
    * Get the extendKey as defined on BIP-32 from the provided seed
@@ -7812,8 +7898,8 @@ var Mnemonic = class {
       chainCode,
       (0, import_utils32.concat)(["0x00", privateKey])
     ]);
-    const checksum = (0, import_ethers4.dataSlice)((0, import_ethers4.sha256)((0, import_ethers4.sha256)(extendedKey)), 0, 4);
-    return (0, import_ethers4.encodeBase58)((0, import_utils32.concat)([extendedKey, checksum]));
+    const checksum = (0, import_ethers2.dataSlice)((0, import_hasher5.sha256)((0, import_hasher5.sha256)(extendedKey)), 0, 4);
+    return (0, import_ethers2.encodeBase58)((0, import_utils32.concat)([extendedKey, checksum]));
   }
   /**
    *  Create a new mnemonic using a randomly generated number as entropy.
@@ -7828,7 +7914,7 @@ var Mnemonic = class {
    * @returns A randomly generated mnemonic
    */
   static generate(size = 32, extraEntropy = "") {
-    const entropy = extraEntropy ? (0, import_ethers4.sha256)((0, import_utils32.concat)([(0, import_crypto3.randomBytes)(size), (0, import_utils32.arrayify)(extraEntropy)])) : (0, import_crypto3.randomBytes)(size);
+    const entropy = extraEntropy ? (0, import_hasher5.sha256)((0, import_utils32.concat)([(0, import_crypto3.randomBytes)(size), (0, import_utils32.arrayify)(extraEntropy)])) : (0, import_crypto3.randomBytes)(size);
     return Mnemonic.entropyToMnemonic(entropy);
   }
 };
@@ -7841,7 +7927,7 @@ var MainnetPUB = (0, import_utils34.hexlify)("0x0488b21e");
 var TestnetPRV2 = (0, import_utils34.hexlify)("0x04358394");
 var TestnetPUB = (0, import_utils34.hexlify)("0x043587cf");
 function base58check(data) {
-  return (0, import_ethers5.encodeBase58)((0, import_utils34.concat)([data, (0, import_ethers5.dataSlice)((0, import_ethers5.sha256)((0, import_ethers5.sha256)(data)), 0, 4)]));
+  return (0, import_ethers3.encodeBase58)((0, import_utils34.concat)([data, (0, import_ethers3.dataSlice)((0, import_hasher6.sha256)((0, import_hasher6.sha256)(data)), 0, 4)]));
 }
 function getExtendedKeyPrefix(isPublic = false, testnet = false) {
   if (isPublic) {
@@ -7897,7 +7983,7 @@ var HDWallet = class {
       this.publicKey = (0, import_utils34.hexlify)(config.publicKey);
     }
     this.parentFingerprint = config.parentFingerprint || this.parentFingerprint;
-    this.fingerprint = (0, import_ethers5.dataSlice)((0, import_ethers5.ripemd160)((0, import_ethers5.sha256)(this.publicKey)), 0, 4);
+    this.fingerprint = (0, import_ethers3.dataSlice)((0, import_ethers3.ripemd160)((0, import_hasher6.sha256)(this.publicKey)), 0, 4);
     this.depth = config.depth || this.depth;
     this.index = config.index || this.index;
     this.chainCode = config.chainCode;
@@ -7929,7 +8015,7 @@ var HDWallet = class {
       data.set((0, import_utils34.arrayify)(this.publicKey));
     }
     data.set((0, import_math19.toBytes)(index, 4), 33);
-    const bytes = (0, import_utils34.arrayify)((0, import_ethers5.computeHmac)("sha512", chainCode, data));
+    const bytes = (0, import_utils34.arrayify)((0, import_ethers3.computeHmac)("sha512", chainCode, data));
     const IL = bytes.slice(0, 32);
     const IR = bytes.slice(32);
     if (privateKey) {
@@ -8000,7 +8086,7 @@ var HDWallet = class {
     });
   }
   static fromExtendedKey(extendedKey) {
-    const decoded = (0, import_ethers5.toBeHex)((0, import_ethers5.decodeBase58)(extendedKey));
+    const decoded = (0, import_ethers3.toBeHex)((0, import_ethers3.decodeBase58)(extendedKey));
     const bytes = (0, import_utils34.arrayify)(decoded);
     const validChecksum = base58check(bytes.slice(0, 78)) === extendedKey;
     if (bytes.length !== 82 || !isValidExtendedKey(bytes)) {
@@ -8621,7 +8707,7 @@ var import_transactions19 = require("@fuel-ts/transactions");
 var import_utils36 = require("@fuel-ts/utils");
 
 // src/predicate/utils/getPredicateRoot.ts
-var import_hasher4 = require("@fuel-ts/hasher");
+var import_hasher7 = require("@fuel-ts/hasher");
 var import_merkle = require("@fuel-ts/merkle");
 var import_utils35 = require("@fuel-ts/utils");
 var getPredicateRoot = (bytecode) => {
@@ -8629,34 +8715,44 @@ var getPredicateRoot = (bytecode) => {
   const bytes = (0, import_utils35.arrayify)(bytecode);
   const chunks = (0, import_utils35.chunkAndPadBytes)(bytes, chunkSize);
   const codeRoot = (0, import_merkle.calcRoot)(chunks.map((c) => (0, import_utils35.hexlify)(c)));
-  const predicateRoot = (0, import_hasher4.hash)((0, import_utils35.concat)(["0x4655454C", codeRoot]));
+  const predicateRoot = (0, import_hasher7.hash)((0, import_utils35.concat)(["0x4655454C", codeRoot]));
   return predicateRoot;
 };
 
 // src/predicate/predicate.ts
 var Predicate = class extends Account {
   bytes;
-  predicateData = Uint8Array.from([]);
-  predicateArgs = [];
+  predicateDataBytes = Uint8Array.from([]);
+  predicateData = [];
   interface;
   /**
    * Creates an instance of the Predicate class.
    *
-   * @param bytes - The bytes of the predicate.
+   * @param bytecode - The bytecode of the predicate.
+   * @param abi - The JSON ABI of the predicate.
    * @param provider - The provider used to interact with the blockchain.
-   * @param jsonAbi - The JSON ABI of the predicate.
+   * @param inputData - The predicate input data (optional).
    * @param configurableConstants - Optional configurable constants for the predicate.
    */
-  constructor(bytes, provider, jsonAbi, configurableConstants) {
+  constructor({
+    bytecode,
+    abi,
+    provider,
+    inputData,
+    configurableConstants
+  }) {
     const { predicateBytes, predicateInterface } = Predicate.processPredicateData(
-      bytes,
-      jsonAbi,
+      bytecode,
+      abi,
       configurableConstants
     );
     const address = import_address10.Address.fromB256(getPredicateRoot(predicateBytes));
     super(address, provider);
     this.bytes = predicateBytes;
     this.interface = predicateInterface;
+    if (inputData !== void 0 && inputData.length > 0) {
+      this.predicateData = inputData;
+    }
   }
   /**
    * Populates the transaction data with predicate data.
@@ -8708,18 +8804,8 @@ var Predicate = class extends Account {
     const transactionRequest = this.populateTransactionPredicateData(transactionRequestLike);
     return super.simulateTransaction(transactionRequest);
   }
-  /**
-   * Sets data for the predicate.
-   *
-   * @param args - Arguments for the predicate function.
-   * @returns The Predicate instance with updated predicate data.
-   */
-  setData(...args) {
-    this.predicateArgs = args;
-    return this;
-  }
   getPredicateData(policiesLength) {
-    if (!this.predicateArgs.length) {
+    if (!this.predicateData.length) {
       return new Uint8Array();
     }
     const mainFn = this.interface?.functions.main;
@@ -8728,7 +8814,7 @@ var Predicate = class extends Account {
       maxInputs: this.provider.getChain().consensusParameters.maxInputs.toNumber()
     });
     const OFFSET = VM_TX_MEMORY + import_abi_coder5.SCRIPT_FIXED_SIZE + import_abi_coder5.INPUT_COIN_FIXED_SIZE + import_abi_coder5.WORD_SIZE + paddedCode.byteLength + policiesLength * import_abi_coder5.WORD_SIZE;
-    return mainFn?.encodeArguments(this.predicateArgs, OFFSET) || new Uint8Array();
+    return mainFn?.encodeArguments(this.predicateData, OFFSET) || new Uint8Array();
   }
   /**
    * Processes the predicate data and returns the altered bytecode and interface.
@@ -8939,6 +9025,18 @@ var FuelConnector = class extends import_events2.EventEmitter {
   async signMessage(_address, _message) {
     throw new Error("Method not implemented.");
   }
+  /**
+   * Should start the sign transaction process and return
+   * the signed transaction.
+   *
+   * @param address - The address to sign the transaction
+   * @param transaction - The transaction to sign
+   *
+   * @returns Transaction signature
+   */
+  async signTransaction(_address, _transaction) {
+    throw new Error("Method not implemented.");
+  }
   /**
    * Should start the send transaction process and return
    * the transaction id submitted to the network.