8820226670

Committed 24 Apr 2024 04:47PM UTC coverage: 92.393% (-0.02%) from 92.411%

Build # 8820226670

Build Type

push

github

Committed by

web-flow

Commit Message

Forward the Order receiver (#1452)

A CoW Swap Order contains an optional `receiver` which represents the target address that should receive the proceeds from the trade. This field is required by the clients of this service API so it should be forwarded.

Changes:

- Forwards the Order `receiver` in the Confirmation View and Transaction decoding

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%)

2 existing lines in 2 files now uncovered.

6882 of 7191 relevant lines covered (95.7%)

307.1 hits per line

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

56.76

/src/routes/transactions/entities/swaps/swap-order-info.entity.ts

import {
  TransactionInfo,
  TransactionInfoType,
} from '@/routes/transactions/entities/transaction-info.entity';
import {
  ApiExtraModels,
  ApiProperty,
  ApiPropertyOptional,
} from '@nestjs/swagger';
import { OrderClass, OrderStatus } from '@/domain/swaps/entities/order.entity';
import { TokenInfo } from '@/routes/transactions/entities/swaps/token-info.entity';

export interface OrderInfo {
  uid: string;
  status: OrderStatus;
  kind: 'buy' | 'sell';
  orderClass: OrderClass;
  validUntil: number;
  sellAmount: string;
  buyAmount: string;
  executedSellAmount: string;
  executedBuyAmount: string;
  explorerUrl: URL;
  executedSurplusFee: string | null;
  receiver: string | null;
  fullAppData: Record<string, unknown> | null;
}

@ApiExtraModels(TokenInfo)
export class SwapOrderTransactionInfo
  extends TransactionInfo
  implements OrderInfo
{
  @ApiProperty({ enum: [TransactionInfoType.SwapOrder] })
  override type = TransactionInfoType.SwapOrder;

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

  constructor(args: {
    uid: string;
    orderStatus: OrderStatus;
    kind: 'buy' | 'sell';
    class: OrderClass;
    validUntil: number;
    sellAmount: string;
    buyAmount: string;
    executedSellAmount: string;
    executedBuyAmount: string;
    sellToken: TokenInfo;
    buyToken: TokenInfo;
    explorerUrl: URL;
    executedSurplusFee: string | null;
    receiver: string | null;
    fullAppData: Record<string, unknown> | null;
  }) {
    super(TransactionInfoType.SwapOrder, null, null);
    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.fullAppData = args.fullAppData;
  }
}

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

safe-global / safe-client-gateway / 8820226670

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