8753281205

Committed 19 Apr 2024 12:09PM UTC coverage: 92.676% (-0.001%) from 92.677%

Build # 8753281205

Build Type

push

github

Committed by

web-flow

Commit Message

Return non formatted Order data (#1426)

The service was previously following a render-ready approach when it came to Swap Orders (i.e.: pre-formatted labels that should be rendered as is).

While this approach is a valid one, the current setup that we have on the Wallet doesn't allow for this type of localisation to be driven by this web service.

Some examples include:
- Position of the currency symbol
- Use of comma vs period for thousands or decimals
- Difference in representation of negative amounts
- LTR vs RTL

Given that in the current state, the frontend clients are expected to have more information regarding the user localisation, this responsibility is then shifted from the CGW to the clients.

This has a couple implications on the API:
- Removes the following labels (they now need to be computed on the client side):
  * feeLabel
  * executionPriceLabel
  * surplusLabel
  * filledPercentage
- Extends the `TokenInfo` with:
  * Token name
  * trusted status
- Token amounts are now returned without decimals (correct decimal formatting should be set by the clients).


{
  "type": "SwapOrder",
  "uid": "string",
  "status": "presignaturePending | open | fulfilled | cancelled | expired | unknown",
  "kind": "buy | sell",
  "class": "market | limit | liquidity | unknown"
  "validUntil": "number",
  "sellAmount": "string",
  "buyAmount": "string",
  "executedSellAmount": "string",
  "executedBuyAmount": "string",
  "sellToken": "TokenInfo", // see below
  "buyToken": "TokenInfo",  // see below
  "explorerUrl": "URL",
  "executedSurplusFee": "string | null"
}

"TokenInfo": {
  "address": "0x{string}",
  "decimals": "number",
  "logoUri": "string | null",
  "name": "string",
  "symbol": "string",
  "trusted": "boolean"
}

Run Details

1929 of 2326 branches covered (82.93%)

Branch coverage included in aggregate %.

58 of 59 new or added lines in 5 files covered. (98.31%)

1 existing line in 1 file now uncovered.

6840 of 7136 relevant lines covered (95.85%)

308.28 hits per line

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

80.0

/src/routes/transactions/entities/__tests__/human-description.builder.ts

import { Builder, IBuilder } from '@/__tests__/builder';
import {
  RichAddressFragment,
  RichTokenValueFragment,
  RichTextFragment,
  RichDecodedInfoFragment,
  RichFragmentType,
} from '@/routes/transactions/entities/human-description.entity';
import { faker } from '@faker-js/faker';

function richTokenValueFragmentBuilder(): IBuilder<RichTokenValueFragment> {
  return new Builder<RichTokenValueFragment>()
    .with('type', RichFragmentType.TokenValue)
    .with('value', faker.string.numeric())
    .with('symbol', faker.finance.currencySymbol())
    .with('logoUri', faker.image.avatar());
}

function richTextFragmentBuilder(): IBuilder<RichTextFragment> {
  return new Builder<RichTextFragment>()
    .with('type', RichFragmentType.Text)
    .with('value', faker.word.words());
}

function richAddressFragmentBuilder(): IBuilder<RichAddressFragment> {
  return new Builder<RichAddressFragment>()
    .with('type', RichFragmentType.Address)
    .with('value', faker.finance.ethereumAddress());
}

const humanDescriptionBuilders: Array<() => IBuilder<RichDecodedInfoFragment>> =
  [
    richTokenValueFragmentBuilder,
    richTextFragmentBuilder,
    richAddressFragmentBuilder,
  ];

export function buildHumanDescription(): RichDecodedInfoFragment[] {
  return Array.from({ length: faker.number.int({ min: 0, max: 6 }) }, () =>
    faker.helpers.arrayElement(humanDescriptionBuilders)().build(),
  );
}

1	import { Builder, IBuilder } from '@/__tests__/builder';	2✔
2	import {	2✔
3	RichAddressFragment,
4	RichTokenValueFragment,
5	RichTextFragment,
6	RichDecodedInfoFragment,
7	RichFragmentType,
8	} from '@/routes/transactions/entities/human-description.entity';
9	import { faker } from '@faker-js/faker';	2✔
10
11	function richTokenValueFragmentBuilder(): IBuilder<RichTokenValueFragment> {
12	return new Builder<RichTokenValueFragment>()	×
13	.with('type', RichFragmentType.TokenValue)
14	.with('value', faker.string.numeric())
15	.with('symbol', faker.finance.currencySymbol())
16	.with('logoUri', faker.image.avatar());
17	}
18
19	function richTextFragmentBuilder(): IBuilder<RichTextFragment> {
20	return new Builder<RichTextFragment>()	8✔
21	.with('type', RichFragmentType.Text)
22	.with('value', faker.word.words());
23	}
24
25	function richAddressFragmentBuilder(): IBuilder<RichAddressFragment> {
UNCOV 26	return new Builder<RichAddressFragment>()	×
27	.with('type', RichFragmentType.Address)
28	.with('value', faker.finance.ethereumAddress());
29	}
30
31	const humanDescriptionBuilders: Array<() => IBuilder<RichDecodedInfoFragment>> =
32	[	2✔
33	richTokenValueFragmentBuilder,
34	richTextFragmentBuilder,
35	richAddressFragmentBuilder,
36	];
37
38	export function buildHumanDescription(): RichDecodedInfoFragment[] {	2✔
39	return Array.from({ length: faker.number.int({ min: 0, max: 6 }) }, () =>	2✔
40	faker.helpers.arrayElement(humanDescriptionBuilders)().build(),	8✔
41	);
42	}

safe-global / safe-client-gateway / 8753281205

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