@paraswap/dex-lib 4.0.0 → 4.0.1-balancer-v3-cables.0

package/src/dex/balancer-v3/types.ts

@@ -0,0 +1,86 @@
+import { BufferState } from '@balancer-labs/balancer-maths';
+import { Address } from '../../types';
+
+// Immutable data types available on all pools (Available from API)
+export type CommonImmutablePoolState = {
+  poolAddress: string;
+  poolType: string;
+  // For boosted pools tokens is the actual pool token wrapped, e.g. aUSDC/aDAI
+  tokens: string[];
+  // For boosted pools underlying is the unwrapped token, e.g. USDC/DAI
+  tokensUnderlying: (string | null)[];
+  weights: bigint[];
+  // TODO re-introduce this once added to API
+  // scalingFactors: bigint[];
+  hookType: string | undefined;
+};
+
+// Mutable data types available on all pools (Available via onchain calls/events)
+export interface CommonMutableState {
+  tokenRates: bigint[];
+  balancesLiveScaled18: bigint[];
+  swapFee: bigint;
+  aggregateSwapFee: bigint;
+  totalSupply: bigint;
+  isPoolPaused: boolean;
+  // TODO remove this once API provides it
+  scalingFactors: bigint[];
+  // TODO remove this once API provides it
+  hasHook: boolean;
+}
+
+type CommonPoolState = CommonImmutablePoolState & CommonMutableState;
+
+export type PoolState =
+  | CommonPoolState
+  | (CommonPoolState & StableMutableState);
+
+// Stable Pool specific mutable data
+export interface StableMutableState {
+  amp: bigint;
+  ampIsUpdating: boolean;
+  ampStartValue: bigint;
+  ampEndValue: bigint;
+  ampStartTime: bigint;
+  ampStopTime: bigint;
+}
+
+export type PoolStateMap = {
+  [address: string]: PoolState;
+};
+
+export type ImmutablePoolStateMap = {
+  [address: string]: CommonImmutablePoolState;
+};
+
+export type Step = {
+  pool: Address;
+  isBuffer: boolean;
+  swapInput: {
+    tokenIn: Address;
+    tokenOut: Address;
+  };
+  poolState: PoolState | BufferState;
+};
+
+export type BalancerV3Data = {
+  steps: Step[];
+};
+
+export type DexParams = {
+  // Used to map network > API Name, e.g. 11155111>SEPOLIA
+  apiNetworkName: string;
+  vaultAddress: string;
+  // This router handles single swaps
+  // https://github.com/balancer/balancer-v3-monorepo/blob/main/pkg/interfaces/contracts/vault/IRouter.sol
+  balancerRouterAddress: string;
+  balancerBatchRouterAddress: string;
+};
+
+export type TokenInfo = {
+  isBoosted: boolean;
+  underlyingToken: string | null;
+  mainToken: string;
+  index: number;
+  rate: bigint;
+};

package/src/dex/balancer-v3/weightedPool.ts

@@ -0,0 +1,2 @@
+// https://sepolia.etherscan.io/tx/0xe07958ff341aab57ab96a10347b65979b5b041f6408336d7e160e59bd02f9a40
+export const WEIGHTED_GAS_COST = 154000;

package/src/dex/index.ts

@@ -93,6 +93,8 @@ import { AaveGsm } from './aave-gsm/aave-gsm';
 import { LitePsm } from './lite-psm/lite-psm';
 import { UsualBond } from './usual-bond/usual-bond';
 import { StkGHO } from './stkgho/stkgho';
+import { BalancerV3 } from './balancer-v3/balancer-v3';
+import { balancerV3Merge } from './balancer-v3/optimizer';
 import { SkyConverter } from './sky-converter/sky-converter';
 import { Stader } from './stader/stader';
 
@@ -122,6 +124,7 @@ const Dexes = [
   Swerve,
   BalancerV1,
   BalancerV2,
+  BalancerV3,
   UniswapV2,
   UniswapV3,
   Algebra,
@@ -215,6 +218,7 @@ export class DexAdapterService {
   public routeOptimizers: IRouteOptimizer<UnoptimizedRate>[] = [
     balancerV1Merge,
     balancerV2Merge,
+    balancerV3Merge,
     uniswapMerge,
     curveV1Merge,
   ];

package/src/dex/weth/config.ts

@@ -25,6 +25,9 @@ export const WethConfig: DexConfigMap<DexParams> = {
     [Network.BASE]: {
       poolGasCost: WethGasCost,
     },
+    [Network.SEPOLIA]: {
+      poolGasCost: WethGasCost,
+    },
   },
   Wbnb: {
     [Network.BSC]: {

package/src/executor/Executor01BytecodeBuilder.ts

@@ -275,6 +275,7 @@ export class Executor01BytecodeBuilder extends ExecutorBytecodeBuilder<
         curExchangeParam.approveData.target,
         curExchangeParam.approveData.token,
         flags.approves[index],
+        curExchangeParam.permit2Approval,
       );
 
       swapCallData = hexConcat([approveCallData, swapCallData]);
@@ -298,6 +299,7 @@ export class Executor01BytecodeBuilder extends ExecutorBytecodeBuilder<
               curExchangeParam.approveData.target,
               curExchangeParam.approveData.token,
               flags.approves[index],
+              curExchangeParam.permit2Approval,
             );
           }
 

package/src/executor/Executor02BytecodeBuilder.ts

@@ -613,6 +613,7 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder<
         curExchangeParam.approveData.target,
         curExchangeParam.approveData.token,
         flags.approves[exchangeParamIndex],
+        curExchangeParam.permit2Approval,
       );
 
       swapExchangeCallData = hexConcat([approveCallData, swapExchangeCallData]);
@@ -630,6 +631,7 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder<
             curExchangeParam.approveData.target,
             curExchangeParam.approveData.token,
             flags.approves[exchangeParamIndex],
+            curExchangeParam.permit2Approval,
           );
         }
 

package/src/executor/Executor03BytecodeBuilder.ts

@@ -186,6 +186,7 @@ export class Executor03BytecodeBuilder extends ExecutorBytecodeBuilder<
         curExchangeParam.approveData.target,
         curExchangeParam.approveData.token,
         flags.approves[index],
+        curExchangeParam.permit2Approval,
       );
 
       swapCallData = hexConcat([approveCallData, swapCallData]);
@@ -205,6 +206,7 @@ export class Executor03BytecodeBuilder extends ExecutorBytecodeBuilder<
           curExchangeParam.approveData.target,
           curExchangeParam.approveData.token,
           flags.approves[index],
+          curExchangeParam.permit2Approval,
         );
       }
 

package/src/executor/ExecutorBytecodeBuilder.ts

@@ -1,6 +1,7 @@
 import { Interface } from '@ethersproject/abi';
 import { IDexHelper } from '../dex-helper';
 import ERC20ABI from '../abi/erc20.json';
+import Permit2Abi from '../abi/permit2.json';
 import { ethers } from 'ethers';
 import {
   Address,
@@ -23,14 +24,17 @@ import {
   DISABLED_MAX_UNIT_APPROVAL_TOKENS,
 } from './constants';
 import { Executors, Flag, SpecialDex } from './types';
-import { MAX_UINT, Network } from '../constants';
+import { MAX_UINT, Network, PERMIT2_ADDRESS } from '../constants';
 import { DexExchangeBuildParam, DexExchangeParam } from '../types';
-import { ExecutorDetector } from './ExecutorDetector';
+import { BI_MAX_UINT160, BI_MAX_UINT48 } from '../bigint-constants';
 
 const {
   utils: { hexlify, hexDataLength, hexConcat, hexZeroPad, solidityPack },
 } = ethers;
 
+const MAX_UINT48 = BI_MAX_UINT48.toString();
+const MAX_UINT160 = BI_MAX_UINT160.toString();
+
 export type SingleSwapCallDataParams<T> = {
   priceRoute: OptimalRate;
   exchangeParams: DexExchangeBuildParam[];
@@ -54,9 +58,11 @@ export type DexCallDataParams<T> = {
 export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
   type!: Executors;
   erc20Interface: Interface;
+  permit2Interface: Interface;
 
   constructor(protected dexHelper: IDexHelper) {
     this.erc20Interface = new Interface(ERC20ABI);
+    this.permit2Interface = new Interface(Permit2Abi);
   }
 
   protected buildSimpleSwapFlags(
@@ -120,8 +126,13 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
     spender: string,
     tokenAddr: Address,
     flag: Flag,
+    permit2 = false,
     amount = MAX_UINT,
   ): string {
+    if (permit2) {
+      return this.buildPermit2CallData(spender, tokenAddr, flag);
+    }
+
     let approveCalldata = this.erc20Interface.encodeFunctionData('approve', [
       spender,
       amount,
@@ -155,6 +166,7 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
           spender,
           tokenAddr,
           Flag.DONT_INSERT_FROM_AMOUNT_DONT_CHECK_BALANCE_AFTER_SWAP,
+          false,
           '0',
         ),
         approvalCalldata,
@@ -164,6 +176,55 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
     return approvalCalldata;
   }
 
+  protected buildPermit2CallData(
+    spender: string,
+    tokenAddr: Address,
+    flag: Flag,
+  ): string {
+    // first, give approval for Permit2 on the token contract
+    // (with this approval, Permit2 contract can invoke safeTransferFrom on the token)
+    let approveData = this.erc20Interface.encodeFunctionData('approve', [
+      PERMIT2_ADDRESS,
+      MAX_UINT,
+    ]);
+
+    let approvalCalldata = this.buildCallData(
+      tokenAddr,
+      approveData,
+      0,
+      APPROVE_CALLDATA_DEST_TOKEN_POS,
+      SpecialDex.DEFAULT,
+      Flag.DONT_INSERT_FROM_AMOUNT_DONT_CHECK_BALANCE_AFTER_SWAP,
+    );
+
+    // second, give approval for spender on Permit2 contract
+    // (with this approval, spender can interact with Permit2 on behalf of the executor)
+    let permit2Data = this.permit2Interface.encodeFunctionData('approve', [
+      tokenAddr,
+      spender,
+      MAX_UINT160,
+      MAX_UINT48,
+    ]);
+
+    let permit2Calldata = this.buildCallData(
+      PERMIT2_ADDRESS,
+      permit2Data,
+      0,
+      APPROVE_CALLDATA_DEST_TOKEN_POS,
+      SpecialDex.DEFAULT,
+      flag,
+    );
+
+    // as approval given only for MAX_UNIT or 0, no need to use insertFromAmount flag
+    const checkSrcTokenBalance = flag % 3 === 2;
+
+    if (checkSrcTokenBalance) {
+      permit2Calldata = hexConcat([permit2Calldata, ZEROS_12_BYTES, tokenAddr]);
+    }
+
+    return hexConcat([approvalCalldata, permit2Calldata]);
+  }
+
   protected buildWrapEthCallData(
     wethAddress: string,
     depositCallData: string,

package/src/generic-swap-transaction-builder.ts

@@ -687,7 +687,7 @@ export class GenericSwapTransactionBuilder {
   ): Promise<DexExchangeBuildParam[]> {
     const spender = bytecodeBuilder.getAddress();
     const tokenTargetMapping: {
-      params: [token: Address, target: Address];
+      params: [token: Address, target: Address, permit2: boolean];
       exchangeParamIndex: number;
     }[] = [];
 
@@ -704,7 +704,11 @@ export class GenericSwapTransactionBuilder {
 
           if (approveParams) {
             tokenTargetMapping.push({
-              params: [approveParams.token, approveParams?.target],
+              params: [
+                approveParams.token,
+                approveParams.target,
+                !!curExchangeParam.permit2Approval,
+              ],
               exchangeParamIndex: currentExchangeParamIndex,
             });
           }

package/src/types.ts

@@ -173,6 +173,7 @@ export type DexExchangeParam = {
   swappedAmountNotPresentInExchangeData?: boolean;
   preSwapUnwrapCalldata?: string;
   returnAmountPos: number | undefined;
+  permit2Approval?: boolean;
 };
 
 export type DexExchangeParamWithBooleanNeedWrapNative = DexExchangeParam & {

package/tests/constants-e2e.ts

@@ -1480,10 +1480,18 @@ export const Tokens: {
       address: '0xDDAfbb505ad214D7b80b1f830fcCc89B60fb7A83',
       decimals: 6,
     },
+    USDCe: {
+      address: '0x2a22f9c3b484c3629090feed35f17ff8f88f76f0',
+      decimals: 6,
+    },
     USDT: {
       address: '0x4ECaBa5870353805a9F068101A40E0f32ed605C6',
       decimals: 6,
     },
+    COW: {
+      address: '0x177127622c4A00F3d409B75571e12cB3c8973d3c',
+      decimals: 18,
+    },
     WXDAI: {
       address: '0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d',
       decimals: 18,
@@ -1492,10 +1500,18 @@ export const Tokens: {
       address: '0xa818f1b57c201e092c4a2017a91815034326efd1',
       decimals: 18,
     },
+    waGnoWETH: {
+      address: '0x57f664882F762FA37903FC864e2B633D384B411A',
+      decimals: 18,
+    },
     aGnowstETH: {
       address: '0x23e4e76d01b2002be436ce8d6044b0aa2f68b68a',
       decimals: 18,
     },
+    waGnowstETH: {
+      address: '0x773CDA0CADe2A3d86E6D4e30699d40bB95174ff2',
+      decimals: 18,
+    },
     aGnoUSDC: {
       address: '0xc6b7aca6de8a6044e0e32d0c841a89244a10d284',
       decimals: 6,
@@ -1619,6 +1635,41 @@ export const Tokens: {
       decimals: 6,
     },
   },
+  [Network.SEPOLIA]: {
+    ETH: { address: ETHER_ADDRESS, decimals: 18 },
+    WETH: {
+      address: '0x7b79995e5f793a07bc00c21412e50ecae098e7f9',
+      decimals: 18,
+    },
+    bal: {
+      address: `0xb19382073c7a0addbb56ac6af1808fa49e377b75`,
+      decimals: 18,
+    },
+    daiAave: {
+      address: `0xff34b3d4aee8ddcd6f9afffb6fe49bd371b8a357`,
+      decimals: 18,
+    },
+    usdcAave: {
+      address: `0x94a9d9ac8a22534e3faca9f4e7f2e2cf85d5e4c8`,
+      decimals: 6,
+    },
+    usdtAave: {
+      address: `0xaa8e23fb1079ea71e0a56f48a2aa51851d8433d0`,
+      decimals: 6,
+    },
+    aDaiAave: {
+      address: `0xde46e43f46ff74a23a65ebb0580cbe3dfe684a17`,
+      decimals: 18,
+    },
+    stataUSDC: {
+      address: `0x8a88124522dbbf1e56352ba3de1d9f78c143751e`,
+      decimals: 6,
+    },
+    stataUSDT: {
+      address: `0x978206fae13faf5a8d293fb614326b237684b750`,
+      decimals: 6,
+    },
+  },
 };
 
 export const Holders: {
@@ -1960,6 +2011,7 @@ export const Holders: {
     USDC: '0x99b31498b0a1dae01fc3433e3cb60f095340935c',
   },
   [Network.GNOSIS]: {
+    COW: '0x4fFAD6ac852c0Af0AA301376F4C5Dea3a928b120',
     XDAI: '0x9fc062032d4F2Fe7dAA601bd8B06C45F9c8f17Be',
     WXDAI: '0xBA12222222228d8Ba445958a75a0704d566BF2C8',
     WETH: '0x800e12aF6c96790EDDdc5B3f3302899e27B2A918',
@@ -1971,8 +2023,11 @@ export const Holders: {
     wstETH: '0x458cD345B4C05e8DF39d0A07220feb4Ec19F5e6f',
     aGnowstETH: '0x458cD345B4C05e8DF39d0A07220feb4Ec19F5e6f',
     sDAI: '0x79f08F2e75A8C99428DE4A2e6456c07C99E55da5',
+    USDCe: '0x555CE236C0220695b68341bc48C68d52210cC35b',
     crvUSD: '0xE4A982fa1f1E8AD1AF238A7b1226b13b56bf5CcD',
     SWPR: '0x9467dcFD4519287e3878C018c02f5670465a9003',
+    waGnoWETH: '0x854B004700885A61107B458f11eCC169A019b764',
+    waGnowstETH: '0x854B004700885A61107B458f11eCC169A019b764',
   },
   [Network.BASE]: {
     WETH: '0x4bb6b2efe7036020ba6f02a05602546c9f25bf28',
@@ -2000,6 +2055,15 @@ export const Holders: {
     cbETH: '0x50e011dD1e2b4906F1534623cD134B30422bb11E',
     wUSDM: '0xe30965Acd0Ee1CE2e0Cd0AcBFB3596bD6fC78A51',
   },
+  [Network.SEPOLIA]: {
+    bal: '0xDb4ff41B4C1222c2b1869A67Be115070688989a2',
+    daiAave: '0xbB0bc84687fFb642fd90a3D12215e7eC16352A49',
+    WETH: '0x546e37DAA15cdb82fd1a717E5dEEa4AF08D4349A',
+    ETH: '0x2CdA41645F2dBffB852a605E92B185501801FC28',
+    stataUSDC: '0x75D06bae37a9c349142fE7cee77804900b1C0EC3',
+    stataUSDT: '0x75D06bae37a9c349142fE7cee77804900b1C0EC3',
+    usdcAave: '0xdD5De55eA6804EFb283f43b0C091C25000a6486c',
+  },
 };
 
 export const SmartTokens = Object.keys(Tokens).reduce((acc, _network) => {
@@ -2025,6 +2089,7 @@ export const NativeTokenSymbols: { [network: number]: string } = {
   [Network.ARBITRUM]: 'ETH',
   [Network.OPTIMISM]: 'ETH',
   [Network.BASE]: 'ETH',
+  [Network.SEPOLIA]: 'ETH',
   [Network.GNOSIS]: 'XDAI',
 };
 
@@ -2037,5 +2102,6 @@ export const WrappedNativeTokenSymbols: { [network: number]: string } = {
   [Network.ARBITRUM]: 'WETH',
   [Network.OPTIMISM]: 'WETH',
   [Network.BASE]: 'WETH',
+  [Network.SEPOLIA]: 'WETH',
   [Network.GNOSIS]: 'WXDAI',
 };