feat: encoder runtime arguments check (#1246)

# Description Fixes #1227
AztecProtocol · Jul 31, 2023 · 407b8b5 · 407b8b5
1 parent 5bf5674
commit 407b8b5
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 2 deletions.
diff --git a/yarn-project/acir-simulator/src/client/private_execution.test.ts b/yarn-project/acir-simulator/src/client/private_execution.test.ts
@@ -639,7 +639,13 @@ describe('Private Execution test suite', () => {
 
       oracle.getPortalContractAddress.mockImplementation(() => Promise.resolve(EthAddress.ZERO));
 
-      const args = [amountToTransfer, owner, insertFnSelector, getThenNullifyFnSelector, getZeroFnSelector];
+      const args = [
+        amountToTransfer,
+        owner,
+        Fr.fromBuffer(insertFnSelector),
+        Fr.fromBuffer(getThenNullifyFnSelector),
+        Fr.fromBuffer(getZeroFnSelector),
+      ];
       const result = await runSimulator({
         args: args,
         abi: abi,

diff --git a/yarn-project/foundation/src/abi/encoder.test.ts b/yarn-project/foundation/src/abi/encoder.test.ts
@@ -0,0 +1,78 @@
+import { ABIParameterVisibility, FunctionAbi, FunctionType } from './abi.js';
+import { encodeArguments } from './encoder.js';
+
+describe('abi/encoder', () => {
+  it('throws when passing string argument as field', () => {
+    const testFunctionAbi: FunctionAbi = {
+      name: 'constructor',
+      functionType: FunctionType.SECRET,
+      isInternal: false,
+      parameters: [
+        {
+          name: 'owner',
+          type: {
+            kind: 'field',
+          },
+          visibility: ABIParameterVisibility.SECRET,
+        },
+      ],
+      returnTypes: [],
+      bytecode: '',
+      verificationKey: '',
+    };
+    const args = ['garbage'];
+
+    expect(() => encodeArguments(testFunctionAbi, args)).toThrowError('Invalid argument "garbage" of type field');
+  });
+
+  it('throws when passing string argument as integer', () => {
+    const testFunctionAbi: FunctionAbi = {
+      name: 'constructor',
+      functionType: FunctionType.SECRET,
+      isInternal: false,
+      parameters: [
+        {
+          name: 'isOwner',
+          type: {
+            sign: 'value',
+            width: 5,
+            kind: 'integer',
+          },
+          visibility: ABIParameterVisibility.SECRET,
+        },
+      ],
+      returnTypes: [],
+      bytecode: '',
+      verificationKey: '',
+    };
+    const args = ['garbage'];
+    expect(() => encodeArguments(testFunctionAbi, args)).toThrowError('Cannot convert garbage to a BigInt');
+  });
+
+  it.only('throws when passing object argument as field', () => {
+    const testFunctionAbi: FunctionAbi = {
+      name: 'constructor',
+      functionType: FunctionType.SECRET,
+      isInternal: false,
+      parameters: [
+        {
+          name: 'owner',
+          type: {
+            kind: 'field',
+          },
+          visibility: ABIParameterVisibility.SECRET,
+        },
+      ],
+      returnTypes: [],
+      bytecode: '',
+      verificationKey: '',
+    };
+    const args = [
+      {
+        value: 'garbage',
+      },
+    ];
+
+    expect(() => encodeArguments(testFunctionAbi, args)).toThrowError('Argument cannot be serialised to a field');
+  });
+});
diff --git a/yarn-project/foundation/src/abi/encoder.ts b/yarn-project/foundation/src/abi/encoder.ts
@@ -29,9 +29,13 @@ class ArgumentEncoder {
         } else if (typeof arg === 'object') {
           if (typeof arg.toField === 'function') {
             this.flattened.push(arg.toField());
-          } else {
+          } else if (arg instanceof Fr) {
             this.flattened.push(arg);
+          } else {
+            throw new Error('Argument cannot be serialised to a field');
           }
+        } else {
+          throw new Error(`Invalid argument "${arg}" of type ${abiType.kind}`);
         }
         break;
       case 'boolean':