@safe-global/safe-deployments 1.37.1 → 1.37.3

package/README.md

@@ -9,7 +9,7 @@ The addresses on the different networks and the abi files are available for each
 
 ## Adding additional deployments:
 
-1. Follow the [deployment steps in the Safe contract repository](https://github.com/safe-global/safe-smart-contracts#deployments).
+1. Follow the [deployment steps in the Safe contract repository](https://github.com/safe-global/safe-smart-account/#deployments).
 2. Verify that the addresses match the expected address for each contract. You can find them under the "addresses" mapping in the respective JSON file in the [assets folder](./src/assets/).
 3. Create a PR adding the new deployment. Example PR can be found [here](https://github.com/safe-global/safe-deployments/pull/676).
 
@@ -20,7 +20,7 @@ The addresses on the different networks and the abi files are available for each
 
 ## Usage
 
-It is possible to directly use the JSON files in the [assets folder](./src/assets/) that contain the addresses and abi definitions.
+It is possible to directly use the JSON files in the [assets folder](./src/assets/) that contain the addresses and ABI definitions.
 
 An alternative is using JavaScript library methods to query the correct deployment. The library supports different methods to get the deployment of a specific contract.
 
@@ -34,10 +34,12 @@ interface DeploymentFilter {
 }
 ```
 
-The method will return a `SingletonDeployment` object or `undefined` if no deployment was found for the specified filter.
+### V1 Methods (single deployments)
+
+Those methods will return a `SingletonDeployment` object or `undefined` if no deployment was found for the specified filter.
 
 ```ts
-interface SingletonDeployment {
+export interface SingletonDeployment {
   // The default address of the deployment.
   defaultAddress: string;
 
@@ -50,11 +52,16 @@ interface SingletonDeployment {
   // The version of the deployment.
   version: string;
 
-  // The hash of the contract code.
-  codeHash: string;
-
-  // A record of addresses, where the key is the address type and the value is the address.
-  addresses: Record<string, string>;
+  // The address & hash of the contract code, where the key is the deployment type.
+  // There could be multiple deployment types: canonical, eip155, zksync
+  // Possible addresses per version:
+  // 1.0.0: canonical
+  // 1.1.1: canonical
+  // 1.2.0: canonical
+  // 1.3.0: canonical, eip155, zksync
+  // 1.4.1: canonical, zksync
+  // Ex: deployments: { "canonical": { "codeHash": "0x1234", "address": "0x5678"}}
+  deployments: Record<string, { address: string; codeHash: string }>;
 
   // A record of network addresses, where the key is the network identifier and the value is the address.
   networkAddresses: Record<string, string>;
@@ -96,19 +103,103 @@ const multiSendLib = getMultiSendDeployment();
 const multiSendCallOnlyLib = getMultiSendCallOnlyDeployment();
 
 const createCallLib = getCreateCallDeployment();
+
+const signMessageLib = getSignMessageLibDeployment();
 ```
 
 - Handler
 
 ```ts
-// Returns recommended handler
-const fallbackHandler = getFallbackHandlerDeployment();
 
 const callbackHandler = getDefaultCallbackHandlerDeployment();
 
 const compatHandler = getCompatibilityFallbackHandlerDeployment();
 ```
 
+### V2 Methods (multiple deployments)
+
+We added a new methods that allow multiple deployment addresses for a contract.
+
+Those methods will return a `SingletonDeployment` object or `undefined` if no deployment was found for the specified filter. Notice the difference in the `networkAddresses` field.
+
+```ts
+export interface SingletonDeployment {
+  // The default address of the deployment.
+  defaultAddress: string;
+
+  // Indicates if the deployment is released.
+  released: boolean;
+
+  // The name of the contract.
+  contractName: string;
+
+  // The version of the deployment.
+  version: string;
+
+  // The address & hash of the contract code, where the key is the deployment type.
+  // There could be multiple deployment types: canonical, eip155, zksync
+  // Possible addresses per version:
+  // 1.0.0: canonical
+  // 1.1.1: canonical
+  // 1.2.0: canonical
+  // 1.3.0: canonical, eip155, zksync
+  // 1.4.1: canonical, zksync
+  // Ex: deployments: { "canonical": { "codeHash": "0x1234", "address": "0x5678"}}
+  deployments: Record<string, { address: string; codeHash: string }>;
+
+  // A record of network addresses, where the key is the network identifier and the value is the address.
+  networkAddresses: Record<string, string | string[]>;
+
+  // The ABI (Application Binary Interface) of the contract.
+  abi: any[];
+}
+```
+
+- Safe
+
+```ts
+const safeSingleton = getSafeSingletonDeployments();
+
+// Returns latest contract version, even if not finally released yet
+const safeSingletonNightly = getSafeSingletonDeployments({ released: undefined });
+
+// Returns released contract version for specific network
+const safeSingletonGörli = getSafeSingletonDeployments({ network: '5' });
+
+// Returns released contract version for specific version
+const safeSingleton100 = getSafeSingletonDeployments({ version: '1.0.0' });
+
+// Version with additional events used on L2 networks
+const safeL2Singleton = getSafeL2SingletonDeployments();
+```
+
+- Factories
+
+```ts
+const proxyFactory = getProxyFactoryDeployments();
+```
+
+- Libraries
+
+```ts
+const multiSendLib = getMultiSendDeployments();
+
+const multiSendCallOnlyLib = getMultiSendCallOnlyDeployments();
+
+const createCallLib = getCreateCallDeployments();
+
+const signMessageLib = getSignMessageLibDeployments();
+```
+
+- Handler
+
+```ts
+
+const callbackHandler = getDefaultCallbackHandlerDeployments();
+
+const compatHandler = getCompatibilityFallbackHandlerDeployments();
+```
+
 ## Release cycle
 
 `safe-deployments` release cycle is once per month, except for urgent issues that require immediate attention.

package/dist/accessors.d.ts

@@ -1,2 +1,15 @@
-import { DeploymentFilter, SingletonDeployment } from './types';
+import { DeploymentFilter, SingletonDeployment, SingletonDeploymentV2 } from './types';
+/**
+ * Retrieves a single simulate transaction accessor deployment based on the provided filter.
+ *
+ * @param {DeploymentFilter} [filter] - Optional 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 getSimulateTxAccessorDeployment: (filter?: DeploymentFilter) => SingletonDeployment | undefined;
+/**
+ * Retrieves multiple simulate transaction accessor deployments based on the provided filter.
+ *
+ * @param {DeploymentFilter} [filter] - Optional filter to apply when searching for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The found deployments in the specified format or undefined if no deployments match the filter.
+ */
+export declare const getSimulateTxAccessorDeployments: (filter?: DeploymentFilter) => SingletonDeploymentV2 | undefined;

package/dist/accessors.js

@@ -1,15 +1,25 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSimulateTxAccessorDeployment = void 0;
-const simulate_tx_accessor_json_1 = __importDefault(require("./assets/v1.3.0/simulate_tx_accessor.json"));
-const simulate_tx_accessor_json_2 = __importDefault(require("./assets/v1.4.1/simulate_tx_accessor.json"));
+exports.getSimulateTxAccessorDeployments = exports.getSimulateTxAccessorDeployment = void 0;
 const utils_1 = require("./utils");
-// This is a sorted array (newest to oldest)
-const accessorDeployments = [simulate_tx_accessor_json_2.default, simulate_tx_accessor_json_1.default];
+const deployments_1 = require("./deployments");
+/**
+ * Retrieves a single simulate transaction accessor deployment based on the provided filter.
+ *
+ * @param {DeploymentFilter} [filter] - Optional filter to apply when searching for the deployment.
+ * @returns {SingletonDeployment | undefined} - The found deployment or undefined if no deployment matches the filter.
+ */
 const getSimulateTxAccessorDeployment = (filter) => {
-    return (0, utils_1.findDeployment)(filter, accessorDeployments);
+    return (0, utils_1.findDeployment)(filter, deployments_1._ACCESSOR_DEPLOYMENTS);
 };
 exports.getSimulateTxAccessorDeployment = getSimulateTxAccessorDeployment;
+/**
+ * Retrieves multiple simulate transaction accessor deployments based on the provided filter.
+ *
+ * @param {DeploymentFilter} [filter] - Optional filter to apply when searching for the deployments.
+ * @returns {SingletonDeploymentV2 | undefined} - The found deployments in the specified format or undefined if no deployments match the filter.
+ */
+const getSimulateTxAccessorDeployments = (filter) => {
+    return (0, utils_1.findDeployment)(filter, deployments_1._ACCESSOR_DEPLOYMENTS, "multiple" /* DeploymentFormats.MULTIPLE */);
+};
+exports.getSimulateTxAccessorDeployments = getSimulateTxAccessorDeployments;

package/dist/assets/v1.0.0/gnosis_safe.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "GnosisSafe",
     "version": "1.0.0",
-    "codeHash": "0xe1f1593df76e69abc2d692792c80f329457551d5e83dde597546a1d58764da80",
-    "addresses": {
-        "canonical": "0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A"
+    "deployments": {
+        "canonical": {
+            "address": "0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A",
+            "codeHash": "0xe1f1593df76e69abc2d692792c80f329457551d5e83dde597546a1d58764da80"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.0.0/proxy_factory.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "ProxyFactory",
     "version": "1.0.0",
-    "codeHash": "0x84a375ad96ab395850d46cd601ed6354d3cf3fb67cec0caf18f34af5c9d1a7f0",
-    "addresses": {
-        "canonical": "0x12302fE9c02ff50939BaAaaf415fc226C078613C"
+    "deployments": {
+        "canonical": {
+            "address": "0x12302fE9c02ff50939BaAaaf415fc226C078613C",
+            "codeHash": "0x84a375ad96ab395850d46cd601ed6354d3cf3fb67cec0caf18f34af5c9d1a7f0"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.1.1/default_callback_handler.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "DefaultCallbackHandler",
     "version": "1.1.1",
-    "codeHash": "0x919a9f5dd111a01f7a8e4b1f5c6a972bb2d1441c67bdec71de6a09d0be92f5b9",
-    "addresses": {
-        "canonical": "0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44"
+    "deployments": {
+        "canonical": {
+            "address": "0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44",
+            "codeHash": "0x919a9f5dd111a01f7a8e4b1f5c6a972bb2d1441c67bdec71de6a09d0be92f5b9"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.1.1/gnosis_safe.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "GnosisSafe",
     "version": "1.1.1",
-    "codeHash": "0x56b8be58b5ad629a621593a2e5e5e8e9a28408dc06e95597497b303902772e45",
-    "addresses": {
-        "canonical": "0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F"
+    "deployments": {
+        "canonical": {
+            "address": "0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F",
+            "codeHash": "0x56b8be58b5ad629a621593a2e5e5e8e9a28408dc06e95597497b303902772e45"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.1.1/multi_send.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "MultiSend",
     "version": "1.1.1",
-    "codeHash": "0xe4e9b4d4c1e3ff06cd51afe0b51eb1b22c0bab51eab38d428ee74540a5ff603e",
-    "addresses": {
-        "canonical": "0x8D29bE29923b68abfDD21e541b9374737B49cdAD"
+    "deployments": {
+        "canonical": {
+            "address": "0x8D29bE29923b68abfDD21e541b9374737B49cdAD",
+            "codeHash": "0xe4e9b4d4c1e3ff06cd51afe0b51eb1b22c0bab51eab38d428ee74540a5ff603e"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.1.1/proxy_factory.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "ProxyFactory",
     "version": "1.1.1",
-    "codeHash": "0x0f0bb9c13be3b595d6f0fde841d5247a96f7e315bd8b97e1363553bee9a7d995",
-    "addresses": {
-        "canonical": "0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B"
+    "deployments": {
+        "canonical": {
+            "address": "0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B",
+            "codeHash": "0x0f0bb9c13be3b595d6f0fde841d5247a96f7e315bd8b97e1363553bee9a7d995"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.2.0/gnosis_safe.json

@@ -2,9 +2,11 @@
     "released": true,
     "contractName": "GnosisSafe",
     "version": "1.2.0",
-    "codeHash": "0x2ae2d1231f0d754a7fa4f5e5d0e5554085e1b500d8e09f95aaaaa3f49c0db922",
-    "addresses": {
-        "canonical": "0x6851D6fDFAfD08c0295C392436245E5bc78B0185"
+    "deployments": {
+        "canonical": {
+            "address": "0x6851D6fDFAfD08c0295C392436245E5bc78B0185",
+            "codeHash": "0x2ae2d1231f0d754a7fa4f5e5d0e5554085e1b500d8e09f95aaaaa3f49c0db922"
+        }
     },
     "networkAddresses": {
         "1": "canonical",

package/dist/assets/v1.3.0/compatibility_fallback_handler.json

@@ -2,11 +2,19 @@
     "released": true,
     "contractName": "CompatibilityFallbackHandler",
     "version": "1.3.0",
-    "codeHash": "0x03e69f7ce809e81687c69b19a7d7cca45b6d551ffdec73d9bb87178476de1abf",
-    "addresses": {
-        "canonical": "0xf48f2B2d2a534e402487b3ee7C18c33Aec0Fe5e4",
-        "eip155": "0x017062a1dE2FE6b99BE3d9d37841FeD19F573804",
-        "zksync": "0x2f870a80647BbC554F3a0EBD093f11B4d2a7492A"
+    "deployments": {
+        "canonical": {
+            "address": "0xf48f2B2d2a534e402487b3ee7C18c33Aec0Fe5e4",
+            "codeHash": "0x03e69f7ce809e81687c69b19a7d7cca45b6d551ffdec73d9bb87178476de1abf"
+        },
+        "eip155": {
+            "address": "0x017062a1dE2FE6b99BE3d9d37841FeD19F573804",
+            "codeHash": "0x03e69f7ce809e81687c69b19a7d7cca45b6d551ffdec73d9bb87178476de1abf"
+        },
+        "zksync": {
+            "address": "0x2f870a80647BbC554F3a0EBD093f11B4d2a7492A",
+            "codeHash": "0x017e9a83d5513f503fb85274f4d1ad1811040d7caa31772750ffb08638c28fbb"
+        }
     },
     "networkAddresses": {
         "1": ["canonical", "eip155"],
@@ -51,6 +59,7 @@
         "148": "eip155",
         "155": "eip155",
         "169": "canonical",
+        "179": "eip155",
         "195": "eip155",
         "196": ["eip155", "canonical"],
         "204": ["eip155", "canonical"],
@@ -70,6 +79,7 @@
         "369": "canonical",
         "420": "eip155",
         "424": "canonical",
+        "480": "canonical",
         "570": "eip155",
         "588": "eip155",
         "592": "canonical",
@@ -119,6 +129,7 @@
         "2331": "canonical",
         "2358": "eip155",
         "2810": "eip155",
+        "3338": "canonical",
         "3737": "canonical",
         "3776": "canonical",
         "4002": "canonical",
@@ -175,6 +186,7 @@
         "17172": "eip155",
         "18231": "canonical",
         "18233": "canonical",
+        "22776": "canonical",
         "23294": "eip155",
         "23295": "eip155",
         "28979": "canonical",
@@ -182,11 +194,13 @@
         "42161": "canonical",
         "42170": "canonical",
         "42220": ["eip155", "canonical"],
+        "42793": "eip155",
         "43113": ["canonical", "eip155"],
         "43114": ["eip155", "canonical"],
         "43288": "eip155",
         "44787": "canonical",
         "45000": "canonical",
+        "47763": "canonical",
         "47805": "canonical",
         "48899": "eip155",
         "53457": "canonical",
@@ -201,6 +215,7 @@
         "73799": "canonical",
         "80001": "canonical",
         "80002": "canonical",
+        "80084": "canonical",
         "80085": ["canonical", "eip155"],
         "81457": "canonical",
         "83291": "canonical",
@@ -208,6 +223,7 @@
         "84532": ["eip155", "canonical"],
         "103454": "eip155",
         "111188": "canonical",
+        "128123": ["eip155", "canonical"],
         "167000": ["eip155", "canonical"],
         "167008": "canonical",
         "167009": ["eip155", "canonical"],
@@ -218,20 +234,24 @@
         "421611": "canonical",
         "421613": "canonical",
         "421614": "canonical",
+        "490000": ["canonical", "eip155"],
         "534351": ["canonical", "eip155"],
         "534352": "canonical",
         "534353": "eip155",
         "555666": "canonical",
         "622277": "canonical",
         "656476": ["eip155", "canonical"],
+        "660279": "canonical",
         "713715": ["eip155", "canonical"],
         "764984": "canonical",
         "810180": "zksync",
+        "978657": "canonical",
         "6038361": ["eip155", "canonical"],
         "7225878": "eip155",
         "7777777": ["canonical", "eip155"],
         "11155111": ["eip155", "canonical"],
         "11155420": "eip155",
+        "12227332": "canonical",
         "94204209": ["canonical", "eip155"],
         "111557560": ["canonical", "eip155"],
         "123420111": ["canonical", "eip155"],
@@ -249,6 +269,7 @@
         "1666700000": "eip155",
         "11297108099": "canonical",
         "11297108109": "canonical",
+        "37714555429": "canonical",
         "88153591557": ["canonical", "eip155"]
     },
     "abi": [

package/dist/assets/v1.3.0/create_call.json

@@ -2,11 +2,19 @@
     "released": true,
     "contractName": "CreateCall",
     "version": "1.3.0",
-    "codeHash": "0x8155d988823a4f6f1bcbc76a64af8e510c4ce68819290d43cf24956bd24dee82",
-    "addresses": {
-        "canonical": "0x7cbB62EaA69F79e6873cD1ecB2392971036cFAa4",
-        "eip155": "0xB19D6FFc2182150F8Eb585b79D4ABcd7C5640A9d",
-        "zksync": "0xcB8e5E438c5c2b45FbE17B02Ca9aF91509a8ad56"
+    "deployments": {
+        "canonical": {
+            "address": "0x7cbB62EaA69F79e6873cD1ecB2392971036cFAa4",
+            "codeHash": "0x8155d988823a4f6f1bcbc76a64af8e510c4ce68819290d43cf24956bd24dee82"
+        },
+        "eip155": {
+            "address": "0xB19D6FFc2182150F8Eb585b79D4ABcd7C5640A9d",
+            "codeHash": "0x8155d988823a4f6f1bcbc76a64af8e510c4ce68819290d43cf24956bd24dee82"
+        },
+        "zksync": {
+            "address": "0xcB8e5E438c5c2b45FbE17B02Ca9aF91509a8ad56",
+            "codeHash": "0x98095337deb9718f4e5ccb1b25a53be5f5e0093502b29df9e857f5e3e12aa194"
+        }
     },
     "networkAddresses": {
         "1": ["canonical", "eip155"],
@@ -51,6 +59,7 @@
         "148": "eip155",
         "155": "eip155",
         "169": "canonical",
+        "179": "eip155",
         "195": "eip155",
         "196": ["eip155", "canonical"],
         "204": ["eip155", "canonical"],
@@ -70,6 +79,7 @@
         "369": "canonical",
         "420": "eip155",
         "424": "canonical",
+        "480": "canonical",
         "570": "eip155",
         "588": "eip155",
         "592": "canonical",
@@ -119,6 +129,7 @@
         "2331": "canonical",
         "2358": "eip155",
         "2810": "eip155",
+        "3338": "canonical",
         "3737": "canonical",
         "3776": "canonical",
         "4002": "canonical",
@@ -175,6 +186,7 @@
         "17172": "eip155",
         "18231": "canonical",
         "18233": "canonical",
+        "22776": "canonical",
         "23294": "eip155",
         "23295": "eip155",
         "28979": "canonical",
@@ -182,11 +194,13 @@
         "42161": "canonical",
         "42170": "canonical",
         "42220": ["eip155", "canonical"],
+        "42793": "eip155",
         "43113": ["canonical", "eip155"],
         "43114": ["eip155", "canonical"],
         "43288": "eip155",
         "44787": "canonical",
         "45000": "canonical",
+        "47763": "canonical",
         "47805": "canonical",
         "48899": "eip155",
         "53457": "canonical",
@@ -201,6 +215,7 @@
         "73799": "canonical",
         "80001": "canonical",
         "80002": "canonical",
+        "80084": "canonical",
         "80085": ["canonical", "eip155"],
         "81457": "canonical",
         "83291": "canonical",
@@ -208,6 +223,7 @@
         "84532": ["eip155", "canonical"],
         "103454": "eip155",
         "111188": "canonical",
+        "128123": ["eip155", "canonical"],
         "167000": ["eip155", "canonical"],
         "167008": "canonical",
         "167009": ["eip155", "canonical"],
@@ -218,20 +234,24 @@
         "421611": "canonical",
         "421613": "canonical",
         "421614": "canonical",
+        "490000": ["canonical", "eip155"],
         "534351": ["canonical", "eip155"],
         "534352": "canonical",
         "534353": "eip155",
         "555666": "canonical",
         "622277": "canonical",
         "656476": ["eip155", "canonical"],
+        "660279": "canonical",
         "713715": ["eip155", "canonical"],
         "764984": "canonical",
         "810180": "zksync",
+        "978657": "canonical",
         "6038361": ["eip155", "canonical"],
         "7225878": "eip155",
         "7777777": ["canonical", "eip155"],
         "11155111": ["eip155", "canonical"],
         "11155420": "eip155",
+        "12227332": "canonical",
         "94204209": ["canonical", "eip155"],
         "111557560": ["canonical", "eip155"],
         "123420111": ["canonical", "eip155"],
@@ -249,6 +269,7 @@
         "1666700000": "eip155",
         "11297108099": "canonical",
         "11297108109": "canonical",
+        "37714555429": "canonical",
         "88153591557": ["canonical", "eip155"]
     },
     "abi": [