9795000982

Committed 04 Jul 2024 01:12PM UTC coverage: 48.523% (-0.06%) from 48.578%

Build # 9795000982

Build Type

push

github

Committed by

web-flow

Commit Message

Include `SwapTransfer` when checking whether `TransactionInfo['type']` is a transfer (#1725)

Adds the relative checks for `SwapTransfer`-typed transfers: (Note: the following can be assumed as we check the address of the settlement contract)

- Add early return for imitation flagging
- Assume `trust` when filtering transfers
- Add test coverage accordingly

Run Details

414 of 2548 branches covered (16.25%)

Branch coverage included in aggregate %.

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

2 existing lines in 1 file now uncovered.

4217 of 6996 relevant lines covered (60.28%)

13.13 hits per line

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

56.86

/src/routes/transactions/swap-transfer-transaction-info.entity.ts

import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { AddressInfo } from '@/routes/common/entities/address-info.entity';
import { RichDecodedInfo } from '@/routes/transactions/entities/human-description.entity';
import {
  TransactionInfo,
  TransactionInfoType,
} from '@/routes/transactions/entities/transaction-info.entity';
import { Transfer } from '@/routes/transactions/entities/transfers/transfer.entity';
import { SwapOrderTransactionInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
import {
  OrderStatus,
  OrderClass,
  OrderKind,
} from '@/domain/swaps/entities/order.entity';
import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';
import {
  TransferDirection,
  TransferTransactionInfo,
} from '@/routes/transactions/entities/transfer-transaction-info.entity';

export class SwapTransferTransactionInfo
  extends TransactionInfo
  implements TransferTransactionInfo, SwapOrderTransactionInfo
{
  // TransferTransactionInfo properties
  @ApiProperty()
  sender: AddressInfo;

  @ApiProperty()
  recipient: AddressInfo;

  @ApiProperty()
  direction: TransferDirection;

  @ApiProperty()
  transferInfo: Transfer;

  // SwapOrderTransactionInfo properties
  @ApiProperty({ description: 'The order UID' })
  uid: string;

  @ApiProperty({
    enum: OrderStatus,
  })
  status: OrderStatus;

  @ApiProperty({ enum: Object.values(OrderKind) })
  kind: OrderKind;

  @ApiProperty({
    enum: OrderClass,
  })
  orderClass: OrderClass;

  @ApiProperty({ description: 'The timestamp when the order expires' })
  validUntil: number;

  @ApiProperty({
    description: 'The sell token raw amount (no decimals)',
  })
  sellAmount: string;

  @ApiProperty({
    description: 'The buy token raw amount (no decimals)',
  })
  buyAmount: string;

  @ApiProperty({
    description: 'The executed sell token raw amount (no decimals)',
  })
  executedSellAmount: string;

  @ApiProperty({
    description: 'The executed buy token raw amount (no decimals)',
  })
  executedBuyAmount: string;

  @ApiProperty({ description: 'The sell token of the order' })
  sellToken: TokenInfo;

  @ApiProperty({ description: 'The buy token of the order' })
  buyToken: TokenInfo;

  @ApiProperty({
    type: String,
    description: 'The URL to the explorer page of the order',
  })
  explorerUrl: string;

  @ApiPropertyOptional({
    type: String,
    nullable: true,
    description: 'The amount of fees paid for this order.',
  })
  executedSurplusFee: string | null;

  @ApiPropertyOptional({
    type: String,
    nullable: true,
    description: 'The (optional) address to receive the proceeds of the trade',
  })
  receiver: string | null;

  @ApiProperty({
    type: String,
  })
  owner: `0x${string}`;

  @ApiPropertyOptional({
    type: Object,
    nullable: true,
    description: 'The App Data for this order',
  })
  fullAppData: Record<string, unknown> | null;

  constructor(args: {
    // TransferTransactionInfo properties
    sender: AddressInfo;
    recipient: AddressInfo;
    direction: TransferDirection;
    transferInfo: Transfer;
    humanDescription: string | null;
    richDecodedInfo: RichDecodedInfo | null | undefined;
    // SwapOrderTransactionInfo properties
    uid: string;
    orderStatus: OrderStatus;
    kind: OrderKind;
    class: OrderClass;
    validUntil: number;
    sellAmount: string;
    buyAmount: string;
    executedSellAmount: string;
    executedBuyAmount: string;
    sellToken: TokenInfo;
    buyToken: TokenInfo;
    explorerUrl: string;
    executedSurplusFee: string | null;
    receiver: string | null;
    owner: `0x${string}`;
    fullAppData: Record<string, unknown> | null;
  }) {
    // TransferTransactionInfo constructor
    super(
      TransactionInfoType.SwapTransfer,
      args.humanDescription,
      args.richDecodedInfo,
    );
    this.sender = args.sender;
    this.recipient = args.recipient;
    this.direction = args.direction;
    this.transferInfo = args.transferInfo;
    // SwapOrderTransactionInfo constructor
    this.uid = args.uid;
    this.status = args.orderStatus;
    this.kind = args.kind;
    this.orderClass = args.class;
    this.validUntil = args.validUntil;
    this.sellAmount = args.sellAmount;
    this.buyAmount = args.buyAmount;
    this.executedSellAmount = args.executedSellAmount;
    this.executedBuyAmount = args.executedBuyAmount;
    this.sellToken = args.sellToken;
    this.buyToken = args.buyToken;
    this.explorerUrl = args.explorerUrl;
    this.executedSurplusFee = args.executedSurplusFee;
    this.receiver = args.receiver;
    this.owner = args.owner;
    this.fullAppData = args.fullAppData;
  }
}

export function isSwapTransferTransactionInfo(
  txInfo: TransactionInfo,
): txInfo is TransferTransactionInfo {
  return txInfo.type === TransactionInfoType.SwapTransfer;
}

1	import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';	16✔
2	import { AddressInfo } from '@/routes/common/entities/address-info.entity';	16✔
3	import { RichDecodedInfo } from '@/routes/transactions/entities/human-description.entity';
4	import {	16✔
5	TransactionInfo,
6	TransactionInfoType,
7	} from '@/routes/transactions/entities/transaction-info.entity';
8	import { Transfer } from '@/routes/transactions/entities/transfers/transfer.entity';	16✔
9	import { SwapOrderTransactionInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
10	import {	16✔
11	OrderStatus,
12	OrderClass,
13	OrderKind,
14	} from '@/domain/swaps/entities/order.entity';
15	import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';	16✔
16	import {	16✔
17	TransferDirection,
18	TransferTransactionInfo,
19	} from '@/routes/transactions/entities/transfer-transaction-info.entity';
20
21	export class SwapTransferTransactionInfo	16✔
22	extends TransactionInfo
23	implements TransferTransactionInfo, SwapOrderTransactionInfo
24	{
25	// TransferTransactionInfo properties
26	@ApiProperty()
27	sender: AddressInfo;	16✔
28
29	@ApiProperty()
30	recipient: AddressInfo;	16✔
31
32	@ApiProperty()
33	direction: TransferDirection;	16✔
34
35	@ApiProperty()
36	transferInfo: Transfer;	16✔
37
38	// SwapOrderTransactionInfo properties
39	@ApiProperty({ description: 'The order UID' })
40	uid: string;	16✔
41
42	@ApiProperty({
43	enum: OrderStatus,
44	})
45	status: OrderStatus;	16✔
46
47	@ApiProperty({ enum: Object.values(OrderKind) })
48	kind: OrderKind;	16✔
49
50	@ApiProperty({
51	enum: OrderClass,
52	})
53	orderClass: OrderClass;	16✔
54
55	@ApiProperty({ description: 'The timestamp when the order expires' })
56	validUntil: number;	16✔
57
58	@ApiProperty({
59	description: 'The sell token raw amount (no decimals)',
60	})
61	sellAmount: string;	16✔
62
63	@ApiProperty({
64	description: 'The buy token raw amount (no decimals)',
65	})
66	buyAmount: string;	16✔
67
68	@ApiProperty({
69	description: 'The executed sell token raw amount (no decimals)',
70	})
71	executedSellAmount: string;	16✔
72
73	@ApiProperty({
74	description: 'The executed buy token raw amount (no decimals)',
75	})
76	executedBuyAmount: string;	16✔
77
78	@ApiProperty({ description: 'The sell token of the order' })
79	sellToken: TokenInfo;	16✔
80
81	@ApiProperty({ description: 'The buy token of the order' })
82	buyToken: TokenInfo;	16✔
83
84	@ApiProperty({
85	type: String,
86	description: 'The URL to the explorer page of the order',
87	})
88	explorerUrl: string;	16✔
89
90	@ApiPropertyOptional({
91	type: String,
92	nullable: true,
93	description: 'The amount of fees paid for this order.',
94	})
95	executedSurplusFee: string \| null;	16✔
96
97	@ApiPropertyOptional({
98	type: String,
99	nullable: true,
100	description: 'The (optional) address to receive the proceeds of the trade',
101	})
102	receiver: string \| null;	16✔
103
104	@ApiProperty({
105	type: String,
106	})
107	owner: `0x${string}`;	16✔
108
109	@ApiPropertyOptional({
110	type: Object,
111	nullable: true,
112	description: 'The App Data for this order',
113	})
114	fullAppData: Record<string, unknown> \| null;	16✔
115
116	constructor(args: {
117	// TransferTransactionInfo properties
118	sender: AddressInfo;
119	recipient: AddressInfo;
120	direction: TransferDirection;
121	transferInfo: Transfer;
122	humanDescription: string \| null;
123	richDecodedInfo: RichDecodedInfo \| null \| undefined;
124	// SwapOrderTransactionInfo properties
125	uid: string;
126	orderStatus: OrderStatus;
127	kind: OrderKind;
128	class: OrderClass;
129	validUntil: number;
130	sellAmount: string;
131	buyAmount: string;
132	executedSellAmount: string;
133	executedBuyAmount: string;
134	sellToken: TokenInfo;
135	buyToken: TokenInfo;
136	explorerUrl: string;
137	executedSurplusFee: string \| null;
138	receiver: string \| null;
139	owner: `0x${string}`;
140	fullAppData: Record<string, unknown> \| null;
141	}) {
142	// TransferTransactionInfo constructor
143	super(	×
144	TransactionInfoType.SwapTransfer,
145	args.humanDescription,
146	args.richDecodedInfo,
147	);
148	this.sender = args.sender;	×
149	this.recipient = args.recipient;	×
150	this.direction = args.direction;	×
151	this.transferInfo = args.transferInfo;	×
152	// SwapOrderTransactionInfo constructor
153	this.uid = args.uid;	×
154	this.status = args.orderStatus;	×
155	this.kind = args.kind;	×
156	this.orderClass = args.class;	×
157	this.validUntil = args.validUntil;	×
158	this.sellAmount = args.sellAmount;	×
159	this.buyAmount = args.buyAmount;	×
160	this.executedSellAmount = args.executedSellAmount;	×
161	this.executedBuyAmount = args.executedBuyAmount;	×
162	this.sellToken = args.sellToken;	×
163	this.buyToken = args.buyToken;	×
164	this.explorerUrl = args.explorerUrl;	×
165	this.executedSurplusFee = args.executedSurplusFee;	×
166	this.receiver = args.receiver;	×
167	this.owner = args.owner;	×
168	this.fullAppData = args.fullAppData;	×
169	}
170	}
171
172	export function isSwapTransferTransactionInfo(	16✔
173	txInfo: TransactionInfo,
174	): txInfo is TransferTransactionInfo {
NEW 175	return txInfo.type === TransactionInfoType.SwapTransfer;	×
176	}

safe-global / safe-client-gateway / 9795000982

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