@cowprotocol/sdk-order-book 0.6.6 → 1.1.0

package/dist/index.js

@@ -25,6 +25,8 @@ __export(src_exports, {
   DEFAULT_BACKOFF_OPTIONS: () => DEFAULT_BACKOFF_OPTIONS,
   DEFAULT_LIMITER_OPTIONS: () => DEFAULT_LIMITER_OPTIONS,
   EcdsaSigningScheme: () => EcdsaSigningScheme,
+  ORDER_BOOK_PARTNER_PROD_CONFIG: () => ORDER_BOOK_PARTNER_PROD_CONFIG,
+  ORDER_BOOK_PARTNER_STAGING_CONFIG: () => ORDER_BOOK_PARTNER_STAGING_CONFIG,
   ORDER_BOOK_PROD_CONFIG: () => ORDER_BOOK_PROD_CONFIG,
   ORDER_BOOK_STAGING_CONFIG: () => ORDER_BOOK_STAGING_CONFIG,
   OnchainOrderData: () => OnchainOrderData,
@@ -41,9 +43,10 @@ __export(src_exports, {
   PriceQuality: () => PriceQuality,
   SellTokenSource: () => SellTokenSource,
   SigningScheme: () => SigningScheme,
-  getBigNumber: () => getBigNumber,
+  getProtocolFeeAmount: () => getProtocolFeeAmount,
+  getQuoteAmountsAfterPartnerFee: () => getQuoteAmountsAfterPartnerFee,
+  getQuoteAmountsAfterSlippage: () => getQuoteAmountsAfterSlippage,
   getQuoteAmountsAndCosts: () => getQuoteAmountsAndCosts,
-  getQuoteAmountsWithCosts: () => getQuoteAmountsWithCosts,
   request: () => request
 });
 module.exports = __toCommonJS(src_exports);
@@ -117,11 +120,12 @@ var getResponseBody = async (response) => {
   }
   return void 0;
 };
-async function request(baseUrl, { path, query, method, body }, rateLimiter, backoffOpts) {
+async function request(baseUrl, { path, query, method, body }, rateLimiter, backoffOpts, additionalHeaders) {
   const queryString = query ? "?" + query : "";
   const headers = {
     Accept: "application/json",
-    "Content-Type": "application/json"
+    "Content-Type": "application/json",
+    ...additionalHeaders
   };
   const url = `${baseUrl}${path}${queryString}`;
   const bodyContent = (() => {
@@ -174,6 +178,8 @@ function transformEthFlowOrder(order) {
 // src/api.ts
 var PROD_BASE_URL = "https://api.cow.fi";
 var STAGING_BASE_URL = "https://barn.api.cow.fi";
+var PARTNER_PROD_BASE_URL = "https://partners.cow.fi";
+var PARTNER_STAGING_BASE_URL = "https://partners.barn.cow.fi";
 var ORDER_BOOK_PROD_CONFIG = {
   [import_sdk_config2.SupportedChainId.MAINNET]: `${PROD_BASE_URL}/mainnet`,
   [import_sdk_config2.SupportedChainId.GNOSIS_CHAIN]: `${PROD_BASE_URL}/xdai`,
@@ -202,6 +208,34 @@ var ORDER_BOOK_STAGING_CONFIG = {
   [import_sdk_config2.SupportedChainId.PLASMA]: `${STAGING_BASE_URL}/plasma`,
   [import_sdk_config2.SupportedChainId.INK]: `${STAGING_BASE_URL}/ink`
 };
+var ORDER_BOOK_PARTNER_PROD_CONFIG = {
+  [import_sdk_config2.SupportedChainId.MAINNET]: `${PARTNER_PROD_BASE_URL}/mainnet`,
+  [import_sdk_config2.SupportedChainId.GNOSIS_CHAIN]: `${PARTNER_PROD_BASE_URL}/xdai`,
+  [import_sdk_config2.SupportedChainId.ARBITRUM_ONE]: `${PARTNER_PROD_BASE_URL}/arbitrum_one`,
+  [import_sdk_config2.SupportedChainId.BASE]: `${PARTNER_PROD_BASE_URL}/base`,
+  [import_sdk_config2.SupportedChainId.SEPOLIA]: `${PARTNER_PROD_BASE_URL}/sepolia`,
+  [import_sdk_config2.SupportedChainId.POLYGON]: `${PARTNER_PROD_BASE_URL}/polygon`,
+  [import_sdk_config2.SupportedChainId.AVALANCHE]: `${PARTNER_PROD_BASE_URL}/avalanche`,
+  [import_sdk_config2.SupportedChainId.LENS]: `${PARTNER_PROD_BASE_URL}/lens`,
+  [import_sdk_config2.SupportedChainId.BNB]: `${PARTNER_PROD_BASE_URL}/bnb`,
+  [import_sdk_config2.SupportedChainId.LINEA]: `${PARTNER_PROD_BASE_URL}/linea`,
+  [import_sdk_config2.SupportedChainId.PLASMA]: `${PARTNER_PROD_BASE_URL}/plasma`,
+  [import_sdk_config2.SupportedChainId.INK]: `${PARTNER_PROD_BASE_URL}/ink`
+};
+var ORDER_BOOK_PARTNER_STAGING_CONFIG = {
+  [import_sdk_config2.SupportedChainId.MAINNET]: `${PARTNER_STAGING_BASE_URL}/mainnet`,
+  [import_sdk_config2.SupportedChainId.GNOSIS_CHAIN]: `${PARTNER_STAGING_BASE_URL}/xdai`,
+  [import_sdk_config2.SupportedChainId.ARBITRUM_ONE]: `${PARTNER_STAGING_BASE_URL}/arbitrum_one`,
+  [import_sdk_config2.SupportedChainId.BASE]: `${PARTNER_STAGING_BASE_URL}/base`,
+  [import_sdk_config2.SupportedChainId.SEPOLIA]: `${PARTNER_STAGING_BASE_URL}/sepolia`,
+  [import_sdk_config2.SupportedChainId.POLYGON]: `${PARTNER_STAGING_BASE_URL}/polygon`,
+  [import_sdk_config2.SupportedChainId.AVALANCHE]: `${PARTNER_STAGING_BASE_URL}/avalanche`,
+  [import_sdk_config2.SupportedChainId.LENS]: `${PARTNER_STAGING_BASE_URL}/lens`,
+  [import_sdk_config2.SupportedChainId.BNB]: `${PARTNER_STAGING_BASE_URL}/bnb`,
+  [import_sdk_config2.SupportedChainId.LINEA]: `${PARTNER_STAGING_BASE_URL}/linea`,
+  [import_sdk_config2.SupportedChainId.PLASMA]: `${PARTNER_STAGING_BASE_URL}/plasma`,
+  [import_sdk_config2.SupportedChainId.INK]: `${PARTNER_STAGING_BASE_URL}/ink`
+};
 function cleanObjectFromUndefinedValues(obj) {
   return Object.keys(obj).reduce(
     (acc, key) => {
@@ -427,8 +461,8 @@ var OrderBookApi = class {
    * @returns The API endpoint to get the order.
    */
   getOrderLink(orderUid, contextOverride) {
-    const { chainId, env } = this.getContextWithOverride(contextOverride);
-    return this.getApiBaseUrls(env)[chainId] + `/api/v1/orders/${orderUid}`;
+    const context = this.getContextWithOverride(contextOverride ?? {});
+    return this.getApiBaseUrls(context)[context.chainId] + `/api/v1/orders/${orderUid}`;
   }
   /**
    * Apply an override to the context for a request.
@@ -439,14 +473,18 @@ var OrderBookApi = class {
     return { ...this.context, ...contextOverride };
   }
   /**
-   * Get the base URLs for the API endpoints given the environment.
-   * @param env The environment to get the base URLs for.
+   * Get the base URLs for the API endpoints given the context.
+   * Uses partner URLs when apiKey is set (and no custom baseUrls override).
+   * @param context The merged API context for the request.
    * @returns The base URLs for the API endpoints.
    */
-  getApiBaseUrls(env) {
-    if (this.context.baseUrls)
-      return this.context.baseUrls;
-    return env === "prod" ? ORDER_BOOK_PROD_CONFIG : ORDER_BOOK_STAGING_CONFIG;
+  getApiBaseUrls(context) {
+    if (context.baseUrls)
+      return context.baseUrls;
+    if (context.apiKey) {
+      return context.env === "prod" ? ORDER_BOOK_PARTNER_PROD_CONFIG : ORDER_BOOK_PARTNER_STAGING_CONFIG;
+    }
+    return context.env === "prod" ? ORDER_BOOK_PROD_CONFIG : ORDER_BOOK_STAGING_CONFIG;
   }
   /**
    * Make a request to the API.
@@ -455,12 +493,14 @@ var OrderBookApi = class {
    * @returns The response from the API.
    */
   fetch(params, contextOverride = {}) {
-    const { chainId, env, backoffOpts: _backoffOpts } = this.getContextWithOverride(contextOverride);
-    const baseUrl = this.getApiBaseUrls(env)[chainId];
+    const context = this.getContextWithOverride(contextOverride);
+    const { chainId, backoffOpts: _backoffOpts, apiKey } = context;
+    const baseUrl = this.getApiBaseUrls(context)[chainId];
     const backoffOpts = _backoffOpts || DEFAULT_BACKOFF_OPTIONS;
     const rateLimiter = contextOverride.limiterOpts ? new import_limiter.RateLimiter(contextOverride.limiterOpts) : this.rateLimiter;
+    const additionalHeaders = apiKey ? { "X-API-Key": apiKey } : void 0;
     (0, import_sdk_common.log)(`Fetching OrderBook API: ${baseUrl}${params.path}. Params: ${JSON.stringify(params, import_sdk_common.jsonWithBigintReplacer)}`);
-    return request(baseUrl, params, rateLimiter, backoffOpts);
+    return request(baseUrl, params, rateLimiter, backoffOpts, additionalHeaders);
   }
 };
 
@@ -629,90 +669,14 @@ var SigningScheme = /* @__PURE__ */ ((SigningScheme2) => {
   return SigningScheme2;
 })(SigningScheme || {});
 
-// src/quoteAmountsAndCostsUtils.ts
+// src/quoteAmountsAndCosts/quoteAmountsAndCosts.const.ts
 var HUNDRED_THOUSANDS = 1e5;
 var ONE_HUNDRED_BPS = BigInt(100 * 100);
-function getQuoteAmountsWithCosts(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,
-    networkCostAmount,
-    quotePrice,
-    sellAmountBeforeNetworkCosts
-  } = _getQuoteAmountsWithCosts({
-    sellDecimals,
-    buyDecimals,
-    orderParams,
-    protocolFeeAmount: getBigNumber(protocolFeeAmount, protocolFeeAmountDecimals),
-    isSell
-  });
-  return {
-    isSell,
-    quotePrice,
-    sellAmountAfterNetworkCosts: sellAmountAfterNetworkCosts.big,
-    buyAmountAfterNetworkCosts: buyAmountAfterNetworkCosts.big,
-    buyAmountBeforeNetworkCosts: buyAmountBeforeNetworkCosts.big,
-    networkCostAmount: networkCostAmount.big,
-    sellAmountBeforeNetworkCosts: sellAmountBeforeNetworkCosts.big
-  };
-}
-function _getQuoteAmountsWithCosts(params) {
-  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 = 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
-  );
-  const buyAmountBeforeNetworkCosts = getBigNumber(quotePrice * sellAmountAfterNetworkCosts.num, buyDecimals);
-  return {
-    isSell,
-    quotePrice,
-    networkCostAmount,
-    sellAmountBeforeNetworkCosts,
-    buyAmountAfterNetworkCosts,
-    sellAmountAfterNetworkCosts,
-    buyAmountBeforeNetworkCosts
-  };
-}
-function getQuoteAmountsWithPartnerFee(params) {
-  const {
-    sellAmountAfterNetworkCosts,
-    buyAmountAfterNetworkCosts,
-    buyAmountBeforeProtocolFee,
-    sellAmountBeforeProtocolFee,
-    isSell,
-    partnerFeeBps
-  } = params;
-  const surplusAmountForPartnerFee = isSell ? buyAmountBeforeProtocolFee : sellAmountBeforeProtocolFee;
-  const partnerFeeAmount = partnerFeeBps > 0 ? surplusAmountForPartnerFee * BigInt(partnerFeeBps) / ONE_HUNDRED_BPS : BigInt(0);
-  const afterPartnerFees = isSell ? {
-    sellAmount: sellAmountAfterNetworkCosts,
-    buyAmount: buyAmountAfterNetworkCosts - partnerFeeAmount
-  } : {
-    sellAmount: sellAmountAfterNetworkCosts + partnerFeeAmount,
-    buyAmount: buyAmountAfterNetworkCosts
-  };
-  return {
-    partnerFeeAmount,
-    afterPartnerFees
-  };
-}
+
+// src/quoteAmountsAndCosts/getProtocolFeeAmount.ts
 function getProtocolFeeAmount(params) {
-  const { orderParams, protocolFeeBps, isSell } = params;
+  const { orderParams, protocolFeeBps } = params;
+  const isSell = orderParams.kind === "sell" /* SELL */;
   if (protocolFeeBps <= 0) {
     return 0n;
   }
@@ -730,9 +694,29 @@ function getProtocolFeeAmount(params) {
     return (sellAmount + feeAmount) * protocolFeeBpsBig / denominator;
   }
 }
-function getQuoteAmountsWithSlippage(params) {
-  const { afterPartnerFees, isSell, slippagePercentBps } = params;
-  const getSlippageAmount = (amount) => amount * BigInt(slippagePercentBps) / ONE_HUNDRED_BPS;
+
+// src/quoteAmountsAndCosts/getQuoteAmountsAfterPartnerFee.ts
+function getQuoteAmountsAfterPartnerFee(params) {
+  const { afterNetworkCosts, beforeAllFees, isSell, partnerFeeBps } = params;
+  const surplusAmountForPartnerFee = isSell ? beforeAllFees.buyAmount : beforeAllFees.sellAmount;
+  const partnerFeeAmount = partnerFeeBps > 0 ? surplusAmountForPartnerFee * BigInt(partnerFeeBps) / ONE_HUNDRED_BPS : BigInt(0);
+  const afterPartnerFees = isSell ? {
+    sellAmount: afterNetworkCosts.sellAmount,
+    buyAmount: afterNetworkCosts.buyAmount - partnerFeeAmount
+  } : {
+    sellAmount: afterNetworkCosts.sellAmount + partnerFeeAmount,
+    buyAmount: afterNetworkCosts.buyAmount
+  };
+  return {
+    partnerFeeAmount,
+    afterPartnerFees
+  };
+}
+
+// src/quoteAmountsAndCosts/getQuoteAmountsAfterSlippage.ts
+function getQuoteAmountsAfterSlippage(params) {
+  const { afterPartnerFees, isSell, slippageBps } = params;
+  const getSlippageAmount = (amount) => amount * BigInt(slippageBps) / ONE_HUNDRED_BPS;
   const afterSlippage = isSell ? {
     sellAmount: afterPartnerFees.sellAmount,
     buyAmount: afterPartnerFees.buyAmount - getSlippageAmount(afterPartnerFees.buyAmount)
@@ -744,66 +728,76 @@ function getQuoteAmountsWithSlippage(params) {
     afterSlippage
   };
 }
+
+// src/quoteAmountsAndCosts/getQuoteAmountsAndCosts.ts
 function getQuoteAmountsAndCosts(params) {
-  const { orderParams, sellDecimals, buyDecimals, slippagePercentBps } = params;
+  const { orderParams, slippagePercentBps } = params;
   const partnerFeeBps = params.partnerFeeBps ?? 0;
   const protocolFeeBps = params.protocolFeeBps ?? 0;
   const isSell = orderParams.kind === "sell" /* SELL */;
+  const sellAmount = BigInt(orderParams.sellAmount);
+  const buyAmount = BigInt(orderParams.buyAmount);
+  const networkCostAmount = BigInt(orderParams.feeAmount);
+  const networkCostAmountInBuyCurrency = buyAmount * networkCostAmount / sellAmount;
   const protocolFeeAmount = getProtocolFeeAmount({
     orderParams,
-    isSell,
     protocolFeeBps
   });
-  const protocolFeeAmountDecimals = isSell ? buyDecimals : sellDecimals;
-  const {
-    networkCostAmount,
-    sellAmountBeforeNetworkCosts,
-    buyAmountAfterNetworkCosts,
-    sellAmountAfterNetworkCosts,
-    buyAmountBeforeNetworkCosts,
-    quotePrice
-  } = _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: sellAmountAfterNetworkCosts.big,
-    buyAmountAfterNetworkCosts: buyAmountAfterNetworkCosts.big,
-    buyAmountBeforeProtocolFee,
-    sellAmountBeforeProtocolFee,
+  const beforeAllFees = isSell ? {
+    // Only in case of SELL order, network costs are already added to sellAmount which comes from /quote API
+    sellAmount: sellAmount + networkCostAmount,
+    /**
+     * Important!
+     * For SELL orders, /quote API returns sellAmount AFTER network costs
+     * buyAmount is correlated to that sellAmount, hence, it doesn't include network costs as well
+     * Because of that, we add network costs here as well to have both amounts consistent
+     */
+    buyAmount: buyAmount + networkCostAmountInBuyCurrency + protocolFeeAmount
+  } : {
+    sellAmount: sellAmount - protocolFeeAmount,
+    buyAmount
+  };
+  const afterProtocolFees = isSell ? {
+    sellAmount: beforeAllFees.sellAmount,
+    buyAmount: beforeAllFees.buyAmount - protocolFeeAmount
+  } : {
+    sellAmount,
+    buyAmount: beforeAllFees.buyAmount
+  };
+  const afterNetworkCosts = isSell ? {
+    // For SELL order, the /quote API response sellAmount is already after network costs
+    // buyAmount is relative to sellAmount, hence it's also after network costs
+    sellAmount,
+    buyAmount
+  } : {
+    // For BUY order, the /quote API response sellAmount is only after protocolFee, so we need to add networks costs to the amount
+    sellAmount: sellAmount + networkCostAmount,
+    buyAmount: afterProtocolFees.buyAmount
+  };
+  const { afterPartnerFees, partnerFeeAmount } = getQuoteAmountsAfterPartnerFee({
+    afterNetworkCosts,
+    beforeAllFees,
     isSell,
     partnerFeeBps
   });
-  const { afterSlippage } = getQuoteAmountsWithSlippage({
+  const { afterSlippage } = getQuoteAmountsAfterSlippage({
     afterPartnerFees,
     isSell,
-    slippagePercentBps
+    slippageBps: slippagePercentBps
   });
-  const beforeNetworkCosts = isSell ? {
-    sellAmount: sellAmountBeforeNetworkCosts.big,
-    buyAmount: buyAmountBeforeProtocolFee
+  const amountsToSign = isSell ? {
+    sellAmount: beforeAllFees.sellAmount,
+    buyAmount: afterSlippage.buyAmount
   } : {
-    sellAmount: sellAmountBeforeProtocolFee,
-    buyAmount: buyAmountBeforeNetworkCosts.big
-  };
-  const beforeAllFees = isSell ? {
-    sellAmount: sellAmountBeforeNetworkCosts.big,
-    buyAmount: buyAmountBeforeNetworkCosts.big
-  } : {
-    sellAmount: sellAmountBeforeNetworkCosts.big - protocolFeeAmount,
-    buyAmount: buyAmountBeforeNetworkCosts.big
+    sellAmount: afterSlippage.sellAmount,
+    buyAmount: beforeAllFees.buyAmount
   };
   return {
     isSell,
     costs: {
       networkFee: {
-        amountInSellCurrency: networkCostAmount.big,
-        amountInBuyCurrency: getBigNumber(quotePrice * networkCostAmount.num, buyDecimals).big
+        amountInSellCurrency: networkCostAmount,
+        amountInBuyCurrency: networkCostAmountInBuyCurrency
       },
       partnerFee: {
         amount: partnerFeeAmount,
@@ -814,27 +808,15 @@ function getQuoteAmountsAndCosts(params) {
         bps: protocolFeeBps
       }
     },
-    beforeNetworkCosts,
     beforeAllFees,
-    afterNetworkCosts: {
-      sellAmount: sellAmountAfterNetworkCosts.big,
-      buyAmount: buyAmountAfterNetworkCosts.big
-    },
+    beforeNetworkCosts: afterProtocolFees,
+    afterProtocolFees,
+    afterNetworkCosts,
     afterPartnerFees,
-    afterSlippage
+    afterSlippage,
+    amountsToSign
   };
 }
-function getBigNumber(value, decimals) {
-  if (typeof value === "number") {
-    const bigAsNumber = value * 10 ** decimals;
-    const bigAsNumberString = bigAsNumber.toFixed();
-    const big2 = BigInt(bigAsNumberString.includes("e") ? bigAsNumber : bigAsNumberString);
-    return { big: big2, num: value };
-  }
-  const big = BigInt(value);
-  const num = Number(big) / 10 ** decimals;
-  return { big, num };
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BuyTokenDestination,
@@ -842,6 +824,8 @@ function getBigNumber(value, decimals) {
   DEFAULT_BACKOFF_OPTIONS,
   DEFAULT_LIMITER_OPTIONS,
   EcdsaSigningScheme,
+  ORDER_BOOK_PARTNER_PROD_CONFIG,
+  ORDER_BOOK_PARTNER_STAGING_CONFIG,
   ORDER_BOOK_PROD_CONFIG,
   ORDER_BOOK_STAGING_CONFIG,
   OnchainOrderData,
@@ -858,8 +842,9 @@ function getBigNumber(value, decimals) {
   PriceQuality,
   SellTokenSource,
   SigningScheme,
-  getBigNumber,
+  getProtocolFeeAmount,
+  getQuoteAmountsAfterPartnerFee,
+  getQuoteAmountsAfterSlippage,
   getQuoteAmountsAndCosts,
-  getQuoteAmountsWithCosts,
   request
 });