@cowprotocol/sdk-order-book 0.2.4-beta.0 → 0.3.0

package/README.md

@@ -18,8 +18,6 @@ yarn add @cowprotocol/sdk-order-book
 
 ## Usage
 
-### Individual package usage
-
 ```typescript
 import { OrderBookApi, SupportedChainId, OrderQuoteRequest, OrderCreation } from '@cowprotocol/sdk-order-book'
 import { setGlobalAdapter } from '@cowprotocol/sdk-common'
@@ -76,7 +74,7 @@ const trades = await orderBookApi.getTrades({
 })
 ```
 
-### Usage with Umbrella SDK
+### Usage with CoW SDK
 
 ```typescript
 import { CowSdk, SupportedChainId, OrderQuoteRequest } from '@cowprotocol/cow-sdk'
@@ -94,7 +92,6 @@ const sdk = new CowSdk({
   adapter,
 })
 
-// Use Order Book through the umbrella SDK
 const { quote } = await sdk.orderBook.getQuote(quoteRequest)
 const orderId = await sdk.orderBook.sendOrder(signedOrder)
 const order = await sdk.orderBook.getOrder(orderId)

package/dist/index.d.mts

@@ -510,12 +510,12 @@ type OrderMetaData = {
      */
     availableBalance?: TokenAmount | null;
     /**
-     * The total amount of `sellToken` that has been executed for this order including fees.
+     * The total amount of `sellToken` that has been transferred from the user for this order so far.
      *
      */
     executedSellAmount: BigUint;
     /**
-     * The total amount of `sellToken` that has been executed for this order without fees.
+     * The total amount of `sellToken` that has been transferred from the user for this order so far minus tokens that were transferred as part of the signed `fee` of the order. This is only relevant for old orders because now all orders have a signed `fee` of 0 and solvers compute an appropriate fee dynamically at the time of the order execution.
      *
      */
     executedSellAmountBeforeFees: BigUint;
@@ -525,7 +525,8 @@ type OrderMetaData = {
      */
     executedBuyAmount: BigUint;
     /**
-     * The total amount of fees that have been executed for this order.
+     * [DEPRECATED] The total amount of the user signed `fee` that have been executed for this order. This value is only non-negative for very old orders.
+     *
      */
     executedFeeAmount: BigUint;
     /**
@@ -536,10 +537,6 @@ type OrderMetaData = {
      * Order status.
      */
     status: OrderStatus;
-    /**
-     * Amount that the signed fee would be without subsidies.
-     */
-    fullFeeAmount?: TokenAmount;
     /**
      * Liquidity orders are functionally the same as normal smart contract
      * orders but are not placed with the intent of actively getting
@@ -566,11 +563,8 @@ type OrderMetaData = {
      */
     onchainOrderData?: OnchainOrderData;
     /**
-     * Surplus fee that the limit order was executed with.
-     */
-    executedSurplusFee?: BigUint;
-    /**
-     * Total fee charged for execution of the order. Contains network fee and protocol fees.
+     * Total fee charged for execution of the order. Contains network fee and protocol fees. This takes into account the historic static fee signed by the user and the new dynamic fee computed by solvers.
+     *
      */
     executedFee?: BigUint;
     /**
@@ -662,7 +656,7 @@ type OrderParameters = {
     validTo: number;
     appData: AppDataHash;
     /**
-     * feeRatio * sellAmount + minimal_fee in atoms.
+     * sellAmount in atoms to cover network fees. Needs to be zero (and incorporated into the limit price) when placing the order
      */
     feeAmount: TokenAmount;
     /**
@@ -710,7 +704,8 @@ declare namespace OrderPostError {
         UNSUPPORTED_TOKEN = "UnsupportedToken",
         INVALID_APP_DATA = "InvalidAppData",
         APP_DATA_HASH_MISMATCH = "AppDataHashMismatch",
-        APPDATA_FROM_MISMATCH = "AppdataFromMismatch"
+        APPDATA_FROM_MISMATCH = "AppdataFromMismatch",
+        OLD_ORDER_ACTIVELY_BID_ON = "OldOrderActivelyBidOn"
     }
 }
 
@@ -826,6 +821,11 @@ type OrderQuoteRequest = (OrderQuoteSide & OrderQuoteValidity & {
      *
      */
     onchainOrder?: any;
+    /**
+     * User provided timeout in milliseconds. Can only be used to reduce the response time for quote requests if the default is too slow as values greater than the default will be capped to the default. Note that reducing the timeout can result in worse quotes because the reduced timeout might be too slow for some price estimators.
+     *
+     */
+    timeout?: number;
 });
 
 /**
@@ -852,6 +852,16 @@ type OrderQuoteResponse = {
      *
      */
     verified: boolean;
+    /**
+     * Protocol fee in basis points (e.g., "2" for 0.02%). This represents the volume-based fee policy. Only present when configured.
+     *
+     */
+    protocolFeeBps?: string;
+    /**
+     * Protocol fee amount in sell token. For SELL orders, this amount is already included in the returned sellAmount. For BUY orders, this amount is applied before network fees are added to sellAmount. Only present when a volume fee is configured.
+     *
+     */
+    protocolFeeSellAmount?: TokenAmount;
 };
 
 type PriceEstimationError = {
@@ -869,9 +879,9 @@ declare namespace PriceEstimationError {
 
 type SolverSettlement = {
     /**
-     * Name of the solver.
+     * Which position the solution achieved in the total ranking of the competition.
      */
-    solver?: string;
+    ranking?: number;
     /**
      * The address used by the solver to execute the settlement on-chain.
      *
@@ -879,22 +889,21 @@ type SolverSettlement = {
      * used instead.
      */
     solverAddress?: string;
-    objective?: {
-        /**
-         * The total objective value used for ranking solutions.
-         */
-        total?: number;
-        surplus?: number;
-        fees?: number;
-        cost?: number;
-        gas?: number;
-    };
     /**
      * The score of the current auction as defined in [CIP-20](https://snapshot.org/#/cow.eth/proposal/0x2d3f9bd1ea72dca84b03e97dda3efc1f4a42a772c54bd2037e8b62e7d09a491f).
-     * It is `null` for old auctions.
      *
      */
-    score?: BigUint | null;
+    score?: BigUint;
+    /**
+     * The reference score as defined in [CIP-67](https://forum.cow.fi/t/cip-67-moving-from-batch-auction-to-the-fair-combinatorial-auction/2967) (if available).
+     *
+     */
+    referenceScore?: BigUint | null;
+    /**
+     * Transaction in which the solution was executed onchain (if available).
+     *
+     */
+    txHash?: TransactionHash | null;
     /**
      * The prices of tokens for settled user orders as passed to the settlement contract.
      *
@@ -905,12 +914,17 @@ type SolverSettlement = {
      */
     orders?: Array<{
         id?: UID;
-        executedAmount?: BigUint;
+        sellAmount?: BigUint;
+        buyAmount?: BigUint;
     }>;
     /**
      * whether the solution is a winner (received the right to get executed) or not
      */
     isWinner?: boolean;
+    /**
+     * whether the solution was filtered out according to the rules of [CIP-67](https://forum.cow.fi/t/cip-67-moving-from-batch-auction-to-the-fair-combinatorial-auction/2967).
+     */
+    filteredOut?: boolean;
 };
 
 /**
@@ -925,15 +939,19 @@ type SolverCompetitionResponse = {
      */
     auctionId?: number;
     /**
-     * The hash of the transaction that the winning solution of this info was submitted in.
+     * Block that the auction started on.
+     */
+    auctionStartBlock?: number;
+    /**
+     * The hashes of the transactions for the winning solutions of this competition.
+     *
      */
-    transactionHash?: TransactionHash | null;
+    transactionHashes?: Array<TransactionHash>;
     /**
-     * Gas price used for ranking solutions.
+     * The reference scores for each winning solver according to [CIP-67](https://forum.cow.fi/t/cip-67-moving-from-batch-auction-to-the-fair-combinatorial-auction/2967) (if available).
+     *
      */
-    gasPrice?: number;
-    liquidityCollectedBlock?: number;
-    competitionSimulationBlock?: number;
+    referenceScores?: Record<string, BigUint>;
     auction?: CompetitionAuction;
     /**
      * Maps from solver name to object describing that solver's settlement.
@@ -1023,6 +1041,10 @@ interface Costs<T> {
         amount: T;
         bps: number;
     };
+    protocolFee: {
+        amount: T;
+        bps: number;
+    };
 }
 /**
  * Details about costs and amounts, costs and fees of a quote.
@@ -1033,6 +1055,9 @@ interface Costs<T> {
  * The order of adding fees and costs is as follows:
  * 1. Network fee is always added to the sell amount
  * 2. Partner fee is added to the surplus amount (sell amount for sell-orders, buy amount for buy-orders)
+ * 3. Protocol fee is already baked into the quoted amounts:
+ *    - for SELL orders it has been deducted from the buy amount
+ *    - for BUY orders it has been added on top of the sell amount.
  *
  * For sell-orders the partner fee is subtracted from the buy amount after network costs.
  * For buy-orders the partner fee is added on top of the sell amount after network costs.
@@ -1052,6 +1077,7 @@ interface QuoteAmountsAndCosts<T = bigint> {
      * so UIs can decide how to show it to the user.
      */
     costs: Costs<T>;
+    beforeAllFees: Amounts<T>;
     /**
      * Amounts before network costs. This amount could be shown to the user to reflect how much they are expected to get
      * before applying any costs or fees (if costs and fees are displayed separately).
@@ -1364,11 +1390,13 @@ interface QuoteAmountsAndCostsParams {
     buyDecimals: number;
     slippagePercentBps: number;
     partnerFeeBps: number | undefined;
+    protocolFeeBps: number | undefined;
 }
 declare function getQuoteAmountsWithCosts(params: {
     sellDecimals: number;
     buyDecimals: number;
     orderParams: OrderParameters;
+    protocolFeeBps?: number;
 }): {
     isSell: boolean;
     quotePrice: number;

package/dist/index.d.ts

@@ -510,12 +510,12 @@ type OrderMetaData = {
      */
     availableBalance?: TokenAmount | null;
     /**
-     * The total amount of `sellToken` that has been executed for this order including fees.
+     * The total amount of `sellToken` that has been transferred from the user for this order so far.
      *
      */
     executedSellAmount: BigUint;
     /**
-     * The total amount of `sellToken` that has been executed for this order without fees.
+     * The total amount of `sellToken` that has been transferred from the user for this order so far minus tokens that were transferred as part of the signed `fee` of the order. This is only relevant for old orders because now all orders have a signed `fee` of 0 and solvers compute an appropriate fee dynamically at the time of the order execution.
      *
      */
     executedSellAmountBeforeFees: BigUint;
@@ -525,7 +525,8 @@ type OrderMetaData = {
      */
     executedBuyAmount: BigUint;
     /**
-     * The total amount of fees that have been executed for this order.
+     * [DEPRECATED] The total amount of the user signed `fee` that have been executed for this order. This value is only non-negative for very old orders.
+     *
      */
     executedFeeAmount: BigUint;
     /**
@@ -536,10 +537,6 @@ type OrderMetaData = {
      * Order status.
      */
     status: OrderStatus;
-    /**
-     * Amount that the signed fee would be without subsidies.
-     */
-    fullFeeAmount?: TokenAmount;
     /**
      * Liquidity orders are functionally the same as normal smart contract
      * orders but are not placed with the intent of actively getting
@@ -566,11 +563,8 @@ type OrderMetaData = {
      */
     onchainOrderData?: OnchainOrderData;
     /**
-     * Surplus fee that the limit order was executed with.
-     */
-    executedSurplusFee?: BigUint;
-    /**
-     * Total fee charged for execution of the order. Contains network fee and protocol fees.
+     * Total fee charged for execution of the order. Contains network fee and protocol fees. This takes into account the historic static fee signed by the user and the new dynamic fee computed by solvers.
+     *
      */
     executedFee?: BigUint;
     /**
@@ -662,7 +656,7 @@ type OrderParameters = {
     validTo: number;
     appData: AppDataHash;
     /**
-     * feeRatio * sellAmount + minimal_fee in atoms.
+     * sellAmount in atoms to cover network fees. Needs to be zero (and incorporated into the limit price) when placing the order
      */
     feeAmount: TokenAmount;
     /**
@@ -710,7 +704,8 @@ declare namespace OrderPostError {
         UNSUPPORTED_TOKEN = "UnsupportedToken",
         INVALID_APP_DATA = "InvalidAppData",
         APP_DATA_HASH_MISMATCH = "AppDataHashMismatch",
-        APPDATA_FROM_MISMATCH = "AppdataFromMismatch"
+        APPDATA_FROM_MISMATCH = "AppdataFromMismatch",
+        OLD_ORDER_ACTIVELY_BID_ON = "OldOrderActivelyBidOn"
     }
 }
 
@@ -826,6 +821,11 @@ type OrderQuoteRequest = (OrderQuoteSide & OrderQuoteValidity & {
      *
      */
     onchainOrder?: any;
+    /**
+     * User provided timeout in milliseconds. Can only be used to reduce the response time for quote requests if the default is too slow as values greater than the default will be capped to the default. Note that reducing the timeout can result in worse quotes because the reduced timeout might be too slow for some price estimators.
+     *
+     */
+    timeout?: number;
 });
 
 /**
@@ -852,6 +852,16 @@ type OrderQuoteResponse = {
      *
      */
     verified: boolean;
+    /**
+     * Protocol fee in basis points (e.g., "2" for 0.02%). This represents the volume-based fee policy. Only present when configured.
+     *
+     */
+    protocolFeeBps?: string;
+    /**
+     * Protocol fee amount in sell token. For SELL orders, this amount is already included in the returned sellAmount. For BUY orders, this amount is applied before network fees are added to sellAmount. Only present when a volume fee is configured.
+     *
+     */
+    protocolFeeSellAmount?: TokenAmount;
 };
 
 type PriceEstimationError = {
@@ -869,9 +879,9 @@ declare namespace PriceEstimationError {
 
 type SolverSettlement = {
     /**
-     * Name of the solver.
+     * Which position the solution achieved in the total ranking of the competition.
      */
-    solver?: string;
+    ranking?: number;
     /**
      * The address used by the solver to execute the settlement on-chain.
      *
@@ -879,22 +889,21 @@ type SolverSettlement = {
      * used instead.
      */
     solverAddress?: string;
-    objective?: {
-        /**
-         * The total objective value used for ranking solutions.
-         */
-        total?: number;
-        surplus?: number;
-        fees?: number;
-        cost?: number;
-        gas?: number;
-    };
     /**
      * The score of the current auction as defined in [CIP-20](https://snapshot.org/#/cow.eth/proposal/0x2d3f9bd1ea72dca84b03e97dda3efc1f4a42a772c54bd2037e8b62e7d09a491f).
-     * It is `null` for old auctions.
      *
      */
-    score?: BigUint | null;
+    score?: BigUint;
+    /**
+     * The reference score as defined in [CIP-67](https://forum.cow.fi/t/cip-67-moving-from-batch-auction-to-the-fair-combinatorial-auction/2967) (if available).
+     *
+     */
+    referenceScore?: BigUint | null;
+    /**
+     * Transaction in which the solution was executed onchain (if available).
+     *
+     */
+    txHash?: TransactionHash | null;
     /**
      * The prices of tokens for settled user orders as passed to the settlement contract.
      *
@@ -905,12 +914,17 @@ type SolverSettlement = {
      */
     orders?: Array<{
         id?: UID;
-        executedAmount?: BigUint;
+        sellAmount?: BigUint;
+        buyAmount?: BigUint;
     }>;
     /**
      * whether the solution is a winner (received the right to get executed) or not
      */
     isWinner?: boolean;
+    /**
+     * whether the solution was filtered out according to the rules of [CIP-67](https://forum.cow.fi/t/cip-67-moving-from-batch-auction-to-the-fair-combinatorial-auction/2967).
+     */
+    filteredOut?: boolean;
 };
 
 /**
@@ -925,15 +939,19 @@ type SolverCompetitionResponse = {
      */
     auctionId?: number;
     /**
-     * The hash of the transaction that the winning solution of this info was submitted in.
+     * Block that the auction started on.
+     */
+    auctionStartBlock?: number;
+    /**
+     * The hashes of the transactions for the winning solutions of this competition.
+     *
      */
-    transactionHash?: TransactionHash | null;
+    transactionHashes?: Array<TransactionHash>;
     /**
-     * Gas price used for ranking solutions.
+     * The reference scores for each winning solver according to [CIP-67](https://forum.cow.fi/t/cip-67-moving-from-batch-auction-to-the-fair-combinatorial-auction/2967) (if available).
+     *
      */
-    gasPrice?: number;
-    liquidityCollectedBlock?: number;
-    competitionSimulationBlock?: number;
+    referenceScores?: Record<string, BigUint>;
     auction?: CompetitionAuction;
     /**
      * Maps from solver name to object describing that solver's settlement.
@@ -1023,6 +1041,10 @@ interface Costs<T> {
         amount: T;
         bps: number;
     };
+    protocolFee: {
+        amount: T;
+        bps: number;
+    };
 }
 /**
  * Details about costs and amounts, costs and fees of a quote.
@@ -1033,6 +1055,9 @@ interface Costs<T> {
  * The order of adding fees and costs is as follows:
  * 1. Network fee is always added to the sell amount
  * 2. Partner fee is added to the surplus amount (sell amount for sell-orders, buy amount for buy-orders)
+ * 3. Protocol fee is already baked into the quoted amounts:
+ *    - for SELL orders it has been deducted from the buy amount
+ *    - for BUY orders it has been added on top of the sell amount.
  *
  * For sell-orders the partner fee is subtracted from the buy amount after network costs.
  * For buy-orders the partner fee is added on top of the sell amount after network costs.
@@ -1052,6 +1077,7 @@ interface QuoteAmountsAndCosts<T = bigint> {
      * so UIs can decide how to show it to the user.
      */
     costs: Costs<T>;
+    beforeAllFees: Amounts<T>;
     /**
      * Amounts before network costs. This amount could be shown to the user to reflect how much they are expected to get
      * before applying any costs or fees (if costs and fees are displayed separately).
@@ -1364,11 +1390,13 @@ interface QuoteAmountsAndCostsParams {
     buyDecimals: number;
     slippagePercentBps: number;
     partnerFeeBps: number | undefined;
+    protocolFeeBps: number | undefined;
 }
 declare function getQuoteAmountsWithCosts(params: {
     sellDecimals: number;
     buyDecimals: number;
     orderParams: OrderParameters;
+    protocolFeeBps?: number;
 }): {
     isSell: boolean;
     quotePrice: number;

package/dist/index.js

@@ -183,7 +183,9 @@ var ORDER_BOOK_PROD_CONFIG = {
   [import_sdk_config2.SupportedChainId.POLYGON]: `${PROD_BASE_URL}/polygon`,
   [import_sdk_config2.SupportedChainId.AVALANCHE]: `${PROD_BASE_URL}/avalanche`,
   [import_sdk_config2.SupportedChainId.LENS]: `${PROD_BASE_URL}/lens`,
-  [import_sdk_config2.SupportedChainId.BNB]: `${PROD_BASE_URL}/bnb`
+  [import_sdk_config2.SupportedChainId.BNB]: `${PROD_BASE_URL}/bnb`,
+  [import_sdk_config2.SupportedChainId.LINEA]: `${PROD_BASE_URL}/linea`,
+  [import_sdk_config2.SupportedChainId.PLASMA]: `${PROD_BASE_URL}/plasma`
 };
 var ORDER_BOOK_STAGING_CONFIG = {
   [import_sdk_config2.SupportedChainId.MAINNET]: `${STAGING_BASE_URL}/mainnet`,
@@ -194,7 +196,9 @@ var ORDER_BOOK_STAGING_CONFIG = {
   [import_sdk_config2.SupportedChainId.POLYGON]: `${STAGING_BASE_URL}/polygon`,
   [import_sdk_config2.SupportedChainId.AVALANCHE]: `${STAGING_BASE_URL}/avalanche`,
   [import_sdk_config2.SupportedChainId.LENS]: `${STAGING_BASE_URL}/lens`,
-  [import_sdk_config2.SupportedChainId.BNB]: `${STAGING_BASE_URL}/bnb`
+  [import_sdk_config2.SupportedChainId.BNB]: `${STAGING_BASE_URL}/bnb`,
+  [import_sdk_config2.SupportedChainId.LINEA]: `${STAGING_BASE_URL}/linea`,
+  [import_sdk_config2.SupportedChainId.PLASMA]: `${STAGING_BASE_URL}/plasma`
 };
 function cleanObjectFromUndefinedValues(obj) {
   return Object.keys(obj).reduce(
@@ -558,6 +562,7 @@ var OrderPostError;
     errorType2["INVALID_APP_DATA"] = "InvalidAppData";
     errorType2["APP_DATA_HASH_MISMATCH"] = "AppDataHashMismatch";
     errorType2["APPDATA_FROM_MISMATCH"] = "AppdataFromMismatch";
+    errorType2["OLD_ORDER_ACTIVELY_BID_ON"] = "OldOrderActivelyBidOn";
   })(errorType = OrderPostError2.errorType || (OrderPostError2.errorType = {}));
 })(OrderPostError || (OrderPostError = {}));
 
@@ -623,16 +628,24 @@ var SigningScheme = /* @__PURE__ */ ((SigningScheme2) => {
 // src/quoteAmountsAndCostsUtils.ts
 var ONE_HUNDRED_BPS = BigInt(100 * 100);
 function getQuoteAmountsWithCosts(params) {
-  const { sellDecimals, buyDecimals, orderParams } = params;
+  const { sellDecimals, buyDecimals, orderParams, protocolFeeBps = 0 } = params;
+  const isSell = orderParams.kind === "sell" /* SELL */;
+  const protocolFeeAmount = getProtocolFeeAmount({ orderParams, isSell, protocolFeeBps });
+  const protocolFeeAmountDecimals = isSell ? buyDecimals : sellDecimals;
   const {
     sellAmountAfterNetworkCosts,
     buyAmountAfterNetworkCosts,
     buyAmountBeforeNetworkCosts,
-    isSell,
     networkCostAmount,
     quotePrice,
     sellAmountBeforeNetworkCosts
-  } = _getQuoteAmountsWithCosts({ sellDecimals, buyDecimals, orderParams });
+  } = _getQuoteAmountsWithCosts({
+    sellDecimals,
+    buyDecimals,
+    orderParams,
+    protocolFeeAmount: getBigNumber(protocolFeeAmount, protocolFeeAmountDecimals),
+    isSell
+  });
   return {
     isSell,
     quotePrice,
@@ -644,12 +657,17 @@ function getQuoteAmountsWithCosts(params) {
   };
 }
 function _getQuoteAmountsWithCosts(params) {
-  const { sellDecimals, buyDecimals, orderParams } = params;
-  const isSell = orderParams.kind === "sell" /* SELL */;
+  const { sellDecimals, buyDecimals, orderParams, isSell, protocolFeeAmount } = params;
   const networkCostAmount = getBigNumber(orderParams.feeAmount, sellDecimals);
   const sellAmountBeforeNetworkCosts = getBigNumber(orderParams.sellAmount, sellDecimals);
   const buyAmountAfterNetworkCosts = getBigNumber(orderParams.buyAmount, buyDecimals);
-  const quotePrice = buyAmountAfterNetworkCosts.num / sellAmountBeforeNetworkCosts.num;
+  const quotePrice = isSell ? (
+    // For SELL order is already deducting protocol fees from buyAmount, so we need to add it back to get the actual price
+    (buyAmountAfterNetworkCosts.num + protocolFeeAmount.num) / sellAmountBeforeNetworkCosts.num
+  ) : (
+    // For BUY order is already adding protocol fees to sellAmount, so we need to subtract it to get the actual price
+    buyAmountAfterNetworkCosts.num / (sellAmountBeforeNetworkCosts.num - protocolFeeAmount.num)
+  );
   const sellAmountAfterNetworkCosts = getBigNumber(
     sellAmountBeforeNetworkCosts.big + networkCostAmount.big,
     sellDecimals
@@ -669,25 +687,43 @@ function getQuoteAmountsWithPartnerFee(params) {
   const {
     sellAmountAfterNetworkCosts,
     buyAmountAfterNetworkCosts,
-    buyAmountBeforeNetworkCosts,
-    sellAmountBeforeNetworkCosts,
+    buyAmountBeforeProtocolFee,
+    sellAmountBeforeProtocolFee,
     isSell,
     partnerFeeBps
   } = params;
-  const surplusAmount = isSell ? buyAmountBeforeNetworkCosts.big : sellAmountBeforeNetworkCosts.big;
-  const partnerFeeAmount = partnerFeeBps > 0 ? surplusAmount * BigInt(partnerFeeBps) / ONE_HUNDRED_BPS : BigInt(0);
+  const surplusAmountForPartnerFee = isSell ? buyAmountBeforeProtocolFee : sellAmountBeforeProtocolFee;
+  const partnerFeeAmount = partnerFeeBps > 0 ? surplusAmountForPartnerFee * BigInt(partnerFeeBps) / ONE_HUNDRED_BPS : BigInt(0);
   const afterPartnerFees = isSell ? {
-    sellAmount: sellAmountAfterNetworkCosts.big,
-    buyAmount: buyAmountAfterNetworkCosts.big - partnerFeeAmount
+    sellAmount: sellAmountAfterNetworkCosts,
+    buyAmount: buyAmountAfterNetworkCosts - partnerFeeAmount
   } : {
-    sellAmount: sellAmountAfterNetworkCosts.big + partnerFeeAmount,
-    buyAmount: buyAmountAfterNetworkCosts.big
+    sellAmount: sellAmountAfterNetworkCosts + partnerFeeAmount,
+    buyAmount: buyAmountAfterNetworkCosts
   };
   return {
     partnerFeeAmount,
     afterPartnerFees
   };
 }
+function getProtocolFeeAmount(params) {
+  const { orderParams, protocolFeeBps, isSell } = params;
+  if (protocolFeeBps <= 0) {
+    return 0n;
+  }
+  const { sellAmount: sellAmountStr, buyAmount: buyAmountStr, feeAmount: feeAmountStr } = orderParams;
+  const sellAmount = BigInt(sellAmountStr);
+  const buyAmount = BigInt(buyAmountStr);
+  const feeAmount = BigInt(feeAmountStr);
+  const protocolFeeBpsBig = BigInt(protocolFeeBps);
+  if (isSell) {
+    const denominator = ONE_HUNDRED_BPS - protocolFeeBpsBig;
+    return buyAmount * protocolFeeBpsBig / denominator;
+  } else {
+    const denominator = ONE_HUNDRED_BPS + protocolFeeBpsBig;
+    return (sellAmount + feeAmount) * protocolFeeBpsBig / denominator;
+  }
+}
 function getQuoteAmountsWithSlippage(params) {
   const { afterPartnerFees, isSell, slippagePercentBps } = params;
   const getSlippageAmount = (amount) => amount * BigInt(slippagePercentBps) / ONE_HUNDRED_BPS;
@@ -705,20 +741,35 @@ function getQuoteAmountsWithSlippage(params) {
 function getQuoteAmountsAndCosts(params) {
   const { orderParams, sellDecimals, buyDecimals, slippagePercentBps } = params;
   const partnerFeeBps = params.partnerFeeBps ?? 0;
-  const {
+  const protocolFeeBps = params.protocolFeeBps ?? 0;
+  const isSell = orderParams.kind === "sell" /* SELL */;
+  const protocolFeeAmount = getProtocolFeeAmount({
+    orderParams,
     isSell,
+    protocolFeeBps
+  });
+  const protocolFeeAmountDecimals = isSell ? buyDecimals : sellDecimals;
+  const {
     networkCostAmount,
     sellAmountBeforeNetworkCosts,
     buyAmountAfterNetworkCosts,
     sellAmountAfterNetworkCosts,
     buyAmountBeforeNetworkCosts,
     quotePrice
-  } = _getQuoteAmountsWithCosts({ sellDecimals, buyDecimals, orderParams });
+  } = _getQuoteAmountsWithCosts({
+    sellDecimals,
+    buyDecimals,
+    orderParams,
+    isSell,
+    protocolFeeAmount: getBigNumber(protocolFeeAmount, protocolFeeAmountDecimals)
+  });
+  const buyAmountBeforeProtocolFee = isSell ? protocolFeeBps > 0 ? buyAmountAfterNetworkCosts.big + protocolFeeAmount : buyAmountBeforeNetworkCosts.big : buyAmountAfterNetworkCosts.big;
+  const sellAmountBeforeProtocolFee = isSell ? sellAmountAfterNetworkCosts.big : protocolFeeBps > 0 ? sellAmountAfterNetworkCosts.big - protocolFeeAmount : sellAmountBeforeNetworkCosts.big;
   const { afterPartnerFees, partnerFeeAmount } = getQuoteAmountsWithPartnerFee({
-    sellAmountAfterNetworkCosts,
-    buyAmountAfterNetworkCosts,
-    buyAmountBeforeNetworkCosts,
-    sellAmountBeforeNetworkCosts,
+    sellAmountAfterNetworkCosts: sellAmountAfterNetworkCosts.big,
+    buyAmountAfterNetworkCosts: buyAmountAfterNetworkCosts.big,
+    buyAmountBeforeProtocolFee,
+    sellAmountBeforeProtocolFee,
     isSell,
     partnerFeeBps
   });
@@ -727,6 +778,20 @@ function getQuoteAmountsAndCosts(params) {
     isSell,
     slippagePercentBps
   });
+  const beforeNetworkCosts = isSell ? {
+    sellAmount: sellAmountBeforeNetworkCosts.big,
+    buyAmount: buyAmountBeforeProtocolFee
+  } : {
+    sellAmount: sellAmountBeforeProtocolFee,
+    buyAmount: buyAmountBeforeNetworkCosts.big
+  };
+  const beforeAllFees = isSell ? {
+    sellAmount: sellAmountBeforeNetworkCosts.big,
+    buyAmount: buyAmountBeforeNetworkCosts.big + protocolFeeAmount
+  } : {
+    sellAmount: sellAmountBeforeNetworkCosts.big - protocolFeeAmount,
+    buyAmount: buyAmountBeforeNetworkCosts.big
+  };
   return {
     isSell,
     costs: {
@@ -737,12 +802,14 @@ function getQuoteAmountsAndCosts(params) {
       partnerFee: {
         amount: partnerFeeAmount,
         bps: partnerFeeBps
+      },
+      protocolFee: {
+        amount: protocolFeeAmount,
+        bps: protocolFeeBps
       }
     },
-    beforeNetworkCosts: {
-      sellAmount: sellAmountBeforeNetworkCosts.big,
-      buyAmount: buyAmountBeforeNetworkCosts.big
-    },
+    beforeNetworkCosts,
+    beforeAllFees,
     afterNetworkCosts: {
       sellAmount: sellAmountAfterNetworkCosts.big,
       buyAmount: buyAmountAfterNetworkCosts.big

package/dist/index.mjs

@@ -2,11 +2,11 @@
 import "cross-fetch/polyfill";
 import { RateLimiter } from "limiter";
 import {
-  SupportedChainId,
   DEFAULT_COW_API_CONTEXT,
-  ENVS_LIST
+  ENVS_LIST,
+  SupportedChainId
 } from "@cowprotocol/sdk-config";
-import { CowError, log, jsonWithBigintReplacer } from "@cowprotocol/sdk-common";
+import { CowError, jsonWithBigintReplacer, log } from "@cowprotocol/sdk-common";
 
 // src/request.ts
 import { backOff } from "exponential-backoff";
@@ -137,7 +137,9 @@ var ORDER_BOOK_PROD_CONFIG = {
   [SupportedChainId.POLYGON]: `${PROD_BASE_URL}/polygon`,
   [SupportedChainId.AVALANCHE]: `${PROD_BASE_URL}/avalanche`,
   [SupportedChainId.LENS]: `${PROD_BASE_URL}/lens`,
-  [SupportedChainId.BNB]: `${PROD_BASE_URL}/bnb`
+  [SupportedChainId.BNB]: `${PROD_BASE_URL}/bnb`,
+  [SupportedChainId.LINEA]: `${PROD_BASE_URL}/linea`,
+  [SupportedChainId.PLASMA]: `${PROD_BASE_URL}/plasma`
 };
 var ORDER_BOOK_STAGING_CONFIG = {
   [SupportedChainId.MAINNET]: `${STAGING_BASE_URL}/mainnet`,
@@ -148,7 +150,9 @@ var ORDER_BOOK_STAGING_CONFIG = {
   [SupportedChainId.POLYGON]: `${STAGING_BASE_URL}/polygon`,
   [SupportedChainId.AVALANCHE]: `${STAGING_BASE_URL}/avalanche`,
   [SupportedChainId.LENS]: `${STAGING_BASE_URL}/lens`,
-  [SupportedChainId.BNB]: `${STAGING_BASE_URL}/bnb`
+  [SupportedChainId.BNB]: `${STAGING_BASE_URL}/bnb`,
+  [SupportedChainId.LINEA]: `${STAGING_BASE_URL}/linea`,
+  [SupportedChainId.PLASMA]: `${STAGING_BASE_URL}/plasma`
 };
 function cleanObjectFromUndefinedValues(obj) {
   return Object.keys(obj).reduce(
@@ -512,6 +516,7 @@ var OrderPostError;
     errorType2["INVALID_APP_DATA"] = "InvalidAppData";
     errorType2["APP_DATA_HASH_MISMATCH"] = "AppDataHashMismatch";
     errorType2["APPDATA_FROM_MISMATCH"] = "AppdataFromMismatch";
+    errorType2["OLD_ORDER_ACTIVELY_BID_ON"] = "OldOrderActivelyBidOn";
   })(errorType = OrderPostError2.errorType || (OrderPostError2.errorType = {}));
 })(OrderPostError || (OrderPostError = {}));
 
@@ -577,16 +582,24 @@ var SigningScheme = /* @__PURE__ */ ((SigningScheme2) => {
 // src/quoteAmountsAndCostsUtils.ts
 var ONE_HUNDRED_BPS = BigInt(100 * 100);
 function getQuoteAmountsWithCosts(params) {
-  const { sellDecimals, buyDecimals, orderParams } = params;
+  const { sellDecimals, buyDecimals, orderParams, protocolFeeBps = 0 } = params;
+  const isSell = orderParams.kind === "sell" /* SELL */;
+  const protocolFeeAmount = getProtocolFeeAmount({ orderParams, isSell, protocolFeeBps });
+  const protocolFeeAmountDecimals = isSell ? buyDecimals : sellDecimals;
   const {
     sellAmountAfterNetworkCosts,
     buyAmountAfterNetworkCosts,
     buyAmountBeforeNetworkCosts,
-    isSell,
     networkCostAmount,
     quotePrice,
     sellAmountBeforeNetworkCosts
-  } = _getQuoteAmountsWithCosts({ sellDecimals, buyDecimals, orderParams });
+  } = _getQuoteAmountsWithCosts({
+    sellDecimals,
+    buyDecimals,
+    orderParams,
+    protocolFeeAmount: getBigNumber(protocolFeeAmount, protocolFeeAmountDecimals),
+    isSell
+  });
   return {
     isSell,
     quotePrice,
@@ -598,12 +611,17 @@ function getQuoteAmountsWithCosts(params) {
   };
 }
 function _getQuoteAmountsWithCosts(params) {
-  const { sellDecimals, buyDecimals, orderParams } = params;
-  const isSell = orderParams.kind === "sell" /* SELL */;
+  const { sellDecimals, buyDecimals, orderParams, isSell, protocolFeeAmount } = params;
   const networkCostAmount = getBigNumber(orderParams.feeAmount, sellDecimals);
   const sellAmountBeforeNetworkCosts = getBigNumber(orderParams.sellAmount, sellDecimals);
   const buyAmountAfterNetworkCosts = getBigNumber(orderParams.buyAmount, buyDecimals);
-  const quotePrice = buyAmountAfterNetworkCosts.num / sellAmountBeforeNetworkCosts.num;
+  const quotePrice = isSell ? (
+    // For SELL order is already deducting protocol fees from buyAmount, so we need to add it back to get the actual price
+    (buyAmountAfterNetworkCosts.num + protocolFeeAmount.num) / sellAmountBeforeNetworkCosts.num
+  ) : (
+    // For BUY order is already adding protocol fees to sellAmount, so we need to subtract it to get the actual price
+    buyAmountAfterNetworkCosts.num / (sellAmountBeforeNetworkCosts.num - protocolFeeAmount.num)
+  );
   const sellAmountAfterNetworkCosts = getBigNumber(
     sellAmountBeforeNetworkCosts.big + networkCostAmount.big,
     sellDecimals
@@ -623,25 +641,43 @@ function getQuoteAmountsWithPartnerFee(params) {
   const {
     sellAmountAfterNetworkCosts,
     buyAmountAfterNetworkCosts,
-    buyAmountBeforeNetworkCosts,
-    sellAmountBeforeNetworkCosts,
+    buyAmountBeforeProtocolFee,
+    sellAmountBeforeProtocolFee,
     isSell,
     partnerFeeBps
   } = params;
-  const surplusAmount = isSell ? buyAmountBeforeNetworkCosts.big : sellAmountBeforeNetworkCosts.big;
-  const partnerFeeAmount = partnerFeeBps > 0 ? surplusAmount * BigInt(partnerFeeBps) / ONE_HUNDRED_BPS : BigInt(0);
+  const surplusAmountForPartnerFee = isSell ? buyAmountBeforeProtocolFee : sellAmountBeforeProtocolFee;
+  const partnerFeeAmount = partnerFeeBps > 0 ? surplusAmountForPartnerFee * BigInt(partnerFeeBps) / ONE_HUNDRED_BPS : BigInt(0);
   const afterPartnerFees = isSell ? {
-    sellAmount: sellAmountAfterNetworkCosts.big,
-    buyAmount: buyAmountAfterNetworkCosts.big - partnerFeeAmount
+    sellAmount: sellAmountAfterNetworkCosts,
+    buyAmount: buyAmountAfterNetworkCosts - partnerFeeAmount
   } : {
-    sellAmount: sellAmountAfterNetworkCosts.big + partnerFeeAmount,
-    buyAmount: buyAmountAfterNetworkCosts.big
+    sellAmount: sellAmountAfterNetworkCosts + partnerFeeAmount,
+    buyAmount: buyAmountAfterNetworkCosts
   };
   return {
     partnerFeeAmount,
     afterPartnerFees
   };
 }
+function getProtocolFeeAmount(params) {
+  const { orderParams, protocolFeeBps, isSell } = params;
+  if (protocolFeeBps <= 0) {
+    return 0n;
+  }
+  const { sellAmount: sellAmountStr, buyAmount: buyAmountStr, feeAmount: feeAmountStr } = orderParams;
+  const sellAmount = BigInt(sellAmountStr);
+  const buyAmount = BigInt(buyAmountStr);
+  const feeAmount = BigInt(feeAmountStr);
+  const protocolFeeBpsBig = BigInt(protocolFeeBps);
+  if (isSell) {
+    const denominator = ONE_HUNDRED_BPS - protocolFeeBpsBig;
+    return buyAmount * protocolFeeBpsBig / denominator;
+  } else {
+    const denominator = ONE_HUNDRED_BPS + protocolFeeBpsBig;
+    return (sellAmount + feeAmount) * protocolFeeBpsBig / denominator;
+  }
+}
 function getQuoteAmountsWithSlippage(params) {
   const { afterPartnerFees, isSell, slippagePercentBps } = params;
   const getSlippageAmount = (amount) => amount * BigInt(slippagePercentBps) / ONE_HUNDRED_BPS;
@@ -659,20 +695,35 @@ function getQuoteAmountsWithSlippage(params) {
 function getQuoteAmountsAndCosts(params) {
   const { orderParams, sellDecimals, buyDecimals, slippagePercentBps } = params;
   const partnerFeeBps = params.partnerFeeBps ?? 0;
-  const {
+  const protocolFeeBps = params.protocolFeeBps ?? 0;
+  const isSell = orderParams.kind === "sell" /* SELL */;
+  const protocolFeeAmount = getProtocolFeeAmount({
+    orderParams,
     isSell,
+    protocolFeeBps
+  });
+  const protocolFeeAmountDecimals = isSell ? buyDecimals : sellDecimals;
+  const {
     networkCostAmount,
     sellAmountBeforeNetworkCosts,
     buyAmountAfterNetworkCosts,
     sellAmountAfterNetworkCosts,
     buyAmountBeforeNetworkCosts,
     quotePrice
-  } = _getQuoteAmountsWithCosts({ sellDecimals, buyDecimals, orderParams });
+  } = _getQuoteAmountsWithCosts({
+    sellDecimals,
+    buyDecimals,
+    orderParams,
+    isSell,
+    protocolFeeAmount: getBigNumber(protocolFeeAmount, protocolFeeAmountDecimals)
+  });
+  const buyAmountBeforeProtocolFee = isSell ? protocolFeeBps > 0 ? buyAmountAfterNetworkCosts.big + protocolFeeAmount : buyAmountBeforeNetworkCosts.big : buyAmountAfterNetworkCosts.big;
+  const sellAmountBeforeProtocolFee = isSell ? sellAmountAfterNetworkCosts.big : protocolFeeBps > 0 ? sellAmountAfterNetworkCosts.big - protocolFeeAmount : sellAmountBeforeNetworkCosts.big;
   const { afterPartnerFees, partnerFeeAmount } = getQuoteAmountsWithPartnerFee({
-    sellAmountAfterNetworkCosts,
-    buyAmountAfterNetworkCosts,
-    buyAmountBeforeNetworkCosts,
-    sellAmountBeforeNetworkCosts,
+    sellAmountAfterNetworkCosts: sellAmountAfterNetworkCosts.big,
+    buyAmountAfterNetworkCosts: buyAmountAfterNetworkCosts.big,
+    buyAmountBeforeProtocolFee,
+    sellAmountBeforeProtocolFee,
     isSell,
     partnerFeeBps
   });
@@ -681,6 +732,20 @@ function getQuoteAmountsAndCosts(params) {
     isSell,
     slippagePercentBps
   });
+  const beforeNetworkCosts = isSell ? {
+    sellAmount: sellAmountBeforeNetworkCosts.big,
+    buyAmount: buyAmountBeforeProtocolFee
+  } : {
+    sellAmount: sellAmountBeforeProtocolFee,
+    buyAmount: buyAmountBeforeNetworkCosts.big
+  };
+  const beforeAllFees = isSell ? {
+    sellAmount: sellAmountBeforeNetworkCosts.big,
+    buyAmount: buyAmountBeforeNetworkCosts.big + protocolFeeAmount
+  } : {
+    sellAmount: sellAmountBeforeNetworkCosts.big - protocolFeeAmount,
+    buyAmount: buyAmountBeforeNetworkCosts.big
+  };
   return {
     isSell,
     costs: {
@@ -691,12 +756,14 @@ function getQuoteAmountsAndCosts(params) {
       partnerFee: {
         amount: partnerFeeAmount,
         bps: partnerFeeBps
+      },
+      protocolFee: {
+        amount: protocolFeeAmount,
+        bps: protocolFeeBps
       }
     },
-    beforeNetworkCosts: {
-      sellAmount: sellAmountBeforeNetworkCosts.big,
-      buyAmount: buyAmountBeforeNetworkCosts.big
-    },
+    beforeNetworkCosts,
+    beforeAllFees,
     afterNetworkCosts: {
       sellAmount: sellAmountAfterNetworkCosts.big,
       buyAmount: buyAmountAfterNetworkCosts.big

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-order-book",
-  "version": "0.2.4-beta.0",
+  "version": "0.3.0",
   "description": "CowProtocol Order Book package",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -31,8 +31,8 @@
     "cross-fetch": "^3.2.0",
     "exponential-backoff": "^3.1.2",
     "limiter": "^3.0.0",
-    "@cowprotocol/sdk-config": "0.3.2-beta.0",
-    "@cowprotocol/sdk-common": "0.3.0-beta.0"
+    "@cowprotocol/sdk-config": "0.4.0",
+    "@cowprotocol/sdk-common": "0.4.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",
@@ -41,7 +41,7 @@
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && npx coveralls < ./coverage/lcov.info",
     "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
-    "swagger:codegen": "openapi --input https://raw.githubusercontent.com/cowprotocol/services/v2.291.0/crates/orderbook/openapi.yml --output src/generated --exportServices false --exportCore false",
+    "swagger:codegen": "openapi --input https://raw.githubusercontent.com/cowprotocol/services/dfb50cb4a103e8f949f5a7145beb6be63ef41c85/crates/orderbook/openapi.yml --output src/generated --exportServices false --exportCore false",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
     "typecheck": "tsc --noEmit"
   }