feat(comlink): ✨ add pagination for getTrades and getFills

dydxprotocol · Mar 26, 2024 · 635dcd6 · 635dcd6
1 parent 4dac677
commit 635dcd6
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 5 deletions.
diff --git a/indexer/services/comlink/public/api-documentation.md b/indexer/services/comlink/public/api-documentation.md
@@ -688,6 +688,7 @@ fetch('https://dydx-testnet.imperator.co/v4/fills?address=string&subaccountNumbe
 |limit|query|number(double)|false|none|
 |createdBeforeOrAtHeight|query|number(double)|false|none|
 |createdBeforeOrAt|query|[IsoString](#schemaisostring)|false|none|
+|page|query|number(double)|false|none|
 
 #### Enumerated Values
 
@@ -702,6 +703,9 @@ fetch('https://dydx-testnet.imperator.co/v4/fills?address=string&subaccountNumbe
 
 ```json
 {
+  "pageSize": 0,
+  "totalResults": 0,
+  "offset": 0,
   "fills": [
     {
       "id": "string",
@@ -800,6 +804,9 @@ fetch('https://dydx-testnet.imperator.co/v4/fills/parentSubaccount?address=strin
 
 ```json
 {
+  "pageSize": 0,
+  "totalResults": 0,
+  "offset": 0,
   "fills": [
     {
       "id": "string",
@@ -1966,13 +1973,17 @@ fetch('https://dydx-testnet.imperator.co/v4/trades/perpetualMarket/{ticker}',
 |limit|query|number(double)|false|none|
 |createdBeforeOrAtHeight|query|number(double)|false|none|
 |createdBeforeOrAt|query|[IsoString](#schemaisostring)|false|none|
+|page|query|number(double)|false|none|
 
 > Example responses
 
 > 200 Response
 
 ```json
 {
+  "pageSize": 0,
+  "totalResults": 0,
+  "offset": 0,
   "trades": [
     {
       "id": "string",
@@ -2968,6 +2979,9 @@ This operation does not require authentication
 
 ```json
 {
+  "pageSize": 0,
+  "totalResults": 0,
+  "offset": 0,
   "fills": [
     {
       "id": "string",
@@ -2994,6 +3008,9 @@ This operation does not require authentication
 
 |Name|Type|Required|Restrictions|Description|
 |---|---|---|---|---|
+|pageSize|number(double)|false|none|none|
+|totalResults|number(double)|false|none|none|
+|offset|number(double)|false|none|none|
 |fills|[[FillResponseObject](#schemafillresponseobject)]|true|none|none|
 
 ## HeightResponse
@@ -3845,6 +3862,9 @@ or
 
 ```json
 {
+  "pageSize": 0,
+  "totalResults": 0,
+  "offset": 0,
   "trades": [
     {
       "id": "string",
@@ -3864,6 +3884,9 @@ or
 
 |Name|Type|Required|Restrictions|Description|
 |---|---|---|---|---|
+|pageSize|number(double)|false|none|none|
+|totalResults|number(double)|false|none|none|
+|offset|number(double)|false|none|none|
 |trades|[[TradeResponseObject](#schematraderesponseobject)]|true|none|none|
 
 ## TransferType

diff --git a/indexer/services/comlink/public/swagger.json b/indexer/services/comlink/public/swagger.json
@@ -471,6 +471,18 @@
       },
       "FillResponse": {
         "properties": {
+          "pageSize": {
+            "type": "number",
+            "format": "double"
+          },
+          "totalResults": {
+            "type": "number",
+            "format": "double"
+          },
+          "offset": {
+            "type": "number",
+            "format": "double"
+          },
           "fills": {
             "items": {
               "$ref": "#/components/schemas/FillResponseObject"
@@ -1066,6 +1078,18 @@
       },
       "TradeResponse": {
         "properties": {
+          "pageSize": {
+            "type": "number",
+            "format": "double"
+          },
+          "totalResults": {
+            "type": "number",
+            "format": "double"
+          },
+          "offset": {
+            "type": "number",
+            "format": "double"
+          },
           "trades": {
             "items": {
               "$ref": "#/components/schemas/TradeResponseObject"
@@ -1523,6 +1547,15 @@
             "schema": {
               "$ref": "#/components/schemas/IsoString"
             }
+          },
+          {
+            "in": "query",
+            "name": "page",
+            "required": false,
+            "schema": {
+              "format": "double",
+              "type": "number"
+            }
           }
         ]
       }
@@ -2246,6 +2279,15 @@
             "schema": {
               "$ref": "#/components/schemas/IsoString"
             }
+          },
+          {
+            "in": "query",
+            "name": "page",
+            "required": false,
+            "schema": {
+              "format": "double",
+              "type": "number"
+            }
           }
         ]
       }

diff --git a/indexer/services/comlink/src/controllers/api/v4/fills-controller.ts b/indexer/services/comlink/src/controllers/api/v4/fills-controller.ts
@@ -55,6 +55,7 @@ class FillsController extends Controller {
       @Query() limit?: number,
       @Query() createdBeforeOrAtHeight?: number,
       @Query() createdBeforeOrAt?: IsoString,
+      @Query() page?: number,
   ): Promise<FillResponse> {
     // TODO(DEC-656): Change to using a cache of markets in Redis similar to Librarian instead of
     // querying the DB.
@@ -68,7 +69,12 @@ class FillsController extends Controller {
     }
 
     const subaccountId: string = SubaccountTable.uuid(address, subaccountNumber);
-    const fills: FillFromDatabase[] = await FillTable.findAll(
+    const {
+      results: fills,
+      limit: pageSize,
+      offset,
+      total,
+    } = await FillTable.findAll(
       {
         subaccountId: [subaccountId],
         clobPairId,
@@ -77,6 +83,7 @@ class FillsController extends Controller {
           ? createdBeforeOrAtHeight.toString()
           : undefined,
         createdBeforeOrAt,
+        page,
       },
       [QueryableField.LIMIT],
     );
@@ -98,6 +105,9 @@ class FillsController extends Controller {
       fills: fills.map((fill: FillFromDatabase): FillResponseObject => {
         return fillToResponseObject(fill, clobPairIdToMarket, subaccountNumber);
       }),
+      pageSize,
+      totalResults: total,
+      offset,
     };
   }
 
@@ -132,7 +142,7 @@ class FillsController extends Controller {
     );
     const subaccountIds: string[] = Object.keys(childIdtoSubaccountNumber);
 
-    const fills: FillFromDatabase[] = await FillTable.findAll(
+    const { results: fills } = await FillTable.findAll(
       {
         subaccountId: subaccountIds,
         clobPairId,

diff --git a/indexer/services/comlink/src/controllers/api/v4/trades-controller.ts b/indexer/services/comlink/src/controllers/api/v4/trades-controller.ts
@@ -45,6 +45,7 @@ class TradesController extends Controller {
       @Query() limit?: number,
       @Query() createdBeforeOrAtHeight?: number,
       @Query() createdBeforeOrAt?: IsoString,
+      @Query() page?: number,
   ): Promise<TradeResponse> {
     const clobPairId: string | undefined = perpetualMarketRefresher
       .getClobPairIdFromTicker(ticker);
@@ -53,7 +54,12 @@ class TradesController extends Controller {
       throw new NotFoundError(`${ticker} not found in tickers of type ${MarketType.PERPETUAL}`);
     }
 
-    const fills: FillFromDatabase[] = await FillTable.findAll(
+    const {
+      results: fills,
+      limit: pageSize,
+      offset,
+      total,
+    } = await FillTable.findAll(
       {
         clobPairId,
         liquidity: Liquidity.TAKER,
@@ -62,6 +68,7 @@ class TradesController extends Controller {
           ? createdBeforeOrAtHeight.toString()
           : undefined,
         createdBeforeOrAt,
+        page,
       },
       [QueryableField.LIQUIDITY, QueryableField.CLOB_PAIR_ID, QueryableField.LIMIT],
     );
@@ -70,6 +77,9 @@ class TradesController extends Controller {
       trades: fills.map((fill: FillFromDatabase): TradeResponseObject => {
         return fillToTradeResponseObject(fill);
       }),
+      pageSize,
+      totalResults: total,
+      offset,
     };
   }
 }

diff --git a/indexer/services/comlink/src/types.ts b/indexer/services/comlink/src/types.ts
@@ -127,7 +127,7 @@ export type AssetPositionsMap = { [symbol: string]: AssetPositionResponseObject
 
 /* ------- FILL TYPES ------- */
 
-export interface FillResponse {
+export interface FillResponse extends PaginationResponse {
   fills: FillResponseObject[],
 }
 
@@ -191,7 +191,7 @@ export interface PnlTicksResponseObject {
 
 /* ------- TRADE TYPES ------- */
 
-export interface TradeResponse {
+export interface TradeResponse extends PaginationResponse {
   trades: TradeResponseObject[],
 }