feat: add liquidity unbalanced permit2

.github/workflows/checks.yml

@@ -53,5 +53,7 @@ jobs:
         uses: ./.github/actions/setup
       - name: Set up foundry (includes anvil)
         uses: foundry-rs/foundry-toolchain@v1
+        with:
+          cache: false
       - name: Run integration tests
         run: pnpm test:integration

app/(app)/debug/page.tsx

@@ -114,6 +114,9 @@ export default function Debug() {
         <Link as={NextLink} href="/debug/remove-allowance">
           Remove allowance
         </Link>
+        <Link as={NextLink} href="/debug/permit2-allowance">
+          Permit2 allowance
+        </Link>
       </VStack>
     </FadeInOnView>
   )

app/(app)/debug/permit2-allowance/page.tsx

@@ -0,0 +1,63 @@
+'use client'
+
+import { useUserAccount } from '@/lib/modules/web3/UserAccountProvider'
+import { Center, Input, Text, VStack } from '@chakra-ui/react'
+import { useState } from 'react'
+import { Address } from 'viem'
+import { sepolia } from 'viem/chains'
+import { useReadContract } from 'wagmi'
+import { fNum } from '@/lib/shared/utils/numbers'
+import { getGqlChain, getNetworkConfig } from '@/lib/config/app.config'
+import { permit2Abi } from '@balancer/sdk'
+
+export default function Page() {
+  const [tokenAddress, setTokenAddress] = useState<Address>('' as Address)
+
+  const { chain, userAddress } = useUserAccount()
+
+  const chainId = chain?.id || sepolia.id
+
+  const { data } = usePermit2Allowance({ chainId, tokenAddress, owner: userAddress })
+
+  return (
+    <Center>
+      <VStack w="50%">
+        <Text>
+          Enter address of token to check permit2 allowance in the current chain:{' '}
+          {chain ? chain.name : 'None'}
+        </Text>
+        <Input type="text" onChange={e => setTokenAddress(e.target.value as Address)} />
+
+        {data && (
+          <div>
+            <div>Amount: {fNum('integer', data[0])}</div>
+            <div>Expires: {data[1]}</div>
+            <div>Nonce: {data[2]}</div>
+          </div>
+        )}
+      </VStack>
+    </Center>
+  )
+}
+
+type Params = {
+  chainId: number
+  tokenAddress: Address
+  owner: Address
+}
+function usePermit2Allowance({ chainId, tokenAddress, owner }: Params) {
+  const permit2Address = '0x000000000022D473030F116dDEE9F6B43aC78BA3'
+  const balancerRouter = getNetworkConfig(getGqlChain(chainId)).contracts.balancer.router!
+  const spender = balancerRouter
+
+  return useReadContract({
+    chainId,
+    address: permit2Address,
+    abi: permit2Abi,
+    functionName: 'allowance',
+    args: [owner, tokenAddress, spender],
+    query: {
+      enabled: !!tokenAddress && !!owner,
+    },
+  })
+}

app/(app)/pools/[chain]/[variant]/[id]/add-liquidity/[[...txHash]]/layout.tsx

@@ -12,6 +12,7 @@ import { isHash } from 'viem'
 import { usePoolRedirect } from '@/lib/modules/pool/pool.hooks'
 import { DefaultPageContainer } from '@/lib/shared/components/containers/DefaultPageContainer'
 import { AddLiquidityProvider } from '@/lib/modules/pool/actions/add-liquidity/AddLiquidityProvider'
+import { Permit2SignatureProvider } from '@/lib/modules/tokens/approvals/permit2/Permit2SignatureProvider'
 
 type Props = PropsWithChildren<{
   params: { txHash?: string[] }
@@ -40,11 +41,13 @@ export default function AddLiquidityLayout({ params: { txHash }, children }: Pro
     <DefaultPageContainer>
       <TransactionStateProvider>
         <RelayerSignatureProvider>
-          <TokenInputsValidationProvider>
-            <AddLiquidityProvider urlTxHash={urlTxHash}>
-              <PriceImpactProvider>{children}</PriceImpactProvider>
-            </AddLiquidityProvider>
-          </TokenInputsValidationProvider>
+          <Permit2SignatureProvider>
+            <TokenInputsValidationProvider>
+              <AddLiquidityProvider urlTxHash={urlTxHash}>
+                <PriceImpactProvider>{children}</PriceImpactProvider>
+              </AddLiquidityProvider>
+            </TokenInputsValidationProvider>
+          </Permit2SignatureProvider>
         </RelayerSignatureProvider>
       </TransactionStateProvider>
     </DefaultPageContainer>

lib/config/config.types.ts

@@ -37,6 +37,8 @@ export interface ContractsConfig {
     vaultV2: Address
     // TODO: make it required when v3 is deployed in all networks
     vaultV3?: Address
+    // TODO: make it required when v3 is deployed in all networks
+    router?: Address
     relayerV6: Address
     minter: Address
   }

lib/config/networks/sepolia.ts

@@ -32,6 +32,7 @@ const networkConfig: NetworkConfig = {
     balancer: {
       vaultV2: '0xBA12222222228d8Ba445958a75a0704d566BF2C8',
       vaultV3: '0x0EF1c156a7986F394d90eD1bEeA6483Cc435F542',
+      router: '0xB12FcB422aAe6720f882E22C340964a7723f2387',
       relayerV6: '0x7852fB9d0895e6e8b3EedA553c03F6e2F9124dF9',
       minter: '0x1783Cd84b3d01854A96B4eD5843753C2CcbD574A',
     },

lib/modules/pool/actions/LiquidityActionHelpers.ts

@@ -11,29 +11,31 @@ import {
   MinimalToken,
   NestedPoolState,
   PoolState,
+  PoolStateWithBalances,
+  Token,
   TokenAmount,
   mapPoolToNestedPoolState,
   mapPoolType,
-  PoolStateWithBalances,
-  Token,
 } from '@balancer/sdk'
-import { Hex, formatUnits, parseUnits, Address } from 'viem'
-import {
-  isAffectedByCspIssue,
-  isComposableStableV1,
-  isCowAmmPool,
-  isGyro,
-  isV3Pool,
-} from '../pool.helpers'
-import { Pool } from '../PoolProvider'
+import BigNumber from 'bignumber.js'
+import { Address, Hex, formatUnits, parseUnits } from 'viem'
+import { GetTokenFn } from '../../tokens/TokensProvider'
 import {
   isNativeAsset,
   isNativeOrWrappedNative,
   isWrappedNativeAsset,
   swapNativeWithWrapped,
 } from '../../tokens/token.helpers'
 import { HumanTokenAmountWithAddress } from '../../tokens/token.types'
-import BigNumber from 'bignumber.js'
+import { Pool } from '../PoolProvider'
+import {
+  isAffectedByCspIssue,
+  isComposableStableV1,
+  isCowAmmPool,
+  isGyro,
+  isV3Pool,
+} from '../pool.helpers'
+import { SdkQueryAddLiquidityOutput } from './add-liquidity/add-liquidity.types'
 
 // Null object used to avoid conditional checks during hook loading state
 const NullPool: Pool = {
@@ -313,10 +315,25 @@ export function hasNoLiquidity(pool: Pool): boolean {
 }
 
 // When the pool has version < v3, it adds extra buildCall params (sender and recipient) that must be present only in V1/V2
-export function formatBuildCallParams<T>(buildCallParams: T, isV3Pool: boolean, account: Address) {
-  // sender must be undefined for v3 pools
-  if (isV3Pool) return buildCallParams
-
+export function formatBuildCallParams<T>(buildCallParams: T, account: Address) {
   // sender and recipient must be defined only for v1 and v2 pools
   return { ...buildCallParams, sender: account, recipient: account }
 }
+
+export function getTokenSymbols(
+  getToken: GetTokenFn,
+  chain: GqlChain,
+  queryOutput?: SdkQueryAddLiquidityOutput
+) {
+  if (!queryOutput?.sdkQueryOutput) return []
+  const amountsIn = queryOutput.sdkQueryOutput.amountsIn
+  const tokenSymbols = amountsIn
+    ?.filter(a => a.amount > 0n)
+    .map(a => getToken(a.token.address, chain)?.symbol ?? 'Unknown')
+  return tokenSymbols
+}
+
+export function getTokenAddresses(queryOutput?: SdkQueryAddLiquidityOutput): Address[] | undefined {
+  if (!queryOutput?.sdkQueryOutput) return undefined
+  return queryOutput.sdkQueryOutput.amountsIn.map(t => t.token.address)
+}

lib/modules/pool/actions/add-liquidity/add-liquidity.types.ts

@@ -1,4 +1,9 @@
-import { AddLiquidityNestedQueryOutput, AddLiquidityQueryOutput, TokenAmount } from '@balancer/sdk'
+import {
+  AddLiquidityNestedQueryOutput,
+  AddLiquidityQueryOutput,
+  Permit2,
+  TokenAmount,
+} from '@balancer/sdk'
 import { Address } from 'viem'
 import { HumanTokenAmountWithAddress } from '@/lib/modules/tokens/token.types'
 
@@ -17,6 +22,7 @@ export interface BuildAddLiquidityInput {
   slippagePercent: string
   queryOutput: QueryAddLiquidityOutput
   relayerApprovalSignature?: Address //only used by Nested Add Liquidity in signRelayer mode
+  permit2?: Permit2 //only used by v3 add liquidity
 }
 
 /*

lib/modules/pool/actions/add-liquidity/handlers/AddLiquidity.handler.ts

@@ -1,6 +1,6 @@
+import { HumanTokenAmountWithAddress } from '@/lib/modules/tokens/token.types'
 import { TransactionConfig } from '@/lib/modules/web3/contracts/contract.types'
 import { BuildAddLiquidityInput, QueryAddLiquidityOutput } from '../add-liquidity.types'
-import { HumanTokenAmountWithAddress } from '@/lib/modules/tokens/token.types'
 
 /**
  * AddLiquidityHandler is an interface that defines the methods that must be implemented by a handler.

lib/modules/pool/actions/add-liquidity/handlers/BaseUnbalancedAddLiquidity.handler.ts

@@ -0,0 +1,71 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { HumanTokenAmountWithAddress } from '@/lib/modules/tokens/token.types'
+import { TransactionConfig } from '@/lib/modules/web3/contracts/contract.types'
+import { getRpcUrl } from '@/lib/modules/web3/transports'
+import {
+  AddLiquidity,
+  AddLiquidityKind,
+  AddLiquidityUnbalancedInput,
+  PriceImpact,
+  PriceImpactAmount,
+} from '@balancer/sdk'
+import { Pool } from '../../../PoolProvider'
+import { LiquidityActionHelpers, areEmptyAmounts } from '../../LiquidityActionHelpers'
+import { SdkBuildAddLiquidityInput, SdkQueryAddLiquidityOutput } from '../add-liquidity.types'
+import { AddLiquidityHandler } from './AddLiquidity.handler'
+
+/**
+ * Base abstract class that shares common logic shared by v3 and v2/v1 pool unbalanced handlers
+ */
+export abstract class BaseUnbalancedAddLiquidityHandler implements AddLiquidityHandler {
+  protected helpers: LiquidityActionHelpers
+
+  constructor(pool: Pool) {
+    this.helpers = new LiquidityActionHelpers(pool)
+  }
+
+  public async simulate(
+    humanAmountsIn: HumanTokenAmountWithAddress[]
+  ): Promise<SdkQueryAddLiquidityOutput> {
+    const addLiquidity = new AddLiquidity()
+    const addLiquidityInput = this.constructSdkInput(humanAmountsIn)
+
+    const sdkQueryOutput = await addLiquidity.query(addLiquidityInput, this.helpers.poolState)
+
+    return { bptOut: sdkQueryOutput.bptOut, sdkQueryOutput }
+  }
+
+  public async getPriceImpact(humanAmountsIn: HumanTokenAmountWithAddress[]): Promise<number> {
+    if (areEmptyAmounts(humanAmountsIn)) {
+      // Avoid price impact calculation when there are no amounts in
+      return 0
+    }
+
+    const addLiquidityInput = this.constructSdkInput(humanAmountsIn)
+
+    const priceImpactABA: PriceImpactAmount = await PriceImpact.addLiquidityUnbalanced(
+      addLiquidityInput,
+      this.helpers.poolState
+    )
+
+    return priceImpactABA.decimal
+  }
+
+  public abstract buildCallData(input: SdkBuildAddLiquidityInput): Promise<TransactionConfig>
+
+  /**
+   * PRIVATE METHODS
+   */
+  protected constructSdkInput(
+    humanAmountsIn: HumanTokenAmountWithAddress[]
+  ): AddLiquidityUnbalancedInput {
+    const amountsIn = this.helpers.toSdkInputAmounts(humanAmountsIn)
+
+    return {
+      chainId: this.helpers.chainId,
+      rpcUrl: getRpcUrl(this.helpers.chainId),
+      amountsIn,
+      kind: AddLiquidityKind.Unbalanced,
+    }
+  }
+}

lib/modules/pool/actions/add-liquidity/handlers/UnbalancedAddLiquidity.handler.integration.spec.ts

@@ -7,6 +7,8 @@ import { UnbalancedAddLiquidityHandler } from './UnbalancedAddLiquidity.handler'
 import { selectAddLiquidityHandler } from './selectAddLiquidityHandler'
 import { HumanTokenAmountWithAddress } from '@/lib/modules/tokens/token.types'
 import { Pool } from '../../../PoolProvider'
+import { getNetworkConfig } from '@/lib/config/app.config'
+import { GqlChain } from '@/lib/shared/services/api/generated/graphql'
 
 function selectUnbalancedHandler() {
   return selectAddLiquidityHandler(aWjAuraWethPoolElementMock()) as UnbalancedAddLiquidityHandler
@@ -110,7 +112,8 @@ describe.skip('When adding unbalanced liquidity for a V3 pool', async () => {
       queryOutput,
     })
 
-    const sepoliaRouter = '0xB12FcB422aAe6720f882E22C340964a7723f2387'
+    const sepoliaRouter = getNetworkConfig(GqlChain.Sepolia).contracts.balancer.router
+
     expect(result.to).toBe(sepoliaRouter)
     expect(result.data).toBeDefined()
   })