Validate functionAbi-related fields (#223)

nucypher · Jun 14, 2023 · 7138a04 · 7138a04 · github-actions · Jun 14, 2023
2 parents aad7ebe + 4f32411
commit 7138a04
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 142 deletions.
diff --git a/src/conditions/base/contract.ts b/src/conditions/base/contract.ts
@@ -6,14 +6,47 @@ import { RpcCondition, rpcConditionSchema } from './rpc';
 
 export const STANDARD_CONTRACT_TYPES = ['ERC20', 'ERC721'];
 
+const functionAbiVariable = Joi.object({
+  internalType: Joi.string().required(),
+  name: Joi.string().required(),
+  type: Joi.string().required(),
+});
+
+const functionAbiSchema = Joi.object({
+  name: Joi.string().required(),
+  type: Joi.string().valid('function').required(),
+  inputs: Joi.array().items(functionAbiVariable),
+  outputs: Joi.array().items(functionAbiVariable),
+  // TODO: Should we restrict this to 'view'?
+  // stateMutability: Joi.string().valid('view').required(),
+}).custom((functionAbi, helper) => {
+  // Validate method name
+  const method = helper.state.ancestors[0].method;
+  if (functionAbi.name !== method) {
+    return helper.message({
+      custom: '"method" must be the same as "functionAbi.name"',
+    });
+  }
+
+  // Validate nr of parameters
+  const parameters = helper.state.ancestors[0].parameters;
+  if (functionAbi.inputs?.length !== parameters.length) {
+    return helper.message({
+      custom: '"parameters" must have the same length as "functionAbi.inputs"',
+    });
+  }
+
+  return functionAbi;
+});
+
 const contractMethodSchemas: Record<string, Joi.Schema> = {
   ...rpcConditionSchema,
   contractAddress: Joi.string().pattern(ETH_ADDRESS_REGEXP).required(),
   standardContractType: Joi.string()
     .valid(...STANDARD_CONTRACT_TYPES)
     .optional(),
   method: Joi.string().required(),
-  functionAbi: Joi.object().optional(),
+  functionAbi: functionAbiSchema.optional(),
   parameters: Joi.array().required(),
 };
 

diff --git a/test/unit/conditions/base/evm.test.ts b/test/unit/conditions/base/evm.test.ts
diff --git a/test/unit/conditions/context.test.ts b/test/unit/conditions/context.test.ts
@@ -82,6 +82,7 @@ describe('context parameters', () => {
       ...testContractConditionObj,
       standardContractType: undefined, // We're going to use a custom function ABI
       functionAbi: testFunctionAbi,
+      method: testFunctionAbi.name,
       parameters: [USER_ADDRESS_PARAM, customParamKey], // We're going to use a custom parameter
       returnValueTest: {
         ...testReturnValueTest,

diff --git a/test/unit/testVariables.ts b/test/unit/testVariables.ts
@@ -40,16 +40,19 @@ export const testFunctionAbi = {
   type: 'function',
   inputs: [
     {
+      internalType: 'address',
       name: 'account',
       type: 'address',
     },
     {
+      internalType: 'uint256',
       name: 'myCustomParam',
       type: 'uint256',
     },
   ],
   outputs: [
     {
+      internalType: 'uint256',
       name: 'someValue',
       type: 'uint256',
     },