Prepare config format & validation for beaconSets section #163

Author: acenolaza

config/airseeker.example.json

@@ -5,13 +5,23 @@
     "level": "INFO"
   },
   "beacons": {
-    "0x924b5d4cb3ec6366ae4302a1ca6aec035594ea3ea48a102d160b50b0c43ebfb5": {
+    "0xbc80cbd7a8b8180e11d189a8334814a44a69c4d083b31305ecf67a3a3ea0fd9a": {
       "airnode": "0xA30CA71Ba54E83127214D3271aEA8F5D6bD4Dace",
-      "templateId": "0xea30f92923ece1a97af69d450a8418db31be5a26a886540a13c09c739ba8eaaa",
+      "templateId": "0x5fadf775c50d6ec9641b9d07ab3a9ca9d92aaf64d27ea54529fb7d8ebc72e713",
+      "fetchInterval": 20
+    },
+    "0x717d60cb328ef7ea138ae1b31c78a03fe6caa1a05568b1649e89cd924321b732": {
+      "airnode": "0xA30CA71Ba54E83127214D3271aEA8F5D6bD4Dace",
+      "templateId": "0x32ee5c344877c40260b6010bb91f85f39b5a9a0f6690d4c6888af90f5613d854",
       "fetchInterval": 20
     }
   },
-  "beaconSets": {},
+  "beaconSets": {
+    "0x786c4a7929a666c77ba5d4d3ce7ed61f2ba9885525f0a7577f014641568926fe": [
+      "0xbc80cbd7a8b8180e11d189a8334814a44a69c4d083b31305ecf67a3a3ea0fd9a",
+      "0x717d60cb328ef7ea138ae1b31c78a03fe6caa1a05568b1649e89cd924321b732"
+    ]
+  },
   "chains": {
     "1": {
       "contracts": {
@@ -82,9 +92,13 @@
     ]
   },
   "templates": {
-    "0xea30f92923ece1a97af69d450a8418db31be5a26a886540a13c09c739ba8eaaa": {
-      "endpointId": "0x13dea3311fe0d6b84f4daeab831befbc49e19e6494c41e9e065a09c3c68f43b6",
-      "parameters": "0x3173737373730000000000000000000000000000000000000000000000000000746f00000000000000000000000000000000000000000000000000000000000055534400000000000000000000000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e7432353600000000000000000000000000000000000000000000000000005f70617468000000000000000000000000000000000000000000000000000000726573756c7400000000000000000000000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030300000000000000000000000000000000000000000000000000066726f6d000000000000000000000000000000000000000000000000000000004554480000000000000000000000000000000000000000000000000000000000"
+    "0x5fadf775c50d6ec9641b9d07ab3a9ca9d92aaf64d27ea54529fb7d8ebc72e713": {
+      "endpointId": "0x18a60ee2138d98b5f968b7177a8a537515e3db46d0712b8dd311625e6c2335c4",
+      "parameters": "0x317373737373730000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006274635f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e7677617000000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e7432353600000000000000000000000000000000000000000000000000005f74696d6573000000000000000000000000000000000000000000000000000031303030303030303030303030303030303030000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000696e636c75646543726f737352617465730000000000000000000000000000007472756500000000000000000000000000000000000000000000000000000000"
+    },
+    "0x32ee5c344877c40260b6010bb91f85f39b5a9a0f6690d4c6888af90f5613d854": {
+      "endpointId": "0x18a60ee2138d98b5f968b7177a8a537515e3db46d0712b8dd311625e6c2335c4",
+      "parameters": "0x317373737373730000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006574685f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e7677617000000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e7432353600000000000000000000000000000000000000000000000000005f74696d6573000000000000000000000000000000000000000000000000000031303030303030303030303030303030303030000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000696e636c75646543726f737352617465730000000000000000000000000000007472756500000000000000000000000000000000000000000000000000000000"
     }
   },
   "triggers": {
@@ -93,7 +107,12 @@
         "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC": {
           "beacons": [
             {
-              "beaconId": "0x924b5d4cb3ec6366ae4302a1ca6aec035594ea3ea48a102d160b50b0c43ebfb5",
+              "beaconId": "0xbc80cbd7a8b8180e11d189a8334814a44a69c4d083b31305ecf67a3a3ea0fd9a",
+              "deviationThreshold": 0.1,
+              "heartbeatInterval": 86400
+            },
+            {
+              "beaconId": "0x717d60cb328ef7ea138ae1b31c78a03fe6caa1a05568b1649e89cd924321b732",
               "deviationThreshold": 0.1,
               "heartbeatInterval": 86400
             }
@@ -105,7 +124,7 @@
         "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC": {
           "beacons": [
             {
-              "beaconId": "0x924b5d4cb3ec6366ae4302a1ca6aec035594ea3ea48a102d160b50b0c43ebfb5",
+              "beaconId": "0x717d60cb328ef7ea138ae1b31c78a03fe6caa1a05568b1649e89cd924321b732",
               "deviationThreshold": 0.2,
               "heartbeatInterval": 86400
             }

src/validation.ts

@@ -17,6 +17,7 @@ export const logSchema = z.object({
 
 export const evmAddressSchema = z.string().regex(/^0x[a-fA-F0-9]{40}$/);
 export const evmBeaconIdSchema = z.string().regex(/^0x[a-fA-F0-9]{64}$/);
+export const evmBeaconSetIdSchema = z.string().regex(/^0x[a-fA-F0-9]{64}$/);
 export const evmTemplateIdSchema = z.string().regex(/^0x[a-fA-F0-9]{64}$/);
 export const evmEndpointIdSchema = z.string().regex(/^0x[a-fA-F0-9]{64}$/);
 export const emptyObjectSchema = z.object({}).strict();
@@ -44,8 +45,22 @@ export const beaconsSchema = z.record(evmBeaconIdSchema, beaconSchema).superRefi
   });
 });
 
-// TODO: Will be refined once we start supporting beacon sets
-export const beaconSetsSchema = emptyObjectSchema;
+export const beaconSetsSchema = z
+  .record(evmBeaconSetIdSchema, z.array(evmBeaconIdSchema))
+  .superRefine((beaconSets, ctx) => {
+    Object.entries(beaconSets).forEach(([beaconSetId, beacons]) => {
+      // Verify that config.beaconSets.<beaconSetId> is valid
+      // by deriving the hash of the beaconIds in the array
+      const derivedBeaconSetId = ethers.utils.keccak256(ethers.utils.defaultAbiCoder.encode(['bytes32[]'], [beacons]));
+      if (derivedBeaconSetId !== beaconSetId) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: `Beacon set ID "${beaconSetId}" is invalid`,
+          path: [beaconSetId],
+        });
+      }
+    });
+  });
 
 export const latestGasPriceOptionsSchema = z
   .object({
@@ -168,6 +183,23 @@ const validateBeaconsReferences: SuperRefinement<{ beacons: Beacons; gateways: G
   });
 };
 
+const validateBeaconSetsReferences: SuperRefinement<{ beacons: Beacons; beaconSets: BeaconSets }> = (config, ctx) => {
+  Object.entries(config.beaconSets).forEach(([beaconSetId, beacons]) => {
+    beacons.forEach((beaconId, index) => {
+      // Verify that config.beaconSets.<beaconSetId>.[beaconId] is
+      // referencing a valid config.beacons.<beaconId> object
+      const beacon = config.beacons[beaconId];
+      if (isNil(beacon)) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: `Beacon ID "${beaconId}" is not defined in the config.beacons object`,
+          path: ['beaconSets', beaconSetId, index],
+        });
+      }
+    });
+  });
+};
+
 const validateBeaconUpdatesReferences: SuperRefinement<{
   beacons: Beacons;
   chains: Chains;
@@ -212,6 +244,7 @@ export const configSchema = z
   })
   .strict()
   .superRefine(validateBeaconsReferences)
+  .superRefine(validateBeaconSetsReferences)
   .superRefine(validateBeaconUpdatesReferences);
 export const encodedValueSchema = z.string().regex(/^0x[a-fA-F0-9]{64}$/);
 export const signatureSchema = z.string().regex(/^0x[a-fA-F0-9]{130}$/);
@@ -223,6 +256,7 @@ export const signedDataSchema = z.object({
 export type Config = z.infer<typeof configSchema>;
 export type Beacon = z.infer<typeof beaconSchema>;
 export type Beacons = z.infer<typeof beaconsSchema>;
+export type BeaconSets = z.infer<typeof beaconSetsSchema>;
 export type Chain = z.infer<typeof chainSchema>;
 export type Chains = z.infer<typeof chainsSchema>;
 export type GasOracleConfig = z.infer<typeof gasOracleSchema>;