11019069660

Committed 24 Sep 2024 05:40PM UTC coverage: 90.703% (-0.06%) from 90.765%

Build # 11019069660

Build Type

Pull #1955

github

Committed by

iamacook

Commit Message

Move type and add param types

Pull Request Pull Request #1955: Compare all deployment type addresses when relaying

Run Details

2509 of 3148 branches covered (79.7%)

Branch coverage included in aggregate %.

30 of 31 new or added lines in 2 files covered. (96.77%)

3 existing lines in 1 file now uncovered.

8340 of 8813 relevant lines covered (94.63%)

445.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.46

/src/domain/common/utils/deployments.ts

// eslint-disable-next-line no-restricted-imports
import {
  getMultiSendCallOnlyDeployments as _getMultiSendCallOnlyDeployments,
  getMultiSendDeployments as _getMultiSendDeployments,
  getProxyFactoryDeployments as _getProxyFactoryDeployments,
  getSafeL2SingletonDeployments as _getSafeL2SingletonDeployments,
  getSafeSingletonDeployments as _getSafeSingletonDeployments,
} from '@safe-global/safe-deployments';

type Filter = {
  chainId: string;
  version: string;
};

/**
 * Returns a list of official ProxyFactory addresses based on given {@link Filter}.
 *
 * @param {string} args.chainId - the chain ID to filter deployments by
 * @param {string} args.version - the version to filter deployments by
 *
 * @returns {Array<`0x${string}`>} - a list of checksummed ProxyFactory addresses
 */
export function getProxyFactoryDeployments(args: Filter): Array<`0x${string}`> {
  return formatDeployments(_getProxyFactoryDeployments, args);
}

/**
 * Returns a list of official L1 singleton addresses based on given {@link Filter}.
 *
 * @param {string} args.chainId - the chain ID to filter deployments by
 * @param {string} args.version - the version to filter deployments by
 *
 * @returns {Array<`0x${string}`>} - a list of checksummed L1 singleton addresses
 */
export function getSafeSingletonDeployments(
  args: Filter,
): Array<`0x${string}`> {
  return formatDeployments(_getSafeSingletonDeployments, args);
}

/**
 * Returns a list of official L2 singleton addresses based on given {@link Filter}.
 *
 * @param {string} args.chainId - the chain ID to filter deployments by
 * @param {string} args.version - the version to filter deployments by
 *
 * @returns {Array<`0x${string}`>} - a list of checksummed L2 singleton addresses
 */
export function getSafeL2SingletonDeployments(
  args: Filter,
): Array<`0x${string}`> {
  return formatDeployments(_getSafeL2SingletonDeployments, args);
}

/**
 * Returns a list of official MultiSendCallOnly addresses based on given {@link Filter}.
 *
 * @param {string} args.chainId - the chain ID to filter deployments by
 * @param {string} args.version - the version to filter deployments by
 *
 * @returns {Array<`0x${string}`>} - a list of checksummed MultiSendCallOnly addresses
 */
export function getMultiSendCallOnlyDeployments(
  args: Filter,
): Array<`0x${string}`> {
  return formatDeployments(_getMultiSendCallOnlyDeployments, args);
}

/**
 * Returns a list of official MultiSend addresses based on given {@link Filter}.
 *
 * @param {string} args.chainId - the chain ID to filter deployments by
 * @param {string} args.version - the version to filter deployments by
 *
 * @returns {Array<`0x${string}`>} - a list of checksummed MultiSend addresses
 */
export function getMultiSendDeployments(args: Filter): Array<`0x${string}`> {
  return formatDeployments(_getMultiSendDeployments, args);
}

/**
 * Helper to remap {@link SingletonDeploymentV2} to a list of checksummed addresses.
 *
 * @param {Function} getDeployments - function to get deployments
 * @param {Filter} filter - filter to apply to deployments
 *
 * @returns {Array<`0x${string}`>} - a list of checksummed addresses
 */
function formatDeployments(
  getDeployments:
    | typeof _getProxyFactoryDeployments
    | typeof _getSafeSingletonDeployments
    | typeof _getSafeL2SingletonDeployments
    | typeof _getMultiSendCallOnlyDeployments
    | typeof _getMultiSendDeployments,
  filter: Filter,
): Array<`0x${string}`> {
  const deployments = getDeployments({
    network: filter.chainId,
    version: filter.version,
  });

  if (!deployments) {
    return [];
  }

  const chainDeployments = deployments.networkAddresses[filter.chainId];
  if (!chainDeployments) {
    return [];
  }

  // Note: can cast as deployment are inherently checksummed
  if (!Array.isArray(chainDeployments)) {
    return [chainDeployments as `0x${string}`];
  }

  return chainDeployments as Array<`0x${string}`>;
}

1	// eslint-disable-next-line no-restricted-imports
2	import {	98✔
3	getMultiSendCallOnlyDeployments as _getMultiSendCallOnlyDeployments,
4	getMultiSendDeployments as _getMultiSendDeployments,
5	getProxyFactoryDeployments as _getProxyFactoryDeployments,
6	getSafeL2SingletonDeployments as _getSafeL2SingletonDeployments,
7	getSafeSingletonDeployments as _getSafeSingletonDeployments,
8	} from '@safe-global/safe-deployments';
9
10	type Filter = {
11	chainId: string;
12	version: string;
13	};
14
15	/**
16	* Returns a list of official ProxyFactory addresses based on given {@link Filter}.
17	*
18	* @param {string} args.chainId - the chain ID to filter deployments by
19	* @param {string} args.version - the version to filter deployments by
20	*
21	* @returns {Array<`0x${string}`>} - a list of checksummed ProxyFactory addresses
22	*/
23	export function getProxyFactoryDeployments(args: Filter): Array<`0x${string}`> {	98✔
24	return formatDeployments(_getProxyFactoryDeployments, args);	216✔
25	}
26
27	/**
28	* Returns a list of official L1 singleton addresses based on given {@link Filter}.
29	*
30	* @param {string} args.chainId - the chain ID to filter deployments by
31	* @param {string} args.version - the version to filter deployments by
32	*
33	* @returns {Array<`0x${string}`>} - a list of checksummed L1 singleton addresses
34	*/
35	export function getSafeSingletonDeployments(	98✔
36	args: Filter,
37	): Array<`0x${string}`> {
38	return formatDeployments(_getSafeSingletonDeployments, args);	256✔
39	}
40
41	/**
42	* Returns a list of official L2 singleton addresses based on given {@link Filter}.
43	*
44	* @param {string} args.chainId - the chain ID to filter deployments by
45	* @param {string} args.version - the version to filter deployments by
46	*
47	* @returns {Array<`0x${string}`>} - a list of checksummed L2 singleton addresses
48	*/
49	export function getSafeL2SingletonDeployments(	98✔
50	args: Filter,
51	): Array<`0x${string}`> {
52	return formatDeployments(_getSafeL2SingletonDeployments, args);	224✔
53	}
54
55	/**
56	* Returns a list of official MultiSendCallOnly addresses based on given {@link Filter}.
57	*
58	* @param {string} args.chainId - the chain ID to filter deployments by
59	* @param {string} args.version - the version to filter deployments by
60	*
61	* @returns {Array<`0x${string}`>} - a list of checksummed MultiSendCallOnly addresses
62	*/
63	export function getMultiSendCallOnlyDeployments(	98✔
64	args: Filter,
65	): Array<`0x${string}`> {
66	return formatDeployments(_getMultiSendCallOnlyDeployments, args);	280✔
67	}
68
69	/**
70	* Returns a list of official MultiSend addresses based on given {@link Filter}.
71	*
72	* @param {string} args.chainId - the chain ID to filter deployments by
73	* @param {string} args.version - the version to filter deployments by
74	*
75	* @returns {Array<`0x${string}`>} - a list of checksummed MultiSend addresses
76	*/
77	export function getMultiSendDeployments(args: Filter): Array<`0x${string}`> {	98✔
78	return formatDeployments(_getMultiSendDeployments, args);	92✔
79	}
80
81	/**
82	* Helper to remap {@link SingletonDeploymentV2} to a list of checksummed addresses.
83	*
84	* @param {Function} getDeployments - function to get deployments
85	* @param {Filter} filter - filter to apply to deployments
86	*
87	* @returns {Array<`0x${string}`>} - a list of checksummed addresses
88	*/
89	function formatDeployments(
90	getDeployments:
91	\| typeof _getProxyFactoryDeployments
92	\| typeof _getSafeSingletonDeployments
93	\| typeof _getSafeL2SingletonDeployments
94	\| typeof _getMultiSendCallOnlyDeployments
95	\| typeof _getMultiSendDeployments,
96	filter: Filter,
97	): Array<`0x${string}`> {
98	const deployments = getDeployments({	1,068✔
99	network: filter.chainId,
100	version: filter.version,
101	});
102
103	if (!deployments) {	1,068✔
104	return [];	80✔
105	}
106
107	const chainDeployments = deployments.networkAddresses[filter.chainId];	988✔
108	if (!chainDeployments) {	988!
NEW 109	return [];	×
110	}
111
112	// Note: can cast as deployment are inherently checksummed
113	if (!Array.isArray(chainDeployments)) {	988✔
114	return [chainDeployments as `0x${string}`];	692✔
115	}
116
117	return chainDeployments as Array<`0x${string}`>;	296✔
118	}

safe-global / safe-client-gateway / 11019069660

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous