fix!: enforce predicateData when predicate has arguments (#3886)

Author: Torres-ssf

.changeset/loud-bags-deny.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/account": minor
+---
+
+fix!: enforce `predicateData` when predicate has arguments

apps/create-fuels-counter-guide/src/components/Predicate.tsx

@@ -31,7 +31,10 @@ export default function Predicate() {
 
   useEffect(() => {
     if (wallet) {
-      const testPredicate = new TestPredicate(wallet);
+      const testPredicate = new TestPredicate({
+        provider: wallet.provider,
+        data: [0],
+      });
       setPredicate(testPredicate);
     }
   }, [wallet]);

apps/docs/src/guide/predicates/snippets/deploying-predicates.ts

@@ -16,6 +16,7 @@ const baseAssetId = await provider.getBaseAssetId();
 // We can deploy dynamically or via `fuels deploy`
 const originalPredicate = new ConfigurablePin({
   provider,
+  data: [1337],
 });
 
 const { waitForResult: waitForDeploy } = await originalPredicate.deploy(wallet);

packages/account/src/predicate/predicate.ts

@@ -27,14 +27,26 @@ import { deployScriptOrPredicate } from '../utils/deployScriptOrPredicate';
 
 import { getPredicateRoot } from './utils';
 
+// Helper type to check if T is a tuple with a fixed, non-zero length
+type IsNonEmptyTuple<T extends unknown[]> = number extends T['length']
+  ? false
+  : T['length'] extends 0
+    ? false
+    : true;
+
+// Type for the 'data' property, required if TData is a non-empty tuple
+export type PredicateDataParam<TData extends InputValue[]> =
+  IsNonEmptyTuple<TData> extends true
+    ? { data: TData } // If TData is a non-empty tuple, 'data' is required
+    : { data?: TData }; // Otherwise (TData is []), 'data' is optional
+
 export type PredicateParams<
   TData extends InputValue[] = InputValue[],
   TConfigurables extends { [name: string]: unknown } | undefined = { [name: string]: unknown },
-> = {
+> = PredicateDataParam<TData> & {
   bytecode: BytesLike;
   provider: Provider;
   abi: JsonAbi;
-  data?: TData;
   configurableConstants?: TConfigurables;
 };
 
@@ -161,7 +173,9 @@ export class Predicate<
    * @returns A new Predicate instance with the same bytecode, ABI and provider but with the ability to set the data and configurable constants.
    */
   toNewInstance(
-    overrides: Pick<PredicateParams<TData, TConfigurables>, 'data' | 'configurableConstants'> = {}
+    overrides: Partial<
+      Pick<PredicateParams<TData, TConfigurables>, 'data' | 'configurableConstants'>
+    > = {}
   ) {
     return new Predicate<TData, TConfigurables>({
       bytecode: this.initialBytecode,

packages/fuel-gauge/src/blob-deploy.test.ts

@@ -18,7 +18,7 @@ import {
 describe('deploying blobs', () => {
   function decodeConfigurables(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    program: Predicate | Script<any, any>
+    program: Predicate<any, any> | Script<any, any>
   ): Record<string, unknown> {
     const configurables: Record<string, unknown> = {};
 
@@ -225,10 +225,6 @@ describe('deploying blobs', () => {
 
     const receiver = Wallet.generate({ provider });
 
-    const loaderPredicate = await (
-      await new PredicateWithMoreConfigurables({ provider }).deploy(wallet)
-    ).waitForResult();
-
     const configurable = {
       FEE: 99,
       ADDRESS: getRandomB256(),
@@ -238,6 +234,13 @@ describe('deploying blobs', () => {
       BOOL: false,
     };
 
+    const loaderPredicate = await (
+      await new PredicateWithMoreConfigurables({
+        provider,
+        data: [configurable.FEE, configurable.ADDRESS],
+      }).deploy(wallet)
+    ).waitForResult();
+
     const predicate = new Predicate({
       data: [configurable.FEE, configurable.ADDRESS],
       bytecode: loaderPredicate.bytes,

packages/fuel-gauge/src/predicate/predicate-configurables.test.ts

@@ -239,6 +239,7 @@ describe('Predicate', () => {
 
       const predicate = new PredicateWithConfigurable({
         provider,
+        data: [99, getRandomB256()],
       });
 
       const destination = WalletUnlocked.generate({

packages/fuel-gauge/src/predicate/predicate-estimations.test.ts

@@ -46,20 +46,27 @@ describe('Predicate', () => {
         bytecode: PredicateMainArgsStruct.bytecode,
         abi: PredicateMainArgsStruct.abi,
         provider,
+        data: [
+          {
+            has_account: true,
+            total_complete: 100,
+          },
+        ],
       });
 
       await fundAccount(wallet, predicateStruct, fundingAmount);
 
       const tx = new ScriptTransactionRequest();
 
       // Get resources from the predicate struct
-      const ressources = await predicateStruct.getResourcesToSpend([
+      const resources = await predicateStruct.getResourcesToSpend([
         {
           assetId: await provider.getBaseAssetId(),
           amount: bn(10_000),
         },
       ]);
-      tx.addResource(ressources[0]);
+
+      tx.addResource(resources[0]);
       // Add predicate bytecode to the input predicate
       (<CoinTransactionRequestInput>tx.inputs[0]).predicate = predicateStruct.bytes;
 
@@ -167,6 +174,12 @@ describe('Predicate', () => {
         abi: PredicateMainArgsStruct.abi,
         bytecode: PredicateMainArgsStruct.bytecode,
         provider,
+        data: [
+          {
+            has_account: true,
+            total_complete: 100,
+          },
+        ],
       });
 
       await fundAccount(wallet, predicateTrue, fundingAmount);
@@ -254,6 +267,12 @@ describe('Predicate', () => {
           abi: PredicateMainArgsStruct.abi,
           bytecode: PredicateMainArgsStruct.bytecode,
           provider,
+          data: [
+            {
+              has_account: true,
+              total_complete: 100,
+            },
+          ],
         });
 
         await fundAccount(wallet, predicateStruct, fundingAmount);
@@ -288,6 +307,12 @@ describe('Predicate', () => {
           abi: PredicateMainArgsStruct.abi,
           bytecode: PredicateMainArgsStruct.bytecode,
           provider,
+          data: [
+            {
+              has_account: true,
+              total_complete: 100,
+            },
+          ],
         });
 
         await fundAccount(wallet, predicateStruct, fundingAmount);

packages/fuel-gauge/src/predicate/predicate-invalidations.test.ts

@@ -23,6 +23,12 @@ describe('Predicate', () => {
         abi: PredicateMainArgsStruct.abi,
         bytecode: PredicateMainArgsStruct.bytecode,
         provider,
+        data: [
+          {
+            has_account: true,
+            total_complete: 100,
+          },
+        ],
       });
 
       await fundAccount(wallet, predicate, 1000);
@@ -57,6 +63,12 @@ describe('Predicate', () => {
         abi: PredicateMainArgsStruct.abi,
         bytecode: PredicateMainArgsStruct.bytecode,
         provider,
+        data: [
+          {
+            has_account: true,
+            total_complete: 100,
+          },
+        ],
       });
 
       await fundAccount(wallet, predicate, 10_000);

templates/nextjs/src/components/Predicate.tsx

@@ -36,7 +36,10 @@ export default function Predicate() {
 
   useEffect(() => {
     if (wallet) {
-      const testPredicate = new TestPredicate(wallet);
+      const testPredicate = new TestPredicate({
+        provider: wallet.provider,
+        data: [0],
+      });
       setPredicate(testPredicate);
     }
   }, [wallet]);

templates/vite/src/components/Predicate.tsx

@@ -35,7 +35,10 @@ export default function Predicate() {
 
   useEffect(() => {
     if (wallet) {
-      const testPredicate = new TestPredicate(wallet);
+      const testPredicate = new TestPredicate({
+        provider: wallet.provider,
+        data: [0],
+      });
       setPredicate(testPredicate);
     }
   }, [wallet]);