feat: abi coder

.changeset/large-points-arrive.md

@@ -0,0 +1,11 @@
+---
+"@fuel-ts/abi-typegen": patch
+"@fuel-ts/abi-coder": patch
+"@fuel-ts/account": patch
+"@fuel-ts/address": patch
+"@fuel-ts/program": patch
+"@fuel-ts/script": patch
+"@fuel-ts/math": patch
+---
+
+chore: added noImplicitOverride option to config

.changeset/long-ducks-jump.md

@@ -0,0 +1,2 @@
+---
+---

.changeset/polite-seas-taste.md

@@ -0,0 +1,4 @@
+---
+---
+
+chore: move type:check to lint hook

.changeset/twenty-needles-buy.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/contract": patch
+---
+
+feat: better typegen contract factory integration with `launchTestNode`

CONTRIBUTING.md

@@ -109,6 +109,85 @@ See also:
 
 - [Developing](#developing)
 
+# Working with Unreleased Forc and Fuel-Core Functionality
+
+When you need to work with unreleased versions of `forc` or `fuel-core`, you can specify a git branch instead of a version number in the respective `VERSION` file.
+
+## Using Unreleased Forc
+
+To use an unreleased version of `forc`:
+
+1.  **Edit the `VERSION` File**
+    Open the `internal/forc/VERSION` file and replace the version number (e.g., `0.59.0`) with the desired git branch:
+
+        ```text
+        git:some/branch-name
+        ```
+
+1.  **Install and Build**
+    To download and build `forc` from the specified branch after updating `VERSION` file, run:
+
+        ```sh
+        pnpm install
+        pnpm build
+        ```
+
+The following directory will be updated or created: `internal/forc/sway-repo`
+
+## Using Unreleased Fuel-Core
+
+Similarly, to use an unreleased version of `fuel-core`:
+
+1.  **Edit the `VERSION` file:**
+    Open the `internal/fuel-core/VERSION` file and replace the version number with the desired git branch:
+
+        ```text
+        git:some/branch-name
+        ```
+
+1.  **Install and Build**
+    To download and build `fuel-core` from the specified branch after updating `VERSION` file, run:
+
+        ```sh
+        pnpm install
+        pnpm build
+        ```
+
+> [!Note]
+> The `internal/forc/sway-repo` and `internal/fuel-core/fuel-core-repo` directory will contain a local clone of the Sway and Fuel Core repository respectively, at the specific version or git branch you have specified in the `internal/forc/VERSION` and `internal/fuel-core/VERSION` file.
+
+## Unreleased Files and Directories Created After Installation
+
+After running `pnpm install` and `pnpm build`, the following files and directories are created:
+
+- Forc Repository:
+
+  - Located at `internal/forc/sway-repo`.
+  - Contains the source code for the version of `forc` you are using.
+
+- Fuel-Core Repository:
+  - Located at `internal/fuel-core/fuel-core-repo`.
+  - Contains the source code for the version of `fuel-core` you are using.
+
+## Switching Back to Standard Binaries
+
+If you switch back to using standard binaries you might encounter issues where the SDK still uses the previously downloaded unreleased binaries.
+
+To resolve the issue and ensure the SDK uses the correct binaries:
+
+1. **Delete the downloaded repositories**
+
+   ```sh
+   rm -rf internal/forc/sway-repo
+   rm -rf internal/fuel-core/fuel-core-repo
+   ```
+
+1. **Reinstall and build**
+   ```sh
+   pnpm install
+   pnpm build
+   ```
+
 # Testing
 
 In order to run tests locally, you can run the following commands:
@@ -182,6 +261,12 @@ DEVNET_WALLET_PVT_KEY=0x...
 TESTNET_WALLET_PVT_KEY=0x...
 ```
 
+This will enable you to run the e2e test locally against the live network:
+
+```sh
+pnpm test:filter e2e-script
+```
+
 <!-- TODO: add/fix block explorer URL after testnet support- Checking Wallet Balance: https://fuellabs.github.io/block-explorer-v2/beta-5/?#/address/fuel1x33ajpj0jy5p2wcqqu45e32r75zrwfeh6hwqfv5un670rv4p0mns58enjg -->
 
 # Commit Convention

apps/docs-snippets/package.json

@@ -4,7 +4,8 @@
   "description": "",
   "private": true,
   "scripts": {
-    "pretest": "./scripts/pretest.sh"
+    "pretest": "./scripts/pretest.sh",
+    "type:check": "tsc --noEmit"
   },
   "devDependencies": {
     "@fuel-ts/account": "workspace:*",

apps/docs-snippets/scripts/pretest.sh

@@ -9,6 +9,3 @@ pnpm fuels build
 
 # Deploys projects (needed for loader bytecode)
 pnpm fuels deploy
-
-# Checks for type errors
-pnpm tsc --noEmit

apps/docs-snippets2/src/testing/launching-a-test-node.ts

@@ -38,7 +38,7 @@ customLaunchTestNode.cleanup();
 import { CounterFactory } from '../typegend/contracts/CounterFactory';
 
 using launchedContractNode = await launchTestNode({
-  contractsConfigs: [{ factory: CounterFactory }],
+  contractsConfigs: [CounterFactory],
 });
 
 const {

apps/docs-snippets2/src/wallets/connectors.ts

@@ -35,11 +35,11 @@ metadata = {
 
 class WalletConnector extends FuelConnector {
   // #region fuel-connector-name
-  name: string = 'My Wallet Connector';
+  public override name: string = 'My Wallet Connector';
   // #endregion fuel-connector-name
 
   // #region fuel-connector-metadata
-  metadata = {
+  public override metadata = {
     install: metadata.install,
     image: metadata.image,
   };

apps/docs-snippets2/src/wallets/fuel-instantiation-options.ts

@@ -2,7 +2,7 @@
 import { Fuel, FuelConnector } from 'fuels';
 
 class WalletConnector extends FuelConnector {
-  name: string = 'My Wallet Connector';
+  public override name: string = 'My Wallet Connector';
 }
 
 const defaultConnectors = (_opts: {

internal/benchmarks/package.json

@@ -6,7 +6,7 @@
   ],
   "scripts": {
     "type:check": "tsc --noEmit",
-    "pretest": "run-s build:forc type:check",
+    "pretest": "run-s build:forc ",
     "build:forc": "pnpm fuels build"
   },
   "license": "Apache-2.0",

package.json

@@ -39,11 +39,12 @@
     "clinic:doctor": "clinic doctor --autocannon [ / ] -- node packages/${npm_config_package_name}/dist/profile.js",
     "clinic:heap": "clinic heapprofiler --autocannon [ / ] -- node packages/${npm_config_package_name}/dist/profile.js",
     "test:integration": "vitest --run --config vitest.node.config.mts $(scripts/tests-find.sh --integration)",
-    "lint": "run-s type:check-tests lint:check prettier:check",
+    "lint": "run-s type:check-tests lint:check prettier:check type:check",
     "lint:check": "eslint . --ext .ts --max-warnings 0",
     "lint:fix": "pnpm lint:check --fix",
     "lint:md-links": "tsx ./scripts/lint-md-links",
     "lint:package-jsons": "tsx ./scripts/lint-package-jsons",
+    "type:check": "turbo run type:check",
     "type:check-tests": "tsc -p tsconfig.test.json",
     "prettier:check": "prettier --check packages --check apps/docs-snippets",
     "prettier:format": "prettier --write packages --check apps/docs-snippets",

packages/abi-coder/src/FunctionFragment.ts

@@ -75,7 +75,7 @@ export class FunctionFragment {
     return new TupleCoder(coders).encode(argumentValues);
   }
 
-  decodeArguments(data: BytesLike) {
+  decodeArguments(data: BytesLike): unknown[] | undefined {
     const bytes = arrayify(data);
     const nonVoidInputs = findNonVoidInputs(this.jsonAbiOld, this.jsonFnOld.inputs);
 

packages/abi-coder/src/encoding/coders/EnumCoder.test.ts

@@ -33,7 +33,7 @@ describe('EnumCoder', () => {
       expect(actual).toStrictEqual(expected);
     });
 
-    it('encodes a native enum', () => {
+    it('encodes a native enum (void)', () => {
       const nativeCoder = new EnumCoder('Native', {
         One: new BooleanCoder(),
         Two: new BigNumberCoder('u64'),
@@ -46,6 +46,19 @@ describe('EnumCoder', () => {
       expect(actual).toStrictEqual(expected);
     });
 
+    it('encodes a native enum (u64)', () => {
+      const nativeCoder = new EnumCoder('Native', {
+        One: new BooleanCoder(),
+        Two: new BigNumberCoder('u64'),
+        Three: new VoidCoder(),
+      });
+
+      const expected = new Uint8Array([0, 0, 0, 0, 0, 0, 0, 2]);
+      // @ts-expect-error native
+      const actual = nativeCoder.encode('Two');
+      expect(actual).toStrictEqual(expected);
+    });
+
     it('should throw an error when encoding if no enum key is provided', async () => {
       await expectToThrowFuelError(
         () => coder.encode({} as never),

packages/abi-coder/src/encoding/coders/EnumCoder.ts

@@ -21,7 +21,7 @@ export class EnumCoder<TCoders extends Record<string, Coder>> extends Coder<
   InputValueOf<TCoders>,
   DecodedValueOf<TCoders>
 > {
-  name: string;
+  override name: string;
   coders: TCoders;
   #caseIndexCoder: BigNumberCoder;
   #encodedValueSize: number;

packages/abi-coder/src/encoding/coders/OptionCoder.ts

@@ -6,7 +6,7 @@ type SwayOption<T> = { None: [] } | { Some: T };
 export type Option<T> = T | undefined;
 
 export class OptionCoder<TCoders extends Record<string, Coder>> extends EnumCoder<TCoders> {
-  encode(value?: Option<unknown>): Uint8Array {
+  override encode(value?: Option<unknown>): Uint8Array {
     const result = super.encode(this.toSwayOption(value) as unknown as InputValueOf<TCoders>);
     return result;
   }
@@ -19,7 +19,7 @@ export class OptionCoder<TCoders extends Record<string, Coder>> extends EnumCode
     return { None: [] };
   }
 
-  decode(data: Uint8Array, offset: number): [DecodedValueOf<TCoders>, number] {
+  override decode(data: Uint8Array, offset: number): [DecodedValueOf<TCoders>, number] {
     const [decoded, newOffset] = super.decode(data, offset);
     return [this.toOption(decoded) as DecodedValueOf<TCoders>, newOffset];
   }

packages/abi-coder/src/encoding/coders/StructCoder.ts

@@ -18,7 +18,7 @@ export class StructCoder<TCoders extends Record<string, Coder>> extends Coder<
   InputValueOf<TCoders>,
   DecodedValueOf<TCoders>
 > {
-  name: string;
+  override name: string;
   coders: TCoders;
   #hasNestedOption: boolean;
 

packages/abi-typegen/src/abi/types/AssetIdType.ts

@@ -1,13 +1,13 @@
 import { B256Type } from './B256Type';
 
 export class AssetIdType extends B256Type {
-  public static swayType = 'struct AssetId';
+  public static override swayType = 'struct AssetId';
 
-  public name = 'AssetId';
+  public override name = 'AssetId';
 
-  static MATCH_REGEX = /^struct AssetId$/m;
+  static override MATCH_REGEX = /^struct AssetId$/m;
 
-  static isSuitableFor(params: { type: string }) {
+  static override isSuitableFor(params: { type: string }) {
     return AssetIdType.MATCH_REGEX.test(params.type);
   }
 }

packages/abi-typegen/src/abi/types/B256Type.ts

@@ -1,13 +1,13 @@
 import { StrType } from './StrType';
 
 export class B256Type extends StrType {
-  public static swayType = 'b256';
+  public static override swayType = 'b256';
 
-  public name = 'b256';
+  public override name = 'b256';
 
-  static MATCH_REGEX = /^b256$/m;
+  static override MATCH_REGEX = /^b256$/m;
 
-  static isSuitableFor(params: { type: string }) {
+  static override isSuitableFor(params: { type: string }) {
     return B256Type.MATCH_REGEX.test(params.type);
   }
 }

packages/abi-typegen/src/abi/types/B512Type.ts

@@ -1,13 +1,13 @@
 import { B256Type } from './B256Type';
 
 export class B512Type extends B256Type {
-  public static swayType = 'struct B512';
+  public static override swayType = 'struct B512';
 
-  public name = 'b512';
+  public override name = 'b512';
 
-  static MATCH_REGEX = /^struct (std::b512::)?B512$/m;
+  static override MATCH_REGEX = /^struct (std::b512::)?B512$/m;
 
-  static isSuitableFor(params: { type: string }) {
+  static override isSuitableFor(params: { type: string }) {
     return B512Type.MATCH_REGEX.test(params.type);
   }
 }

packages/abi-typegen/src/abi/types/BytesType.ts

@@ -3,17 +3,17 @@ import type { IType } from '../../types/interfaces/IType';
 import { ArrayType } from './ArrayType';
 
 export class BytesType extends ArrayType {
-  public static swayType = 'struct Bytes';
+  public static override swayType = 'struct Bytes';
 
-  public name = 'bytes';
+  public override name = 'bytes';
 
-  static MATCH_REGEX: RegExp = /^struct (std::bytes::)?Bytes/m;
+  static override MATCH_REGEX: RegExp = /^struct (std::bytes::)?Bytes/m;
 
-  static isSuitableFor(params: { type: string }) {
+  static override isSuitableFor(params: { type: string }) {
     return BytesType.MATCH_REGEX.test(params.type);
   }
 
-  public parseComponentsAttributes(_params: { types: IType[] }) {
+  public override parseComponentsAttributes(_params: { types: IType[] }) {
     const capitalizedName = 'Bytes';
 
     this.attributes = {

packages/abi-typegen/src/abi/types/RawUntypedPtr.ts

@@ -3,13 +3,13 @@ import type { IType } from '../../types/interfaces/IType';
 import { U64Type } from './U64Type';
 
 export class RawUntypedPtr extends U64Type implements IType {
-  public static swayType = 'raw untyped ptr';
+  public static override swayType = 'raw untyped ptr';
 
-  public name = 'rawUntypedPtr';
+  public override name = 'rawUntypedPtr';
 
-  public static MATCH_REGEX: RegExp = /^raw untyped ptr$/m;
+  public static override MATCH_REGEX: RegExp = /^raw untyped ptr$/m;
 
-  static isSuitableFor(params: { type: string }) {
+  static override isSuitableFor(params: { type: string }) {
     return RawUntypedPtr.MATCH_REGEX.test(params.type);
   }
 }

packages/abi-typegen/src/abi/types/RawUntypedSlice.ts

@@ -3,17 +3,17 @@ import type { IType } from '../../types/interfaces/IType';
 import { ArrayType } from './ArrayType';
 
 export class RawUntypedSlice extends ArrayType {
-  public static swayType = 'raw untyped slice';
+  public static override swayType = 'raw untyped slice';
 
-  public name = 'rawUntypedSlice';
+  public override name = 'rawUntypedSlice';
 
-  public static MATCH_REGEX: RegExp = /^raw untyped slice$/m;
+  public static override MATCH_REGEX: RegExp = /^raw untyped slice$/m;
 
-  static isSuitableFor(params: { type: string }) {
+  static override isSuitableFor(params: { type: string }) {
     return RawUntypedSlice.MATCH_REGEX.test(params.type);
   }
 
-  public parseComponentsAttributes(_params: { types: IType[] }) {
+  public override parseComponentsAttributes(_params: { types: IType[] }) {
     const capitalizedName = 'RawSlice';
 
     this.attributes = {