@paraswap/dex-lib 2.28.7 → 2.28.9-take-surplus.0

package/src/router/directswap.ts

@@ -29,7 +29,7 @@ export class DirectSwap<DexDirectReturn> implements IRouter<DexDirectReturn> {
     referrerAddress: Address | undefined,
     partnerAddress: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,
@@ -76,13 +76,9 @@ export class DirectSwap<DexDirectReturn> implements IRouter<DexDirectReturn> {
           encodePartnerAddressForFeeLogic({
             partnerAddress,
             partnerFeePercent,
-            positiveSlippageToUser,
+            takeSurplus,
           }),
-          encodeFeePercent(
-            partnerFeePercent,
-            positiveSlippageToUser,
-            priceRoute.side,
-          ),
+          encodeFeePercent(partnerFeePercent, takeSurplus, priceRoute.side),
         ];
 
     return dex.getDirectParam!(

package/src/router/irouter.ts

@@ -9,7 +9,7 @@ export interface IRouter<RouterParam> {
     referrerAddress: Address | undefined,
     partner: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,

package/src/router/megaswap.ts

@@ -42,7 +42,7 @@ export class MegaSwap extends PayloadEncoder implements IRouter<MegaSwapParam> {
     referrerAddress: Address | undefined,
     partnerAddress: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,
@@ -58,13 +58,9 @@ export class MegaSwap extends PayloadEncoder implements IRouter<MegaSwapParam> {
           encodePartnerAddressForFeeLogic({
             partnerAddress,
             partnerFeePercent,
-            positiveSlippageToUser,
+            takeSurplus,
           }),
-          encodeFeePercent(
-            partnerFeePercent,
-            positiveSlippageToUser,
-            SwapSide.SELL,
-          ),
+          encodeFeePercent(partnerFeePercent, takeSurplus, SwapSide.SELL),
         ];
 
     const sellData: ContractMegaSwapSellData = {

package/src/router/multiswap.ts

@@ -45,7 +45,7 @@ export class MultiSwap
     referrerAddress: Address | undefined,
     partnerAddress: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,
@@ -66,13 +66,9 @@ export class MultiSwap
           encodePartnerAddressForFeeLogic({
             partnerAddress,
             partnerFeePercent,
-            positiveSlippageToUser,
+            takeSurplus,
           }),
-          encodeFeePercent(
-            partnerFeePercent,
-            positiveSlippageToUser,
-            SwapSide.SELL,
-          ),
+          encodeFeePercent(partnerFeePercent, takeSurplus, SwapSide.SELL),
         ];
 
     const sellData: ContractSellData = {

package/src/router/payload-encoder.ts

@@ -29,14 +29,14 @@ const HALF_SPLIT = '5000';
 export function encodePartnerAddressForFeeLogic({
   partnerAddress,
   partnerFeePercent,
-  positiveSlippageToUser,
+  takeSurplus,
 }: {
   partnerAddress: string;
   partnerFeePercent: string;
-  positiveSlippageToUser: boolean;
+  takeSurplus: boolean;
 }): string {
   const isPartnerTakeNoFeeNoPos =
-    +partnerFeePercent === 0 && positiveSlippageToUser == true;
+    +partnerFeePercent === 0 && takeSurplus == false;
 
   // nullify partner address to fallback default circuit contract without partner/referrer (no harm as no fee taken at all)
   const partner = isPartnerTakeNoFeeNoPos ? NULL_ADDRESS : partnerAddress;
@@ -51,11 +51,11 @@ export function encodePartnerAddressForFeeLogic({
 
 export function encodeFeePercent(
   partnerFeePercent: string,
-  positiveSlippageToUser: boolean,
+  takeSurplus: boolean,
   side: SwapSide,
 ) {
   const isNoFeeAndPositiveSlippageToPartner =
-    positiveSlippageToUser === false && BigInt(partnerFeePercent) === 0n;
+    takeSurplus === true && BigInt(partnerFeePercent) === 0n;
 
   let fee = isNoFeeAndPositiveSlippageToPartner
     ? BigInt(HALF_SPLIT)
@@ -70,9 +70,9 @@ export function encodeFeePercent(
     fee |= OneShift17;
   }
 
-  // Set 14th bit if positiveSlippageToUser is true
+  // Set 14th bit if takeSurplus is false
   // Upd: not used onchain anymore but better to keep to prevent collisions and ensure continuity of analytics
-  if (positiveSlippageToUser) fee |= OneShift14;
+  if (!takeSurplus) fee |= OneShift14;
 
   // Set 15th bit to take fee from srcToken
   if (side === SwapSide.BUY && !isNoFeeAndPositiveSlippageToPartner)

package/src/router/simpleswap.ts

@@ -223,7 +223,7 @@ export abstract class SimpleRouterBase<RouterParam>
     referrerAddress: Address | undefined,
     partnerAddress: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,
@@ -272,7 +272,7 @@ export abstract class SimpleRouter extends SimpleRouterBase<SimpleSwapParam> {
     referrerAddress: Address | undefined,
     partnerAddress: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,
@@ -292,13 +292,9 @@ export abstract class SimpleRouter extends SimpleRouterBase<SimpleSwapParam> {
           encodePartnerAddressForFeeLogic({
             partnerAddress,
             partnerFeePercent,
-            positiveSlippageToUser,
+            takeSurplus,
           }),
-          encodeFeePercent(
-            partnerFeePercent,
-            positiveSlippageToUser,
-            this.side,
-          ),
+          encodeFeePercent(partnerFeePercent, takeSurplus, this.side),
         ];
 
     const sellData: ConstractSimpleData = {

package/src/router/simpleswapnft.ts

@@ -60,7 +60,7 @@ export class SimpleBuyNFT extends SimpleRouterBase<SimpleBuyNFTParam> {
     referrerAddress: Address | undefined,
     partnerAddress: Address,
     partnerFeePercent: string,
-    positiveSlippageToUser: boolean,
+    takeSurplus: boolean,
     beneficiary: Address,
     permit: string,
     deadline: string,
@@ -102,13 +102,9 @@ export class SimpleBuyNFT extends SimpleRouterBase<SimpleBuyNFTParam> {
           encodePartnerAddressForFeeLogic({
             partnerAddress,
             partnerFeePercent,
-            positiveSlippageToUser,
+            takeSurplus,
           }),
-          encodeFeePercent(
-            partnerFeePercent,
-            positiveSlippageToUser,
-            SwapSide.BUY,
-          ),
+          encodeFeePercent(partnerFeePercent, takeSurplus, SwapSide.BUY),
         ];
 
     const buyData: ContractSimpleBuyNFTData = {

package/src/transaction-builder.ts

@@ -17,7 +17,7 @@ export class TransactionBuilder {
     referrerAddress,
     partnerAddress,
     partnerFeePercent,
-    positiveSlippageToUser,
+    takeSurplus,
     gasPrice,
     maxFeePerGas,
     maxPriorityFeePerGas,
@@ -33,7 +33,7 @@ export class TransactionBuilder {
     referrerAddress?: Address;
     partnerAddress: Address;
     partnerFeePercent: string;
-    positiveSlippageToUser?: boolean;
+    takeSurplus?: boolean;
     gasPrice?: string; // // @TODO: improve types? so that either gasPrice or ALL of max.*FeePerGas MUST be returned?
     maxFeePerGas?: string;
     maxPriorityFeePerGas?: string;
@@ -53,7 +53,7 @@ export class TransactionBuilder {
         referrerAddress,
         partnerAddress,
         partnerFeePercent,
-        positiveSlippageToUser ?? true,
+        takeSurplus ?? false,
         _beneficiary,
         permit || '0x',
         deadline,