@safe-global/safe-deployments 1.37.0 → 1.37.2

package/dist/libs.js

@@ -1,47 +1,77 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSignMessageLibDeployment = exports.getCreateCallDeployment = exports.getMultiSendCallOnlyDeployment = exports.getMultiSendDeployment = void 0;
-const create_call_json_1 = __importDefault(require("./assets/v1.3.0/create_call.json"));
-const create_call_json_2 = __importDefault(require("./assets/v1.4.1/create_call.json"));
-const multi_send_json_1 = __importDefault(require("./assets/v1.1.1/multi_send.json"));
-const multi_send_json_2 = __importDefault(require("./assets/v1.3.0/multi_send.json"));
-const multi_send_json_3 = __importDefault(require("./assets/v1.4.1/multi_send.json"));
-const multi_send_call_only_json_1 = __importDefault(require("./assets/v1.3.0/multi_send_call_only.json"));
-const multi_send_call_only_json_2 = __importDefault(require("./assets/v1.4.1/multi_send_call_only.json"));
-const sign_message_lib_json_1 = __importDefault(require("./assets/v1.3.0/sign_message_lib.json"));
-const sign_message_lib_json_2 = __importDefault(require("./assets/v1.4.1/sign_message_lib.json"));
+exports.getSignMessageLibDeployments = exports.getSignMessageLibDeployment = exports.getCreateCallDeployments = exports.getCreateCallDeployment = exports.getMultiSendCallOnlyDeployments = exports.getMultiSendCallOnlyDeployment = exports.getMultiSendDeployments = exports.getMultiSendDeployment = void 0;
+const deployments_1 = require("./deployments");
 const utils_1 = require("./utils");
-// This is a sorted array (by preference, currently we use 111 in most cases)
-const multiSendDeployments = [
-    multi_send_json_3.default, multi_send_json_2.default, multi_send_json_1.default
-];
+/**
+ * Get the MultiSend deployment based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployment.
+ * @returns {SingletonDeployment | undefined} - The matched deployment or undefined if not found.
+ */
 const getMultiSendDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, multiSendDeployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._MULTI_SEND_DEPLOYMENTS);
 };
 exports.getMultiSendDeployment = getMultiSendDeployment;
-// This is a sorted array (by preference)
-const multiSendCallOnlyDeployments = [
-    multi_send_call_only_json_2.default, multi_send_call_only_json_1.default
-];
+/**
+ * Get all MultiSend deployments based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The matched deployments or undefined if not found.
+ */
+const getMultiSendDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._MULTI_SEND_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getMultiSendDeployments = getMultiSendDeployments;
+/**
+ * Get the MultiSendCallOnly deployment based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployment.
+ * @returns {SingletonDeployment | undefined} - The matched deployment or undefined if not found.
+ */
 const getMultiSendCallOnlyDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, multiSendCallOnlyDeployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._MULTI_SEND_CALL_ONLY_DEPLOYMENTS);
 };
 exports.getMultiSendCallOnlyDeployment = getMultiSendCallOnlyDeployment;
-// This is a sorted array (by preference)
-const createCallDeployments = [
-    create_call_json_2.default, create_call_json_1.default
-];
+/**
+ * Get all MultiSendCallOnly deployments based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The matched deployments or undefined if not found.
+ */
+const getMultiSendCallOnlyDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._MULTI_SEND_CALL_ONLY_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getMultiSendCallOnlyDeployments = getMultiSendCallOnlyDeployments;
+/**
+ * Get the CreateCall deployment based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployment.
+ * @returns {SingletonDeployment | undefined} - The matched deployment or undefined if not found.
+ */
 const getCreateCallDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, createCallDeployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._CREATE_CALL_DEPLOYMENTS);
 };
 exports.getCreateCallDeployment = getCreateCallDeployment;
-const signMessageLibDeployments = [
-    sign_message_lib_json_2.default, sign_message_lib_json_1.default
-];
+/**
+ * Get all CreateCall deployments based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The matched deployments or undefined if not found.
+ */
+const getCreateCallDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._CREATE_CALL_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getCreateCallDeployments = getCreateCallDeployments;
+/**
+ * Get the SignMessageLib deployment based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployment.
+ * @returns {SingletonDeployment | undefined} - The matched deployment or undefined if not found.
+ */
 const getSignMessageLibDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, signMessageLibDeployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._SIGN_MESSAGE_LIB_DEPLOYMENTS);
 };
 exports.getSignMessageLibDeployment = getSignMessageLibDeployment;
+/**
+ * Get all SignMessageLib deployments based on the provided filter.
+ * @param {DeploymentFilter} [filter] - The filter criteria for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The matched deployments or undefined if not found.
+ */
+const getSignMessageLibDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._SIGN_MESSAGE_LIB_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getSignMessageLibDeployments = getSignMessageLibDeployments;

package/dist/safes.d.ts

@@ -1,5 +1,25 @@
-import { DeploymentFilter, SingletonDeployment } from './types';
-export declare const _safeDeployments: SingletonDeployment[];
+import { DeploymentFilter, SingletonDeployment, SingletonDeploymentV2 } from './types';
+/**
+ * Finds the latest safe singleton deployment that matches the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployment.
+ * @returns {SingletonDeployment | undefined} - The found deployment or undefined if no deployment matches the filter.
+ */
 export declare const getSafeSingletonDeployment: (filter?: DeploymentFilter) => SingletonDeployment | undefined;
-export declare const _safeL2Deployments: SingletonDeployment[];
+/**
+ * Finds all safe singleton deployments that match the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The found deployments or undefined if no deployments match the filter.
+ */
+export declare const getSafeSingletonDeployments: (filter?: DeploymentFilter) => SingletonDeploymentV2 | undefined;
+/**
+ * Finds the latest safe L2 singleton deployment that matches the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployment.
+ * @returns {SingletonDeployment | undefined} - The found deployment or undefined if no deployment matches the filter.
+ */
 export declare const getSafeL2SingletonDeployment: (filter?: DeploymentFilter) => SingletonDeployment | undefined;
+/**
+ * Finds all safe L2 singleton deployments that match the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The found deployments or undefined if no deployments match the filter.
+ */
+export declare const getSafeL2SingletonDeployments: (filter?: DeploymentFilter) => SingletonDeploymentV2 | undefined;

package/dist/safes.js

@@ -1,30 +1,41 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSafeL2SingletonDeployment = exports._safeL2Deployments = exports.getSafeSingletonDeployment = exports._safeDeployments = void 0;
-const safe_l2_json_1 = __importDefault(require("./assets/v1.4.1/safe_l2.json"));
-const safe_json_1 = __importDefault(require("./assets/v1.4.1/safe.json"));
-const gnosis_safe_l2_json_1 = __importDefault(require("./assets/v1.3.0/gnosis_safe_l2.json"));
-const gnosis_safe_json_1 = __importDefault(require("./assets/v1.3.0/gnosis_safe.json"));
-const gnosis_safe_json_2 = __importDefault(require("./assets/v1.2.0/gnosis_safe.json"));
-const gnosis_safe_json_3 = __importDefault(require("./assets/v1.1.1/gnosis_safe.json"));
-const gnosis_safe_json_4 = __importDefault(require("./assets/v1.0.0/gnosis_safe.json"));
+exports.getSafeL2SingletonDeployments = exports.getSafeL2SingletonDeployment = exports.getSafeSingletonDeployments = exports.getSafeSingletonDeployment = void 0;
+const deployments_1 = require("./deployments");
 const utils_1 = require("./utils");
-// This is a sorted array (newest to oldest), exported for tests
-exports._safeDeployments = [
-    safe_json_1.default, gnosis_safe_json_1.default, gnosis_safe_json_2.default, gnosis_safe_json_3.default, gnosis_safe_json_4.default
-];
+/**
+ * Finds the latest safe singleton deployment that matches the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployment.
+ * @returns {SingletonDeployment | undefined} - The found deployment or undefined if no deployment matches the filter.
+ */
 const getSafeSingletonDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, exports._safeDeployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._SAFE_DEPLOYMENTS);
 };
 exports.getSafeSingletonDeployment = getSafeSingletonDeployment;
-// This is a sorted array (newest to oldest), exported for tests
-exports._safeL2Deployments = [
-    safe_l2_json_1.default, gnosis_safe_l2_json_1.default
-];
+/**
+ * Finds all safe singleton deployments that match the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The found deployments or undefined if no deployments match the filter.
+ */
+const getSafeSingletonDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._SAFE_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getSafeSingletonDeployments = getSafeSingletonDeployments;
+/**
+ * Finds the latest safe L2 singleton deployment that matches the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployment.
+ * @returns {SingletonDeployment | undefined} - The found deployment or undefined if no deployment matches the filter.
+ */
 const getSafeL2SingletonDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, exports._safeL2Deployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._SAFE_L2_DEPLOYMENTS);
 };
 exports.getSafeL2SingletonDeployment = getSafeL2SingletonDeployment;
+/**
+ * Finds all safe L2 singleton deployments that match the given filter.
+ * @param {DeploymentFilter} [filter] - The filter to apply when searching for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The found deployments or undefined if no deployments match the filter.
+ */
+const getSafeL2SingletonDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._SAFE_L2_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getSafeL2SingletonDeployments = getSafeL2SingletonDeployments;

package/dist/types.d.ts

@@ -1,13 +1,48 @@
+export type AddressType = 'canonical' | 'eip155' | 'zksync';
+export declare const enum DeploymentFormats {
+    SINGLETON = "singleton",
+    MULTIPLE = "multiple"
+}
+type AtLeastOne<T, U = {
+    [K in keyof T]: Pick<T, K>;
+}> = Partial<T> & U[keyof U];
+export interface SingletonDeploymentJSON {
+    released: boolean;
+    contractName: string;
+    version: string;
+    deployments: AtLeastOne<Record<AddressType, {
+        address: string;
+        codeHash: string;
+    }>>;
+    networkAddresses: Record<string, AddressType | AddressType[]>;
+    abi: any[];
+}
 export interface SingletonDeployment {
     defaultAddress: string;
+    released: boolean;
+    contractName: string;
     version: string;
-    abi: any[];
+    deployments: AtLeastOne<Record<AddressType, {
+        address: string;
+        codeHash: string;
+    }>>;
     networkAddresses: Record<string, string>;
-    contractName: string;
+    abi: any[];
+}
+export interface SingletonDeploymentV2 {
     released: boolean;
+    contractName: string;
+    version: string;
+    deployments: AtLeastOne<Record<AddressType, {
+        address: string;
+        codeHash: string;
+    }>>;
+    abi: any[];
+    networkAddresses: Record<string, string | string[]>;
 }
 export interface DeploymentFilter {
     version?: string;
     released?: boolean;
     network?: string;
 }
+export {};

package/dist/utils.d.ts

@@ -1,2 +1,12 @@
-import { DeploymentFilter, SingletonDeployment } from './types';
-export declare const findDeployment: (criteria: DeploymentFilter | undefined, deployments: SingletonDeployment[]) => SingletonDeployment | undefined;
+import { DeploymentFilter, SingletonDeployment, SingletonDeploymentJSON, DeploymentFormats, SingletonDeploymentV2 } from './types';
+/**
+ * Finds a deployment that matches the given criteria.
+ * This function is implemented as a regular function to allow for overloading: https://github.com/microsoft/TypeScript/issues/33482
+ *
+ * @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.
+ */
+declare function findDeployment(criteria: DeploymentFilter | undefined, deployments: SingletonDeploymentJSON[], format?: DeploymentFormats.SINGLETON): SingletonDeployment | undefined;
+declare function findDeployment(criteria: DeploymentFilter | undefined, deployments: SingletonDeploymentJSON[], format: DeploymentFormats.MULTIPLE): SingletonDeploymentV2 | undefined;
+export { findDeployment };

package/dist/utils.js

@@ -3,19 +3,71 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findDeployment = void 0;
+exports.findDeployment = findDeployment;
 const satisfies_1 = __importDefault(require("semver/functions/satisfies"));
 const DEFAULT_FILTER = { released: true };
-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))
+// 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];
+    // The usage of non-null assertion below is safe, because we validate that the asset files are properly formed in tests
+    const defaultAddress = deployment.deployments[defaultAddressType].address;
+    const networkAddresses = Object.fromEntries(Object.entries(deployment.networkAddresses).map(([chainId, addressTypes]) => [
+        chainId,
+        Array.isArray(addressTypes)
+            ? deployment.deployments[addressTypes[0]].address
+            : deployment.deployments[addressTypes].address,
+    ]));
+    return Object.assign(Object.assign({}, deployment), { defaultAddress, networkAddresses });
+};
+/**
+ * Maps a SingletonDeploymentJSON object to a SingletonDeploymentV2 object.
+ *
+ * This function transforms the `networkAddresses` field of the deployment JSON object.
+ * It converts each entry in `networkAddresses` to an array of addresses, using the `addresses` field
+ * to resolve each address type.
+ *
+ * @param {SingletonDeploymentJSON} deployment - The deployment JSON object to map.
+ * @returns {SingletonDeploymentV2} - The mapped deployment object in V2 format.
+ */
+const mapJsonToDeploymentsFormatV2 = (deployment) => {
+    const newJson = Object.assign({}, deployment);
+    newJson.networkAddresses = Object.fromEntries(Object.entries(deployment.networkAddresses).map(([chainId, addressTypes]) => [
+        chainId,
+        (Array.isArray(addressTypes)
+            ? // The usage of non-null assertion below is safe, because we validate that the asset files are properly formed in tests
+                addressTypes.map((addressType) => deployment.deployments[addressType].address)
+            : deployment.deployments[addressTypes].address),
+    ]));
+    return newJson;
+};
+function findDeployment(criteria = DEFAULT_FILTER, deployments, format = "singleton" /* DeploymentFormats.SINGLETON */) {
+    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;
     });
-};
-exports.findDeployment = findDeployment;
+    if (!deploymentJson)
+        return undefined;
+    if (format === "multiple" /* DeploymentFormats.MULTIPLE */) {
+        return mapJsonToDeploymentsFormatV2(deploymentJson);
+    }
+    else {
+        return mapJsonToDeploymentsFormatV1(deploymentJson);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/safe-deployments",
-  "version": "1.37.0",
+  "version": "1.37.2",
   "description": "Collection of Safe singleton deployments",
   "homepage": "https://github.com/safe-global/safe-deployments/",
   "license": "MIT",
@@ -8,17 +8,18 @@
   "typings": "dist/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "test",
-    "build"
+    "src"
   ],
   "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/ scripts/",
     "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",
+    "verify": "ts-node scripts/verify.ts",
+    "prepack": "npm run build",
     "test": "jest"
   },
   "repository": {
@@ -35,24 +36,22 @@
     "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",
+    "ethers": "^6.13.1",
     "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.3"
+    "typescript": "^5.5.2",
+    "typescript-eslint": "^7.14.1"
   },
   "dependencies": {
-    "semver": "^7.6.0"
+    "semver": "^7.6.2"
   }
 }