@safe-global/safe-deployments 1.37.1 → 1.37.2

package/src/libs.ts

@@ -1,38 +1,80 @@
-import CreateCall130 from './assets/v1.3.0/create_call.json';
-import CreateCall141 from './assets/v1.4.1/create_call.json';
-import MultiSend111 from './assets/v1.1.1/multi_send.json';
-import MultiSend130 from './assets/v1.3.0/multi_send.json';
-import MultiSend141 from './assets/v1.4.1/multi_send.json';
-import MultiSendCallOnly130 from './assets/v1.3.0/multi_send_call_only.json';
-import MultiSendCallOnly141 from './assets/v1.4.1/multi_send_call_only.json';
-import SignMessageLib130 from './assets/v1.3.0/sign_message_lib.json';
-import SignMessageLib141 from './assets/v1.4.1/sign_message_lib.json';
-import { DeploymentFilter, SingletonDeployment, SingletonDeploymentJSON } from './types';
+import {
+  _CREATE_CALL_DEPLOYMENTS,
+  _MULTI_SEND_CALL_ONLY_DEPLOYMENTS,
+  _MULTI_SEND_DEPLOYMENTS,
+  _SIGN_MESSAGE_LIB_DEPLOYMENTS,
+} from './deployments';
+import { DeploymentFilter, DeploymentFormats, SingletonDeployment, SingletonDeploymentV2 } from './types';
 import { findDeployment } from './utils';
 
-// This is a sorted array (by preference, currently we use 111 in most cases)
-const multiSendDeployments: SingletonDeploymentJSON[] = [MultiSend141, MultiSend130, MultiSend111];
-
+/**
+ * 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.
+ */
 export const getMultiSendDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
-  return findDeployment(filter, multiSendDeployments);
+  return findDeployment(filter, _MULTI_SEND_DEPLOYMENTS);
 };
 
-// This is a sorted array (by preference)
-const multiSendCallOnlyDeployments: SingletonDeploymentJSON[] = [MultiSendCallOnly141, MultiSendCallOnly130];
+/**
+ * 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.
+ */
+export const getMultiSendDeployments = (filter?: DeploymentFilter): SingletonDeploymentV2 | undefined => {
+  return findDeployment(filter, _MULTI_SEND_DEPLOYMENTS, DeploymentFormats.MULTIPLE);
+};
 
+/**
+ * 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.
+ */
 export const getMultiSendCallOnlyDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
-  return findDeployment(filter, multiSendCallOnlyDeployments);
+  return findDeployment(filter, _MULTI_SEND_CALL_ONLY_DEPLOYMENTS);
 };
 
-// This is a sorted array (by preference)
-const createCallDeployments: SingletonDeploymentJSON[] = [CreateCall141, CreateCall130];
+/**
+ * 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.
+ */
+export const getMultiSendCallOnlyDeployments = (filter?: DeploymentFilter): SingletonDeploymentV2 | undefined => {
+  return findDeployment(filter, _MULTI_SEND_CALL_ONLY_DEPLOYMENTS, DeploymentFormats.MULTIPLE);
+};
 
+/**
+ * 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.
+ */
 export const getCreateCallDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
-  return findDeployment(filter, createCallDeployments);
+  return findDeployment(filter, _CREATE_CALL_DEPLOYMENTS);
 };
 
-const signMessageLibDeployments: SingletonDeploymentJSON[] = [SignMessageLib141, SignMessageLib130];
+/**
+ * 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.
+ */
+export const getCreateCallDeployments = (filter?: DeploymentFilter): SingletonDeploymentV2 | undefined => {
+  return findDeployment(filter, _CREATE_CALL_DEPLOYMENTS, DeploymentFormats.MULTIPLE);
+};
 
+/**
+ * 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.
+ */
 export const getSignMessageLibDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
-  return findDeployment(filter, signMessageLibDeployments);
+  return findDeployment(filter, _SIGN_MESSAGE_LIB_DEPLOYMENTS);
+};
+
+/**
+ * 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.
+ */
+export const getSignMessageLibDeployments = (filter?: DeploymentFilter): SingletonDeploymentV2 | undefined => {
+  return findDeployment(filter, _SIGN_MESSAGE_LIB_DEPLOYMENTS, DeploymentFormats.MULTIPLE);
 };

package/src/safes.ts

@@ -1,29 +1,39 @@
-import SafeL2141 from './assets/v1.4.1/safe_l2.json';
-import Safe141 from './assets/v1.4.1/safe.json';
-import GnosisSafeL2130 from './assets/v1.3.0/gnosis_safe_l2.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 { DeploymentFilter, SingletonDeployment, SingletonDeploymentJSON } from './types';
+import { _SAFE_DEPLOYMENTS, _SAFE_L2_DEPLOYMENTS } from './deployments';
+import { DeploymentFilter, DeploymentFormats, SingletonDeployment, SingletonDeploymentV2 } from './types';
 import { findDeployment } from './utils';
 
-// This is a sorted array (newest to oldest), exported for tests
-export const _safeDeployments: SingletonDeploymentJSON[] = [
-  Safe141,
-  GnosisSafe130,
-  GnosisSafe120,
-  GnosisSafe111,
-  GnosisSafe100,
-];
-
+/**
+ * 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 const getSafeSingletonDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
-  return findDeployment(filter, _safeDeployments);
+  return findDeployment(filter, _SAFE_DEPLOYMENTS);
 };
 
-// This is a sorted array (newest to oldest), exported for tests
-export const _safeL2Deployments: SingletonDeploymentJSON[] = [SafeL2141, GnosisSafeL2130];
+/**
+ * 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 const getSafeSingletonDeployments = (filter?: DeploymentFilter): SingletonDeploymentV2 | undefined => {
+  return findDeployment(filter, _SAFE_DEPLOYMENTS, DeploymentFormats.MULTIPLE);
+};
 
+/**
+ * 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 const getSafeL2SingletonDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
-  return findDeployment(filter, _safeL2Deployments);
+  return findDeployment(filter, _SAFE_L2_DEPLOYMENTS);
+};
+
+/**
+ * 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 const getSafeL2SingletonDeployments = (filter?: DeploymentFilter): SingletonDeploymentV2 | undefined => {
+  return findDeployment(filter, _SAFE_L2_DEPLOYMENTS, DeploymentFormats.MULTIPLE);
 };

package/src/types.ts

@@ -1,16 +1,15 @@
-enum AddressType {
-  // The original address the contract was deployed on.
-  // Starting with 1.4.1, the contracts are deployed with an EIP155-compatible transaction.
-  CANONICAL = 'canonical',
+export type AddressType = 'canonical' | 'eip155' | 'zksync';
 
-  // An address that was deployed with a transaction compatible with the EIP155 standard.
-  // The type is only used for 1.3.0 deployments.
-  EIP155 = 'eip155',
+export const enum DeploymentFormats {
+  // The old format that only allows a single address for each network.
+  SINGLETON = 'singleton',
 
-  // An address that is deployed to the ZkSync VM networks.
-  ZKSYNC = 'zksync',
+  // The new format that allows multiple addresses for each network.
+  MULTIPLE = 'multiple',
 }
 
+type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> & U[keyof U];
+
 export interface SingletonDeploymentJSON {
   // Indicates if the deployment is released.
   released: boolean;
@@ -21,20 +20,19 @@ export interface SingletonDeploymentJSON {
   // The version of the deployment.
   version: string;
 
-  // The hash of the contract code.
-  codeHash: string;
-
-  // A record of network addresses, where the key is the network identifier and the value is either a single address type or an array of address types.
-  networkAddresses: Record<string, string | string[]>;
-
-  // A record of addresses, where the key is the address type and the value is the address.
+  // 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
-  addresses: Record<string, string>;
+  // Ex: deployments: { "canonical": { "codeHash": "0x1234", "address": "0x5678"}}
+  deployments: AtLeastOne<Record<AddressType, { address: string; codeHash: string }>>;
+
+  // A record of network addresses, where the key is the network identifier and the value is either a single address type or an array of address types.
+  networkAddresses: Record<string, AddressType | AddressType[]>;
 
   // The ABI (Application Binary Interface) of the contract.
   /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
@@ -56,11 +54,16 @@ export 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: AtLeastOne<Record<AddressType, { 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>;
@@ -74,11 +77,10 @@ export interface SingletonDeploymentV2 {
   released: boolean;
   contractName: string;
   version: string;
-  codeHash: string;
+  deployments: AtLeastOne<Record<AddressType, { address: string; codeHash: string }>>;
   /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
   abi: any[];
-  networkAddresses: Record<string, AddressType | AddressType[]>;
-  addresses: Partial<Record<AddressType, string>>;
+  networkAddresses: Record<string, string | string[]>;
 }
 
 export interface DeploymentFilter {

package/src/utils.ts

@@ -1,4 +1,11 @@
-import { DeploymentFilter, SingletonDeployment, SingletonDeploymentJSON } from './types';
+import {
+  DeploymentFilter,
+  SingletonDeployment,
+  SingletonDeploymentJSON,
+  DeploymentFormats,
+  SingletonDeploymentV2,
+  AddressType,
+} from './types';
 import semverSatisfies from 'semver/functions/satisfies';
 
 const DEFAULT_FILTER: DeploymentFilter = { released: true };
@@ -18,28 +25,68 @@ const mapJsonToDeploymentsFormatV1 = (deployment: SingletonDeploymentJSON): Sing
   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];
+  // 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.addresses[addressTypes[0]] : deployment.addresses[addressTypes],
+      Array.isArray(addressTypes)
+        ? deployment.deployments[addressTypes[0]]!.address
+        : deployment.deployments[addressTypes]!.address,
     ]),
   );
 
   return { ...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: SingletonDeploymentJSON): SingletonDeploymentV2 => {
+  const newJson = { ...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) as AddressType[])
+        : deployment.deployments[addressTypes]!.address) as AddressType,
+    ]),
+  );
+
+  return newJson;
+};
+
 /**
  * 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.
  */
-export const findDeployment = (
-  criteria: DeploymentFilter = DEFAULT_FILTER,
+function findDeployment(
+  criteria: DeploymentFilter | undefined,
+  deployments: SingletonDeploymentJSON[],
+  format?: DeploymentFormats.SINGLETON,
+): SingletonDeployment | undefined;
+function findDeployment(
+  criteria: DeploymentFilter | undefined,
   deployments: SingletonDeploymentJSON[],
-): SingletonDeployment | undefined => {
+  format: DeploymentFormats.MULTIPLE,
+): SingletonDeploymentV2 | undefined;
+function findDeployment(
+  criteria = DEFAULT_FILTER,
+  deployments: SingletonDeploymentJSON[],
+  format: DeploymentFormats = DeploymentFormats.SINGLETON,
+): SingletonDeployment | SingletonDeploymentV2 | undefined {
   const { version, released, network } = { ...DEFAULT_FILTER, ...criteria };
 
   const deploymentJson = deployments.find((deployment) => {
@@ -50,5 +97,13 @@ export const findDeployment = (
     return true;
   });
 
-  return deploymentJson ? mapJsonToDeploymentsFormatV1(deploymentJson) : undefined;
-};
+  if (!deploymentJson) return undefined;
+
+  if (format === DeploymentFormats.MULTIPLE) {
+    return mapJsonToDeploymentsFormatV2(deploymentJson);
+  } else {
+    return mapJsonToDeploymentsFormatV1(deploymentJson);
+  }
+}
+
+export { findDeployment };