safe-global / safe-client-gateway / 8753281205

89%

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