feat(rebalancer-sim): Add simulation harness for warp route rebalancer testing

.github/workflows/rebalancer-sim-test.yml

@@ -0,0 +1,84 @@
+name: rebalancer-sim-test
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'typescript/rebalancer/**'
+      - 'typescript/rebalancer-sim/**'
+      - 'solidity/contracts/mock/MockValueTransferBridge.sol'
+      - '.github/workflows/rebalancer-sim-test.yml'
+  pull_request:
+    paths:
+      - 'typescript/rebalancer/**'
+      - 'typescript/rebalancer-sim/**'
+      - 'solidity/contracts/mock/MockValueTransferBridge.sol'
+      - '.github/workflows/rebalancer-sim-test.yml'
+  workflow_dispatch:
+
+concurrency:
+  group: rebalancer-sim-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  rebalancer-sim-test-matrix:
+    runs-on: depot-ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        test:
+          # Split full-simulation by scenario (file_grep-pattern, using _ as separator)
+          - full-simulation_extreme-drain
+          - full-simulation_extreme-accumulate
+          - full-simulation_large-unidirectional
+          - full-simulation_whale-transfers
+          - full-simulation_balanced-bidirectional
+          - full-simulation_random-with-headroom
+          # Other test files
+          - inflight-guard
+          - harness-setup
+          - unidirectional
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          submodules: recursive
+
+      - name: pnpm-build
+        uses: ./.github/actions/pnpm-build-with-cache
+
+      - name: Setup Foundry
+        uses: ./.github/actions/setup-foundry
+
+      - name: Run rebalancer-sim test (${{ matrix.test }})
+        working-directory: typescript/rebalancer-sim
+        run: |
+          if [[ "${{ matrix.test }}" == *"_"* ]]; then
+            FILE=$(echo "${{ matrix.test }}" | cut -d_ -f1)
+            PATTERN=$(echo "${{ matrix.test }}" | cut -d_ -f2)
+            pnpm mocha --config .mocharc.json "./test/**/*${FILE}*.test.ts" --grep "${PATTERN}" --exit
+          else
+            pnpm mocha --config .mocharc.json "./test/**/*${{ matrix.test }}*.test.ts" --exit
+          fi
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v5
+        with:
+          name: rebalancer-sim-results-${{ matrix.test }}
+          path: typescript/rebalancer-sim/results/*.html
+          if-no-files-found: ignore
+          retention-days: 7
+
+  rebalancer-sim-test:
+    runs-on: ubuntu-latest
+    needs: [rebalancer-sim-test-matrix]
+    if: always()
+    steps:
+      - uses: actions/checkout@v6
+      - name: Check rebalancer-sim test status
+        uses: ./.github/actions/check-job-status
+        with:
+          job_name: 'Rebalancer Sim Test'
+          result: ${{ needs.rebalancer-sim-test-matrix.result }}

.lintstagedrc

@@ -2,5 +2,6 @@
   "*.js": "prettier --write",
   "*.ts": "prettier --write",
   "*.md": "prettier --write",
-  "*.sol": "prettier --write"
+  "*.sol": "prettier --write",
+  "*.json": "prettier --write"
 }

Dockerfile

@@ -39,6 +39,7 @@ COPY typescript/keyfunder/package.json ./typescript/keyfunder/
 COPY typescript/provider-sdk/package.json ./typescript/provider-sdk/
 COPY typescript/radix-sdk/package.json ./typescript/radix-sdk/
 COPY typescript/rebalancer/package.json ./typescript/rebalancer/
+COPY typescript/rebalancer-sim/package.json ./typescript/rebalancer-sim/
 COPY typescript/relayer/package.json ./typescript/relayer/
 COPY typescript/sdk/package.json ./typescript/sdk/
 COPY typescript/tsconfig/package.json ./typescript/tsconfig/

solidity/contracts/mock/MockValueTransferBridge.sol

@@ -2,8 +2,11 @@
 pragma solidity ^0.8.13;
 
 import {ITokenBridge, Quote} from "../interfaces/ITokenBridge.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 contract MockValueTransferBridge is ITokenBridge {
+    using SafeERC20 for IERC20;
     address public collateral;
 
     constructor(address _collateral) {
@@ -33,6 +36,13 @@ contract MockValueTransferBridge is ITokenBridge {
         bytes32 _recipient,
         uint256 _amountOut
     ) external payable virtual override returns (bytes32 transferId) {
+        // Pull tokens from caller (warp token) - caller must have approved this bridge
+        IERC20(collateral).safeTransferFrom(
+            msg.sender,
+            address(this),
+            _amountOut
+        );
+
         emit SentTransferRemote(
             uint32(block.chainid),
             _destinationDomain,

typescript/cli/src/tests/ethereum/warp/warp-rebalancer.e2e-test.ts

@@ -6,6 +6,7 @@ import { $, type ProcessPromise } from 'zx';
 
 import {
   type ERC20,
+  ERC20Test__factory,
   ERC20__factory,
   HypERC20Collateral__factory,
   MockValueTransferBridge__factory,
@@ -941,10 +942,6 @@ describe('hyperlane warp rebalancer e2e tests', async function () {
     const originDomain = chain3Metadata.domainId;
     const destDomain = chain2Metadata.domainId;
 
-    // Chain names
-    const originName = CHAIN_NAME_3;
-    const destName = CHAIN_NAME_2;
-
     // RPC URLs
     const originRpc = chain3Metadata.rpcUrls[0].http;
     const destRpc = chain2Metadata.rpcUrls[0].http;
@@ -998,6 +995,15 @@ describe('hyperlane warp rebalancer e2e tests', async function () {
       },
     });
 
+    const originTkn = ERC20__factory.connect(originTknAddress, originProvider);
+    const destTkn = ERC20__factory.connect(destTknAddress, destProvider);
+
+    // Verify initial balances before rebalancing
+    let originBalance = await originTkn.balanceOf(originContractAddress);
+    let destBalance = await destTkn.balanceOf(destContractAddress);
+    expect(originBalance.toString()).to.equal(toWei(10));
+    expect(destBalance.toString()).to.equal(toWei(10));
+
     // Promise that will resolve with the event that is emitted by the bridge when the rebalance transaction is sent
     const listenForSentTransferRemote = new Promise<{
       origin: Domain;
@@ -1032,27 +1038,21 @@ describe('hyperlane warp rebalancer e2e tests', async function () {
     expect(sentTransferRemote.recipient).to.equal(destContractAddress);
     expect(sentTransferRemote.amount).to.equal(BigInt(toWei(5)));
 
-    const originTkn = ERC20__factory.connect(originTknAddress, originProvider);
-    const destTkn = ERC20__factory.connect(destTknAddress, destProvider);
-
-    let originBalance = await originTkn.balanceOf(originContractAddress);
-    let destBalance = await destTkn.balanceOf(destContractAddress);
-
-    // Verify that the tokens are in the right place before the transfer
-    expect(originBalance.toString()).to.equal(toWei(10));
-    expect(destBalance.toString()).to.equal(toWei(10));
+    // Verify that the bridge pulled tokens from origin (10 - 5 = 5)
+    originBalance = await originTkn.balanceOf(originContractAddress);
+    expect(originBalance.toString()).to.equal(toWei(5));
 
-    // Simulate rebalancing by transferring tokens from destination to origin chain.
-    // This process locks tokens on the destination chain and unlocks them on the origin,
-    // effectively increasing collateral on the destination while decreasing it on the origin,
-    // which achieves the desired rebalancing effect.
-    await hyperlaneWarpSendRelay({
-      origin: destName,
-      destination: originName,
-      warpCorePath: warpCoreConfigPath,
-      relay: true,
-      value: sentTransferRemote.amount.toString(),
-    });
+    // Simulate bridge delivery by minting tokens to destination warp token
+    // In a real bridge, tokens would be delivered to the destination chain
+    const destSigner = new Wallet(ANVIL_KEY, destProvider);
+    const destCollateralToken = ERC20Test__factory.connect(
+      destTknAddress,
+      destSigner,
+    );
+    await destCollateralToken.mintTo(
+      destContractAddress,
+      sentTransferRemote.amount.toString(),
+    );
 
     originBalance = await originTkn.balanceOf(originContractAddress);
     destBalance = await destTkn.balanceOf(destContractAddress);
@@ -1241,6 +1241,18 @@ describe('hyperlane warp rebalancer e2e tests', async function () {
         },
       });
 
+      const originTkn = ERC20__factory.connect(
+        originTknAddress,
+        originProvider,
+      );
+      const destTkn = ERC20__factory.connect(destTknAddress, destProvider);
+
+      // Verify initial balances before rebalancing
+      let originBalance = await originTkn.balanceOf(originContractAddress);
+      let destBalance = await destTkn.balanceOf(destContractAddress);
+      expect(originBalance.toString()).to.equal(toWei(10));
+      expect(destBalance.toString()).to.equal(toWei(10));
+
       // Promise that will resolve with the event that is emitted by the bridge when the rebalance transaction is sent
       const listenForSentTransferRemote = new Promise<{
         origin: Domain;
@@ -1284,30 +1296,22 @@ describe('hyperlane warp rebalancer e2e tests', async function () {
         BigInt(toWei(manualRebalanceAmount)),
       );
 
-      const originTkn = ERC20__factory.connect(
-        originTknAddress,
-        originProvider,
+      // Verify that the bridge pulled tokens from origin (10 - 5 = 5)
+      originBalance = await originTkn.balanceOf(originContractAddress);
+      expect(originBalance.toString()).to.equal(
+        toWei(10 - Number(manualRebalanceAmount)),
       );
-      const destTkn = ERC20__factory.connect(destTknAddress, destProvider);
-
-      let originBalance = await originTkn.balanceOf(originContractAddress);
-      let destBalance = await destTkn.balanceOf(destContractAddress);
-
-      // Verify that the tokens are in the right place before the transfer
-      expect(originBalance.toString()).to.equal(toWei(10));
-      expect(destBalance.toString()).to.equal(toWei(10));
 
-      // Simulate rebalancing by transferring tokens from destination to origin chain.
-      // This process locks tokens on the destination chain and unlocks them on the origin,
-      // effectively increasing collateral on the destination while decreasing it on the origin,
-      // which achieves the desired rebalancing effect.
-      await hyperlaneWarpSendRelay({
-        origin: destName,
-        destination: originName,
-        warpCorePath: warpCoreConfigPath,
-        relay: true,
-        value: sentTransferRemote.amount.toString(),
-      });
+      // Simulate bridge delivery by minting tokens to destination warp token
+      const destSigner = new Wallet(ANVIL_KEY, destProvider);
+      const destCollateralToken = ERC20Test__factory.connect(
+        destTknAddress,
+        destSigner,
+      );
+      await destCollateralToken.mintTo(
+        destContractAddress,
+        sentTransferRemote.amount.toString(),
+      );
 
       originBalance = await originTkn.balanceOf(originContractAddress);
       destBalance = await destTkn.balanceOf(destContractAddress);

typescript/rebalancer-sim/.gitignore

@@ -0,0 +1,6 @@
+.env
+dist
+cache
+
+# Simulation results (generated at runtime)
+results/

typescript/rebalancer-sim/.mocharc.json

@@ -0,0 +1,6 @@
+{
+  "import": ["tsx"],
+  "extension": ["ts"],
+  "timeout": 120000,
+  "exit": true
+}