@safe-global/safe-deployments 1.36.0 → 1.37.1

package/dist/types.d.ts

@@ -1,13 +1,39 @@
+declare enum AddressType {
+    CANONICAL = "canonical",
+    EIP155 = "eip155",
+    ZKSYNC = "zksync"
+}
+export interface SingletonDeploymentJSON {
+    released: boolean;
+    contractName: string;
+    version: string;
+    codeHash: string;
+    networkAddresses: Record<string, string | string[]>;
+    addresses: Record<string, string>;
+    abi: any[];
+}
 export interface SingletonDeployment {
     defaultAddress: string;
+    released: boolean;
+    contractName: string;
     version: string;
-    abi: any[];
+    codeHash: string;
+    addresses: Record<string, string>;
     networkAddresses: Record<string, string>;
-    contractName: string;
+    abi: any[];
+}
+export interface SingletonDeploymentV2 {
     released: boolean;
+    contractName: string;
+    version: string;
+    codeHash: string;
+    abi: any[];
+    networkAddresses: Record<string, AddressType | AddressType[]>;
+    addresses: Partial<Record<AddressType, string>>;
 }
 export interface DeploymentFilter {
     version?: string;
     released?: boolean;
     network?: string;
 }
+export {};

package/dist/types.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var AddressType;
+(function (AddressType) {
+    // The original address the contract was deployed on.
+    // Starting with 1.4.1, the contracts are deployed with an EIP155-compatible transaction.
+    AddressType["CANONICAL"] = "canonical";
+    // An address that was deployed with a transaction compatible with the EIP155 standard.
+    // The type is only used for 1.3.0 deployments.
+    AddressType["EIP155"] = "eip155";
+    // An address that is deployed to the ZkSync VM networks.
+    AddressType["ZKSYNC"] = "zksync";
+})(AddressType || (AddressType = {}));

package/dist/utils.d.ts

@@ -1,2 +1,9 @@
-import { DeploymentFilter, SingletonDeployment } from './types';
-export declare const findDeployment: (criteria: DeploymentFilter | undefined, deployments: SingletonDeployment[]) => SingletonDeployment | undefined;
+import { DeploymentFilter, SingletonDeployment, SingletonDeploymentJSON } from './types';
+/**
+ * Finds a deployment that matches the given criteria.
+ *
+ * @param {DeploymentFilter} [criteria=DEFAULT_FILTER] - The filter criteria to match deployments.
+ * @param {SingletonDeploymentJSON[]} deployments - The list of deployment JSON objects to search.
+ * @returns {SingletonDeployment | undefined} - The found deployment object or undefined if no match is found.
+ */
+export declare const findDeployment: (criteria: DeploymentFilter | undefined, deployments: SingletonDeploymentJSON[]) => SingletonDeployment | undefined;

package/dist/utils.js

@@ -6,16 +6,45 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.findDeployment = void 0;
 const satisfies_1 = __importDefault(require("semver/functions/satisfies"));
 const DEFAULT_FILTER = { released: true };
+// The older JSON format had a `defaultAddress` field, which became obsolete due to EIP-155 enforcement and non-EVM compatible chains.
+// This led to multiple "default" addresses, sometimes on the same chain ID. To maintain backwards compatibility, we map `defaultAddress`
+// to the address deployed on a chosen default network.
+const DEFAULT_NETWORK_CHAIN_ID = '1';
+/**
+ * Maps a SingletonDeploymentJSON object to a SingletonDeployment object.
+ *
+ * @param {SingletonDeploymentJSON} deployment - The deployment JSON object to map.
+ * @returns {SingletonDeployment} - The mapped deployment object.
+ */
+const mapJsonToDeploymentsFormatV1 = (deployment) => {
+    const defaultAddressType = Array.isArray(deployment.networkAddresses[DEFAULT_NETWORK_CHAIN_ID])
+        ? deployment.networkAddresses[DEFAULT_NETWORK_CHAIN_ID][0]
+        : deployment.networkAddresses[DEFAULT_NETWORK_CHAIN_ID];
+    const defaultAddress = deployment.addresses[defaultAddressType];
+    const networkAddresses = Object.fromEntries(Object.entries(deployment.networkAddresses).map(([chainId, addressTypes]) => [
+        chainId,
+        Array.isArray(addressTypes) ? deployment.addresses[addressTypes[0]] : deployment.addresses[addressTypes],
+    ]));
+    return Object.assign(Object.assign({}, deployment), { defaultAddress, networkAddresses });
+};
+/**
+ * Finds a deployment that matches the given criteria.
+ *
+ * @param {DeploymentFilter} [criteria=DEFAULT_FILTER] - The filter criteria to match deployments.
+ * @param {SingletonDeploymentJSON[]} deployments - The list of deployment JSON objects to search.
+ * @returns {SingletonDeployment | undefined} - The found deployment object or undefined if no match is found.
+ */
 const findDeployment = (criteria = DEFAULT_FILTER, deployments) => {
-    const criteriaWithDefaults = Object.assign(Object.assign({}, DEFAULT_FILTER), criteria);
-    return deployments.find((deployment) => {
-        if (typeof criteriaWithDefaults.version !== 'undefined' && !(0, satisfies_1.default)(deployment.version, criteriaWithDefaults.version))
+    const { version, released, network } = Object.assign(Object.assign({}, DEFAULT_FILTER), criteria);
+    const deploymentJson = deployments.find((deployment) => {
+        if (version && !(0, satisfies_1.default)(deployment.version, version))
             return false;
-        if (typeof criteriaWithDefaults.released === 'boolean' && deployment.released != criteriaWithDefaults.released)
+        if (typeof released === 'boolean' && deployment.released !== released)
             return false;
-        if (criteriaWithDefaults.network && !deployment.networkAddresses[criteriaWithDefaults.network])
+        if (network && !deployment.networkAddresses[network])
             return false;
         return true;
     });
+    return deploymentJson ? mapJsonToDeploymentsFormatV1(deploymentJson) : undefined;
 };
 exports.findDeployment = findDeployment;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/safe-deployments",
-  "version": "1.36.0",
+  "version": "1.37.1",
   "description": "Collection of Safe singleton deployments",
   "homepage": "https://github.com/safe-global/safe-deployments/",
   "license": "MIT",
@@ -13,12 +13,14 @@
     "build"
   ],
   "scripts": {
-    "build": "yarn rimraf dist && tsc",
-    "lint": "yarn lint:ts && yarn lint:json",
-    "lint:ts": "eslint --max-warnings 0 .",
+    "build": "rimraf dist && tsc",
+    "lint": "npm run lint:ts && npm run lint:json",
+    "lint:ts": "eslint --max-warnings 0 src/",
     "lint:json": "prettier -c src/assets/*/*.json",
-    "prepack": "yarn build",
-    "prepare": "husky install",
+    "lint:fix": "npm run lint:fix:ts && npm run lint:fix:json",
+    "lint:fix:ts": "npm run lint:ts -- --fix",
+    "lint:fix:json": "prettier -w src/assets/*/*.json",
+    "prepack": "npm run build",
     "test": "jest"
   },
   "repository": {
@@ -35,24 +37,20 @@
     "url": "https://github.com/safe-global/safe-deployments/issues"
   },
   "devDependencies": {
+    "@eslint/js": "^8.57.0",
     "@types/jest": "^29.5.12",
-    "@types/node": "^20.11.30",
+    "@types/node": "^20.14.9",
     "@types/semver": "^7.5.8",
-    "@typescript-eslint/eslint-plugin": "^7.4.0",
-    "@typescript-eslint/parser": "^7.4.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.4.3"
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.5.2",
+    "typescript-eslint": "^7.14.1"
   },
   "dependencies": {
-    "semver": "^7.6.0"
+    "semver": "^7.6.2"
   }
 }