FuelLabs · Torres-ssf · Dec 13, 2023 · Dec 7, 2023 · Dec 7, 2023 · Dec 7, 2023
@@ -0,0 +1,8 @@
+---
+"@fuel-ts/hasher": minor
+"@fuel-ts/program": minor
+"@fuel-ts/providers": minor
+"@fuel-ts/wallet": minor
+---
+
+add method to hash tx on TransactionRequest classes
@@ -1,41 +1,38 @@
 import { safeExec } from '@fuel-ts/errors/test-utils';
+import type { Provider } from 'fuels';
+import { WalletUnlocked, Predicate, BN, getRandomB256, BaseAssetId } from 'fuels';
+
 import {
-  WalletUnlocked,
-  FUEL_NETWORK_URL,
-  Provider,
-  Predicate,
-  BN,
-  getRandomB256,
-  BaseAssetId,
-} from 'fuels';
-
-import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../test/fixtures/forc-projects';
+  DocSnippetProjectsEnum,
+  getDocsSnippetsForcProject,
+} from '../../../test/fixtures/forc-projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
   let walletWithFunds: WalletUnlocked;
+  let provider: Provider;
   let gasPrice: BN;
   const { abiContents: abi, binHexlified: bin } = getDocsSnippetsForcProject(
     DocSnippetProjectsEnum.SIMPLE_PREDICATE
   );
 
   beforeAll(async () => {
     walletWithFunds = await getTestWallet();
-    ({ minGasPrice: gasPrice } = walletWithFunds.provider.getGasConfig());
+    provider = walletWithFunds.provider;
+    ({ minGasPrice: gasPrice } = provider.getGasConfig());
   });
 
   it('should successfully use predicate to spend assets', async () => {
     // #region send-and-spend-funds-from-predicates-2
-    const provider = await Provider.create(FUEL_NETWORK_URL);
     const predicate = new Predicate(bin, provider, abi);
     // #endregion send-and-spend-funds-from-predicates-2
 
     // #region send-and-spend-funds-from-predicates-3
-    const amountToPredicate = 300_000;
+    const amountToPredicate = 10_000;
 
     const tx = await walletWithFunds.transfer(predicate.address, amountToPredicate, BaseAssetId, {
       gasPrice,
-      gasLimit: 10_000,
+      gasLimit: 1_000,
     });
 
     await tx.waitForResult();
@@ -58,11 +55,11 @@ describe(__filename, () => {
 
     const tx2 = await predicate.transfer(
       receiverWallet.address,
-      amountToPredicate - 150_000,
+      amountToPredicate - 1000,
       BaseAssetId,
       {
         gasPrice,
-        gasLimit: 10_000,
+        gasLimit: 1_000,
       }
     );
 
@@ -71,14 +68,13 @@ describe(__filename, () => {
   });
 
   it('should fail when trying to spend predicates entire amount', async () => {
-    const provider = await Provider.create(FUEL_NETWORK_URL);
     const predicate = new Predicate(bin, provider, abi);
 
     const amountToPredicate = 100;
 
     const tx = await walletWithFunds.transfer(predicate.address, amountToPredicate, BaseAssetId, {
       gasPrice,
-      gasLimit: 10_000,
+      gasLimit: 1_000,
     });
 
     await tx.waitForResult();
@@ -94,7 +90,7 @@ describe(__filename, () => {
     const { error } = await safeExec(() =>
       predicate.transfer(receiverWallet.address, predicateBalance, BaseAssetId, {
         gasPrice,
-        gasLimit: 10_000,
+        gasLimit: 1_000,
       })
     );
 
@@ -106,17 +102,16 @@ describe(__filename, () => {
   });
 
   it('should fail when set wrong input data for predicate', async () => {
-    const provider = await Provider.create(FUEL_NETWORK_URL);
     const predicateOwner = WalletUnlocked.generate({
       provider,
     });
     const predicate = new Predicate(bin, predicateOwner.provider, abi);
 
-    const amountToPredicate = 200_000;
+    const amountToPredicate = 10_000;
 
     const tx = await walletWithFunds.transfer(predicate.address, amountToPredicate, BaseAssetId, {
       gasPrice,
-      gasLimit: 10_000,
+      gasLimit: 1_000,
     });
 
     await tx.waitForResult();
@@ -130,7 +125,7 @@ describe(__filename, () => {
     const { error } = await safeExec(() =>
       predicate.transfer(receiverWallet.address, amountToPredicate, BaseAssetId, {
         gasPrice,
-        gasLimit: 10_000,
+        gasLimit: 1_000,
       })
     );
 
@@ -140,4 +135,48 @@ describe(__filename, () => {
 
     expect((<Error>error).message).toMatch(errorMsg);
   });
+
+  it('should ensure predicate createTransfer works as expected', async () => {
+    const predicate = new Predicate(bin, provider, abi);
+
+    const amountToPredicate = 10_000;
+
+    const tx = await walletWithFunds.transfer(predicate.address, amountToPredicate, BaseAssetId, {
+      gasPrice,
+      gasLimit: 1_000,
+    });
+
+    await tx.waitForResult();
+
+    const inputAddress = '0xfc05c23a8f7f66222377170ddcbfea9c543dff0dd2d2ba4d0478a4521423a9d4';
+
+    predicate.setData(inputAddress);
+
+    const receiverWallet = WalletUnlocked.generate({
+      provider,
+    });
+
+    // #region send-and-spend-funds-from-predicates-8
+    const transactionRequest = await predicate.createTransfer(
+      receiverWallet.address,
+      amountToPredicate,
+      BaseAssetId,
+      {
+        gasPrice,
+        gasLimit: 1_000,
+      }
+    );
+
+    const chainId = provider.getChainId();
+
+    const txId = transactionRequest.getTransactionId(chainId);
+
+    const res = await predicate.sendTransaction(transactionRequest);
+
+    await res.waitForResult();
+    // #endregion send-and-spend-funds-from-predicates-8
+    const txIdFromExecutedTx = res.id;
+
+    expect(txId).toEqual(txIdFromExecutedTx);
+  });
 });
@@ -38,6 +38,14 @@ Note the method transfer has two parameters: the recipient's address and the int
 
 Once the predicate resolves with a return value `true` based on its predefined condition, our predicate successfully spends its funds by means of a transfer to a desired wallet.
 
+---
+
+In a similar approach, you can use the `createTransfer` method, which returns a `ScriptTransactionRequest`. Then, we can submit this transaction request by calling the `sendTransaction` method.
+
+This can be useful if you need the transaction ID before actually submitting it to the node.
+
+<<< @/../../docs-snippets/src/guide/predicates/send-and-spend-funds-from-predicates.test.ts#send-and-spend-funds-from-predicates-8{ts:line-numbers}
+
 ## Spending Entire Predicate Held Amount
 
 Trying to forward the entire amount held by the predicate results in an error because no funds are left to cover the transaction fees. Attempting this will result in an error message like:

@@ -6,7 +6,7 @@ import { Address } from '@fuel-ts/address';
 import { BaseAssetId } from '@fuel-ts/address/configs';
 import { ContractFactory } from '@fuel-ts/contract';
 import { encrypt, decrypt } from '@fuel-ts/crypto';
-import { hashTransaction, hashMessage } from '@fuel-ts/hasher';
+import { hashMessage } from '@fuel-ts/hasher';
 import { HDWallet } from '@fuel-ts/hdwallet';
 import { AbstractPredicate } from '@fuel-ts/interfaces';
 import { BN } from '@fuel-ts/math';
@@ -84,7 +84,6 @@ log(createConfig);
 /**
  * hasher
  */
-log(hashTransaction);
 log(hashMessage);
 
 /**

@@ -28,8 +28,6 @@
     "@fuel-ts/address": "workspace:*",
     "@fuel-ts/crypto": "workspace:*",
     "@fuel-ts/math": "workspace:*",
-    "@fuel-ts/providers": "workspace:*",
-    "@fuel-ts/transactions": "workspace:*",
     "@fuel-ts/utils": "workspace:*",
     "ethers": "^6.7.1",
     "ramda": "^0.29.0"

@@ -1,9 +1,6 @@
-import { bn } from '@fuel-ts/math';
-import { transactionRequestify } from '@fuel-ts/providers';
 import signMessageTest from '@fuel-ts/testcases/src/signMessage.json';
-import signTransactionTest from '@fuel-ts/testcases/src/signTransaction.json';
 
-import { hashMessage, hash, hashTransaction } from './hasher';
+import { hashMessage, hash } from './hasher';
 
 describe('Hasher', () => {
   it('Hash message', () => {
@@ -15,40 +12,4 @@ describe('Hasher', () => {
       '0xf5ca38f748a1d6eaf726b8a42fb575c3c71f1864a8143301782de13da2d9202b'
     );
   });
-
-  it('Hash script transaction request', () => {
-    const transactionRequest = signTransactionTest.transaction;
-
-    expect(hashTransaction(transactionRequest, 0)).toEqual(signTransactionTest.hashedTransaction);
-  });
-
-  it('Hash script transaction with predicateGas', () => {
-    const transactionRequest = transactionRequestify({
-      type: 0,
-      gasPrice: '0x1',
-      gasLimit: '0x1dcd6500',
-      inputs: [
-        {
-          type: 2,
-          amount: '0x0',
-          sender: '0x00000000000000000000000059f2f1fcfe2474fd5f0b9ba1e73ca90b143eb8d0',
-          recipient: '0x809f80a984a60d641d4a6d284e3969ff380eb478e587bcba0ed1a3f0ef271ede',
-          witnessIndex: 0,
-          data: '0x3b42028d86539b607afeaf8d32501fa03c494ecad7e65a16a7a8ebc264f4b67a000000000000000000000000dadd1125b8df98a66abd5eb302c0d9ca5a061dc200000000000000000000000090f79bf6eb2c4f870365e785982e1f101e93b906456bdaffaf74fe03521754ac445d148033c0c6acf7d593132c43f92fdbc7324c0000000000000000000000000000000000000000000000008ac7230489e80000',
-          nonce: '0x0000000000000000000000000000000000000000000000000000000000000002',
-          predicate:
-            '0x1a405000910000206144000b6148000540411480504cc04c72580020295134165b501012615c000772680002595d7001616171015b61a0106165711a5b6400125b5c100b2404000024000000664e627bfc0db0bfa8f182efc913b552681143e328b555d9697c40ad0eb527ad',
-          predicateGasUsed: bn(25),
-        },
-      ],
-      outputs: [],
-      witnesses: [],
-      script: '0x',
-      scriptData: '0x',
-    });
-
-    expect(hashTransaction(transactionRequest, 0)).toEqual(
-      '0xc0f5e25f37294c5b0218b377cae9622df03a05dc540374827c9e7a7f65560842'
-    );
-  });
 });
@@ -1,12 +1,6 @@
-import { ZeroBytes32 } from '@fuel-ts/address/configs';
 import { bufferFromString } from '@fuel-ts/crypto';
-import { bn } from '@fuel-ts/math';
-import type { TransactionRequestLike } from '@fuel-ts/providers';
-import { transactionRequestify } from '@fuel-ts/providers';
-import { OutputType, InputType, TransactionCoder, TransactionType } from '@fuel-ts/transactions';
 import type { BytesLike } from 'ethers';
-import { sha256, concat } from 'ethers';
-import { clone } from 'ramda';
+import { sha256 } from 'ethers';
 
 /**
  * hash string messages with sha256
@@ -29,91 +23,6 @@ export function uint64ToBytesBE(value: number): Uint8Array {
   return new Uint8Array(dataView.buffer);
 }
 
-/**
- * Hash transaction request with sha256. [Read more](https://github.com/FuelLabs/fuel-specs/blob/master/specs/protocol/identifiers.md#transaction-id)
- *
- * @param transactionRequest - Transaction request to be hashed
- * @returns sha256 hash of the transaction
- */
-export function hashTransaction(transactionRequestLike: TransactionRequestLike, chainId: number) {
-  const transactionRequest = transactionRequestify(transactionRequestLike);
-  // Return a new transaction object without references to the original transaction request
-  const transaction = transactionRequest.toTransaction();
-
-  if (transaction.type === TransactionType.Script) {
-    transaction.receiptsRoot = ZeroBytes32;
-  }
-
-  // Zero out input fields
-  transaction.inputs = transaction.inputs.map((input) => {
-    const inputClone = clone(input);
-
-    switch (inputClone.type) {
-      // Zero out on signing: txPointer, predicateGasUsed
-      case InputType.Coin: {
-        inputClone.txPointer = {
-          blockHeight: 0,
-          txIndex: 0,
-        };
-        inputClone.predicateGasUsed = bn(0);
-        return inputClone;
-      }
-      // Zero out on signing: predicateGasUsed
-      case InputType.Message: {
-        inputClone.predicateGasUsed = bn(0);
-        return inputClone;
-      }
-      // Zero out on signing: txID, outputIndex, balanceRoot, stateRoot, and txPointer
-      case InputType.Contract: {
-        inputClone.txPointer = {
-          blockHeight: 0,
-          txIndex: 0,
-        };
-        inputClone.txID = ZeroBytes32;
-        inputClone.outputIndex = 0;
-        inputClone.balanceRoot = ZeroBytes32;
-        inputClone.stateRoot = ZeroBytes32;
-        return inputClone;
-      }
-      default:
-        return inputClone;
-    }
-  });
-  // Zero out output fields
-  transaction.outputs = transaction.outputs.map((output) => {
-    const outputClone = clone(output);
-
-    switch (outputClone.type) {
-      // Zero out on signing: balanceRoot, stateRoot
-      case OutputType.Contract: {
-        outputClone.balanceRoot = ZeroBytes32;
-        outputClone.stateRoot = ZeroBytes32;
-        return outputClone;
-      }
-      // Zero out on signing: amount
-      case OutputType.Change: {
-        outputClone.amount = bn(0);
-        return outputClone;
-      }
-      // Zero out on signing: amount, to and assetId
-      case OutputType.Variable: {
-        outputClone.to = ZeroBytes32;
-        outputClone.amount = bn(0);
-        outputClone.assetId = ZeroBytes32;
-        return outputClone;
-      }
-      default:
-        return outputClone;
-    }
-  });
-  transaction.witnessesCount = 0;
-  transaction.witnesses = [];
-
-  const chainIdBytes = uint64ToBytesBE(chainId);
-  const concatenatedData = concat([chainIdBytes, new TransactionCoder().encode(transaction)]);
-  return sha256(concatenatedData);
-}
-
 /**
  * wrap sha256
  *