Merge pull request #56 from hyperlane-xyz/metadata-parsing-fix

Fix chain metadata parsing

.vscode/settings.json

@@ -16,14 +16,14 @@
   "[typescript]": {
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.organizeImports": "explicit"
     },
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "[typescriptreact]": {
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.organizeImports": "explicit"
     },
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },

src/features/chains/chainConfig.ts

@@ -1,14 +1,13 @@
 import { z } from 'zod';
 
-import { ChainMetadata, ChainMetadataSchema, MultiProvider } from '@hyperlane-xyz/sdk';
+import { ChainMetadata, ChainMetadataSchemaObject, MultiProvider } from '@hyperlane-xyz/sdk';
 
 import { logger } from '../../utils/logger';
 
-export const ChainConfigSchema = z.record(
-  ChainMetadataSchema.and(
-    z.object({ mailbox: z.string().optional(), interchainGasPaymaster: z.string().optional() }),
-  ),
-);
+export const ChainConfigSchema = ChainMetadataSchemaObject.extend({
+  mailbox: z.string().optional(),
+  interchainGasPaymaster: z.string().optional(),
+});
 
 export type ChainConfig = ChainMetadata & { mailbox?: Address; interchainGasPaymaster?: Address };
 

src/features/chains/chainconfig.test.ts

@@ -0,0 +1,29 @@
+import { tryParseChainConfig } from './chainConfig';
+
+const validConfig = {
+  chainId: 12345,
+  name: 'mytestnet',
+  protocol: 'ethereum',
+  rpcUrls: [{ http: 'https://fakerpc.com' }],
+  blockExplorers: [
+    {
+      name: 'FakeScan',
+      family: 'other',
+      url: 'https://fakeexplorer.com',
+      apiUrl: 'https://fakeexplorer.com',
+    },
+  ],
+  blocks: { confirmations: 1, estimateBlockTime: 10 },
+  mailbox: '0x14999bccB37118713891DAAA1D5959a02E206C1f',
+};
+
+describe('chain configs', () => {
+  it('parses valid config', async () => {
+    const result = tryParseChainConfig(JSON.stringify(validConfig));
+    expect(result.success).toBe(true);
+  });
+  it('rejects invalid config', async () => {
+    const result = tryParseChainConfig(JSON.stringify({ ...validConfig, chainId: undefined }));
+    expect(result.success).toBe(false);
+  });
+});