add orderId param to getTrades cow api method

cowprotocol · Jun 8, 2022 · 688038b · 688038b
1 parent e3322fa
commit 688038b
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 6 deletions.
diff --git a/src/api/cow/cow.spec.ts b/src/api/cow/cow.spec.ts
@@ -265,6 +265,22 @@ test('Valid: Get last 5 trades for a given trader ', async () => {
   expect(trades.length).toEqual(5)
 })
 
+test('Valid: Get last 5 trades for a given order id ', async () => {
+  const TRADES_RESPONSE = Array(5).fill(TRADE_RESPONSE)
+  fetchMock.mockResponseOnce(JSON.stringify(TRADES_RESPONSE), { status: HTTP_STATUS_OK })
+  const trades = await cowSdk.cowApi.getTrades({
+    orderId: TRADE_RESPONSE.orderUid,
+    limit: 5,
+    offset: 0,
+  })
+  expect(fetchMock).toHaveBeenCalledTimes(1)
+  expect(fetchMock).toHaveBeenCalledWith(
+    `https://api.cow.fi/rinkeby/api/v1/trades?orderUid=${TRADE_RESPONSE.orderUid}&limit=5`,
+    FETCH_RESPONSE_PARAMETERS
+  )
+  expect(trades.length).toEqual(5)
+})
+
 test('Invalid: Get last 5 trades for an unexisting trader ', async () => {
   fetchMock.mockResponseOnce(
     JSON.stringify({

diff --git a/src/api/cow/index.ts b/src/api/cow/index.ts
@@ -127,10 +127,13 @@ export class CowApi {
   }
 
   async getTrades(params: GetTradesParams): Promise<TradeMetaData[]> {
-    const { owner, limit, offset } = params
-    const qsParams = objectToQueryString({ owner, limit, offset })
+    const { owner, orderId, limit, offset } = params
+    if (owner && orderId) {
+      throw new CowError('Cannot specify both owner and orderId')
+    }
+    const qsParams = objectToQueryString({ owner, orderUid: orderId, limit, offset })
     const chainId = await this.context.chainId
-    log.debug(logPrefix, '[util:operator] Get trades for', chainId, owner, { limit, offset })
+    log.debug(logPrefix, '[util:operator] Get trades for', chainId, { owner, orderId, limit, offset })
     try {
       const response = await this.get(`/trades${qsParams}`)
 

diff --git a/src/api/cow/types.ts b/src/api/cow/types.ts
@@ -1,4 +1,5 @@
 import { GetQuoteResponse, OrderKind } from '@gnosis.pm/gp-v2-contracts'
+import { StrictUnion } from 'utilities'
 import { SupportedChainId as ChainId } from '../../constants/chains'
 import { OrderCancellation, SigningSchemeValue } from '../../utils/sign'
 
@@ -69,9 +70,13 @@ export type GetOrdersParams = {
   owner: string
 } & PaginationParams
 
-export type GetTradesParams = {
-  owner: string
-} & PaginationParams
+export type GetTradesParams = StrictUnion<
+  | {
+      owner: string
+    }
+  | { orderId: string }
+> &
+  PaginationParams
 
 export type ProfileData = {
   totalTrades: number

diff --git a/src/types/utilities.d.ts b/src/types/utilities.d.ts
@@ -0,0 +1,3 @@
+type UnionKeys<T> = T extends T ? keyof T : never
+type StrictUnionHelper<T, TAll> = T extends any ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>> : never
+export type StrictUnion<T> = StrictUnionHelper<T, T>