feat: reshape tracking response schema

l2beat · Mar 7, 2024 · 5b21bfb · 5b21bfb
1 parent 0bc4073
commit 5b21bfb
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 41 deletions.
diff --git a/packages/backend/src/tracking/http/TrackingController.test.ts b/packages/backend/src/tracking/http/TrackingController.test.ts
@@ -6,7 +6,10 @@ import {
   OAppConfigurationRecord,
   OAppConfigurationRepository,
 } from '../../peripherals/database/OAppConfigurationRepository'
-import { OAppDefaultConfigurationRepository } from '../../peripherals/database/OAppDefaultConfigurationRepository'
+import {
+  OAppDefaultConfigurationRecord,
+  OAppDefaultConfigurationRepository,
+} from '../../peripherals/database/OAppDefaultConfigurationRepository'
 import {
   OAppRecord,
   OAppRepository,
@@ -103,6 +106,27 @@ describe(TrackingController.name, () => {
           },
         ]
 
+        const mockDefaultConfigurations: OAppDefaultConfigurationRecord[] = [
+          {
+            sourceChainId: chainId,
+            targetChainId: ChainId.ETHEREUM,
+            protocolVersion: ProtocolVersion.V1,
+            configuration: defaultConfiguration,
+          },
+          {
+            sourceChainId: chainId,
+            targetChainId: ChainId.OPTIMISM,
+            protocolVersion: ProtocolVersion.V1,
+            configuration: defaultConfiguration,
+          },
+          {
+            sourceChainId: chainId,
+            targetChainId: ChainId.BSC,
+            protocolVersion: ProtocolVersion.V1,
+            configuration: defaultConfiguration,
+          },
+        ]
+
         const oAppRepo = mockObject<OAppRepository>({
           getBySourceChain: () => Promise.resolve([oAppA, oAppB]),
         })
@@ -112,27 +136,7 @@ describe(TrackingController.name, () => {
         })
         const oAppDefaultConfigRepo =
           mockObject<OAppDefaultConfigurationRepository>({
-            getBySourceChain: (chainId) =>
-              Promise.resolve([
-                {
-                  sourceChainId: chainId,
-                  targetChainId: ChainId.ETHEREUM,
-                  protocolVersion: ProtocolVersion.V1,
-                  configuration: defaultConfiguration,
-                },
-                {
-                  sourceChainId: chainId,
-                  targetChainId: ChainId.OPTIMISM,
-                  protocolVersion: ProtocolVersion.V1,
-                  configuration: defaultConfiguration,
-                },
-                {
-                  sourceChainId: chainId,
-                  targetChainId: ChainId.BSC,
-                  protocolVersion: ProtocolVersion.V1,
-                  configuration: defaultConfiguration,
-                },
-              ]),
+            getBySourceChain: () => Promise.resolve(mockDefaultConfigurations),
           })
 
         const controller = new TrackingController(
@@ -155,14 +159,15 @@ describe(TrackingController.name, () => {
             configurations: [
               {
                 targetChainId: ChainId.ETHEREUM,
-                configuration: defaultConfiguration,
                 isDefault: true,
               },
               {
                 targetChainId: ChainId.BSC,
-                configuration: customConfiguration,
+                changedConfiguration: {
+                  relayer: customConfiguration.relayer,
+                  oracle: customConfiguration.oracle,
+                },
                 isDefault: false,
-                diffs: ['relayer', 'oracle'],
               },
             ],
           },
@@ -175,18 +180,25 @@ describe(TrackingController.name, () => {
             configurations: [
               {
                 targetChainId: ChainId.ETHEREUM,
-                configuration: customConfiguration,
+                changedConfiguration: {
+                  oracle: customConfiguration.oracle,
+                  relayer: customConfiguration.relayer,
+                },
                 isDefault: false,
-                diffs: ['relayer', 'oracle'],
               },
               {
                 targetChainId: ChainId.OPTIMISM,
-                configuration: defaultConfiguration,
                 isDefault: true,
               },
             ],
           },
         ])
+        expect(result.defaultConfigurations).toEqual(
+          mockDefaultConfigurations.map((c) => ({
+            targetChainId: c.targetChainId,
+            configuration: c.configuration,
+          })),
+        )
       })
     })
   })

diff --git a/packages/backend/src/tracking/http/TrackingController.ts b/packages/backend/src/tracking/http/TrackingController.ts
@@ -57,6 +57,11 @@ class TrackingController {
     return {
       sourceChainId: chainId,
       oApps: oAppsWithConfigs,
+
+      defaultConfigurations: defaultConfigurations.map((record) => ({
+        targetChainId: record.targetChainId,
+        configuration: record.configuration,
+      })),
     }
   }
 }
@@ -104,16 +109,26 @@ function resolveConfigurationChanges(
     })
 
     if (diffKeys.length === 0) {
-      return {
-        ...configuration,
+      const result = {
+        oAppId: configuration.oAppId,
+        targetChainId: configuration.targetChainId,
         isDefault: true,
       } as const
+
+      return result
     }
 
     return {
-      ...configuration,
+      oAppId: configuration.oAppId,
+      targetChainId: configuration.targetChainId,
       isDefault: false,
-      diffs: diffKeys,
+      changedConfiguration: diffKeys.reduce<Partial<OAppConfiguration>>(
+        (acc, key) => ({
+          ...acc,
+          [key]: configuration.configuration[key],
+        }),
+        {},
+      ),
     } as const
   })
 }
diff --git a/packages/libs/src/apis/TrackingApi.ts b/packages/libs/src/apis/TrackingApi.ts
@@ -10,16 +10,18 @@ export {
   ResolvedConfigurationWithAppId,
 }
 
+const OAppConfiguration = z.object({
+  relayer: branded(z.string(), EthereumAddress),
+  oracle: branded(z.string(), EthereumAddress),
+  inboundProofLibraryVersion: z.number(),
+  outboundProofType: z.number(),
+  outboundBlockConfirmations: z.number(),
+  inboundBlockConfirmations: z.number(),
+})
+type OAppConfiguration = z.infer<typeof OAppConfiguration>
+
 const BaseConfiguration = z.object({
   targetChainId: branded(z.number(), ChainId),
-  configuration: z.object({
-    relayer: branded(z.string(), EthereumAddress),
-    oracle: branded(z.string(), EthereumAddress),
-    inboundProofLibraryVersion: z.number(),
-    outboundProofType: z.number(),
-    outboundBlockConfirmations: z.number(),
-    inboundBlockConfirmations: z.number(),
-  }),
   isDefault: z.boolean(),
 })
 type BaseConfiguration = z.infer<typeof BaseConfiguration>
@@ -31,7 +33,7 @@ type DefaultConfiguration = z.infer<typeof DefaultConfiguration>
 
 const ChangedConfiguration = BaseConfiguration.extend({
   isDefault: z.literal(false),
-  diffs: z.array(z.string()), // keyof OAppConfiguration
+  changedConfiguration: OAppConfiguration.partial(),
 })
 type ChangedConfiguration = z.infer<typeof ChangedConfiguration>
 
@@ -66,6 +68,12 @@ type OAppWithConfigs = z.infer<typeof OAppWithConfigs>
 const OAppsResponse = z.object({
   sourceChainId: branded(z.number(), ChainId),
   oApps: z.array(OAppWithConfigs),
+  defaultConfigurations: z.array(
+    z.object({
+      targetChainId: branded(z.number(), ChainId),
+      configuration: OAppConfiguration,
+    }),
+  ),
 })
 
 type OAppsResponse = z.infer<typeof OAppsResponse>