Adds check-deployment-addresses.ts script

Author: acenolaza

package.json

@@ -23,6 +23,7 @@
   "scripts": {
     "build": "pnpm build:hardhat && tsc -p tsconfig.build.json",
     "build:hardhat": "hardhat --config hardhat.build.config.ts compile",
+    "check:deployment-addresses": "ts-node scripts/check-deployment-addresses.ts",
     "deploy:InverseApi3ReaderProxyV1": "hardhat deploy --network $NETWORK --tags InverseApi3ReaderProxyV1",
     "deploy:NormalizedApi3ReaderProxyV1": "hardhat deploy --network $NETWORK --tags NormalizedApi3ReaderProxyV1",
     "deploy:ProductApi3ReaderProxyV1": "hardhat deploy --network $NETWORK --tags ProductApi3ReaderProxyV1",

scripts/check-deployment-addresses.ts

@@ -0,0 +1,29 @@
+import * as fs from 'node:fs';
+import { join } from 'node:path';
+
+import { getDeploymentAddresses } from './src/deployment-addresses';
+
+async function main(): Promise<void> {
+  const addressesJsonPath = join('deployments', 'addresses.json');
+  const existingAddressesJsonString = fs.existsSync(addressesJsonPath)
+    ? fs.readFileSync(addressesJsonPath, 'utf8')
+    : '{}';
+
+  const generatedAddressesJsonString = getDeploymentAddresses();
+
+  // Normalize by parsing and re-stringifying to ensure consistent formatting for comparison
+  const normalizedExisting = `${JSON.stringify(JSON.parse(existingAddressesJsonString), null, 2)}\n`;
+  const normalizedGenerated = `${JSON.stringify(JSON.parse(generatedAddressesJsonString), null, 2)}\n`;
+
+  if (normalizedExisting !== normalizedGenerated) {
+    throw new Error(`${addressesJsonPath} is outdated. Please run "pnpm generate:deployment-addresses".`);
+  }
+}
+
+main()
+  .then(() => process.exit(0))
+  .catch((error) => {
+    // eslint-disable-next-line no-console
+    console.error(error);
+    process.exit(1);
+  });