7932833131

Committed 16 Feb 2024 03:38PM UTC coverage: 93.676% (-0.3%) from 93.948%

Build # 7932833131

Build Type

Pull #1148

github

Committed by

iamacook

Commit Message

Merge branch 'main' into use-abiencoders

Pull Request Pull Request #1148: Replace Safe/ERC-20 `ContractHelper`s with `AbiDecoder`s

Run Details

1630 of 1950 branches covered (83.59%)

Branch coverage included in aggregate %.

21 of 22 new or added lines in 5 files covered. (95.45%)

12 existing lines in 2 files now uncovered.

6072 of 6272 relevant lines covered (96.81%)

194.23 hits per line

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

0.0

/src/domain/relay/entities/contract-function.entity.ts

import { Abi, decodeFunctionData } from 'viem';
import { Hex } from 'viem/types/misc';

/**
 * Argument mapper representation for a contract function.
 *
 * The generic parameter represents the expected type that should be returned
 * by the mapper.
 */
export type ContractFunctionArgsMapper<B> = {
  name: string;
  mapper: (args: readonly unknown[]) => B;
};

/**
 * Decodes the arguments of the {@link contractFunction} given the provided
 * {@link abi}.
 *
 * @param contractFunction - the contract function used to decode the arguments
 * @param abi - the abi of the contract use to check the function call
 * @param data - the data representing the function call
 */
export function decode<B>(
  contractFunction: ContractFunctionArgsMapper<B>,
  abi: readonly unknown[] | Abi,
  data: Hex,
): B {
  const { functionName, args } = decodeFunctionData({
    abi,
    data,
  });

  if (contractFunction.name != functionName || !args)
    throw Error(`Provided data is not a call to ${contractFunction.name}`);

  return contractFunction.mapper(args);
}

/**
 * Checks if a {@link data} can represent a call to a target with {@link abi}
 *
 * @param abi - the abi of the contract to check the function call with
 * @param data - the data containing the function call
 */
export function isCall(abi: readonly unknown[] | Abi, data: Hex): boolean {
  try {
    decodeFunctionData({
      abi,
      data,
    });
  } catch {
    return false;
  }

  return true;
}

UNCOV 1	import { Abi, decodeFunctionData } from 'viem';	×
2	import { Hex } from 'viem/types/misc';
3
4	/**
5	* Argument mapper representation for a contract function.
6	*
7	* The generic parameter represents the expected type that should be returned
8	* by the mapper.
9	*/
10	export type ContractFunctionArgsMapper<B> = {
11	name: string;
12	mapper: (args: readonly unknown[]) => B;
13	};
14
15	/**
16	* Decodes the arguments of the {@link contractFunction} given the provided
17	* {@link abi}.
18	*
19	* @param contractFunction - the contract function used to decode the arguments
20	* @param abi - the abi of the contract use to check the function call
21	* @param data - the data representing the function call
22	*/
UNCOV 23	export function decode<B>(	×
24	contractFunction: ContractFunctionArgsMapper<B>,
25	abi: readonly unknown[] \| Abi,
26	data: Hex,
27	): B {
UNCOV 28	const { functionName, args } = decodeFunctionData({	×
29	abi,
30	data,
31	});
32
UNCOV 33	if (contractFunction.name != functionName \|\| !args)	×
34	throw Error(`Provided data is not a call to ${contractFunction.name}`);	×
35
UNCOV 36	return contractFunction.mapper(args);	×
37	}
38
39	/**
40	* Checks if a {@link data} can represent a call to a target with {@link abi}
41	*
42	* @param abi - the abi of the contract to check the function call with
43	* @param data - the data containing the function call
44	*/
UNCOV 45	export function isCall(abi: readonly unknown[] \| Abi, data: Hex): boolean {	×
UNCOV 46	try {	×
UNCOV 47	decodeFunctionData({	×
48	abi,
49	data,
50	});
51	} catch {
UNCOV 52	return false;	×
53	}
54
UNCOV 55	return true;	×
56	}

safe-global / safe-client-gateway / 7932833131

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