@safe-global/safe-deployments 1.37.0 → 1.37.2

package/src/__tests__/assets.test.ts

@@ -1,8 +1,11 @@
-import fs from "fs";
-import path from "path";
+import fs from 'fs';
+import path from 'path';
+import { SingletonDeploymentJSON, AddressType } from '../types';
+
+const KNOWN_ADDRESS_TYPES: AddressType[] = ['canonical', 'eip155', 'zksync'];
 
 function assetPath(...paths: string[]) {
-  return path.join(__dirname, "..", "assets", ...paths);
+  return path.join(__dirname, '..', 'assets', ...paths);
 }
 
 function versions() {
@@ -16,67 +19,93 @@ function versionFiles(version: string) {
 }
 
 async function readAsset(version: string, file: string) {
-  return await fs.promises.readFile(assetPath(version, file), "utf-8");
+  return await fs.promises.readFile(assetPath(version, file), 'utf-8');
 }
 
-async function readAssetJSON(version: string, file: string) {
+async function readAssetJSON(version: string, file: string): Promise<SingletonDeploymentJSON | undefined> {
   return JSON.parse(await readAsset(version, file));
 }
 
-describe("assets/", () => {
+describe('assets/', () => {
   for (const version of versions()) {
     describe(version, () => {
       for (const file of versionFiles(version)) {
         describe(file, () => {
-          describe("networkAddresses", () => {
-            it("should be sorted by chain ID", async () => {
+          describe('networkAddresses', () => {
+            it('should be sorted by chain ID', async () => {
               // We manually parse the JSON here, since ECMA `JSON.parse` will
               // always order fields with numeric keys.
               const json = await readAsset(version, file);
-              const networkAddresses = json
-                .replace(
-                  /^[\s\S]*"networkAddresses" *: *\{([^}]*)\}[\s\S]*$/,
-                  "$1"
-                )
-                .trim();
-              const keys = networkAddresses.split(",").map((pair) => {
-                const [key] = pair.split(":");
-                return parseInt(key.trim().replace(/^"(.*)"$/, "$1"));
+              const networkAddresses = json.replace(/^[\s\S]*"networkAddresses" *: *\{([^}]*)\}[\s\S]*$/, '$1').trim();
+              const keys = networkAddresses.split(',').map((pair) => {
+                const [key] = pair.split(':');
+                return parseInt(key.trim().replace(/^"(.*)"$/, '$1'));
               });
               const sorted = [...keys].sort((a, b) => a - b);
               expect(keys).toEqual(sorted);
             });
 
-            it("should only contain canonical addresses", async () => {
-              const { networkAddresses } = await readAssetJSON(version, file);
-              const canonicalAddresses = [
-                // Ethereum Mainnet address
-                networkAddresses[1],
-                // For v1.3.0, support alternate address with different
-                // `CREATE2` deployer, notably used for Optimism Mainnet
-                ...(version === "v1.3.0" ? [networkAddresses[10]] : []),
-                // zkSync Mainnet address
-                networkAddresses[324],
-              ].filter((address) => address !== undefined);
-
-              for (const [network, address] of Object.entries(
-                networkAddresses
-              )) {
-                expect(
-                  canonicalAddresses.map((address) => [network, address])
-                ).toContainEqual([network, address]);
+            it('networks should only contain known address types', async () => {
+              const deploymentJson = await readAssetJSON(version, file);
+              if (!deploymentJson) {
+                throw new Error(`Failed to read asset ${version}/${file}`);
+              }
+
+              const { networkAddresses, deployments } = deploymentJson;
+              const canonicalAddressTypes = Object.keys(deployments);
+
+              for (const addressType of Object.values(networkAddresses)) {
+                if (Array.isArray(addressType)) {
+                  for (const type of addressType) {
+                    expect(canonicalAddressTypes).toContain(type);
+                  }
+                } else {
+                  expect(canonicalAddressTypes).toContain(addressType);
+                }
               }
             });
           });
+
+          it('should only contain known address types', async () => {
+            const deploymentJson = await readAssetJSON(version, file);
+            if (!deploymentJson) {
+              throw new Error(`Failed to read asset ${version}/${file}`);
+            }
+            const { deployments } = deploymentJson;
+
+            for (const addressType of Object.keys(deployments)) {
+              expect(KNOWN_ADDRESS_TYPES).toContain(addressType);
+            }
+          });
+
+          it('no network can contain zksync address together with other address types', async () => {
+            const deploymentJson = await readAssetJSON(version, file);
+            if (!deploymentJson) {
+              throw new Error(`Failed to read asset ${version}/${file}`);
+            }
+            const { networkAddresses } = deploymentJson;
+
+            for (const network of Object.keys(networkAddresses)) {
+              const addressTypes = networkAddresses[network];
+
+              if (Array.isArray(addressTypes)) {
+                expect(addressTypes).not.toContain('zksync');
+              }
+            }
+          });
         });
       }
 
-      describe("networkAddresses", () => {
-        it("should contain the same networks in all files", async () => {
+      describe('networkAddresses', () => {
+        it('should contain the same networks in all files', async () => {
           const files = versionFiles(version);
           const networkCounts: Record<string, number> = {};
           for (const file of files) {
-            const { networkAddresses } = await readAssetJSON(version, file);
+            const deploymentJson = await readAssetJSON(version, file);
+            if (!deploymentJson) {
+              throw new Error(`Failed to read asset ${version}/${file}`);
+            }
+            const { networkAddresses } = deploymentJson;
             for (const network of Object.keys(networkAddresses)) {
               networkCounts[network] = (networkCounts[network] ?? 0) + 1;
             }
@@ -85,6 +114,40 @@ describe("assets/", () => {
             expect([network, count]).toEqual([network, files.length]);
           }
         });
+
+        it('the address types for a network should be the same in all files', async () => {
+          const files = versionFiles(version);
+          const networkAddressMap: Record<string, string | string[]> = {};
+
+          for (const file of files) {
+            const deploymentJson = await readAssetJSON(version, file);
+            if (!deploymentJson) {
+              throw new Error(`Failed to read asset ${version}/${file}`);
+            }
+            const { networkAddresses } = deploymentJson;
+
+            for (const [network, addressTypes] of Object.entries(networkAddresses)) {
+              if (!networkAddressMap[network]) {
+                networkAddressMap[network] = addressTypes;
+              } else {
+                // We use try/catch here to make the error message more readable.
+                // Without it the error message looks like:
+                // Expected: "canonical"
+                // Actual:   ["canonical", "eip155"]
+                try {
+                  expect(addressTypes).toEqual(networkAddressMap[network]);
+                } catch (e) {
+                  console.log(`
+                    Discrepancy in network ${network}
+                    Expected: ${networkAddressMap[network]}
+                    Actual:   ${addressTypes}
+                  `);
+                  throw e;
+                }
+              }
+            }
+          }
+        });
       });
     });
   }

package/src/__tests__/factories.test.ts

@@ -1,12 +1,12 @@
-import ProxyFactory130 from '../assets/v1.3.0/proxy_factory.json';
-import ProxyFactory141 from '../assets/v1.4.1/safe_proxy_factory.json';
+import ProxyFactory130 from './assets/v1/v1.3.0/proxy_factory.json';
+import ProxyFactory141 from './assets/v1/v1.4.1/safe_proxy_factory.json';
 import { getProxyFactoryDeployment } from '../factories';
 
 describe('factories.ts', () => {
   describe('getProxyFactoryDeployment', () => {
     it('should find the latest deployment first', () => {
       const result = getProxyFactoryDeployment();
-      expect(result).toBe(ProxyFactory141);
+      expect(result).toMatchObject(ProxyFactory141);
       expect(result).not.toBe(ProxyFactory130);
     });
   });

package/src/__tests__/handler.test.ts

@@ -1,5 +1,5 @@
-import DefaultCallbackHandler130 from '../assets/v1.1.1/default_callback_handler.json';
-import CompatibilityFallbackHandler141 from '../assets/v1.4.1/compatibility_fallback_handler.json';
+import DefaultCallbackHandler130 from './assets/v1/v1.1.1/default_callback_handler.json';
+import CompatibilityFallbackHandler141 from './assets/v1/v1.4.1/compatibility_fallback_handler.json';
 import {
   getDefaultCallbackHandlerDeployment,
   getCompatibilityFallbackHandlerDeployment,
@@ -10,21 +10,21 @@ describe('handler.ts', () => {
   describe('getDefaultCallbackHandlerDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getDefaultCallbackHandlerDeployment();
-      expect(result).toBe(DefaultCallbackHandler130);
+      expect(result).toMatchObject(DefaultCallbackHandler130);
     });
   });
 
   describe('getCompatibilityFallbackHandlerDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getCompatibilityFallbackHandlerDeployment();
-      expect(result).toBe(CompatibilityFallbackHandler141);
+      expect(result).toMatchObject(CompatibilityFallbackHandler141);
     });
   });
 
   describe('getFallbackHandlerDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getFallbackHandlerDeployment();
-      expect(result).toBe(CompatibilityFallbackHandler141);
+      expect(result).toMatchObject(CompatibilityFallbackHandler141);
       expect(result).not.toBe(DefaultCallbackHandler130);
     });
   });

package/src/__tests__/libs.test.ts

@@ -1,8 +1,8 @@
-import CreateCall141 from '../assets/v1.4.1/create_call.json';
-import MultiSend111 from '../assets/v1.1.1/multi_send.json';
-import MultiSend141 from '../assets/v1.4.1/multi_send.json';
-import MultiSendCallOnly141 from '../assets/v1.4.1/multi_send_call_only.json';
-import SignMessageLib141 from '../assets/v1.4.1/sign_message_lib.json';
+import CreateCall141 from './assets/v1/v1.4.1/create_call.json';
+import MultiSend111 from './assets/v1/v1.1.1/multi_send.json';
+import MultiSend141 from './assets/v1/v1.4.1/multi_send.json';
+import MultiSendCallOnly141 from './assets/v1/v1.4.1/multi_send_call_only.json';
+import SignMessageLib141 from './assets/v1/v1.4.1/sign_message_lib.json';
 import {
   getMultiSendDeployment,
   getMultiSendCallOnlyDeployment,
@@ -14,26 +14,26 @@ describe('libs.ts', () => {
   describe('getMultiSendDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getMultiSendDeployment();
-      expect(result).toBe(MultiSend141);
+      expect(result).toMatchObject(MultiSend141);
       expect(result).not.toBe(MultiSend111);
     });
   });
   describe('getMultiSendCallOnlyDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getMultiSendCallOnlyDeployment();
-      expect(result).toBe(MultiSendCallOnly141);
+      expect(result).toMatchObject(MultiSendCallOnly141);
     });
   });
   describe('getCreateCallDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getCreateCallDeployment();
-      expect(result).toBe(CreateCall141);
+      expect(result).toMatchObject(CreateCall141);
     });
   });
   describe('getSignMessageLibDeployment', () => {
     it('should find the preferred deployment first', () => {
       const result = getSignMessageLibDeployment();
-      expect(result).toBe(SignMessageLib141);
+      expect(result).toMatchObject(SignMessageLib141);
     });
   });
 });

package/src/__tests__/safes.test.ts

@@ -1,19 +1,16 @@
-import SafeL2141 from '../assets/v1.4.1/safe_l2.json';
-import Safe141 from '../assets/v1.4.1/safe.json';
-import GnosisSafe130 from '../assets/v1.3.0/gnosis_safe.json';
-import GnosisSafe120 from '../assets/v1.2.0/gnosis_safe.json';
-import GnosisSafe111 from '../assets/v1.1.1/gnosis_safe.json';
-import GnosisSafe100 from '../assets/v1.0.0/gnosis_safe.json';
-import {
-  getSafeSingletonDeployment,
-  getSafeL2SingletonDeployment,
-} from '../safes';
+import SafeL2141 from './assets/v1/v1.4.1/safe_l2.json';
+import Safe141 from './assets/v1/v1.4.1/safe.json';
+import GnosisSafe130 from './assets/v1/v1.3.0/gnosis_safe.json';
+import GnosisSafe120 from './assets/v1/v1.2.0/gnosis_safe.json';
+import GnosisSafe111 from './assets/v1/v1.1.1/gnosis_safe.json';
+import GnosisSafe100 from './assets/v1/v1.0.0/gnosis_safe.json';
+import { getSafeSingletonDeployment, getSafeL2SingletonDeployment } from '../safes';
 
 describe('safes.ts', () => {
   describe('getSafeSingletonDeployment', () => {
     it('should find the latest deployment first', () => {
       const result = getSafeSingletonDeployment();
-      expect(result).toBe(Safe141);
+      expect(result).toMatchObject(Safe141);
       [GnosisSafe130, GnosisSafe120, GnosisSafe111, GnosisSafe100].forEach((version) => {
         expect(result).not.toBe(version);
       });
@@ -22,7 +19,7 @@ describe('safes.ts', () => {
   describe('getSafeL2SingletonDeployment', () => {
     it('should find the latest deployment first', () => {
       const result = getSafeL2SingletonDeployment();
-      expect(result).toBe(SafeL2141);
+      expect(result).toMatchObject(SafeL2141);
     });
   });
 });