@cowprotocol/sdk-order-book 0.3.2 → 0.4.0

package/dist/index.d.mts

@@ -1121,6 +1121,15 @@ type GetOrdersRequest = {
     offset?: number;
     limit?: number;
 };
+/**
+ * The parameters for the `getTrades` request.
+ */
+type GetTradesRequest = {
+    owner?: Address;
+    orderUid?: UID;
+    offset?: number;
+    limit?: number;
+};
 /**
  * The CoW Protocol OrderBook API client.
  *
@@ -1204,10 +1213,7 @@ declare class OrderBookApi {
      * @param contextOverride Optional context override for this request.
      * @returns A list of trades matching the request.
      */
-    getTrades(request: {
-        owner?: Address;
-        orderUid?: UID;
-    }, contextOverride?: PartialApiContext): Promise<Array<Trade>>;
+    getTrades(request: GetTradesRequest, contextOverride?: PartialApiContext): Promise<Array<Trade>>;
     /**
      * Get a list of orders for a given `owner`.
      * @param request The request parameters with `request.offset = 0` and `request.limit = 1000` by default.
@@ -1419,4 +1425,4 @@ type BigNumber = {
  */
 declare function getBigNumber(value: string | bigint | number, decimals: number): BigNumber;
 
-export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type Quote, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getBigNumber, getQuoteAmountsAndCosts, getQuoteAmountsWithCosts, request };
+export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type GetTradesRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type Quote, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getBigNumber, getQuoteAmountsAndCosts, getQuoteAmountsWithCosts, request };

package/dist/index.d.ts

@@ -1121,6 +1121,15 @@ type GetOrdersRequest = {
     offset?: number;
     limit?: number;
 };
+/**
+ * The parameters for the `getTrades` request.
+ */
+type GetTradesRequest = {
+    owner?: Address;
+    orderUid?: UID;
+    offset?: number;
+    limit?: number;
+};
 /**
  * The CoW Protocol OrderBook API client.
  *
@@ -1204,10 +1213,7 @@ declare class OrderBookApi {
      * @param contextOverride Optional context override for this request.
      * @returns A list of trades matching the request.
      */
-    getTrades(request: {
-        owner?: Address;
-        orderUid?: UID;
-    }, contextOverride?: PartialApiContext): Promise<Array<Trade>>;
+    getTrades(request: GetTradesRequest, contextOverride?: PartialApiContext): Promise<Array<Trade>>;
     /**
      * Get a list of orders for a given `owner`.
      * @param request The request parameters with `request.offset = 0` and `request.limit = 1000` by default.
@@ -1419,4 +1425,4 @@ type BigNumber = {
  */
 declare function getBigNumber(value: string | bigint | number, decimals: number): BigNumber;
 
-export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type Quote, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getBigNumber, getQuoteAmountsAndCosts, getQuoteAmountsWithCosts, request };
+export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type GetTradesRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type Quote, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getBigNumber, getQuoteAmountsAndCosts, getQuoteAmountsWithCosts, request };

package/dist/index.js

@@ -247,7 +247,9 @@ var OrderBookApi = class {
     } else if (!request2.owner && !request2.orderUid) {
       return Promise.reject(new import_sdk_common.CowError("Must specify either owner or orderId"));
     }
-    const query = new URLSearchParams(cleanObjectFromUndefinedValues(request2));
+    const { offset = 0, limit = 10, ...rest } = request2;
+    const params = { ...rest, offset: offset.toString(), limit: limit.toString() };
+    const query = new URLSearchParams(cleanObjectFromUndefinedValues(params));
     return this.fetch({ path: "/api/v1/trades", method: "GET", query }, contextOverride);
   }
   /**

package/dist/index.mjs

@@ -201,7 +201,9 @@ var OrderBookApi = class {
     } else if (!request2.owner && !request2.orderUid) {
       return Promise.reject(new CowError("Must specify either owner or orderId"));
     }
-    const query = new URLSearchParams(cleanObjectFromUndefinedValues(request2));
+    const { offset = 0, limit = 10, ...rest } = request2;
+    const params = { ...rest, offset: offset.toString(), limit: limit.toString() };
+    const query = new URLSearchParams(cleanObjectFromUndefinedValues(params));
     return this.fetch({ path: "/api/v1/trades", method: "GET", query }, contextOverride);
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-order-book",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "CowProtocol Order Book package",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",