438 update to allow optional address for addremoveswap

.changeset/unlucky-mangos-doubt.md

@@ -0,0 +1,5 @@
+---
+"@balancer/sdk": minor
+---
+
+Add optional sender and userData inputs for add/remove/swap queries. Sender can be used to query accurate result when pool may have hook thats behaviour is affected by sender, e.g. loyalty fee hook.

src/entities/addLiquidity/addLiquidityV3/doAddLiquidityProportionalQuery.ts

@@ -1,6 +1,5 @@
-import { createPublicClient, http, zeroAddress } from 'viem';
-import { AddLiquidityProportionalInput } from '../types';
-import { BALANCER_ROUTER, CHAINS } from '@/utils';
+import { createPublicClient, Hex, http } from 'viem';
+import { BALANCER_ROUTER, ChainId, CHAINS } from '@/utils';
 import {
     balancerRouterAbi,
     permit2Abi,
@@ -10,7 +9,10 @@ import {
 import { Address } from '@/types';
 
 export const doAddLiquidityProportionalQuery = async (
-    { rpcUrl, chainId }: AddLiquidityProportionalInput,
+    rpcUrl: string,
+    chainId: ChainId,
+    sender: Address,
+    userData: Hex,
     poolAddress: Address,
     bptOut: bigint,
 ): Promise<bigint[]> => {
@@ -28,7 +30,7 @@ export const doAddLiquidityProportionalQuery = async (
             ...permit2Abi,
         ],
         functionName: 'queryAddLiquidityProportional',
-        args: [poolAddress, bptOut, zeroAddress, '0x'],
+        args: [poolAddress, bptOut, sender, userData],
     });
 
     return [...amountsIn];

src/entities/addLiquidity/addLiquidityV3/doAddLiquiditySingleTokenQuery.ts

@@ -1,6 +1,5 @@
-import { createPublicClient, http, zeroAddress } from 'viem';
-import { AddLiquiditySingleTokenInput } from '../types';
-import { BALANCER_ROUTER, CHAINS } from '@/utils';
+import { createPublicClient, Hex, http } from 'viem';
+import { BALANCER_ROUTER, ChainId, CHAINS } from '@/utils';
 import {
     balancerRouterAbi,
     permit2Abi,
@@ -10,7 +9,11 @@ import {
 import { Address } from '@/types';
 
 export const doAddLiquiditySingleTokenQuery = async (
-    { rpcUrl, chainId, tokenIn }: AddLiquiditySingleTokenInput,
+    rpcUrl: string,
+    chainId: ChainId,
+    sender: Address,
+    userData: Hex,
+    tokenIn: Address,
     poolAddress: Address,
     bptOut: bigint,
 ): Promise<bigint> => {
@@ -28,7 +31,7 @@ export const doAddLiquiditySingleTokenQuery = async (
             ...permit2Abi,
         ],
         functionName: 'queryAddLiquiditySingleTokenExactOut',
-        args: [poolAddress, tokenIn, bptOut, zeroAddress, '0x'],
+        args: [poolAddress, tokenIn, bptOut, sender, userData],
     });
     return amountIn;
 };

src/entities/addLiquidity/addLiquidityV3/doAddLiquidityUnbalancedQuery.ts

@@ -1,6 +1,5 @@
-import { createPublicClient, http, zeroAddress } from 'viem';
-import { AddLiquidityUnbalancedInput } from '../types';
-import { BALANCER_ROUTER, CHAINS } from '@/utils';
+import { createPublicClient, Hex, http } from 'viem';
+import { BALANCER_ROUTER, ChainId, CHAINS } from '@/utils';
 import {
     balancerRouterAbi,
     permit2Abi,
@@ -10,7 +9,10 @@ import {
 import { Address } from '@/types';
 
 export const doAddLiquidityUnbalancedQuery = async (
-    { rpcUrl, chainId }: AddLiquidityUnbalancedInput,
+    rpcUrl: string,
+    chainId: ChainId,
+    sender: Address,
+    userData: Hex,
     poolAddress: Address,
     maxAmountsIn: bigint[],
 ) => {
@@ -28,7 +30,7 @@ export const doAddLiquidityUnbalancedQuery = async (
             ...permit2Abi,
         ],
         functionName: 'queryAddLiquidityUnbalanced',
-        args: [poolAddress, maxAmountsIn, zeroAddress, '0x'],
+        args: [poolAddress, maxAmountsIn, sender, userData],
     });
     return bptAmountOut;
 };

src/entities/addLiquidity/addLiquidityV3/index.ts

@@ -1,4 +1,4 @@
-import { encodeFunctionData } from 'viem';
+import { encodeFunctionData, zeroAddress } from 'viem';
 import { balancerRouterAbi } from '@/abi';
 import { Token } from '@/entities/token';
 import { TokenAmount } from '@/entities/tokenAmount';
@@ -50,7 +50,10 @@ export class AddLiquidityV3 implements AddLiquidityBase {
 
                 // proportional join query returns exactAmountsIn for exactBptOut
                 const amountsInNumbers = await doAddLiquidityProportionalQuery(
-                    input,
+                    input.rpcUrl,
+                    input.chainId,
+                    input.sender ?? zeroAddress,
+                    input.userData ?? '0x',
                     poolState.address,
                     bptAmount.rawAmount,
                 );
@@ -70,7 +73,10 @@ export class AddLiquidityV3 implements AddLiquidityBase {
             case AddLiquidityKind.Unbalanced: {
                 const maxAmountsIn = getAmounts(sortedTokens, input.amountsIn);
                 const bptAmountOut = await doAddLiquidityUnbalancedQuery(
-                    input,
+                    input.rpcUrl,
+                    input.chainId,
+                    input.sender ?? zeroAddress,
+                    input.userData ?? '0x',
                     poolState.address,
                     maxAmountsIn,
                 );
@@ -87,7 +93,11 @@ export class AddLiquidityV3 implements AddLiquidityBase {
                     input.bptOut.rawAmount,
                 );
                 const amountIn = await doAddLiquiditySingleTokenQuery(
-                    input,
+                    input.rpcUrl,
+                    input.chainId,
+                    input.sender ?? zeroAddress,
+                    input.userData ?? '0x',
+                    input.tokenIn,
                     poolState.address,
                     input.bptOut.rawAmount,
                 );
@@ -104,7 +114,7 @@ export class AddLiquidityV3 implements AddLiquidityBase {
             }
         }
 
-        const output: AddLiquidityBaseQueryOutput = {
+        const output: AddLiquidityBaseQueryOutput & { userData: Hex } = {
             to: BALANCER_ROUTER[input.chainId],
             poolType: poolState.type,
             poolId: poolState.id,
@@ -114,13 +124,14 @@ export class AddLiquidityV3 implements AddLiquidityBase {
             tokenInIndex,
             chainId: input.chainId,
             protocolVersion: 3,
+            userData: input.userData ?? '0x',
         };
 
         return output;
     }
 
     buildCall(
-        input: AddLiquidityBaseBuildCallInput,
+        input: AddLiquidityBaseBuildCallInput & { userData: Hex },
     ): AddLiquidityBuildCallOutput {
         const amounts = getAmountsCall(input);
         let callData: Hex;
@@ -135,7 +146,7 @@ export class AddLiquidityV3 implements AddLiquidityBase {
                             amounts.maxAmountsIn,
                             amounts.minimumBpt,
                             !!input.wethIsEth,
-                            '0x',
+                            input.userData,
                         ],
                     });
                 }
@@ -150,7 +161,7 @@ export class AddLiquidityV3 implements AddLiquidityBase {
                             input.amountsIn.map((a) => a.amount),
                             amounts.minimumBpt,
                             !!input.wethIsEth,
-                            '0x',
+                            input.userData,
                         ],
                     });
                 }
@@ -170,7 +181,7 @@ export class AddLiquidityV3 implements AddLiquidityBase {
                             input.amountsIn[input.tokenInIndex].amount,
                             input.bptOut.amount,
                             !!input.wethIsEth,
-                            '0x',
+                            input.userData,
                         ],
                     });
                 }
@@ -192,7 +203,7 @@ export class AddLiquidityV3 implements AddLiquidityBase {
     }
 
     public buildCallWithPermit2(
-        input: AddLiquidityBaseBuildCallInput,
+        input: AddLiquidityBaseBuildCallInput & { userData: Hex },
         permit2: Permit2,
     ): AddLiquidityBuildCallOutput {
         const buildCallOutput = this.buildCall(input);

src/entities/addLiquidity/index.ts

@@ -13,6 +13,7 @@ import { AddLiquidityV3 } from './addLiquidityV3';
 import { InputValidator } from '../inputValidator/inputValidator';
 import { AddLiquidityCowAmm } from './addLiquidityCowAmm';
 import { Permit2 } from '../permit2Helper';
+import { Hex } from 'viem';
 
 export class AddLiquidity implements AddLiquidityBase {
     constructor(public config?: AddLiquidityConfig) {}
@@ -42,7 +43,11 @@ export class AddLiquidity implements AddLiquidityBase {
         }
     }
 
-    buildCall(input: AddLiquidityBuildCallInput): AddLiquidityBuildCallOutput {
+    buildCall(
+        input:
+            | AddLiquidityBuildCallInput
+            | (AddLiquidityBuildCallInput & { userData: Hex }),
+    ): AddLiquidityBuildCallOutput {
         switch (input.protocolVersion) {
             case 1: {
                 const addLiquidity = new AddLiquidityCowAmm();
@@ -57,6 +62,10 @@ export class AddLiquidity implements AddLiquidityBase {
             }
             case 3: {
                 if (!('sender' in input)) {
+                    if (!('userData' in input))
+                        throw new Error(
+                            'UserData must be provided in buildCall input',
+                        );
                     const addLiquidity = new AddLiquidityV3();
                     return addLiquidity.buildCall(input);
                 }
@@ -68,10 +77,14 @@ export class AddLiquidity implements AddLiquidityBase {
     }
 
     buildCallWithPermit2(
-        input: AddLiquidityBuildCallInput,
+        input:
+            | AddLiquidityBuildCallInput
+            | (AddLiquidityBuildCallInput & { userData: Hex }),
         permit2: Permit2,
     ): AddLiquidityBuildCallOutput {
         InputValidator.validateBuildCallWithPermit2(input);
+        if (!('userData' in input))
+            throw new Error('UserData must be provided in buildCall input');
 
         const addLiquidity = new AddLiquidityV3();
         return addLiquidity.buildCallWithPermit2(input, permit2);

src/entities/addLiquidity/types.ts

@@ -18,6 +18,8 @@ export enum AddLiquidityKind {
 export type AddLiquidityBaseInput = {
     chainId: number;
     rpcUrl: string;
+    sender?: Address;
+    userData?: Hex;
 };
 
 export type AddLiquidityUnbalancedInput = AddLiquidityBaseInput & {

src/entities/addLiquidityBoosted/index.ts

@@ -76,7 +76,7 @@ export class AddLiquidityBoostedV3 {
                 const bptAmountOut = await doAddLiquidityUnbalancedQuery(
                     input.rpcUrl,
                     input.chainId,
-                    input.userAddress ?? zeroAddress,
+                    input.sender ?? zeroAddress,
                     input.userData ?? '0x',
                     poolState.address,
                     maxAmountsIn,
@@ -102,7 +102,7 @@ export class AddLiquidityBoostedV3 {
                     await doAddLiquidityProportionalQuery(
                         input.rpcUrl,
                         input.chainId,
-                        input.userAddress ?? zeroAddress,
+                        input.sender ?? zeroAddress,
                         input.userData ?? '0x',
                         poolState.address,
                         input.referenceAmount.rawAmount,

src/entities/addLiquidityBoosted/types.ts

@@ -9,7 +9,7 @@ export type AddLiquidityBoostedProportionalInput = {
     rpcUrl: string;
     referenceAmount: InputAmount;
     kind: AddLiquidityKind.Proportional;
-    userAddress?: Address;
+    sender?: Address;
     userData?: Hex;
 };
 
@@ -18,7 +18,7 @@ export type AddLiquidityBoostedUnbalancedInput = {
     rpcUrl: string;
     amountsIn: InputAmount[];
     kind: AddLiquidityKind.Unbalanced;
-    userAddress?: Address;
+    sender?: Address;
     userData?: Hex;
 };
 

src/entities/removeLiquidity/index.ts

@@ -15,6 +15,7 @@ import { RemoveLiquidityV3 } from './removeLiquidityV3';
 import { RemoveLiquidityCowAmm } from './removeLiquidityCowAmm';
 import { Permit } from '../permitHelper';
 import { RemoveLiquidityV2BuildCallInput } from './removeLiquidityV2/types';
+import { Hex } from 'viem';
 
 export class RemoveLiquidity implements RemoveLiquidityBase {
     private readonly inputValidator: InputValidator = new InputValidator();
@@ -81,7 +82,8 @@ export class RemoveLiquidity implements RemoveLiquidityBase {
     public buildCall(
         input:
             | RemoveLiquidityBaseBuildCallInput
-            | RemoveLiquidityV2BuildCallInput,
+            | RemoveLiquidityV2BuildCallInput
+            | (RemoveLiquidityBaseBuildCallInput & { userData: Hex }),
     ): RemoveLiquidityBuildCallOutput {
         const isV2Input = 'sender' in input;
         switch (input.protocolVersion) {
@@ -98,6 +100,10 @@ export class RemoveLiquidity implements RemoveLiquidityBase {
             }
             case 3: {
                 if (!isV2Input) {
+                    if (!('userData' in input))
+                        throw new Error(
+                            'UserData must be provided in buildCall input',
+                        );
                     const removeLiquidity = new RemoveLiquidityV3();
                     return removeLiquidity.buildCall(input);
                 }
@@ -111,10 +117,13 @@ export class RemoveLiquidity implements RemoveLiquidityBase {
     public buildCallWithPermit(
         input:
             | RemoveLiquidityBaseBuildCallInput
-            | RemoveLiquidityV2BuildCallInput,
+            | RemoveLiquidityV2BuildCallInput
+            | (RemoveLiquidityBaseBuildCallInput & { userData: Hex }),
         permit: Permit,
     ): RemoveLiquidityBuildCallOutput {
         if (input.protocolVersion === 3) {
+            if (!('userData' in input))
+                throw new Error('UserData must be provided in buildCall input');
             const removeLiquidity = new RemoveLiquidityV3();
             return removeLiquidity.buildCallWithPermit(input, permit);
         }

src/entities/removeLiquidity/removeLiquidityV3/doRemoveLiquidityProportionalQuery.ts

@@ -4,14 +4,17 @@ import {
     vaultExtensionAbi_V3,
     vaultV3Abi,
 } from '@/abi';
-import { BALANCER_ROUTER, CHAINS } from '@/utils';
-import { createPublicClient, http, zeroAddress } from 'viem';
-import { RemoveLiquidityProportionalInput } from '../types';
+import { BALANCER_ROUTER, ChainId, CHAINS } from '@/utils';
+import { createPublicClient, Hex, http } from 'viem';
 import { Address } from '@/types';
 
 export const doRemoveLiquidityProportionalQuery = async (
-    { chainId, rpcUrl, bptIn }: RemoveLiquidityProportionalInput,
+    rpcUrl: string,
+    chainId: ChainId,
+    sender: Address,
+    userData: Hex,
     poolAddress: Address,
+    exactBptAmountIn: bigint,
 ): Promise<readonly bigint[]> => {
     const client = createPublicClient({
         transport: http(rpcUrl),
@@ -26,7 +29,7 @@ export const doRemoveLiquidityProportionalQuery = async (
             ...permit2Abi,
         ],
         functionName: 'queryRemoveLiquidityProportional',
-        args: [poolAddress, bptIn.rawAmount, zeroAddress, '0x'],
+        args: [poolAddress, exactBptAmountIn, sender, userData],
     });
     return amountsOut;
 };