8785921024

Committed 22 Apr 2024 02:34PM UTC coverage: 92.171% (-0.04%) from 92.214%

Build # 8785921024

Build Type

push

github

Committed by

web-flow

Commit Message

Rename Order.class to Order.orderClass (#1439)

Renames `Order.class` to `Order.orderClass` to avoid using JS reserved keywords as property names – https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#reserved_words.

This was supposed to be included in becda8f8b but instead, the `status` property was the one renamed (it should remain as `status`).

## Changes

- Renames `class` to `orderClass`
- Renames `orderStatus` to `status`

Run Details

1816 of 2205 branches covered (82.36%)

Branch coverage included in aggregate %.

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

1 existing line in 1 file now uncovered.

6237 of 6532 relevant lines covered (95.48%)

344.71 hits per line

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

57.58

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

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

  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;
  }) {
    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;
  }
}

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

safe-global / safe-client-gateway / 8785921024

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