8819787228

Committed 24 Apr 2024 04:12PM UTC coverage: 92.383% (-0.03%) from 92.411%

Build # 8819787228

Build Type

Pull #1452

github

Committed by

web-flow

Commit Message

Merge 743cab5fb into e5150cb4e

Pull Request Pull Request #1452: Forward the Order receiver

Run Details

1912 of 2327 branches covered (82.17%)

Branch coverage included in aggregate %.

2 of 4 new or added lines in 2 files covered. (50.0%)

3 existing lines in 3 files now uncovered.

6881 of 7191 relevant lines covered (95.69%)

307.25 hits per line

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

63.46

/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, OrderStatus } from '@/domain/swaps/entities/order.entity';
import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';

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

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

export type ConfirmationView =
  | BaselineConfirmationView
  | CowSwapConfirmationView;

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: URL;

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

  @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.fullAppData = args.fullAppData;
  }
}

1	import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';	94✔
2	import { DataDecodedParameter } from '@/routes/data-decode/entities/data-decoded-parameter.entity';	94✔
3	import { OrderInfo } from '@/routes/transactions/entities/swaps/swap-order-info.entity';
4	import { OrderClass, OrderStatus } from '@/domain/swaps/entities/order.entity';	94✔
5	import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';	94✔
6
7	interface Baseline {
8	method: string;
9	parameters: DataDecodedParameter[] \| null;
10	}
11
12	enum DecodedType {	94✔
13	Generic = 'GENERIC',	94✔
14	CowSwapOrder = 'COW_SWAP_ORDER',	94✔
15	}
16
17	export type ConfirmationView =
18	\| BaselineConfirmationView
19	\| CowSwapConfirmationView;
20
21	export class BaselineConfirmationView implements Baseline {	94✔
22	@ApiProperty({ enum: [DecodedType.Generic] })
23	type = DecodedType.Generic;	94✔
24
25	@ApiProperty()
26	method: string;	94✔
27
28	@ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
29	parameters: DataDecodedParameter[] \| null;	94✔
30
31	constructor(args: {
32	method: string;
33	parameters: DataDecodedParameter[] \| null;
34	}) {
35	this.method = args.method;	×
36	this.parameters = args.parameters;	×
37	}
38	}
39
40	export class CowSwapConfirmationView implements Baseline, OrderInfo {	94✔
41	// Baseline implementation
42	@ApiProperty({ enum: [DecodedType.CowSwapOrder] })
43	type = DecodedType.CowSwapOrder;	94✔
44
45	@ApiProperty()
46	method: string;	94✔
47
48	@ApiPropertyOptional({ type: [DataDecodedParameter], nullable: true })
49	parameters: DataDecodedParameter[] \| null;	94✔
50
51	// OrderInfo implementation
52	@ApiProperty({ description: 'The order UID' })
53	uid: string;	94✔
54
55	@ApiProperty({
56	enum: OrderStatus,
57	})
58	status: OrderStatus;	94✔
59
60	@ApiProperty({ enum: ['buy', 'sell'] })
61	kind: 'buy' \| 'sell';	94✔
62
63	@ApiProperty({
64	enum: OrderClass,
65	})
66	orderClass: OrderClass;	94✔
67
68	@ApiProperty({ description: 'The timestamp when the order expires' })
69	validUntil: number;	94✔
70
71	@ApiProperty({
72	description: 'The sell token raw amount (no decimals)',
73	})
74	sellAmount: string;	94✔
75
76	@ApiProperty({
77	description: 'The buy token raw amount (no decimals)',
78	})
79	buyAmount: string;	94✔
80
81	@ApiProperty({
82	description: 'The executed sell token raw amount (no decimals)',
83	})
84	executedSellAmount: string;	94✔
85
86	@ApiProperty({
87	description: 'The executed buy token raw amount (no decimals)',
88	})
89	executedBuyAmount: string;	94✔
90
91	@ApiProperty({
92	type: String,
93	description: 'The URL to the explorer page of the order',
94	})
95	explorerUrl: URL;	94✔
96
97	@ApiPropertyOptional({
98	type: String,
99	nullable: true,
100	description: 'The amount of fees paid for this order.',
101	})
102	executedSurplusFee: string \| null;	94✔
103
104	@ApiPropertyOptional({
105	type: String,
106	nullable: true,
107	description: 'The (optional) address to receive the proceeds of the trade',
108	})
109	receiver: string \| null;	94✔
110
111	@ApiPropertyOptional({
112	type: Object,
113	nullable: true,
114	description: 'The App Data for this order',
115	})
116	fullAppData: Record<string, unknown> \| null;	94✔
117
118	@ApiProperty({ description: 'The sell token of the order' })
119	sellToken: TokenInfo;	94✔
120
121	@ApiProperty({ description: 'The buy token of the order' })
122	buyToken: TokenInfo;	94✔
123
124	constructor(
125	args: Baseline & OrderInfo & { sellToken: TokenInfo; buyToken: TokenInfo },
126	) {
127	this.method = args.method;	×
128	this.parameters = args.parameters;	×
129	this.uid = args.uid;	×
130	this.status = args.status;	×
131	this.kind = args.kind;	×
132	this.orderClass = args.orderClass;	×
133	this.validUntil = args.validUntil;	×
134	this.sellAmount = args.sellAmount;	×
135	this.buyAmount = args.buyAmount;	×
136	this.executedSellAmount = args.executedSellAmount;	×
137	this.executedBuyAmount = args.executedBuyAmount;	×
138	this.explorerUrl = args.explorerUrl;	×
139	this.executedSurplusFee = args.executedSurplusFee;	×
140	this.sellToken = args.sellToken;	×
141	this.buyToken = args.buyToken;	×
NEW 142	this.receiver = args.receiver;	×
UNCOV 143	this.fullAppData = args.fullAppData;	×
144	}
145	}

safe-global / safe-client-gateway / 8819787228

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