Merge branch 'master' into st/fix/unset-cached-resource-for-failed-tx

FuelLabs · Aug 9, 2024 · 6e6ba87 · 6e6ba87
2 parents 318fa60 + 1d2abd7
commit 6e6ba87
Show file tree

Hide file tree

Showing 27 changed files with 223 additions and 43 deletions.
diff --git a/.changeset/real-crabs-listen.md b/.changeset/real-crabs-listen.md
@@ -0,0 +1,4 @@
+---
+---
+
+ci: update retry and timeout on Transaction `SqueezedOut` test
diff --git a/.changeset/stupid-planets-joke.md b/.changeset/stupid-planets-joke.md
@@ -0,0 +1,6 @@
+---
+"@fuel-ts/account": patch
+"@fuel-ts/errors": patch
+---
+
+chore: add validation for TX max outputs exceeded
diff --git a/.changeset/ten-otters-report.md b/.changeset/ten-otters-report.md
@@ -0,0 +1,6 @@
+---
+"@fuel-ts/abi-typegen": patch
+"@fuel-ts/utils": patch
+---
+
+feat: improve typegen bytecode compression
diff --git a/apps/docs/src/guide/errors/index.md b/apps/docs/src/guide/errors/index.md
@@ -301,4 +301,8 @@ If you believe you found a bug, please report the [issue](https://github.com/Fue
 
 ### `MAX_INPUTS_EXCEEDED`
 
-When the number of transaction inputs exceeds the maximum limit allowed by the blockchain.
+When the number of transaction inputs exceeds the maximum limit allowed by the blockchain.
+
+### `MAX_OUTPUTS_EXCEEDED`
+
+When the number of transaction outputs exceeds the maximum limit allowed by the blockchain.
diff --git a/packages/abi-typegen/src/templates/contract/factory.hbs b/packages/abi-typegen/src/templates/contract/factory.hbs
@@ -1,11 +1,11 @@
 {{header}}
 
-import { ContractFactory } from "fuels";
+import { ContractFactory, decompressBytecode } from "fuels";
 import type { Provider, Account, DeployContractOptions, DeployContractResult } from "fuels";
 
 import { {{capitalizedName}} } from "./{{capitalizedName}}";
 
-const bytecode = "{{hexlifiedBinString}}";
+const bytecode = decompressBytecode("{{compressedBytecode}}");
 
 export class {{capitalizedName}}Factory extends ContractFactory {
 

diff --git a/packages/abi-typegen/src/templates/contract/factory.test.ts b/packages/abi-typegen/src/templates/contract/factory.test.ts
@@ -1,3 +1,4 @@
+import * as utilsMod from '@fuel-ts/utils';
 import { join } from 'path';
 
 import {
@@ -24,6 +25,8 @@ describe('templates/factory', () => {
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.MINIMAL);
     const rawContents = project.abiContents;
 
+    vi.spyOn(utilsMod, 'compressBytecode').mockReturnValueOnce('0x-bytecode-here');
+
     // executing
     const abi = new Abi({
       filepath: './my-contract-abi.json',

diff --git a/packages/abi-typegen/src/templates/contract/factory.ts b/packages/abi-typegen/src/templates/contract/factory.ts
@@ -1,3 +1,5 @@
+import { compressBytecode } from '@fuel-ts/utils';
+
 import type { Abi } from '../../abi/Abi';
 import { renderHbsTemplate } from '../renderHbsTemplate';
 
@@ -22,7 +24,7 @@ export function renderFactoryTemplate(params: { abi: Abi }) {
       capitalizedName,
       abiJsonString,
       storageSlotsJsonString,
-      hexlifiedBinString,
+      compressedBytecode: compressBytecode(hexlifiedBinString),
     },
   });
 

diff --git a/packages/abi-typegen/src/templates/predicate/main.hbs b/packages/abi-typegen/src/templates/predicate/main.hbs
@@ -59,7 +59,7 @@ export type {{capitalizedName}}Parameters = Omit<
 
 const abi = {{abiJsonString}};
 
-const bytecode = '{{hexlifiedBinString}}';
+const bytecode = decompressBytecode('{{compressedBytecode}}');
 
 export class {{capitalizedName}} extends Predicate<
   {{capitalizedName}}Inputs,

diff --git a/packages/abi-typegen/src/templates/predicate/main.test.ts b/packages/abi-typegen/src/templates/predicate/main.test.ts
@@ -1,4 +1,5 @@
 import { safeExec } from '@fuel-ts/errors/test-utils';
+import * as utilsMod from '@fuel-ts/utils';
 import { join } from 'path';
 
 import {
@@ -18,7 +19,13 @@ import { renderMainTemplate } from './main';
  * @group node
  */
 describe('main.ts', () => {
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
   test('should render main template', () => {
+    vi.spyOn(utilsMod, 'compressBytecode').mockReturnValueOnce('0x-bytecode-here');
+
     const { restore } = mockVersions();
 
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.PREDICATE);
@@ -46,6 +53,8 @@ describe('main.ts', () => {
   });
 
   test('should render main template with configurable', () => {
+    vi.spyOn(utilsMod, 'compressBytecode').mockReturnValueOnce('0x-bytecode-here');
+
     const { restore } = mockVersions();
 
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.PREDICATE_WITH_CONFIGURABLE);

diff --git a/packages/abi-typegen/src/templates/predicate/main.ts b/packages/abi-typegen/src/templates/predicate/main.ts
@@ -1,4 +1,5 @@
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { compressBytecode } from '@fuel-ts/utils';
 
 import type { Abi } from '../../abi/Abi';
 import { renderHbsTemplate } from '../renderHbsTemplate';
@@ -32,7 +33,7 @@ export function renderMainTemplate(params: { abi: Abi }) {
   const { structs } = formatStructs({ types });
   const { imports } = formatImports({
     types,
-    baseMembers: ['Predicate', 'Provider', 'InputValue', 'PredicateParams'],
+    baseMembers: ['Predicate', 'Provider', 'InputValue', 'PredicateParams', 'decompressBytecode'],
   });
 
   const { prefixedInputs: inputs, output } = func.attributes;
@@ -45,7 +46,7 @@ export function renderMainTemplate(params: { abi: Abi }) {
       structs,
       enums,
       abiJsonString,
-      hexlifiedBinString,
+      compressedBytecode: compressBytecode(hexlifiedBinString),
       capitalizedName,
       imports,
       configurables,

diff --git a/packages/abi-typegen/src/templates/script/main.hbs b/packages/abi-typegen/src/templates/script/main.hbs
@@ -53,7 +53,7 @@ export type {{capitalizedName}}Configurables = Partial<{
 
 const abi = {{abiJsonString}};
 
-const bytecode = '{{hexlifiedBinString}}';
+const bytecode = decompressBytecode('{{compressedBytecode}}');
 
 export class {{capitalizedName}} extends Script<{{capitalizedName}}Inputs, {{capitalizedName}}Output> {
 

diff --git a/packages/abi-typegen/src/templates/script/main.test.ts b/packages/abi-typegen/src/templates/script/main.test.ts
@@ -1,4 +1,5 @@
 import { safeExec } from '@fuel-ts/errors/test-utils';
+import * as utilsMod from '@fuel-ts/utils';
 import { join } from 'path';
 
 import {
@@ -18,7 +19,13 @@ import { renderMainTemplate } from './main';
  * @group node
  */
 describe('main.ts', () => {
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
   test('should render main template', () => {
+    vi.spyOn(utilsMod, 'compressBytecode').mockReturnValueOnce('0x-bytecode-here');
+
     const { restore } = mockVersions();
 
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.SCRIPT);
@@ -45,6 +52,8 @@ describe('main.ts', () => {
   });
 
   test('should render main template with configurables', () => {
+    vi.spyOn(utilsMod, 'compressBytecode').mockReturnValueOnce('0x-bytecode-here');
+
     const { restore } = mockVersions();
 
     const project = getTypegenForcProject(AbiTypegenProjectsEnum.SCRIPT_WITH_CONFIGURABLE);

diff --git a/packages/abi-typegen/src/templates/script/main.ts b/packages/abi-typegen/src/templates/script/main.ts
@@ -1,4 +1,5 @@
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { compressBytecode } from '@fuel-ts/utils';
 
 import type { Abi } from '../../abi/Abi';
 import { renderHbsTemplate } from '../renderHbsTemplate';
@@ -30,7 +31,10 @@ export function renderMainTemplate(params: { abi: Abi }) {
 
   const { enums } = formatEnums({ types });
   const { structs } = formatStructs({ types });
-  const { imports } = formatImports({ types, baseMembers: ['Script', 'Account'] });
+  const { imports } = formatImports({
+    types,
+    baseMembers: ['Script', 'Account', 'decompressBytecode'],
+  });
 
   const { prefixedInputs: inputs, output } = func.attributes;
 
@@ -42,7 +46,7 @@ export function renderMainTemplate(params: { abi: Abi }) {
       structs,
       enums,
       abiJsonString,
-      hexlifiedBinString,
+      compressedBytecode: compressBytecode(hexlifiedBinString),
       capitalizedName,
       imports,
       configurables,

diff --git a/packages/abi-typegen/test/fixtures/templates/contract/factory.hbs b/packages/abi-typegen/test/fixtures/templates/contract/factory.hbs
@@ -10,12 +10,12 @@
   Fuel-Core version: 33.33.33
 */
 
-import { ContractFactory } from "fuels";
+import { ContractFactory, decompressBytecode } from "fuels";
 import type { Provider, Account, DeployContractOptions, DeployContractResult } from "fuels";
 
 import { MyContract } from "./MyContract";
 
-const bytecode = "0x-bytecode-here";
+const bytecode = decompressBytecode("0x-bytecode-here");
 
 export class MyContractFactory extends ContractFactory {
 

diff --git a/packages/abi-typegen/test/fixtures/templates/predicate-with-configurable/main.hbs b/packages/abi-typegen/test/fixtures/templates/predicate-with-configurable/main.hbs
@@ -12,6 +12,7 @@
 
 import {
   BigNumberish,
+  decompressBytecode,
   InputValue,
   Predicate,
   PredicateParams,
@@ -99,7 +100,7 @@ const abi = {
   ]
 };
 
-const bytecode = '0x000';
+const bytecode = decompressBytecode('0x-bytecode-here');
 
 export class MyPredicate extends Predicate<
   MyPredicateInputs,

diff --git a/packages/abi-typegen/test/fixtures/templates/predicate/main.hbs b/packages/abi-typegen/test/fixtures/templates/predicate/main.hbs
@@ -13,6 +13,7 @@
 import {
   BigNumberish,
   BN,
+  decompressBytecode,
   InputValue,
   Predicate,
   PredicateParams,
@@ -297,7 +298,7 @@ const abi = {
   "configurables": []
 };
 
-const bytecode = '0x000';
+const bytecode = decompressBytecode('0x-bytecode-here');
 
 export class MyPredicate extends Predicate<
   MyPredicateInputs,

diff --git a/packages/abi-typegen/test/fixtures/templates/script-with-configurable/main.hbs b/packages/abi-typegen/test/fixtures/templates/script-with-configurable/main.hbs
@@ -13,6 +13,7 @@
 import {
   Account,
   BigNumberish,
+  decompressBytecode,
   Script,
 } from 'fuels';
 
@@ -92,7 +93,7 @@ const abi = {
   ]
 };
 
-const bytecode = '0x000';
+const bytecode = decompressBytecode('0x-bytecode-here');
 
 export class MyScript extends Script<MyScriptInputs, MyScriptOutput> {
 

diff --git a/packages/abi-typegen/test/fixtures/templates/script/main.hbs b/packages/abi-typegen/test/fixtures/templates/script/main.hbs
@@ -14,6 +14,7 @@ import {
   Account,
   BigNumberish,
   BN,
+  decompressBytecode,
   Script,
 } from 'fuels';
 
@@ -289,7 +290,7 @@ const abi = {
   "configurables": []
 };
 
-const bytecode = '0x000';
+const bytecode = decompressBytecode('0x-bytecode-here');
 
 export class MyScript extends Script<MyScriptInputs, MyScriptOutput> {
 

diff --git a/packages/account/src/providers/provider.test.ts b/packages/account/src/providers/provider.test.ts
@@ -677,7 +677,53 @@ describe('Provider', () => {
       () => sender.sendTransaction(request),
       new FuelError(
         ErrorCode.MAX_INPUTS_EXCEEDED,
-        'The transaction exceeds the maximum allowed number of inputs for funding.'
+        'The transaction exceeds the maximum allowed number of inputs.'
+      )
+    );
+  });
+
+  it('should throws if max of ouputs was exceeded', async () => {
+    const maxOutputs = 2;
+    using launched = await setupTestProviderAndWallets({
+      nodeOptions: {
+        snapshotConfig: {
+          chainConfig: {
+            consensus_parameters: {
+              V1: {
+                tx_params: {
+                  V1: {
+                    max_outputs: maxOutputs,
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      walletsConfig: {
+        count: 3,
+      },
+    });
+
+    const {
+      wallets: [sender, receiver1, receiver2],
+      provider,
+    } = launched;
+
+    const baseAssetId = provider.getBaseAssetId();
+
+    const request = new ScriptTransactionRequest();
+    const resources = await sender.getResourcesToSpend([[1000, baseAssetId]]);
+    request.addCoinOutput(receiver1.address, 1, baseAssetId);
+    request.addCoinOutput(receiver2.address, 1, baseAssetId);
+
+    request.addResources(resources);
+
+    await expectToThrowFuelError(
+      () => sender.sendTransaction(request),
+      new FuelError(
+        ErrorCode.MAX_OUTPUTS_EXCEEDED,
+        'The transaction exceeds the maximum allowed number of outputs.'
       )
     );
   });

diff --git a/packages/account/src/providers/provider.ts b/packages/account/src/providers/provider.ts
@@ -704,10 +704,18 @@ Supported fuel-core version: ${supportedVersion}.`
   }
 
   private validateTransaction(tx: TransactionRequest, consensusParameters: ConsensusParameters) {
-    if (bn(tx.inputs.length).gt(consensusParameters.txParameters.maxInputs)) {
+    const { maxOutputs, maxInputs } = consensusParameters.txParameters;
+    if (bn(tx.inputs.length).gt(maxInputs)) {
       throw new FuelError(
         ErrorCode.MAX_INPUTS_EXCEEDED,
-        'The transaction exceeds the maximum allowed number of inputs for funding.'
+        'The transaction exceeds the maximum allowed number of inputs.'
+      );
+    }
+
+    if (bn(tx.outputs.length).gt(maxOutputs)) {
+      throw new FuelError(
+        ErrorCode.MAX_OUTPUTS_EXCEEDED,
+        'The transaction exceeds the maximum allowed number of outputs.'
       );
     }
   }

diff --git a/packages/errors/src/error-codes.ts b/packages/errors/src/error-codes.ts
@@ -78,6 +78,7 @@ export enum ErrorCode {
   TRANSACTION_SQUEEZED_OUT = 'transaction-squeezed-out',
   CONTRACT_SIZE_EXCEEDS_LIMIT = 'contract-size-exceeds-limit',
   MAX_INPUTS_EXCEEDED = 'max-inputs-exceeded',
+  MAX_OUTPUTS_EXCEEDED = 'max-outputs-exceeded',
 
   // receipt
   INVALID_RECEIPT_TYPE = 'invalid-receipt-type',

diff --git a/packages/fuel-gauge/src/transaction-response.test.ts b/packages/fuel-gauge/src/transaction-response.test.ts
@@ -204,7 +204,7 @@ describe('TransactionResponse', () => {
 
   it(
     'should throw error for a SqueezedOut status update [waitForResult]',
-    { timeout: 10_000 },
+    { timeout: 10_000, retry: 10 },
     async () => {
       /**
        * a larger --tx-pool-ttl 1s is necessary to ensure that the transaction doesn't get squeezed out

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -50,6 +50,7 @@
     "@fuel-ts/errors": "workspace:*",
     "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/math": "workspace:*",
-    "@fuel-ts/versions": "workspace:*"
+    "@fuel-ts/versions": "workspace:*",
+    "fflate": "^0.8.2"
   }
 }
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -13,3 +13,4 @@ export * from './utils/base58';
 export * from './utils/dataSlice';
 export * from './utils/toUtf8Bytes';
 export * from './utils/toUtf8String';
+export * from './utils/bytecode';