@cowprotocol/sdk-trading 0.4.3 → 0.4.4

package/dist/index.d.mts

@@ -235,6 +235,12 @@ interface PostTradeAdditionalParams {
      */
     signingScheme?: SigningScheme;
     customEIP1271Signature?: (orderToSign: UnsignedOrder, signer: AbstractSigner<Provider>) => Promise<string>;
+    /**
+     * By default, we adjust the quoted sell/buy amounts to include network gas costs, slippage buffer,
+     * partner fees, and similar extras. Disable this when you prefer to post the raw amounts provided
+     * by the caller (for example, for limit orders that should not include these costs).
+     */
+    applyCostsSlippageAndFees?: boolean;
 }
 
 type QuoteResultsWithSigner = {
@@ -358,8 +364,9 @@ interface OrderToSignParams {
     isEthFlow: boolean;
     from: string;
     networkCostsAmount?: string;
+    applyCostsSlippageAndFees?: boolean;
 }
-declare function getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow }: OrderToSignParams, limitOrderParams: LimitTradeParameters, appDataKeccak256: string): UnsignedOrder;
+declare function getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow, applyCostsSlippageAndFees }: OrderToSignParams, limitOrderParams: LimitTradeParameters, appDataKeccak256: string): UnsignedOrder;
 
 declare function postCoWProtocolTrade(orderBookApi: OrderBookApi, appData: TradingAppDataInfo, params: LimitTradeParameters, additionalParams?: PostTradeAdditionalParams, paramSigner?: SignerLike): Promise<OrderPostingResult>;
 

package/dist/index.d.ts

@@ -235,6 +235,12 @@ interface PostTradeAdditionalParams {
      */
     signingScheme?: SigningScheme;
     customEIP1271Signature?: (orderToSign: UnsignedOrder, signer: AbstractSigner<Provider>) => Promise<string>;
+    /**
+     * By default, we adjust the quoted sell/buy amounts to include network gas costs, slippage buffer,
+     * partner fees, and similar extras. Disable this when you prefer to post the raw amounts provided
+     * by the caller (for example, for limit orders that should not include these costs).
+     */
+    applyCostsSlippageAndFees?: boolean;
 }
 
 type QuoteResultsWithSigner = {
@@ -358,8 +364,9 @@ interface OrderToSignParams {
     isEthFlow: boolean;
     from: string;
     networkCostsAmount?: string;
+    applyCostsSlippageAndFees?: boolean;
 }
-declare function getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow }: OrderToSignParams, limitOrderParams: LimitTradeParameters, appDataKeccak256: string): UnsignedOrder;
+declare function getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow, applyCostsSlippageAndFees }: OrderToSignParams, limitOrderParams: LimitTradeParameters, appDataKeccak256: string): UnsignedOrder;
 
 declare function postCoWProtocolTrade(orderBookApi: OrderBookApi, appData: TradingAppDataInfo, params: LimitTradeParameters, additionalParams?: PostTradeAdditionalParams, paramSigner?: SignerLike): Promise<OrderPostingResult>;
 

package/dist/index.js

@@ -133,7 +133,7 @@ function unsignedOrderForSigning(order) {
 }
 
 // src/getOrderToSign.ts
-function getOrderToSign({ chainId, from, networkCostsAmount = "0", isEthFlow }, limitOrderParams, appDataKeccak256) {
+function getOrderToSign({ chainId, from, networkCostsAmount = "0", isEthFlow, applyCostsSlippageAndFees = true }, limitOrderParams, appDataKeccak256) {
   const {
     sellAmount,
     buyAmount,
@@ -161,18 +161,24 @@ function getOrderToSign({ chainId, from, networkCostsAmount = "0", isEthFlow },
     appData: appDataKeccak256,
     partiallyFillable
   };
-  const { afterSlippage } = (0, import_sdk_order_book2.getQuoteAmountsAndCosts)({
-    orderParams,
-    slippagePercentBps: slippageBps,
-    partnerFeeBps: getPartnerFeeBps(partnerFee),
-    sellDecimals: sellTokenDecimals,
-    buyDecimals: buyTokenDecimals
-  });
+  let sellAmountToUse = sellAmount;
+  let buyAmountToUse = buyAmount;
+  if (applyCostsSlippageAndFees) {
+    const { afterSlippage } = (0, import_sdk_order_book2.getQuoteAmountsAndCosts)({
+      orderParams,
+      slippagePercentBps: slippageBps,
+      partnerFeeBps: getPartnerFeeBps(partnerFee),
+      sellDecimals: sellTokenDecimals,
+      buyDecimals: buyTokenDecimals
+    });
+    sellAmountToUse = afterSlippage.sellAmount.toString();
+    buyAmountToUse = afterSlippage.buyAmount.toString();
+  }
   return {
     sellToken,
     buyToken,
-    sellAmount: afterSlippage.sellAmount.toString(),
-    buyAmount: afterSlippage.buyAmount.toString(),
+    sellAmount: sellAmountToUse,
+    buyAmount: buyAmountToUse,
     validTo,
     kind,
     partiallyFillable,
@@ -374,7 +380,8 @@ async function postCoWProtocolTrade(orderBookApi, appData, params, additionalPar
   const {
     networkCostsAmount = "0",
     signingScheme: _signingScheme = import_sdk_order_book4.SigningScheme.EIP712,
-    customEIP1271Signature
+    customEIP1271Signature,
+    applyCostsSlippageAndFees
   } = additionalParams;
   const isEthFlow = getIsEthFlowOrder(params);
   if (isEthFlow) {
@@ -389,7 +396,11 @@ async function postCoWProtocolTrade(orderBookApi, appData, params, additionalPar
   const { appDataKeccak256, fullAppData } = appData;
   const chainId = orderBookApi.context.chainId;
   const from = owner || await signer.getAddress();
-  const orderToSign = getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow }, params, appData.appDataKeccak256);
+  const orderToSign = getOrderToSign(
+    { chainId, from, networkCostsAmount, isEthFlow, applyCostsSlippageAndFees },
+    params,
+    appData.appDataKeccak256
+  );
   (0, import_sdk_common5.log)("Signing order...");
   const { signature, signingScheme } = await (async () => {
     if (_signingScheme === import_sdk_order_book4.SigningScheme.PRESIGN) {
@@ -643,7 +654,9 @@ async function getQuoteRaw(_tradeParameters, trader, advancedSettings, _orderBoo
     env = "prod"
   } = tradeParameters;
   if (validTo !== void 0 && validFor !== void 0) {
-    throw new Error("Cannot specify both validFor and validTo. Use validFor for relative time or validTo for absolute time.");
+    throw new Error(
+      "Cannot specify both validFor and validTo. Use validFor for relative time or validTo for absolute time."
+    );
   }
   const effectiveValidFor = validFor ?? DEFAULT_QUOTE_VALIDITY;
   (0, import_sdk_common11.log)(

package/dist/index.mjs

@@ -81,7 +81,7 @@ function unsignedOrderForSigning(order) {
 }
 
 // src/getOrderToSign.ts
-function getOrderToSign({ chainId, from, networkCostsAmount = "0", isEthFlow }, limitOrderParams, appDataKeccak256) {
+function getOrderToSign({ chainId, from, networkCostsAmount = "0", isEthFlow, applyCostsSlippageAndFees = true }, limitOrderParams, appDataKeccak256) {
   const {
     sellAmount,
     buyAmount,
@@ -109,18 +109,24 @@ function getOrderToSign({ chainId, from, networkCostsAmount = "0", isEthFlow },
     appData: appDataKeccak256,
     partiallyFillable
   };
-  const { afterSlippage } = getQuoteAmountsAndCosts({
-    orderParams,
-    slippagePercentBps: slippageBps,
-    partnerFeeBps: getPartnerFeeBps(partnerFee),
-    sellDecimals: sellTokenDecimals,
-    buyDecimals: buyTokenDecimals
-  });
+  let sellAmountToUse = sellAmount;
+  let buyAmountToUse = buyAmount;
+  if (applyCostsSlippageAndFees) {
+    const { afterSlippage } = getQuoteAmountsAndCosts({
+      orderParams,
+      slippagePercentBps: slippageBps,
+      partnerFeeBps: getPartnerFeeBps(partnerFee),
+      sellDecimals: sellTokenDecimals,
+      buyDecimals: buyTokenDecimals
+    });
+    sellAmountToUse = afterSlippage.sellAmount.toString();
+    buyAmountToUse = afterSlippage.buyAmount.toString();
+  }
   return {
     sellToken,
     buyToken,
-    sellAmount: afterSlippage.sellAmount.toString(),
-    buyAmount: afterSlippage.buyAmount.toString(),
+    sellAmount: sellAmountToUse,
+    buyAmount: buyAmountToUse,
     validTo,
     kind,
     partiallyFillable,
@@ -330,7 +336,8 @@ async function postCoWProtocolTrade(orderBookApi, appData, params, additionalPar
   const {
     networkCostsAmount = "0",
     signingScheme: _signingScheme = SigningScheme3.EIP712,
-    customEIP1271Signature
+    customEIP1271Signature,
+    applyCostsSlippageAndFees
   } = additionalParams;
   const isEthFlow = getIsEthFlowOrder(params);
   if (isEthFlow) {
@@ -345,7 +352,11 @@ async function postCoWProtocolTrade(orderBookApi, appData, params, additionalPar
   const { appDataKeccak256, fullAppData } = appData;
   const chainId = orderBookApi.context.chainId;
   const from = owner || await signer.getAddress();
-  const orderToSign = getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow }, params, appData.appDataKeccak256);
+  const orderToSign = getOrderToSign(
+    { chainId, from, networkCostsAmount, isEthFlow, applyCostsSlippageAndFees },
+    params,
+    appData.appDataKeccak256
+  );
   log2("Signing order...");
   const { signature, signingScheme } = await (async () => {
     if (_signingScheme === SigningScheme3.PRESIGN) {
@@ -609,7 +620,9 @@ async function getQuoteRaw(_tradeParameters, trader, advancedSettings, _orderBoo
     env = "prod"
   } = tradeParameters;
   if (validTo !== void 0 && validFor !== void 0) {
-    throw new Error("Cannot specify both validFor and validTo. Use validFor for relative time or validTo for absolute time.");
+    throw new Error(
+      "Cannot specify both validFor and validTo. Use validFor for relative time or validTo for absolute time."
+    );
   }
   const effectiveValidFor = validFor ?? DEFAULT_QUOTE_VALIDITY;
   log4(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-trading",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "CowProtocol trading",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -29,17 +29,17 @@
     "ts-jest": "^29.0.0",
     "tsx": "^4.19.4",
     "@cowprotocol/sdk-ethers-v5-adapter": "0.2.0",
+    "@cow-sdk/typescript-config": "0.0.0-beta.0",
     "@cowprotocol/sdk-ethers-v6-adapter": "0.2.0",
-    "@cowprotocol/sdk-viem-adapter": "0.2.0",
-    "@cow-sdk/typescript-config": "0.0.0-beta.0"
+    "@cowprotocol/sdk-viem-adapter": "0.2.0"
   },
   "dependencies": {
     "deepmerge": "^4.3.1",
     "@cowprotocol/sdk-common": "0.3.0",
     "@cowprotocol/sdk-config": "0.2.0",
     "@cowprotocol/sdk-app-data": "4.1.5",
-    "@cowprotocol/sdk-order-signing": "0.1.8",
-    "@cowprotocol/sdk-contracts-ts": "0.4.2",
+    "@cowprotocol/sdk-order-signing": "0.1.9",
+    "@cowprotocol/sdk-contracts-ts": "0.4.3",
     "@cowprotocol/sdk-order-book": "0.1.4"
   },
   "scripts": {