9125710885

Committed 17 May 2024 09:03AM UTC coverage: 92.815% (-0.002%) from 92.817%

Build # 9125710885

Build Type

push

github

Committed by

web-flow

Commit Message

Move `/locking` and `/campaign` routes under `/community` (#1560)

Moves all Locking Service-related routes under `/community`, aligning with the domain of the Activity Program:

- Rename `Locking-` module, controller, service to `Community-`.
- Rename the following (as of yet unused) routes:
  - `GET` `/v1/locking/campaigns` ->`/v1/community/campaigns`
  - `GET` `/v1/locking/campaigns/:campaignId` ->`/v1/community/campaigns/:campaignId`
  - `GET` `/v1/locking/campaigns/:campaignId/leaderboard` -> `/v1/community/campaigns/:campaignId/leaderboard`
- Rename the following (and deprecate with a redirection of the currently used) routes:
  - `GET` `/v1/locking/leaderboard` -> `/v1/community/locking/leaderboard`
  - `GET` `/v1/locking/leaderboard/rank/:safeAddress` -> `/v1/community/locking/:safeAddress/rank`
  - `GET` `/v1/locking/:safeAddress/history` -> `/v1/community/locking/:safeAddress/history`

Run Details

2022 of 2474 branches covered (81.73%)

Branch coverage included in aggregate %.

51 of 51 new or added lines in 5 files covered. (100.0%)

1 existing line in 1 file now uncovered.

7111 of 7366 relevant lines covered (96.54%)

325.64 hits per line

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

78.41

/src/routes/transactions/mappers/common/transaction-info.mapper.ts

import { Inject, Injectable } from '@nestjs/common';
import { IConfigurationService } from '@/config/configuration.service.interface';
import { ModuleTransaction } from '@/domain/safe/entities/module-transaction.entity';
import { MultisigTransaction } from '@/domain/safe/entities/multisig-transaction.entity';
import { Operation } from '@/domain/safe/entities/operation.entity';
import { TokenRepository } from '@/domain/tokens/token.repository';
import { ITokenRepository } from '@/domain/tokens/token.repository.interface';
import { TokenType } from '@/routes/balances/entities/token-type.entity';
import { DataDecodedParameter } from '@/routes/data-decode/entities/data-decoded-parameter.entity';
import { DataDecoded } from '@/routes/data-decode/entities/data-decoded.entity';
import { SettingsChangeTransaction } from '@/routes/transactions/entities/settings-change-transaction.entity';
import { TransactionInfo } from '@/routes/transactions/entities/transaction-info.entity';
import { CustomTransactionMapper } from '@/routes/transactions/mappers/common/custom-transaction.mapper';
import { DataDecodedParamHelper } from '@/routes/transactions/mappers/common/data-decoded-param.helper';
import { Erc20TransferMapper } from '@/routes/transactions/mappers/common/erc20-transfer.mapper';
import { Erc721TransferMapper } from '@/routes/transactions/mappers/common/erc721-transfer.mapper';
import { HumanDescriptionMapper } from '@/routes/transactions/mappers/common/human-description.mapper';
import { NativeCoinTransferMapper } from '@/routes/transactions/mappers/common/native-coin-transfer.mapper';
import { SettingsChangeMapper } from '@/routes/transactions/mappers/common/settings-change.mapper';
import { SwapOrderMapper } from '@/routes/transactions/mappers/common/swap-order.mapper';
import { isHex } from 'viem';
import { ILoggingService, LoggingService } from '@/logging/logging.interface';
import { SwapOrderTransactionInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
import { SwapOrderHelper } from '@/routes/transactions/helpers/swap-order.helper';

@Injectable()
export class MultisigTransactionInfoMapper {
  private readonly TRANSFER_METHOD = 'transfer';
  private readonly TRANSFER_FROM_METHOD = 'transferFrom';
  private readonly SAFE_TRANSFER_FROM_METHOD = 'safeTransferFrom';
  private readonly isRichFragmentsEnabled: boolean;
  private readonly isSwapsDecodingEnabled: boolean;

  private readonly ERC20_TRANSFER_METHODS = [
    this.TRANSFER_METHOD,
    this.TRANSFER_FROM_METHOD,
  ];

  private readonly ERC721_TRANSFER_METHODS = [
    this.TRANSFER_METHOD,
    this.TRANSFER_FROM_METHOD,
    this.SAFE_TRANSFER_FROM_METHOD,
  ];

  constructor(
    @Inject(ITokenRepository) private readonly tokenRepository: TokenRepository,
    @Inject(IConfigurationService)
    private readonly configurationService: IConfigurationService,
    @Inject(LoggingService) private readonly loggingService: ILoggingService,
    private readonly dataDecodedParamHelper: DataDecodedParamHelper,
    private readonly customTransactionMapper: CustomTransactionMapper,
    private readonly settingsChangeMapper: SettingsChangeMapper,
    private readonly nativeCoinTransferMapper: NativeCoinTransferMapper,
    private readonly erc20TransferMapper: Erc20TransferMapper,
    private readonly erc721TransferMapper: Erc721TransferMapper,
    private readonly humanDescriptionMapper: HumanDescriptionMapper,
    private readonly swapOrderMapper: SwapOrderMapper,
    private readonly swapOrderHelper: SwapOrderHelper,
  ) {
    this.isRichFragmentsEnabled = this.configurationService.getOrThrow(
      'features.richFragments',
    );
    this.isSwapsDecodingEnabled = this.configurationService.getOrThrow(
      'features.swapsDecoding',
    );
  }

  async mapTransactionInfo(
    chainId: string,
    transaction: MultisigTransaction | ModuleTransaction,
  ): Promise<TransactionInfo> {
    const value = Number(transaction?.value) || 0;
    const dataByteLength = transaction.data
      ? Buffer.byteLength(transaction.data)
      : 0;

    const dataSize =
      dataByteLength >= 2 ? Math.floor((dataByteLength - 2) / 2) : 0;

    const richDecodedInfo =
      await this.humanDescriptionMapper.mapRichDecodedInfo(
        transaction,
        chainId,
      );

    const humanDescription =
      this.humanDescriptionMapper.mapHumanDescription(richDecodedInfo);

    // If the rich fragment feature is disabled, we set it as undefined.
    // Undefined properties are not rendered on the response
    const richDecodedInfoApiProperty = this.isRichFragmentsEnabled
      ? richDecodedInfo
      : undefined;

    if (this.isSwapsDecodingEnabled) {
      const swapOrder: SwapOrderTransactionInfo | null =
        await this.mapSwapOrder(chainId, transaction);
      // If the transaction is a swap order, we return it immediately
      if (swapOrder) return swapOrder;
    }

    if (this.isCustomTransaction(value, dataSize, transaction.operation)) {
      return await this.customTransactionMapper.mapCustomTransaction(
        transaction,
        dataSize,
        chainId,
        humanDescription,
        richDecodedInfoApiProperty,
      );
    }

    if (this.isNativeCoinTransfer(value, dataSize)) {
      return this.nativeCoinTransferMapper.mapNativeCoinTransfer(
        chainId,
        transaction,
        humanDescription,
        richDecodedInfoApiProperty,
      );
    }

    if (this.isSettingsChange(transaction, value, dataSize)) {
      const settingsInfo = await this.settingsChangeMapper.mapSettingsChange(
        chainId,
        transaction,
      );

      if (!transaction.dataDecoded) {
        throw new Error(
          `Data decoded is null. txHash=${transaction.transactionHash}`,
        );
      }

      const dataDecodedParameters: DataDecodedParameter[] | null =
        transaction.dataDecoded.parameters?.map(
          (parameter) =>
            new DataDecodedParameter(
              parameter.name,
              parameter.type,
              parameter.value,
              parameter.valueDecoded,
            ),
        ) ?? null;

      return new SettingsChangeTransaction(
        new DataDecoded(transaction.dataDecoded.method, dataDecodedParameters),
        settingsInfo,
        humanDescription,
        richDecodedInfoApiProperty,
      );
    }

    if (this.isValidTokenTransfer(transaction)) {
      const token = await this.tokenRepository
        .getToken({ chainId, address: transaction.to })
        .catch(() => null);

      switch (token?.type) {
        case TokenType.Erc20:
          return this.erc20TransferMapper.mapErc20Transfer(
            token,
            chainId,
            transaction,
            humanDescription,
            richDecodedInfoApiProperty,
          );
        case TokenType.Erc721:
          return this.erc721TransferMapper.mapErc721Transfer(
            token,
            chainId,
            transaction,
            humanDescription,
            richDecodedInfoApiProperty,
          );
      }
    }

    return this.customTransactionMapper.mapCustomTransaction(
      transaction,
      dataSize,
      chainId,
      humanDescription,
      richDecodedInfoApiProperty,
    );
  }

  /**
   * Maps a swap order transaction.
   * If the transaction is not a swap order, it returns null.
   *
   * @param chainId
   * @param transaction
   * @private
   */
  private async mapSwapOrder(
    chainId: string,
    transaction: MultisigTransaction | ModuleTransaction,
  ): Promise<SwapOrderTransactionInfo | null> {
    if (!transaction?.data || !isHex(transaction.data)) {
      return null;
    }

    const orderData: `0x${string}` | null = this.swapOrderHelper.findSwapOrder(
      transaction.data,
    );

    if (!orderData) {
      return null;
    }

    try {
      return await this.swapOrderMapper.mapSwapOrder(chainId, {
        data: orderData,
      });
    } catch (error) {
      // The transaction is a swap order, but we couldn't decode it successfully.
      this.loggingService.warn(error);
      return null;
    }
  }

  private isCustomTransaction(
    value: number,
    dataSize: number,
    operation: Operation,
  ): boolean {
    return (value > 0 && dataSize > 0) || operation !== 0;
  }

  private isNativeCoinTransfer(value: number, dataSize: number): boolean {
    return value > 0 && dataSize === 0;
  }

  private isSettingsChange(
    transaction: MultisigTransaction | ModuleTransaction,
    value: number,
    dataSize: number,
  ): boolean {
    const isSettingsChangeMethod: boolean = transaction.dataDecoded
      ? SettingsChangeMapper.SETTINGS_CHANGE_METHODS.includes(
          transaction.dataDecoded.method,
        )
      : false;

    return (
      value === 0 &&
      dataSize > 0 &&
      transaction.safe === transaction.to &&
      isSettingsChangeMethod
    );
  }

  private isValidTokenTransfer(
    transaction: MultisigTransaction | ModuleTransaction,
  ): boolean {
    return (
      (this.isErc20Transfer(transaction) ||
        this.isErc721Transfer(transaction)) &&
      this.isSafeSenderOrReceiver(transaction)
    );
  }

  private isErc20Transfer(
    transaction: MultisigTransaction | ModuleTransaction,
  ): boolean {
    const { dataDecoded } = transaction;
    return this.ERC20_TRANSFER_METHODS.some(
      (method) => method === dataDecoded?.method,
    );
  }

  private isErc721Transfer(
    transaction: MultisigTransaction | ModuleTransaction,
  ): boolean {
    const { dataDecoded } = transaction;
    return this.ERC721_TRANSFER_METHODS.some(
      (method) => method === dataDecoded?.method,
    );
  }

  private isSafeSenderOrReceiver(
    transaction: MultisigTransaction | ModuleTransaction,
  ): boolean {
    const { dataDecoded } = transaction;
    if (!dataDecoded) return false;
    return (
      this.TRANSFER_METHOD == dataDecoded.method ||
      this.dataDecodedParamHelper.getFromParam(dataDecoded, '') ===
        transaction.safe ||
      this.dataDecodedParamHelper.getToParam(dataDecoded, '') ===
        transaction.safe
    );
  }
}

1	import { Inject, Injectable } from '@nestjs/common';	106✔
2	import { IConfigurationService } from '@/config/configuration.service.interface';	106✔
3	import { ModuleTransaction } from '@/domain/safe/entities/module-transaction.entity';
4	import { MultisigTransaction } from '@/domain/safe/entities/multisig-transaction.entity';
5	import { Operation } from '@/domain/safe/entities/operation.entity';
6	import { TokenRepository } from '@/domain/tokens/token.repository';	106✔
7	import { ITokenRepository } from '@/domain/tokens/token.repository.interface';	106✔
8	import { TokenType } from '@/routes/balances/entities/token-type.entity';	106✔
9	import { DataDecodedParameter } from '@/routes/data-decode/entities/data-decoded-parameter.entity';	106✔
10	import { DataDecoded } from '@/routes/data-decode/entities/data-decoded.entity';	106✔
11	import { SettingsChangeTransaction } from '@/routes/transactions/entities/settings-change-transaction.entity';	106✔
12	import { TransactionInfo } from '@/routes/transactions/entities/transaction-info.entity';
13	import { CustomTransactionMapper } from '@/routes/transactions/mappers/common/custom-transaction.mapper';	106✔
14	import { DataDecodedParamHelper } from '@/routes/transactions/mappers/common/data-decoded-param.helper';	106✔
15	import { Erc20TransferMapper } from '@/routes/transactions/mappers/common/erc20-transfer.mapper';	106✔
16	import { Erc721TransferMapper } from '@/routes/transactions/mappers/common/erc721-transfer.mapper';	106✔
17	import { HumanDescriptionMapper } from '@/routes/transactions/mappers/common/human-description.mapper';	106✔
18	import { NativeCoinTransferMapper } from '@/routes/transactions/mappers/common/native-coin-transfer.mapper';	106✔
19	import { SettingsChangeMapper } from '@/routes/transactions/mappers/common/settings-change.mapper';	106✔
20	import { SwapOrderMapper } from '@/routes/transactions/mappers/common/swap-order.mapper';	106✔
21	import { isHex } from 'viem';	106✔
22	import { ILoggingService, LoggingService } from '@/logging/logging.interface';	106✔
23	import { SwapOrderTransactionInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
24	import { SwapOrderHelper } from '@/routes/transactions/helpers/swap-order.helper';	106✔
25
26	@Injectable()
27	export class MultisigTransactionInfoMapper {	106✔
28	private readonly TRANSFER_METHOD = 'transfer';	1,372✔
29	private readonly TRANSFER_FROM_METHOD = 'transferFrom';	1,372✔
30	private readonly SAFE_TRANSFER_FROM_METHOD = 'safeTransferFrom';	1,372✔
31	private readonly isRichFragmentsEnabled: boolean;
32	private readonly isSwapsDecodingEnabled: boolean;
33
34	private readonly ERC20_TRANSFER_METHODS = [	1,372✔
35	this.TRANSFER_METHOD,
36	this.TRANSFER_FROM_METHOD,
37	];
38
39	private readonly ERC721_TRANSFER_METHODS = [	1,372✔
40	this.TRANSFER_METHOD,
41	this.TRANSFER_FROM_METHOD,
42	this.SAFE_TRANSFER_FROM_METHOD,
43	];
44
45	constructor(
46	@Inject(ITokenRepository) private readonly tokenRepository: TokenRepository,	1,372✔
47	@Inject(IConfigurationService)
48	private readonly configurationService: IConfigurationService,	1,372✔
49	@Inject(LoggingService) private readonly loggingService: ILoggingService,	1,372✔
50	private readonly dataDecodedParamHelper: DataDecodedParamHelper,	1,372✔
51	private readonly customTransactionMapper: CustomTransactionMapper,	1,372✔
52	private readonly settingsChangeMapper: SettingsChangeMapper,	1,372✔
53	private readonly nativeCoinTransferMapper: NativeCoinTransferMapper,	1,372✔
54	private readonly erc20TransferMapper: Erc20TransferMapper,	1,372✔
55	private readonly erc721TransferMapper: Erc721TransferMapper,	1,372✔
56	private readonly humanDescriptionMapper: HumanDescriptionMapper,	1,372✔
57	private readonly swapOrderMapper: SwapOrderMapper,	1,372✔
58	private readonly swapOrderHelper: SwapOrderHelper,	1,372✔
59	) {
60	this.isRichFragmentsEnabled = this.configurationService.getOrThrow(	1,372✔
61	'features.richFragments',
62	);
63	this.isSwapsDecodingEnabled = this.configurationService.getOrThrow(	1,372✔
64	'features.swapsDecoding',
65	);
66	}
67
68	async mapTransactionInfo(
69	chainId: string,
70	transaction: MultisigTransaction \| ModuleTransaction,
71	): Promise<TransactionInfo> {
72	const value = Number(transaction?.value) \|\| 0;	86✔
73	const dataByteLength = transaction.data	86✔
74	? Buffer.byteLength(transaction.data)
75	: 0;
76
77	const dataSize =
78	dataByteLength >= 2 ? Math.floor((dataByteLength - 2) / 2) : 0;	86✔
79
80	const richDecodedInfo =
81	await this.humanDescriptionMapper.mapRichDecodedInfo(	86✔
82	transaction,
83	chainId,
84	);
85
86	const humanDescription =
87	this.humanDescriptionMapper.mapHumanDescription(richDecodedInfo);	86✔
88
89	// If the rich fragment feature is disabled, we set it as undefined.
90	// Undefined properties are not rendered on the response
91	const richDecodedInfoApiProperty = this.isRichFragmentsEnabled	86!
92	? richDecodedInfo
93	: undefined;
94
95	if (this.isSwapsDecodingEnabled) {	86✔
96	const swapOrder: SwapOrderTransactionInfo \| null =
97	await this.mapSwapOrder(chainId, transaction);	86✔
98	// If the transaction is a swap order, we return it immediately
99	if (swapOrder) return swapOrder;	86!
100	}
101
102	if (this.isCustomTransaction(value, dataSize, transaction.operation)) {	86✔
103	return await this.customTransactionMapper.mapCustomTransaction(	42✔
104	transaction,
105	dataSize,
106	chainId,
107	humanDescription,
108	richDecodedInfoApiProperty,
109	);
110	}
111
112	if (this.isNativeCoinTransfer(value, dataSize)) {	44✔
113	return this.nativeCoinTransferMapper.mapNativeCoinTransfer(	30✔
114	chainId,
115	transaction,
116	humanDescription,
117	richDecodedInfoApiProperty,
118	);
119	}
120
121	if (this.isSettingsChange(transaction, value, dataSize)) {	14!
122	const settingsInfo = await this.settingsChangeMapper.mapSettingsChange(	×
123	chainId,
124	transaction,
125	);
126
127	if (!transaction.dataDecoded) {	×
128	throw new Error(	×
129	`Data decoded is null. txHash=${transaction.transactionHash}`,
130	);
131	}
132
133	const dataDecodedParameters: DataDecodedParameter[] \| null =
134	transaction.dataDecoded.parameters?.map(	×
135	(parameter) =>
136	new DataDecodedParameter(	×
137	parameter.name,
138	parameter.type,
139	parameter.value,
140	parameter.valueDecoded,
141	),
142	) ?? null;
143
144	return new SettingsChangeTransaction(	×
145	new DataDecoded(transaction.dataDecoded.method, dataDecodedParameters),
146	settingsInfo,
147	humanDescription,
148	richDecodedInfoApiProperty,
149	);
150	}
151
152	if (this.isValidTokenTransfer(transaction)) {	14✔
153	const token = await this.tokenRepository	14✔
154	.getToken({ chainId, address: transaction.to })
155	.catch(() => null);	×
156
157	switch (token?.type) {	14!
158	case TokenType.Erc20:
159	return this.erc20TransferMapper.mapErc20Transfer(	12✔
160	token,
161	chainId,
162	transaction,
163	humanDescription,
164	richDecodedInfoApiProperty,
165	);
166	case TokenType.Erc721:
167	return this.erc721TransferMapper.mapErc721Transfer(	2✔
168	token,
169	chainId,
170	transaction,
171	humanDescription,
172	richDecodedInfoApiProperty,
173	);
174	}
175	}
176
UNCOV 177	return this.customTransactionMapper.mapCustomTransaction(	×
178	transaction,
179	dataSize,
180	chainId,
181	humanDescription,
182	richDecodedInfoApiProperty,
183	);
184	}
185
186	/**
187	* Maps a swap order transaction.
188	* If the transaction is not a swap order, it returns null.
189	*
190	* @param chainId
191	* @param transaction
192	* @private
193	*/
194	private async mapSwapOrder(
195	chainId: string,
196	transaction: MultisigTransaction \| ModuleTransaction,
197	): Promise<SwapOrderTransactionInfo \| null> {
198	if (!transaction?.data \|\| !isHex(transaction.data)) {	86!
199	return null;	4✔
200	}
201
202	const orderData: `0x${string}` \| null = this.swapOrderHelper.findSwapOrder(	82✔
203	transaction.data,
204	);
205
206	if (!orderData) {	82✔
207	return null;	82✔
208	}
209
210	try {	×
211	return await this.swapOrderMapper.mapSwapOrder(chainId, {	×
212	data: orderData,
213	});
214	} catch (error) {
215	// The transaction is a swap order, but we couldn't decode it successfully.
216	this.loggingService.warn(error);	×
217	return null;	×
218	}
219	}
220
221	private isCustomTransaction(
222	value: number,
223	dataSize: number,
224	operation: Operation,
225	): boolean {
226	return (value > 0 && dataSize > 0) \|\| operation !== 0;	86✔
227	}
228
229	private isNativeCoinTransfer(value: number, dataSize: number): boolean {
230	return value > 0 && dataSize === 0;	44✔
231	}
232
233	private isSettingsChange(
234	transaction: MultisigTransaction \| ModuleTransaction,
235	value: number,
236	dataSize: number,
237	): boolean {
238	const isSettingsChangeMethod: boolean = transaction.dataDecoded	14!
239	? SettingsChangeMapper.SETTINGS_CHANGE_METHODS.includes(
240	transaction.dataDecoded.method,
241	)
242	: false;
243
244	return (	14✔
245	value === 0 &&	14!
246	dataSize > 0 &&
247	transaction.safe === transaction.to &&
248	isSettingsChangeMethod
249	);
250	}
251
252	private isValidTokenTransfer(
253	transaction: MultisigTransaction \| ModuleTransaction,
254	): boolean {
255	return (	14✔
256	(this.isErc20Transfer(transaction) \|\|	15✔
257	this.isErc721Transfer(transaction)) &&
258	this.isSafeSenderOrReceiver(transaction)
259	);
260	}
261
262	private isErc20Transfer(
263	transaction: MultisigTransaction \| ModuleTransaction,
264	): boolean {
265	const { dataDecoded } = transaction;	14✔
266	return this.ERC20_TRANSFER_METHODS.some(	14✔
267	(method) => method === dataDecoded?.method,	16!
268	);
269	}
270
271	private isErc721Transfer(
272	transaction: MultisigTransaction \| ModuleTransaction,
273	): boolean {
274	const { dataDecoded } = transaction;	2✔
275	return this.ERC721_TRANSFER_METHODS.some(	2✔
276	(method) => method === dataDecoded?.method,	6!
277	);
278	}
279
280	private isSafeSenderOrReceiver(
281	transaction: MultisigTransaction \| ModuleTransaction,
282	): boolean {
283	const { dataDecoded } = transaction;	14✔
284	if (!dataDecoded) return false;	14!
285	return (	14✔
286	this.TRANSFER_METHOD == dataDecoded.method \|\|	8!
287	this.dataDecodedParamHelper.getFromParam(dataDecoded, '') ===
288	transaction.safe \|\|
289	this.dataDecodedParamHelper.getToParam(dataDecoded, '') ===
290	transaction.safe
291	);
292	}
293	}

safe-global / safe-client-gateway / 9125710885

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