9642573892

Committed 24 Jun 2024 09:02AM UTC coverage: 48.734% (-0.03%) from 48.767%

Build # 9642573892

Build Type

push

github

Committed by

web-flow

Commit Message

Add TWAP decoding to confirmation view (#1681)

Adds the relevant decoded to return the `TwapOrderInfo` from the confirmation view endpoint:

- Add `CowSwapTwapConfirmationView` with `COW_SWAP_TWAP_ORDER` `type` 
- Change types of `TwapOrderInfo` to ensure no issue with max. integers/time consistency
  - `numberOfParts`: number -> string
  - `timeBetweenParts`: string -> number
- Add `TwapOrderHelper['twapStructToPartialOrderInfo']` to reduce duplicate code
- Add TWAP decoding to `TransactionsViewService`

Run Details

415 of 2483 branches covered (16.71%)

Branch coverage included in aggregate %.

36 of 86 new or added lines in 7 files covered. (41.86%)

2 existing lines in 2 files now uncovered.

4107 of 6796 relevant lines covered (60.43%)

13.25 hits per line

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

58.59

/src/routes/transactions/entities/confirmation-view/confirmation-view.entity.ts

import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { DataDecodedParameter } from '@/routes/data-decode/entities/data-decoded-parameter.entity';
import { OrderInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
import {
  OrderClass,
  OrderKind,
  OrderStatus,
} from '@/domain/swaps/entities/order.entity';
import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';
import {
  DurationOfPart,
  StartTime,
  TwapOrderInfo,
} from '@/routes/transactions/entities/swaps/twap-order-info.entity';

interface Baseline {
  method: string;
  parameters: DataDecodedParameter[] | null;
}

enum DecodedType {
  Generic = 'GENERIC',
  CowSwapOrder = 'COW_SWAP_ORDER',
  CowSwapTwapOrder = 'COW_SWAP_TWAP_ORDER',
}

export type ConfirmationView =
  | BaselineConfirmationView
  | CowSwapConfirmationView
  | CowSwapTwapConfirmationView;

export class BaselineConfirmationView implements Baseline {
  @ApiProperty({ enum: [DecodedType.Generic] })
  type = DecodedType.Generic;

  @ApiProperty()
  method: string;

  @ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
  parameters: DataDecodedParameter[] | null;

  constructor(args: {
    method: string;
    parameters: DataDecodedParameter[] | null;
  }) {
    this.method = args.method;
    this.parameters = args.parameters;
  }
}

export class CowSwapConfirmationView implements Baseline, OrderInfo {
  // Baseline implementation
  @ApiProperty({ enum: [DecodedType.CowSwapOrder] })
  type = DecodedType.CowSwapOrder;

  @ApiProperty()
  method: string;

  @ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
  parameters: DataDecodedParameter[] | null;

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

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

  @ApiProperty({ enum: ['buy', 'sell'] })
  kind: 'buy' | 'sell';

  @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({
    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;

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

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

  constructor(
    args: Baseline & OrderInfo & { sellToken: TokenInfo; buyToken: TokenInfo },
  ) {
    this.method = args.method;
    this.parameters = args.parameters;
    this.uid = args.uid;
    this.status = args.status;
    this.kind = args.kind;
    this.orderClass = args.orderClass;
    this.validUntil = args.validUntil;
    this.sellAmount = args.sellAmount;
    this.buyAmount = args.buyAmount;
    this.executedSellAmount = args.executedSellAmount;
    this.executedBuyAmount = args.executedBuyAmount;
    this.explorerUrl = args.explorerUrl;
    this.executedSurplusFee = args.executedSurplusFee;
    this.sellToken = args.sellToken;
    this.buyToken = args.buyToken;
    this.receiver = args.receiver;
    this.owner = args.owner;
    this.fullAppData = args.fullAppData;
  }
}

export class CowSwapTwapConfirmationView implements Baseline, TwapOrderInfo {
  // Baseline implementation
  @ApiProperty({ enum: [DecodedType.CowSwapTwapOrder] })
  type = DecodedType.CowSwapTwapOrder;

  @ApiProperty()
  method: string;

  @ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
  parameters: DataDecodedParameter[] | null;

  // TwapOrderInfo implementation
  @ApiProperty({
    enum: OrderStatus,
    description: 'The TWAP status',
  })
  status: OrderStatus;

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

  @ApiProperty({ enum: OrderClass })
  class: OrderClass.Limit;

  @ApiProperty({ description: 'The timestamp when the TWAP 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;

  @ApiPropertyOptional({
    nullable: true,
    description:
      'The executed sell token raw amount (no decimals), or null if there are too many parts',
  })
  executedSellAmount: string | null;

  @ApiPropertyOptional({
    nullable: true,
    description:
      'The executed buy token raw amount (no decimals), or null if there are too many parts',
  })
  executedBuyAmount: string | null;

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

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

  @ApiProperty({
    description: 'The address to receive the proceeds of the trade',
  })
  receiver: `0x${string}`;

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

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

  @ApiProperty({
    description: 'The number of parts in the TWAP',
  })
  numberOfParts: string;

  @ApiProperty({
    description: 'The amount of sellToken to sell in each part',
  })
  partSellAmount: string;

  @ApiProperty({
    description: 'The amount of buyToken that must be bought in each part',
  })
  minPartLimit: string;

  @ApiProperty({
    description: 'The duration of the TWAP interval',
  })
  timeBetweenParts: number;

  @ApiProperty({
    description: 'Whether the TWAP is valid for the entire interval or not',
  })
  durationOfPart: DurationOfPart;

  @ApiProperty({
    description: 'The start time of the TWAP',
  })
  startTime: StartTime;

  constructor(args: {
    method: string;
    parameters: DataDecodedParameter[] | null;
    status: OrderStatus;
    kind: OrderKind.Sell;
    class: OrderClass.Limit;
    validUntil: number;
    sellAmount: string;
    buyAmount: string;
    executedSellAmount: string | null;
    executedBuyAmount: string | null;
    sellToken: TokenInfo;
    buyToken: TokenInfo;
    receiver: `0x${string}`;
    owner: `0x${string}`;
    fullAppData: Record<string, unknown> | null;
    numberOfParts: string;
    partSellAmount: string;
    minPartLimit: string;
    timeBetweenParts: number;
    durationOfPart: DurationOfPart;
    startTime: StartTime;
  }) {
    this.method = args.method;
    this.parameters = args.parameters;
    this.status = args.status;
    this.kind = args.kind;
    this.class = 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.receiver = args.receiver;
    this.owner = args.owner;
    this.fullAppData = args.fullAppData;
    this.numberOfParts = args.numberOfParts;
    this.partSellAmount = args.partSellAmount;
    this.minPartLimit = args.minPartLimit;
    this.timeBetweenParts = args.timeBetweenParts;
    this.durationOfPart = args.durationOfPart;
    this.startTime = args.startTime;
  }
}

1	import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';	16✔
2	import { DataDecodedParameter } from '@/routes/data-decode/entities/data-decoded-parameter.entity';	16✔
3	import { OrderInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
4	import {	16✔
5	OrderClass,
6	OrderKind,
7	OrderStatus,
8	} from '@/domain/swaps/entities/order.entity';
9	import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';	16✔
10	import {
11	DurationOfPart,
12	StartTime,
13	TwapOrderInfo,
14	} from '@/routes/transactions/entities/swaps/twap-order-info.entity';
15
16	interface Baseline {
17	method: string;
18	parameters: DataDecodedParameter[] \| null;
19	}
20
21	enum DecodedType {	16✔
22	Generic = 'GENERIC',	16✔
23	CowSwapOrder = 'COW_SWAP_ORDER',	16✔
24	CowSwapTwapOrder = 'COW_SWAP_TWAP_ORDER',	16✔
25	}
26
27	export type ConfirmationView =
28	\| BaselineConfirmationView
29	\| CowSwapConfirmationView
30	\| CowSwapTwapConfirmationView;
31
32	export class BaselineConfirmationView implements Baseline {	16✔
33	@ApiProperty({ enum: [DecodedType.Generic] })
34	type = DecodedType.Generic;	16✔
35
36	@ApiProperty()
37	method: string;	16✔
38
39	@ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
40	parameters: DataDecodedParameter[] \| null;	16✔
41
42	constructor(args: {
43	method: string;
44	parameters: DataDecodedParameter[] \| null;
45	}) {
46	this.method = args.method;	×
47	this.parameters = args.parameters;	×
48	}
49	}
50
51	export class CowSwapConfirmationView implements Baseline, OrderInfo {	16✔
52	// Baseline implementation
53	@ApiProperty({ enum: [DecodedType.CowSwapOrder] })
54	type = DecodedType.CowSwapOrder;	16✔
55
56	@ApiProperty()
57	method: string;	16✔
58
59	@ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
60	parameters: DataDecodedParameter[] \| null;	16✔
61
62	// OrderInfo implementation
63	@ApiProperty({ description: 'The order UID' })
64	uid: string;	16✔
65
66	@ApiProperty({
67	enum: OrderStatus,
68	})
69	status: OrderStatus;	16✔
70
71	@ApiProperty({ enum: ['buy', 'sell'] })
72	kind: 'buy' \| 'sell';	16✔
73
74	@ApiProperty({
75	enum: OrderClass,
76	})
77	orderClass: OrderClass;	16✔
78
79	@ApiProperty({ description: 'The timestamp when the order expires' })
80	validUntil: number;	16✔
81
82	@ApiProperty({
83	description: 'The sell token raw amount (no decimals)',
84	})
85	sellAmount: string;	16✔
86
87	@ApiProperty({
88	description: 'The buy token raw amount (no decimals)',
89	})
90	buyAmount: string;	16✔
91
92	@ApiProperty({
93	description: 'The executed sell token raw amount (no decimals)',
94	})
95	executedSellAmount: string;	16✔
96
97	@ApiProperty({
98	description: 'The executed buy token raw amount (no decimals)',
99	})
100	executedBuyAmount: string;	16✔
101
102	@ApiProperty({
103	type: String,
104	description: 'The URL to the explorer page of the order',
105	})
106	explorerUrl: string;	16✔
107
108	@ApiPropertyOptional({
109	type: String,
110	nullable: true,
111	description: 'The amount of fees paid for this order.',
112	})
113	executedSurplusFee: string \| null;	16✔
114
115	@ApiPropertyOptional({
116	type: String,
117	nullable: true,
118	description: 'The (optional) address to receive the proceeds of the trade',
119	})
120	receiver: string \| null;	16✔
121
122	@ApiProperty({
123	type: String,
124	})
125	owner: `0x${string}`;	16✔
126
127	@ApiPropertyOptional({
128	type: Object,
129	nullable: true,
130	description: 'The App Data for this order',
131	})
132	fullAppData: Record<string, unknown> \| null;	16✔
133
134	@ApiProperty({ description: 'The sell token of the order' })
135	sellToken: TokenInfo;	16✔
136
137	@ApiProperty({ description: 'The buy token of the order' })
138	buyToken: TokenInfo;	16✔
139
140	constructor(
141	args: Baseline & OrderInfo & { sellToken: TokenInfo; buyToken: TokenInfo },
142	) {
143	this.method = args.method;	×
144	this.parameters = args.parameters;	×
145	this.uid = args.uid;	×
146	this.status = args.status;	×
147	this.kind = args.kind;	×
148	this.orderClass = args.orderClass;	×
149	this.validUntil = args.validUntil;	×
150	this.sellAmount = args.sellAmount;	×
151	this.buyAmount = args.buyAmount;	×
152	this.executedSellAmount = args.executedSellAmount;	×
153	this.executedBuyAmount = args.executedBuyAmount;	×
154	this.explorerUrl = args.explorerUrl;	×
155	this.executedSurplusFee = args.executedSurplusFee;	×
156	this.sellToken = args.sellToken;	×
157	this.buyToken = args.buyToken;	×
158	this.receiver = args.receiver;	×
159	this.owner = args.owner;	×
160	this.fullAppData = args.fullAppData;	×
161	}
162	}
163
164	export class CowSwapTwapConfirmationView implements Baseline, TwapOrderInfo {	16✔
165	// Baseline implementation
166	@ApiProperty({ enum: [DecodedType.CowSwapTwapOrder] })
167	type = DecodedType.CowSwapTwapOrder;	16✔
168
169	@ApiProperty()
170	method: string;	16✔
171
172	@ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
173	parameters: DataDecodedParameter[] \| null;	16✔
174
175	// TwapOrderInfo implementation
176	@ApiProperty({
177	enum: OrderStatus,
178	description: 'The TWAP status',
179	})
180	status: OrderStatus;	16✔
181
182	@ApiProperty({ enum: OrderKind })
183	kind: OrderKind.Sell;	16✔
184
185	@ApiProperty({ enum: OrderClass })
186	class: OrderClass.Limit;	16✔
187
188	@ApiProperty({ description: 'The timestamp when the TWAP expires' })
189	validUntil: number;	16✔
190
191	@ApiProperty({
192	description: 'The sell token raw amount (no decimals)',
193	})
194	sellAmount: string;	16✔
195
196	@ApiProperty({
197	description: 'The buy token raw amount (no decimals)',
198	})
199	buyAmount: string;	16✔
200
201	@ApiPropertyOptional({
202	nullable: true,
203	description:
204	'The executed sell token raw amount (no decimals), or null if there are too many parts',
205	})
206	executedSellAmount: string \| null;	16✔
207
208	@ApiPropertyOptional({
209	nullable: true,
210	description:
211	'The executed buy token raw amount (no decimals), or null if there are too many parts',
212	})
213	executedBuyAmount: string \| null;	16✔
214
215	@ApiProperty({ description: 'The sell token of the TWAP' })
216	sellToken: TokenInfo;	16✔
217
218	@ApiProperty({ description: 'The buy token of the TWAP' })
219	buyToken: TokenInfo;	16✔
220
221	@ApiProperty({
222	description: 'The address to receive the proceeds of the trade',
223	})
224	receiver: `0x${string}`;	16✔
225
226	@ApiProperty({
227	type: String,
228	})
229	owner: `0x${string}`;	16✔
230
231	@ApiPropertyOptional({
232	type: Object,
233	nullable: true,
234	description: 'The App Data for this TWAP',
235	})
236	fullAppData: Record<string, unknown> \| null;	16✔
237
238	@ApiProperty({
239	description: 'The number of parts in the TWAP',
240	})
241	numberOfParts: string;	16✔
242
243	@ApiProperty({
244	description: 'The amount of sellToken to sell in each part',
245	})
246	partSellAmount: string;	16✔
247
248	@ApiProperty({
249	description: 'The amount of buyToken that must be bought in each part',
250	})
251	minPartLimit: string;	16✔
252
253	@ApiProperty({
254	description: 'The duration of the TWAP interval',
255	})
256	timeBetweenParts: number;	16✔
257
258	@ApiProperty({
259	description: 'Whether the TWAP is valid for the entire interval or not',
260	})
261	durationOfPart: DurationOfPart;	16✔
262
263	@ApiProperty({
264	description: 'The start time of the TWAP',
265	})
266	startTime: StartTime;	16✔
267
268	constructor(args: {
269	method: string;
270	parameters: DataDecodedParameter[] \| null;
271	status: OrderStatus;
272	kind: OrderKind.Sell;
273	class: OrderClass.Limit;
274	validUntil: number;
275	sellAmount: string;
276	buyAmount: string;
277	executedSellAmount: string \| null;
278	executedBuyAmount: string \| null;
279	sellToken: TokenInfo;
280	buyToken: TokenInfo;
281	receiver: `0x${string}`;
282	owner: `0x${string}`;
283	fullAppData: Record<string, unknown> \| null;
284	numberOfParts: string;
285	partSellAmount: string;
286	minPartLimit: string;
287	timeBetweenParts: number;
288	durationOfPart: DurationOfPart;
289	startTime: StartTime;
290	}) {
NEW 291	this.method = args.method;	×
NEW 292	this.parameters = args.parameters;	×
NEW 293	this.status = args.status;	×
NEW 294	this.kind = args.kind;	×
NEW 295	this.class = args.class;	×
NEW 296	this.validUntil = args.validUntil;	×
NEW 297	this.sellAmount = args.sellAmount;	×
NEW 298	this.buyAmount = args.buyAmount;	×
NEW 299	this.executedSellAmount = args.executedSellAmount;	×
NEW 300	this.executedBuyAmount = args.executedBuyAmount;	×
NEW 301	this.sellToken = args.sellToken;	×
NEW 302	this.buyToken = args.buyToken;	×
NEW 303	this.receiver = args.receiver;	×
NEW 304	this.owner = args.owner;	×
NEW 305	this.fullAppData = args.fullAppData;	×
NEW 306	this.numberOfParts = args.numberOfParts;	×
NEW 307	this.partSellAmount = args.partSellAmount;	×
NEW 308	this.minPartLimit = args.minPartLimit;	×
NEW 309	this.timeBetweenParts = args.timeBetweenParts;	×
NEW 310	this.durationOfPart = args.durationOfPart;	×
NEW 311	this.startTime = args.startTime;	×
312	}
313	}

safe-global / safe-client-gateway / 9642573892

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