Validate signed API name triggers

api3dao · Dec 6, 2023 · 93ca962 · 93ca962
1 parent 43bf629
commit 93ca962
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 1 deletion.
diff --git a/packages/airnode-feed/src/validation/schema.test.ts b/packages/airnode-feed/src/validation/schema.test.ts
@@ -93,3 +93,21 @@ test('validates trigger references', async () => {
     ])
   );
 });
+
+test('trigger must point to a valid Signed API definition', async () => {
+  // As a note, having unused Signed API definitions is not an error.
+  const invalidConfig: Config = {
+    ...config,
+    signedApis: [{ ...config.signedApis[0]!, name: 'different-name' }],
+  };
+
+  await expect(async () => configSchema.parseAsync(invalidConfig)).rejects.toStrictEqual(
+    new ZodError([
+      {
+        code: 'custom',
+        message: 'Unable to find signed API with name: localhost',
+        path: ['triggers', 'signedApiUpdates', 0, 'signedApiName'],
+      },
+    ])
+  );
+});
diff --git a/packages/airnode-feed/src/validation/schema.ts b/packages/airnode-feed/src/validation/schema.ts
@@ -225,6 +225,8 @@ export const signedApiSchema = z.strictObject({
   url: z.string().url(),
 });
 
+export type SignedApi = z.infer<typeof signedApiSchema>;
+
 export const signedApisSchema = z
   .array(signedApiSchema)
   .nonempty()
@@ -241,6 +243,22 @@ export const signedApisSchema = z
     }
   });
 
+const validateSignedApiReferences: SuperRefinement<{
+  triggers: Triggers;
+  signedApis: SignedApi[];
+}> = (config, ctx) => {
+  for (const [index, trigger] of config.triggers.signedApiUpdates.entries()) {
+    const api = config.signedApis.find((api) => api.name === trigger.signedApiName);
+    if (!api) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: `Unable to find signed API with name: ${trigger.signedApiName}`,
+        path: ['triggers', 'signedApiUpdates', index, 'signedApiName'],
+      });
+    }
+  }
+};
+
 export const oisesSchema = z.array(oisSchema);
 
 export const apisCredentialsSchema = z.array(config.apiCredentialsSchema);
@@ -272,7 +290,8 @@ export const configSchema = z
   })
   .superRefine(validateTemplatesReferences)
   .superRefine(validateOisReferences)
-  .superRefine(validateTriggerReferences);
+  .superRefine(validateTriggerReferences)
+  .superRefine(validateSignedApiReferences);
 
 export const encodedValueSchema = z.string().regex(/^0x[\dA-Fa-f]{64}$/);