8176033973

Committed 06 Mar 2024 05:12PM UTC coverage: 93.349% (-0.08%) from 93.427%

Build # 8176033973

Build Type

Pull #1268

github

Committed by

iamacook

Commit Message

Migrate `DataDecoded` to `zod`

Pull Request Pull Request #1268: Migrate `DataDecoded` to `zod`

Run Details

1746 of 2107 branches covered (82.87%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 3 files covered. (100.0%)

2 existing lines in 2 files now uncovered.

6437 of 6659 relevant lines covered (96.67%)

344.68 hits per line

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

78.17

/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';

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

safe-global / safe-client-gateway / 8176033973

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