safe-global / safe-client-gateway / 8784763765

89%

push

github

Add support for Swap orders in tx confirmation route (#1435)

Adds support for CoW Swap Orders in `POST chains/:chainId/safes/:safeAddress/views/transaction-confirmation` route. If a CoW Swap Order is found, the type of the Transaction Confirmation View would be of `COW_SWAP_ORDER`.

A `COW_SWAP_ORDER` confirmation view would have, in addition to what is returned by a `GENERIC` view, the properties of an `Order` (which can also be found on the transaction decoding done for the History and Queue endpoints).

The Cow Swap Confirmation view is returned if:
- The Order data was successfully retrieved
- The Token data (buy and sell) were successfully retrieved and is considered valid (e.g. with decimal information)
- The Order is considered valid (by the Safe{Wallet} standards) – e.g. order kind should not be `unknown`.

```
POST chains/:chainId/safes/:safeAddress/views/transaction-confirmation

{
  "type": COW_SWAP_ORDER",
  "method": "string",
  "parameters": "DataDecodedParameter[]",
  "uid": "string",
  "status": "presignaturePending | open | fulfilled | cancelled | expired | unknown",
  "kind": "buy | sell",
  "orderClass": "market | limit | liquidity | unknown",
  "validUntil": "number (timestamp)",
  "sellAmount": "string (raw amount, no decimals)",
  "buyAmount": "string (raw amount, no decimals)",
  "executedSellAmount": "string (raw amount, no decimals)",
  "executedBuyAmount": "string (raw amount, no decimals)",
  "explorerUrl": "URL (string format URL)",
  "executedSurplusFee": "string | null",
  "sellToken": "TokenInfo (object with properties of TokenInfo)",
  "buyToken": "TokenInfo (object with properties of TokenInfo)"
}
```

Changes:

- Adds a new `ConfirmationView` type – `CowSwapConfirmationView`.
- The `CowSwapConfirmationView` contains the baseline data expected for the Transaction Confirmation View screen plus the CoW Swap Order data if it was successfully retrieved.

1921 of 2339 branches covered (82.13%)

Branch coverage included in aggregate %.

37 of 68 new or added lines in 4 files covered. (54.41%)

6898 of 7223 relevant lines covered (95.5%)

311.61 hits per line