feat: add main arg support to Scripts (#745)

* add test files and refactor

* update export

* add helpers

* add and update tests

* Update docs

* add cs

* Code review tweaks

* add tx params

* add test for failure

* refactor more  like predicates

* revise md

* adjust default export

* revert change

* rm unused

* rename

* fix type

* fix export

* improve types

* improve types

* refactor

* refactor

* make more strict

Author: Cameron Manavian

.changeset/rotten-dogs-pump.md

@@ -0,0 +1,9 @@
+---
+"@fuel-ts/abi-coder": minor
+"@fuel-ts/contract": minor
+"fuels": minor
+"@fuel-ts/providers": minor
+"@fuel-ts/script": minor
+---
+
+Add support for main args in scripts

docs/_guide/scripts/calling-a-script.md

@@ -2,6 +2,10 @@
 
 # Calling a script
 
-We will use the `script` instance created in the [previous section](./instantiating-a-script.md) to call the script.
+Suppose your Sway script `main` function is written using the arguments passed to the `main` function like so:
 
-[@code:typescript](./packages/script/src/script.test.ts#typedoc:script-call)
+[@code:rust](./packages/fuel-gauge/test-projects/script-main-args/src/main.sw#typedoc:script-with-main-args)
+
+You can still hand code out a solution wrapper using `callScript` utility to call your script with data. However, if you prefer to use the ABI generated from your script, you can use the `ScriptFactory` helper:
+
+[@code:typescript](./packages/fuel-gauge/src/script-main-args.test.ts#typedoc:script-call-factory)

package.json

@@ -44,7 +44,7 @@
     "@changesets/changelog-github": "^0.4.7",
     "@changesets/cli": "^2.25.0",
     "@ethersproject/bytes": "^5.7.0",
-    "@jest/types": "28.1.0",
+    "@jest/types": "29.4.3",
     "@types/jest": "^29.2.3",
     "@types/node": "^14.18.32",
     "@types/node-fetch": "^2.6.2",

packages/abi-coder/src/abi-coder.ts

@@ -169,6 +169,7 @@ export default class AbiCoder {
               types: types.length,
               nonEmptyTypes: nonEmptyTypes.length,
               values: bytes.length,
+              newOffset,
             },
             value: {
               types,

packages/abi-coder/src/interface.ts

@@ -129,7 +129,8 @@ export default class Interface {
   encodeFunctionData(
     functionFragment: FunctionFragment | string,
     values: Array<InputValue>,
-    offset = 0
+    offset = 0,
+    isMainArgs = false
   ): Uint8Array {
     const fragment =
       typeof functionFragment === 'string' ? this.getFunction(functionFragment) : functionFragment;
@@ -145,8 +146,12 @@ export default class Interface {
       return selector;
     }
 
-    const isRef = inputs.length > 1 || isReferenceType(inputs[0].type);
     const args = this.abiCoder.encode(inputs, values, offset);
+    if (isMainArgs) {
+      return args;
+    }
+
+    const isRef = inputs.length > 1 || isReferenceType(inputs[0].type);
     return concat([selector, new BooleanCoder().encode(isRef), args]);
   }
 

packages/contract/package.json

@@ -31,13 +31,10 @@
     "@ethersproject/logger": "^5.7.0",
     "@ethersproject/sha2": "^5.7.0",
     "@fuel-ts/abi-coder": "workspace:*",
-    "@fuel-ts/address": "workspace:*",
-    "@fuel-ts/math": "workspace:*",
-    "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/keystore": "workspace:*",
     "@fuel-ts/merkle": "workspace:*",
+    "@fuel-ts/program": "workspace:*",
     "@fuel-ts/providers": "workspace:*",
-    "@fuel-ts/script": "workspace:*",
     "@fuel-ts/sparsemerkle": "workspace:*",
     "@fuel-ts/wallet": "workspace:*",
     "@fuel-ts/transactions": "workspace:*",

packages/contract/src/contracts/contract-factory.ts renamed to packages/contract/src/contract-factory.ts

@@ -4,16 +4,15 @@ import { Logger } from '@ethersproject/logger';
 import { Interface } from '@fuel-ts/abi-coder';
 import type { JsonAbi } from '@fuel-ts/abi-coder';
 import { randomBytes } from '@fuel-ts/keystore';
+import { Contract } from '@fuel-ts/program';
 import type { CreateTransactionRequestLike, Provider } from '@fuel-ts/providers';
 import { CreateTransactionRequest } from '@fuel-ts/providers';
 import type { StorageSlot } from '@fuel-ts/transactions';
 import { MAX_GAS_PER_TX } from '@fuel-ts/transactions';
 import { versions } from '@fuel-ts/versions';
 import type { Account } from '@fuel-ts/wallet';
 
-import { getContractId, getContractStorageRoot, includeHexPrefix } from '../util';
-
-import Contract from './contract';
+import { getContractId, getContractStorageRoot, includeHexPrefix } from './util';
 
 const logger = new Logger(versions.FUELS);
 

packages/contract/src/index.ts

@@ -1,10 +1,2 @@
-export * from './types';
-export { default as ContractFactory } from './contracts/contract-factory';
-export { default as Contract } from './contracts/contract';
-export { FunctionInvocationScope } from './contracts/functions/invocation-scope';
-export { MultiCallInvocationScope } from './contracts/functions/multicall-scope';
-export {
-  InvocationResult,
-  FunctionInvocationResult,
-} from './contracts/functions/invocation-results';
+export { default as ContractFactory } from './contract-factory';
 export * as ContractUtils from './util';

packages/contract/src/util.ts

@@ -37,15 +37,6 @@ export const getContractId = (
   return contractId;
 };
 
-/**
- * Generic assert function to avoid undesirable errors
- */
-export function assert(condition: unknown, message: string): asserts condition {
-  if (!condition) {
-    throw new Error(message);
-  }
-}
-
 export const includeHexPrefix = (value: string, options?: DataOptions) =>
   hexlify(value, {
     ...options,

packages/fuel-gauge/src/contract-factory.test.ts

@@ -85,11 +85,11 @@ describe('Contract Factory', () => {
   it('Creates a factory from inputs that can prepare call data', async () => {
     const factory = await createContractFactory();
 
-    const contact = await factory.deployContract();
+    const contract = await factory.deployContract();
 
-    const prepared = contact.functions.increment_counter(1).getCallConfig();
+    const prepared = contract.functions.increment_counter(1).getCallConfig();
     expect(prepared).toEqual({
-      contract: expect.objectContaining({ id: contact.id }),
+      program: expect.objectContaining({ id: contract.id }),
       func: expect.objectContaining({ name: 'increment_counter' }),
       args: [1],
       bytesOffset: 720,