Deployment preparation: Unbalanced add router

v3/tasks/20250826-v3-unbalanced-add-router/index.ts

@@ -0,0 +1,10 @@
+import { UnbalancedLiquidityRouterViaSwapDeployment } from './input';
+import { Task, TaskRunOptions } from '@src';
+
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+export default async (task: Task, { force, from }: TaskRunOptions = {}): Promise<void> => {
+  const input = task.input() as UnbalancedLiquidityRouterViaSwapDeployment;
+
+  const routerArgs = [input.Vault, input.Permit2, input.WETH, input.RouterVersion];
+  await task.deployAndVerify('AddUnbalancedLiquidityViaSwapRouter', routerArgs, from, force);
+};

v3/tasks/20250826-v3-unbalanced-add-router/input.ts

@@ -0,0 +1,20 @@
+import { Task, TaskMode } from '@src';
+
+export type UnbalancedLiquidityRouterViaSwapDeployment = {
+  Vault: string;
+  Permit2: string;
+  WETH: string;
+  RouterVersion: string;
+};
+
+const Vault = new Task('20241204-v3-vault', TaskMode.READ_ONLY);
+const Permit2 = new Task('00000000-permit2', TaskMode.READ_ONLY);
+const WETH = new Task('00000000-tokens', TaskMode.READ_ONLY);
+const BaseVersion = { version: 1, deployment: '20250826-v3-unbalanced-add-router' };
+
+export default {
+  Vault,
+  Permit2,
+  WETH,
+  RouterVersion: JSON.stringify({ name: 'AddUnbalancedLiquidityViaSwapRouter', ...BaseVersion }),
+};

v3/tasks/20250826-v3-unbalanced-add-router/readme.md

@@ -0,0 +1,22 @@
+# 2025-03-07 - V3 Router V2
+
+Redeployment of the Base Router for V3.
+Contains `Router` for basic, single step operations (e.g., pool initialization, add, remove, swap).
+
+The original router can still be used. The difference is this version saves the sender (i.e., uses the `saveSender` modifier) on initialization as well as on add liquidity operations, enabling pools to verify the sender on liquidity operations (e.g., to enforce a single-LP, as in liquidity bootstrapping or treasury management pools).
+
+There were also other changes to the Router contract and inheritance hierarchy since the original deployment (e.g., introduction of WethLib and `SenderGuard` in `RouterCommon`), but these are refactors designed to make router development easier (e.g., for the AggregatorRouter), and are not semantic or interface changes.
+
+## Useful Files
+
+- [Code](https://github.com/balancer/balancer-v3-monorepo/commit/577b86c7aec06c01e5f57bf20d4a0f728ce249b2).
+- [Ethereum mainnet addresses](./output/mainnet.json)
+- [Gnosis mainnet addresses](./output/gnosis.json)
+- [Arbitrum mainnet addresses](./output/arbitrum.json)
+- [Base mainnet addresses](./output/base.json)
+- [Optimism mainnet addresses](./output/optimism.json)
+- [Avalanche mainnet addresses](./output/avalanche.json)
+- [Hyperevm mainnet addresses](./output/hyperevm.json)
+- [Sepolia testnet addresses](./output/sepolia.json)
+- [`Router` artifact](./artifact/Router.json)
+

v3/tasks/20250826-v3-unbalanced-add-router/test/task.fork.ts

@@ -0,0 +1,119 @@
+import hre, { ethers } from 'hardhat';
+import { expect } from 'chai';
+import { describeForkTest, getForkedNetwork, getSigner, impersonate, Task, TaskMode } from '@src';
+import { Contract } from 'ethers';
+import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
+import { fp } from '@helpers/numbers';
+import { ZERO_ADDRESS } from '@helpers/constants';
+import { UnbalancedLiquidityRouterViaSwapDeployment } from '../input';
+import { currentTimestamp, MINUTE } from '@helpers/time';
+
+describeForkTest('V3-UnbalancedAddRouter', 'mainnet', 23227500, function () {
+  const versionNumber = 1;
+
+  const TASK_NAME = '20250826-v3-unbalanced-add-router';
+  const CONTRACT_NAME = 'AddUnbalancedLiquidityViaSwapRouter';
+  const POOL_CONTRACT_NAME = 'ReClammPool';
+
+  let task: Task;
+  let router: Contract, permit2: Contract;
+  let pool: Contract;
+  let wethSigner: SignerWithAddress, alice: SignerWithAddress;
+  let input: UnbalancedLiquidityRouterViaSwapDeployment;
+
+  const AAVE = '0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9';
+  let WETH: string;
+  const AAVE_WETH_POOL = '0x9d1fcf346ea1b073de4d5834e25572cc6ad71f4d';
+
+  before('run task', async () => {
+    task = new Task(TASK_NAME, TaskMode.TEST, getForkedNetwork(hre));
+    await task.run({ force: true });
+
+    input = task.input() as UnbalancedLiquidityRouterViaSwapDeployment;
+
+    router = await task.deployedInstance(CONTRACT_NAME);
+    permit2 = await task.instanceAt('IPermit2', input.Permit2);
+
+    WETH = input.WETH;
+    wethSigner = await impersonate(input.WETH, fp(10e8));
+    alice = await getSigner();
+  });
+
+  before('setup contracts and parameters', async () => {
+    const task = new Task('20250702-v3-reclamm-pool-v2', TaskMode.READ_ONLY, getForkedNetwork(hre));
+    pool = await task.instanceAt(POOL_CONTRACT_NAME, AAVE_WETH_POOL);
+  });
+
+  it('checks router version', async () => {
+    const routerVersion = JSON.parse(await router.version());
+    expect(routerVersion.name).to.be.eq(CONTRACT_NAME);
+    expect(routerVersion.version).to.be.eq(versionNumber);
+    expect(routerVersion.deployment).to.be.eq(TASK_NAME);
+  });
+
+  it('checks getters', async () => {
+    expect(await router.getPermit2()).to.eq(permit2.address);
+    expect(await router.getWeth()).to.eq(input.WETH);
+  });
+
+  it('checks router WETH', async () => {
+    const wethTx = wethSigner.sendTransaction({
+      to: router.address,
+      value: ethers.utils.parseEther('1.0'),
+    });
+    await expect(wethTx).to.not.be.reverted;
+
+    const aliceTx = alice.sendTransaction({
+      to: router.address,
+      value: ethers.utils.parseEther('1.0'),
+    });
+    await expect(aliceTx).to.be.reverted;
+  });
+
+  it('adds liquidity unbalanced to a reclamm pool', async () => {
+    const totalSupply = await pool.totalSupply();
+    const bptAmountOut = totalSupply.div(10);
+
+    const amountsIn = await router
+      .connect(ZERO_ADDRESS)
+      .callStatic.queryAddLiquidityProportional(pool.address, bptAmountOut, alice.address, '0x');
+    const aaveAmountInAddProportional = amountsIn[0];
+    const wethAmountInAddProportional = amountsIn[1];
+
+    const wethSwapForAave = await router
+      .connect(ZERO_ADDRESS)
+      .callStatic.querySwapSingleTokenExactOut(
+        pool.address,
+        WETH,
+        AAVE,
+        aaveAmountInAddProportional,
+        alice.address,
+        '0x'
+      );
+
+    const addLiquidityParams = {
+      maxAmountsIn: amountsIn,
+      exactBptAmountOut: bptAmountOut,
+      userData: '0x',
+    };
+
+    const swapExactOutParams = {
+      tokenIn: WETH,
+      tokenOut: AAVE,
+      exactAmountOut: aaveAmountInAddProportional,
+      maxAmountIn: wethSwapForAave.mul(101).div(100), // 1% slippage
+      userData: '0x',
+    };
+
+    await router
+      .connect(alice)
+      .addUnbalancedLiquidityViaSwapExactOut(
+        pool.address,
+        (await currentTimestamp()).add(MINUTE),
+        true,
+        addLiquidityParams,
+        swapExactOutParams,
+        { value: wethAmountInAddProportional.add(wethSwapForAave) }
+      );
+  });
+});