@safe-global/safe-deployments 1.37.0 → 1.37.2

package/README.md

@@ -3,87 +3,206 @@
 [![npm version](https://badge.fury.io/js/%40safe-global%2Fsafe-deployments.svg)](https://badge.fury.io/js/%40safe-global%2Fsafe-deployments)
 [![CI](https://github.com/safe-global/safe-deployments/actions/workflows/test.yml/badge.svg)](https://github.com/safe-global/safe-deployments/actions/workflows/test.yml)
 
-This contract contains a collection of deployments of the contract of the [Safe contracts repository](https://github.com/safe-global/safe-contracts). 
+This contract contains a collection of deployments of the contract of the [Safe contracts repository](https://github.com/safe-global/safe-smart-account).
 
-For each deployment the address on the different networks and the abi files are available. To get an overview of the available versions check the available [json assets](./src/assets/).
+The addresses on the different networks and the abi files are available for each deployment. To get an overview of the available versions, check the available [json assets](./src/assets/).
 
-To add additional deployments please follow the [deployment steps in the Safe contract repository](https://github.com/safe-global/safe-contracts#deployments).
+## Adding additional deployments:
+
+1. Follow the [deployment steps in the Safe contract repository](https://github.com/safe-global/safe-smart-contracts#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).
 
 ## Install
+
 - npm - `npm i @safe-global/safe-deployments`
 - yarn - `yarn add @safe-global/safe-deployments`
 
 ## 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 to use the JavaScript library methods to query the correct deployment. The library supports different methods to get the deployment of a specific contract.
+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.
 
-Each of the method takes an optional `DeploymentFilter` as a parameter.
+Each of the methods takes an optional `DeploymentFilter` as a parameter.
 
 ```ts
 interface DeploymentFilter {
-    version?: string,
-    released?: boolean, // Defaults to true if no filter is specified
-    network?: string // Chain id of the network
+  version?: string;
+  released?: boolean; // Defaults to true if no filter is specified
+  network?: string; // Chain id of the network
 }
 ```
 
-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
+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>;
+
+  // The ABI (Application Binary Interface) of the contract.
+  abi: any[];
+}
+```
+
+- Safe
+
+```ts
+const safeSingleton = getSafeSingletonDeployment();
+
+// Returns latest contract version, even if not finally released yet
+const safeSingletonNightly = getSafeSingletonDeployment({ released: undefined });
+
+// Returns released contract version for specific network
+const safeSingletonGörli = getSafeSingletonDeployment({ network: '5' });
+
+// Returns released contract version for specific version
+const safeSingleton100 = getSafeSingletonDeployment({ version: '1.0.0' });
+
+// Version with additional events used on L2 networks
+const safeL2Singleton = getSafeL2SingletonDeployment();
+```
+
+- Factories
+
+```ts
+const proxyFactory = getProxyFactoryDeployment();
+```
+
+- Libraries
 
 ```ts
-interface SingletonDeployment {
-    defaultAddress: string, // Address the contract was deployed to by the Safe team
-    version: string,
-    abi: any[],
-    networkAddresses: Record<string, string>, // Address of the contract by network
-    contractName: string,
-    released: boolean // A released version was audited and has a running bug bounty
+const multiSendLib = getMultiSendDeployment();
+
+const multiSendCallOnlyLib = getMultiSendCallOnlyDeployment();
+
+const createCallLib = getCreateCallDeployment();
+
+const signMessageLib = getSignMessageLibDeployment();
+```
+
+- Handler
+
+```ts
+
+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 = getSafeSingletonDeployment()
+const safeSingleton = getSafeSingletonDeployments();
 
 // Returns latest contract version, even if not finally released yet
-const safeSingletonNightly = getSafeSingletonDeployment({ released: undefined })
+const safeSingletonNightly = getSafeSingletonDeployments({ released: undefined });
 
 // Returns released contract version for specific network
-const safeSingletonGörli = getSafeSingletonDeployment({ network: "5" })
+const safeSingletonGörli = getSafeSingletonDeployments({ network: '5' });
 
 // Returns released contract version for specific version
-const safeSingleton100 = getSafeSingletonDeployment({ version: "1.0.0" })
+const safeSingleton100 = getSafeSingletonDeployments({ version: '1.0.0' });
 
 // Version with additional events used on L2 networks
-const safeL2Singleton = getSafeL2SingletonDeployment()
+const safeL2Singleton = getSafeL2SingletonDeployments();
 ```
 
 - Factories
+
 ```ts
-const proxyFactory = getProxyFactoryDeployment()
+const proxyFactory = getProxyFactoryDeployments();
 ```
 
 - Libraries
+
 ```ts
-const multiSendLib = getMultiSendDeployment()
+const multiSendLib = getMultiSendDeployments();
+
+const multiSendCallOnlyLib = getMultiSendCallOnlyDeployments();
 
-const multiSendCallOnlyLib = getMultiSendCallOnlyDeployment()
+const createCallLib = getCreateCallDeployments();
 
-const createCallLib = getCreateCallDeployment()
+const signMessageLib = getSignMessageLibDeployments();
 ```
 
 - Handler
+
 ```ts
-// Returns recommended handler
-const fallbackHandler = getFallbackHandlerDeployment()
 
-const callbackHandler = getDefaultCallbackHandlerDeployment()
+const callbackHandler = getDefaultCallbackHandlerDeployments();
 
-const compatHandler = getCompatibilityFallbackHandlerDeployment()
+const compatHandler = getCompatibilityFallbackHandlerDeployments();
 ```
+
 ## Release cycle
-`safe-deployments` release cycle is once per month, except urgent issues that require immediate attention. 
+
+`safe-deployments` release cycle is once per month, except for urgent issues that require immediate attention.
 
 ## Notes
 

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,17 +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;