8233839963

Committed 11 Mar 2024 12:49PM UTC coverage: 92.682% (-0.8%) from 93.433%

Build # 8233839963

Build Type

push

github

Committed by

fmrsabino

Commit Message

Add SwapOrderTransactionInfo

Run Details

1744 of 2122 branches covered (82.19%)

Branch coverage included in aggregate %.

46 of 98 new or added lines in 7 files covered. (46.94%)

1 existing line in 1 file now uncovered.

6438 of 6706 relevant lines covered (96.0%)

349.13 hits per line

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

79.22

/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 { SetPreSignatureDecoder } from '@/domain/swaps/contracts/decoders/set-pre-signature-decoder.helper';
import { SwapOrderMapper } from '@/routes/transactions/mappers/common/swap-order.mapper';

@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 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,
    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 setPreSignatureDecoder: SetPreSignatureDecoder,
    private readonly swapOrderMapper: SwapOrderMapper,
  ) {
    this.isRichFragmentsEnabled = this.configurationService.getOrThrow(
      'features.richFragments',
    );
  }

  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.isCoWSwapOrder(transaction)) {
      return await this.swapOrderMapper.mapSwapOrder(
        chainId,
        transaction,
        dataSize,
      );
    }

    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,
    );
  }

  private isCoWSwapOrder(
    transaction: MultisigTransaction | ModuleTransaction,
  ): boolean {
    if (!transaction.data) return false;
    return this.setPreSignatureDecoder.isSetPreSignature(transaction.data);
  }

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

safe-global / safe-client-gateway / 8233839963

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