@cowprotocol/sdk-order-book 3.2.1 → 4.0.0

package/README.md

@@ -4,6 +4,12 @@
 
 # SDK Order Book
 
+## Test coverage
+
+| Statements                  | Branches                | Functions                 | Lines             |
+| --------------------------- | ----------------------- | ------------------------- | ----------------- |
+| ![Statements](https://img.shields.io/badge/statements-86.89%25-yellow.svg?style=flat) | ![Branches](https://img.shields.io/badge/branches-77%25-red.svg?style=flat) | ![Functions](https://img.shields.io/badge/functions-88.09%25-yellow.svg?style=flat) | ![Lines](https://img.shields.io/badge/lines-87.06%25-yellow.svg?style=flat) |
+
 This package provides a comprehensive API client for interacting with the CoW Protocol Order Book. It handles order submission, retrieval, cancellation, and trading data with built-in rate limiting, retries, and error handling.
 
 ## Installation

package/dist/index.d.mts

@@ -832,7 +832,7 @@ type DebugOrderResponse = {
 /**
  * How was the order signed?
  */
-declare enum EcdsaSigningScheme {
+declare enum EcdsaSigningScheme$1 {
     EIP712 = "eip712",
     ETHSIGN = "ethsign"
 }
@@ -859,12 +859,12 @@ type NativePriceResponse = {
  * `OrderCancellation(bytes orderUid)` from the order's owner.
  *
  */
-type OrderCancellation = {
+type OrderCancellation$1 = {
     /**
      * OrderCancellation signed by owner
      */
     signature: EcdsaSignature;
-    signingScheme: EcdsaSigningScheme;
+    signingScheme: EcdsaSigningScheme$1;
 };
 
 type OrderCancellationError = {
@@ -887,7 +887,7 @@ declare namespace OrderCancellationError {
  * EIP-712 signature of struct OrderCancellations { orderUid: bytes[] } from the order's owner.
  *
  */
-type OrderCancellations = {
+type OrderCancellations$1 = {
     /**
      * Up to 128 UIDs of orders to cancel.
      */
@@ -896,7 +896,7 @@ type OrderCancellations = {
      * `OrderCancellation` signed by the owner.
      */
     signature: EcdsaSignature;
-    signingScheme: EcdsaSigningScheme;
+    signingScheme: EcdsaSigningScheme$1;
 };
 
 /**
@@ -1609,6 +1609,74 @@ interface QuoteAmountsAndCosts<T = bigint> {
     amountsToSign: Amounts<T>;
 }
 
+/**
+ * The subset of {@link SigningScheme} values that can be produced by signing an
+ * order with an ECDSA key (i.e. `eip712` and `ethsign`).
+ *
+ * The orderbook OpenAPI spec models `EcdsaSigningScheme` and `SigningScheme` as
+ * two independent string enums. When generated as TypeScript `enum`s they become
+ * nominally unrelated types, so an `EcdsaSigningScheme` value is not assignable
+ * to a `SigningScheme` field even though every `EcdsaSigningScheme` value is a
+ * valid `SigningScheme` value.
+ *
+ * This caused a type error in the documented low-level flow, where the result of
+ * `OrderSigningUtils.signOrder()` (which carries `EcdsaSigningScheme`) is spread
+ * into the `OrderCreation` body of `OrderBookApi.sendOrder()` (which expects
+ * `SigningScheme`):
+ *
+ * ```ts
+ * const { quote } = await orderBookApi.getQuote(quoteRequest)
+ * const orderSigningResult = await OrderSigningUtils.signOrder(quote, chainId, signer)
+ * // previously failed: EcdsaSigningScheme not assignable to SigningScheme
+ * const orderId = await orderBookApi.sendOrder({ ...quote, ...orderSigningResult })
+ * ```
+ *
+ * To fix this `EcdsaSigningScheme` is defined here as a genuine subset of
+ * `SigningScheme` rather than a standalone enum. It keeps the same runtime values
+ * and member names, so existing usages (`EcdsaSigningScheme.EIP712`,
+ * `Record<EcdsaSigningScheme, T>`, etc.) keep working, while values are now
+ * assignable to `SigningScheme`.
+ *
+ * @see https://github.com/cowprotocol/cow-sdk/issues/187
+ */
+declare const EcdsaSigningScheme: {
+    readonly EIP712: SigningScheme.EIP712;
+    readonly ETHSIGN: SigningScheme.ETHSIGN;
+};
+/**
+ * How was the order signed?
+ *
+ * Subset of {@link SigningScheme} restricted to the schemes produced by ECDSA
+ * signing (`eip712` and `ethsign`). Values are assignable to `SigningScheme`.
+ */
+type EcdsaSigningScheme = (typeof EcdsaSigningScheme)[keyof typeof EcdsaSigningScheme];
+/**
+ * Data a user provides when cancelling a single order.
+ *
+ * Re-typed on top of the generated `OrderCancellation` so its `signingScheme`
+ * uses the {@link EcdsaSigningScheme} subset of `SigningScheme`. This keeps the
+ * result of `OrderSigningUtils.signOrderCancellation()` directly assignable to
+ * this type.
+ *
+ * @see https://github.com/cowprotocol/cow-sdk/issues/187
+ */
+type OrderCancellation = Omit<OrderCancellation$1, 'signingScheme'> & {
+    signingScheme: EcdsaSigningScheme;
+};
+/**
+ * Data a user provides when cancelling multiple orders.
+ *
+ * Re-typed on top of the generated `OrderCancellations` so its `signingScheme`
+ * uses the {@link EcdsaSigningScheme} subset of `SigningScheme`. This keeps the
+ * result of `OrderSigningUtils.signOrderCancellations()` directly assignable to
+ * this type.
+ *
+ * @see https://github.com/cowprotocol/cow-sdk/issues/187
+ */
+type OrderCancellations = Omit<OrderCancellations$1, 'signingScheme'> & {
+    signingScheme: EcdsaSigningScheme;
+};
+
 /**
  * An object containing *production* environment base URLs for each supported `chainId`.
  * @see {@link https://api.cow.fi/docs/#/}

package/dist/index.d.ts

@@ -832,7 +832,7 @@ type DebugOrderResponse = {
 /**
  * How was the order signed?
  */
-declare enum EcdsaSigningScheme {
+declare enum EcdsaSigningScheme$1 {
     EIP712 = "eip712",
     ETHSIGN = "ethsign"
 }
@@ -859,12 +859,12 @@ type NativePriceResponse = {
  * `OrderCancellation(bytes orderUid)` from the order's owner.
  *
  */
-type OrderCancellation = {
+type OrderCancellation$1 = {
     /**
      * OrderCancellation signed by owner
      */
     signature: EcdsaSignature;
-    signingScheme: EcdsaSigningScheme;
+    signingScheme: EcdsaSigningScheme$1;
 };
 
 type OrderCancellationError = {
@@ -887,7 +887,7 @@ declare namespace OrderCancellationError {
  * EIP-712 signature of struct OrderCancellations { orderUid: bytes[] } from the order's owner.
  *
  */
-type OrderCancellations = {
+type OrderCancellations$1 = {
     /**
      * Up to 128 UIDs of orders to cancel.
      */
@@ -896,7 +896,7 @@ type OrderCancellations = {
      * `OrderCancellation` signed by the owner.
      */
     signature: EcdsaSignature;
-    signingScheme: EcdsaSigningScheme;
+    signingScheme: EcdsaSigningScheme$1;
 };
 
 /**
@@ -1609,6 +1609,74 @@ interface QuoteAmountsAndCosts<T = bigint> {
     amountsToSign: Amounts<T>;
 }
 
+/**
+ * The subset of {@link SigningScheme} values that can be produced by signing an
+ * order with an ECDSA key (i.e. `eip712` and `ethsign`).
+ *
+ * The orderbook OpenAPI spec models `EcdsaSigningScheme` and `SigningScheme` as
+ * two independent string enums. When generated as TypeScript `enum`s they become
+ * nominally unrelated types, so an `EcdsaSigningScheme` value is not assignable
+ * to a `SigningScheme` field even though every `EcdsaSigningScheme` value is a
+ * valid `SigningScheme` value.
+ *
+ * This caused a type error in the documented low-level flow, where the result of
+ * `OrderSigningUtils.signOrder()` (which carries `EcdsaSigningScheme`) is spread
+ * into the `OrderCreation` body of `OrderBookApi.sendOrder()` (which expects
+ * `SigningScheme`):
+ *
+ * ```ts
+ * const { quote } = await orderBookApi.getQuote(quoteRequest)
+ * const orderSigningResult = await OrderSigningUtils.signOrder(quote, chainId, signer)
+ * // previously failed: EcdsaSigningScheme not assignable to SigningScheme
+ * const orderId = await orderBookApi.sendOrder({ ...quote, ...orderSigningResult })
+ * ```
+ *
+ * To fix this `EcdsaSigningScheme` is defined here as a genuine subset of
+ * `SigningScheme` rather than a standalone enum. It keeps the same runtime values
+ * and member names, so existing usages (`EcdsaSigningScheme.EIP712`,
+ * `Record<EcdsaSigningScheme, T>`, etc.) keep working, while values are now
+ * assignable to `SigningScheme`.
+ *
+ * @see https://github.com/cowprotocol/cow-sdk/issues/187
+ */
+declare const EcdsaSigningScheme: {
+    readonly EIP712: SigningScheme.EIP712;
+    readonly ETHSIGN: SigningScheme.ETHSIGN;
+};
+/**
+ * How was the order signed?
+ *
+ * Subset of {@link SigningScheme} restricted to the schemes produced by ECDSA
+ * signing (`eip712` and `ethsign`). Values are assignable to `SigningScheme`.
+ */
+type EcdsaSigningScheme = (typeof EcdsaSigningScheme)[keyof typeof EcdsaSigningScheme];
+/**
+ * Data a user provides when cancelling a single order.
+ *
+ * Re-typed on top of the generated `OrderCancellation` so its `signingScheme`
+ * uses the {@link EcdsaSigningScheme} subset of `SigningScheme`. This keeps the
+ * result of `OrderSigningUtils.signOrderCancellation()` directly assignable to
+ * this type.
+ *
+ * @see https://github.com/cowprotocol/cow-sdk/issues/187
+ */
+type OrderCancellation = Omit<OrderCancellation$1, 'signingScheme'> & {
+    signingScheme: EcdsaSigningScheme;
+};
+/**
+ * Data a user provides when cancelling multiple orders.
+ *
+ * Re-typed on top of the generated `OrderCancellations` so its `signingScheme`
+ * uses the {@link EcdsaSigningScheme} subset of `SigningScheme`. This keeps the
+ * result of `OrderSigningUtils.signOrderCancellations()` directly assignable to
+ * this type.
+ *
+ * @see https://github.com/cowprotocol/cow-sdk/issues/187
+ */
+type OrderCancellations = Omit<OrderCancellations$1, 'signingScheme'> & {
+    signingScheme: EcdsaSigningScheme;
+};
+
 /**
  * An object containing *production* environment base URLs for each supported `chainId`.
  * @see {@link https://api.cow.fi/docs/#/}

package/dist/index.js

@@ -450,7 +450,7 @@ var OrderBookApi = class {
   getSolverCompetition(auctionIdorTx, contextOverride = {}) {
     return this.fetch(
       {
-        path: `/api/v1/solver_competition${typeof auctionIdorTx === "string" ? "/by_tx_hash" : ""}/${auctionIdorTx}`,
+        path: `/api/v2/solver_competition${typeof auctionIdorTx === "string" ? "/by_tx_hash" : ""}/${auctionIdorTx}`,
         method: "GET"
       },
       contextOverride
@@ -542,13 +542,6 @@ var DebugFeePolicy;
   })(kind = DebugFeePolicy2.kind || (DebugFeePolicy2.kind = {}));
 })(DebugFeePolicy || (DebugFeePolicy = {}));
 
-// src/generated/models/EcdsaSigningScheme.ts
-var EcdsaSigningScheme = /* @__PURE__ */ ((EcdsaSigningScheme2) => {
-  EcdsaSigningScheme2["EIP712"] = "eip712";
-  EcdsaSigningScheme2["ETHSIGN"] = "ethsign";
-  return EcdsaSigningScheme2;
-})(EcdsaSigningScheme || {});
-
 // src/generated/models/OnchainOrderData.ts
 var OnchainOrderData;
 ((OnchainOrderData2) => {
@@ -846,6 +839,12 @@ function getQuoteAmountsAndCosts(params) {
     amountsToSign
   };
 }
+
+// src/signingSchemes.ts
+var EcdsaSigningScheme = {
+  EIP712: "eip712" /* EIP712 */,
+  ETHSIGN: "ethsign" /* ETHSIGN */
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BuyTokenDestination,

package/dist/index.mjs

@@ -399,7 +399,7 @@ var OrderBookApi = class {
   getSolverCompetition(auctionIdorTx, contextOverride = {}) {
     return this.fetch(
       {
-        path: `/api/v1/solver_competition${typeof auctionIdorTx === "string" ? "/by_tx_hash" : ""}/${auctionIdorTx}`,
+        path: `/api/v2/solver_competition${typeof auctionIdorTx === "string" ? "/by_tx_hash" : ""}/${auctionIdorTx}`,
         method: "GET"
       },
       contextOverride
@@ -491,13 +491,6 @@ var DebugFeePolicy;
   })(kind = DebugFeePolicy2.kind || (DebugFeePolicy2.kind = {}));
 })(DebugFeePolicy || (DebugFeePolicy = {}));
 
-// src/generated/models/EcdsaSigningScheme.ts
-var EcdsaSigningScheme = /* @__PURE__ */ ((EcdsaSigningScheme2) => {
-  EcdsaSigningScheme2["EIP712"] = "eip712";
-  EcdsaSigningScheme2["ETHSIGN"] = "ethsign";
-  return EcdsaSigningScheme2;
-})(EcdsaSigningScheme || {});
-
 // src/generated/models/OnchainOrderData.ts
 var OnchainOrderData;
 ((OnchainOrderData2) => {
@@ -795,6 +788,12 @@ function getQuoteAmountsAndCosts(params) {
     amountsToSign
   };
 }
+
+// src/signingSchemes.ts
+var EcdsaSigningScheme = {
+  EIP712: "eip712" /* EIP712 */,
+  ETHSIGN: "ethsign" /* ETHSIGN */
+};
 export {
   BuyTokenDestination,
   CompetitionOrderStatus,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-order-book",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "CowProtocol Order Book package",
   "repository": {
     "type": "git",
@@ -22,7 +22,6 @@
     "@types/jest": "^29.4.0",
     "@types/node": "^20.17.31",
     "@types/semver-sort": "^0.0.1",
-    "coveralls": "^3.1.1",
     "jest": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
     "openapi-typescript-codegen": "0.29.0",
@@ -36,15 +35,16 @@
     "cross-fetch": "^3.2.0",
     "exponential-backoff": "^3.1.2",
     "limiter": "^3.0.0",
-    "@cowprotocol/sdk-config": "2.2.1",
-    "@cowprotocol/sdk-common": "0.11.1"
+    "@cowprotocol/sdk-config": "2.3.1",
+    "@cowprotocol/sdk-common": "0.12.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",
     "prebuild": "pnpm swagger:codegen",
     "lint": "eslint src/**/*.ts --quiet",
     "test": "jest",
-    "test:coverage": "jest --coverage --json --outputFile=jest.results.json && npx coveralls < ./coverage/lcov.info",
+    "test:coverage": "jest --coverage",
+    "coverage:badges": "istanbul-badges-readme --exitCode=1",
     "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
     "swagger:codegen": "openapi --input https://raw.githubusercontent.com/cowprotocol/services/5341875c9498b2026d1b6f67c840b086e4696dcd/crates/orderbook/openapi.yml --output src/generated --exportServices false --exportCore false",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",