feat: make predicates functions accept request tx params (#383)

FuelLabs · Jul 9, 2022 · 3bed0aa · 3bed0aa
1 parent e8758fc
commit 3bed0aa
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 13 deletions.
diff --git a/packages/contract/src/__test__/contract.test.ts b/packages/contract/src/__test__/contract.test.ts
@@ -80,6 +80,24 @@ describe('Contract', () => {
     expect(contract.provider).toEqual(provider);
   });
 
+  it('should fail to execute call if gasLimit is too low', async () => {
+    const contract = await setup();
+
+    let failed;
+    try {
+      await contract.functions
+        .foo(1336)
+        .txParams({
+          gasLimit: 1,
+        })
+        .call();
+    } catch (e) {
+      failed = true;
+    }
+
+    expect(failed).toEqual(true);
+  });
+
   it('submits multiple calls', async () => {
     const contract = await setup();
 
@@ -89,6 +107,24 @@ describe('Contract', () => {
     expect(results).toEqual([1337n, 1337n]);
   });
 
+  it('should fail to execute multiple calls if gasLimit is too low', async () => {
+    const contract = await setup();
+
+    let failed;
+    try {
+      await contract
+        .multiCall([contract.functions.foo(1336), contract.functions.foo(1336)])
+        .txParams({
+          gasLimit: 1,
+        })
+        .call();
+    } catch (e) {
+      failed = true;
+    }
+
+    expect(failed).toEqual(true);
+  });
+
   it('dryRuns multiple calls', async () => {
     const contract = await setup();
 

diff --git a/packages/predicate/src/predicate.test.ts b/packages/predicate/src/predicate.test.ts
@@ -256,4 +256,37 @@ describe('Predicate', () => {
       ]);
     }).rejects.toThrow('Invalid Predicate');
   });
+
+  // TODO: Enable this test once predicates start to consume gas
+  // FUELS-TS - https://github.com/FuelLabs/fuels-ts/issues/385
+  // SPEC - https://github.com/FuelLabs/fuel-specs/issues/119
+  it.skip('should fail if inform gasLimit too low', async () => {
+    const receiverAddress = hexlify(randomBytes(32));
+    const wallet = await setup();
+    const amountToPredicate = 10n;
+    const predicate = new Predicate(testPredicateStruct, StructAbiInputs);
+
+    const initialPredicateBalance = await setupPredicate(wallet, amountToPredicate, predicate);
+
+    const validation: Validation = {
+      has_account: true,
+      total_complete: 100n,
+    };
+
+    let failed;
+    try {
+      await predicate.submitSpendPredicate(
+        wallet,
+        initialPredicateBalance,
+        receiverAddress,
+        [validation],
+        undefined,
+        { gasLimit: 1 }
+      );
+    } catch (e) {
+      failed = true;
+    }
+
+    expect(failed).toEqual(true);
+  });
 });
diff --git a/packages/predicate/src/predicate.ts b/packages/predicate/src/predicate.ts
@@ -5,10 +5,19 @@ import { AbiCoder } from '@fuel-ts/abi-coder';
 import { NativeAssetId } from '@fuel-ts/constants';
 import { ContractUtils } from '@fuel-ts/contract';
 import type { BigNumberish } from '@fuel-ts/math';
-import type { CoinQuantityLike, TransactionResult, Coin } from '@fuel-ts/providers';
+import type {
+  CoinQuantityLike,
+  TransactionRequestLike,
+  TransactionResult,
+  Coin,
+} from '@fuel-ts/providers';
 import { ScriptTransactionRequest } from '@fuel-ts/providers';
 import type { Wallet } from '@fuel-ts/wallet';
 
+type BuildPredicateOptions = {
+  fundTransaction?: boolean;
+} & Pick<TransactionRequestLike, 'gasLimit' | 'gasPrice' | 'bytePrice' | 'maturity'>;
+
 export class Predicate {
   bytes: Uint8Array;
   address: BytesLike;
@@ -28,12 +37,15 @@ export class Predicate {
     wallet: Wallet,
     amountToPredicate: BigNumberish,
     assetId: BytesLike = NativeAssetId,
-    options: {
-      fundTransaction?: boolean;
-    } = { fundTransaction: true }
+    predicateOptions?: BuildPredicateOptions
   ): Promise<ScriptTransactionRequest> {
+    const options = {
+      fundTransaction: true,
+      ...predicateOptions,
+    };
     const request = new ScriptTransactionRequest({
       gasLimit: 1000000,
+      ...options,
     });
 
     // output is locked behind predicate
@@ -57,9 +69,7 @@ export class Predicate {
     wallet: Wallet,
     amountToPredicate: BigNumberish,
     assetId: BytesLike = NativeAssetId,
-    options: {
-      fundTransaction?: boolean;
-    } = { fundTransaction: true }
+    options?: BuildPredicateOptions
   ): Promise<TransactionResult<'success'>> {
     const request = await this.buildPredicateTransaction(
       wallet,
@@ -78,15 +88,18 @@ export class Predicate {
     receiverAddress: BytesLike,
     predicateData?: InputValue[],
     assetId: BytesLike = NativeAssetId,
-    options: {
-      fundTransaction?: boolean;
-    } = { fundTransaction: true }
+    predicateOptions?: BuildPredicateOptions
   ): Promise<ScriptTransactionRequest> {
     const predicateCoins: Coin[] = await wallet.provider.getCoinsToSpend(this.address, [
       [amountToSpend, assetId],
     ]);
+    const options = {
+      fundTransaction: true,
+      ...predicateOptions,
+    };
     const request = new ScriptTransactionRequest({
       gasLimit: 1000000,
+      ...options,
     });
 
     let encoded: undefined | Uint8Array;
@@ -129,9 +142,7 @@ export class Predicate {
     receiverAddress: BytesLike,
     predicateData?: InputValue[],
     assetId: BytesLike = NativeAssetId,
-    options: {
-      fundTransaction?: boolean;
-    } = { fundTransaction: true }
+    options?: BuildPredicateOptions
   ): Promise<TransactionResult<'success'>> {
     const request = await this.buildSpendPredicate(
       wallet,