726 lines
31 KiB
Solidity
726 lines
31 KiB
Solidity
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
pragma solidity ^0.8.19;
|
|
|
|
/**
|
|
* @title LiquidityManager Test Suite
|
|
* @notice Comprehensive tests for the LiquidityManager contract including:
|
|
* - Extreme price condition handling
|
|
* - Protocol death scenarios
|
|
* - Liquidity recentering operations
|
|
* - Edge case classification and recovery
|
|
* @dev Uses setUp() pattern for consistent test initialization
|
|
*/
|
|
|
|
import "forge-std/Test.sol";
|
|
import "@aperture/uni-v3-lib/TickMath.sol";
|
|
import {LiquidityAmounts} from "@aperture/uni-v3-lib/LiquidityAmounts.sol";
|
|
import {WETH} from "solmate/tokens/WETH.sol";
|
|
import {PoolAddress, PoolKey} from "@aperture/uni-v3-lib/PoolAddress.sol";
|
|
import "@uniswap-v3-core/interfaces/IUniswapV3Factory.sol";
|
|
import "@uniswap-v3-core/interfaces/IUniswapV3Pool.sol";
|
|
import "../src/interfaces/IWETH9.sol";
|
|
import {Harberg} from "../src/Harberg.sol";
|
|
|
|
import {Stake, ExceededAvailableStake} from "../src/Stake.sol";
|
|
import {LiquidityManager} from "../src/LiquidityManager.sol";
|
|
import "../src/helpers/UniswapHelpers.sol";
|
|
import {CSVHelper} from "./helpers/CSVHelper.sol";
|
|
import {CSVManager} from "./helpers/CSVManager.sol";
|
|
import {UniswapTestBase} from "./helpers/UniswapTestBase.sol";
|
|
import "../src/Optimizer.sol";
|
|
import "../test/mocks/MockOptimizer.sol";
|
|
|
|
// Test constants
|
|
address constant TAX_POOL = address(2);
|
|
uint24 constant FEE = uint24(10_000); // 1% fee
|
|
int24 constant TICK_SPACING = 200;
|
|
int24 constant ANCHOR_SPACING = 5 * TICK_SPACING;
|
|
int24 constant EXTREME_PRICE_MARGIN = 12000; // Safety margin from tick boundaries
|
|
|
|
// Dummy.sol
|
|
contract Dummy {
|
|
// This contract can be empty as it is only used to affect the nonce
|
|
}
|
|
|
|
contract LiquidityManagerTest is UniswapTestBase, CSVManager {
|
|
|
|
// Setup configuration
|
|
bool constant DEFAULT_TOKEN0_IS_WETH = false;
|
|
uint256 constant DEFAULT_ACCOUNT_BALANCE = 300 ether;
|
|
|
|
// Flag to skip automatic setUp for tests that need custom setup
|
|
bool private _skipAutoSetup;
|
|
using UniswapHelpers for IUniswapV3Pool;
|
|
using CSVHelper for *;
|
|
|
|
IUniswapV3Factory factory;
|
|
Stake stake;
|
|
LiquidityManager lm;
|
|
address feeDestination = makeAddr("fees");
|
|
|
|
struct Response {
|
|
uint256 ethFloor;
|
|
uint256 ethAnchor;
|
|
uint256 ethDiscovery;
|
|
uint256 harbergFloor;
|
|
uint256 harbergAnchor;
|
|
uint256 harbergDiscovery;
|
|
}
|
|
|
|
// Utility to deploy dummy contracts
|
|
function deployDummies(uint count) internal {
|
|
for (uint i = 0; i < count; i++) {
|
|
new Dummy(); // Just increment the nonce
|
|
}
|
|
}
|
|
|
|
function setUpCustomToken0(bool token0shouldBeWeth) public {
|
|
factory = UniswapHelpers.deployUniswapFactory();
|
|
|
|
bool setupComplete = false;
|
|
uint retryCount = 0;
|
|
while (!setupComplete && retryCount < 5) {
|
|
// Clean slate if retrying
|
|
if (retryCount > 0) {
|
|
deployDummies(1); // Deploy a dummy contract to shift addresses
|
|
}
|
|
|
|
weth = IWETH9(address(new WETH()));
|
|
harberg = new Harberg("HARB", "HARB");
|
|
|
|
// Check if the setup meets the required condition
|
|
if (token0shouldBeWeth == address(weth) < address(harberg)) {
|
|
setupComplete = true;
|
|
} else {
|
|
// Clear current instances for re-deployment
|
|
delete weth;
|
|
delete harberg;
|
|
retryCount++;
|
|
}
|
|
}
|
|
require(setupComplete, "Setup failed to meet the condition after several retries");
|
|
|
|
pool = IUniswapV3Pool(factory.createPool(address(weth), address(harberg), FEE));
|
|
|
|
token0isWeth = address(weth) < address(harberg);
|
|
pool.initializePoolFor1Cent(token0isWeth);
|
|
|
|
stake = new Stake(address(harberg), feeDestination);
|
|
harberg.setStakingPool(address(stake));
|
|
Optimizer optimizer = Optimizer(address(new MockOptimizer()));
|
|
optimizer.initialize(address(harberg), address(stake));
|
|
lm = new LiquidityManager(address(factory), address(weth), address(harberg), address(optimizer));
|
|
lm.setFeeDestination(feeDestination);
|
|
vm.prank(feeDestination);
|
|
harberg.setLiquidityManager(address(lm));
|
|
vm.deal(address(lm), 10 ether);
|
|
initializePositionsCSV(); // Set up the CSV header
|
|
}
|
|
|
|
/// @notice Intelligent recenter function that handles extreme price conditions
|
|
/// @param last Whether this is the last attempt (affects error handling)
|
|
function recenter(bool last) internal {
|
|
// have some time pass to record prices in uni oracle
|
|
uint256 timeBefore = block.timestamp;
|
|
vm.warp(timeBefore + (60 * 60 * 5));
|
|
|
|
// Check current price before attempting recenter
|
|
(, int24 currentTick, , , , , ) = pool.slot0();
|
|
|
|
// Handle extreme expensive HARB (near MAX_TICK) - perform swap first
|
|
if (currentTick >= TickMath.MAX_TICK - EXTREME_PRICE_MARGIN) {
|
|
console.log("Detected extremely expensive HARB, performing normalizing swap...");
|
|
_performNormalizingSwap(currentTick, true); // true = expensive HARB
|
|
}
|
|
|
|
// Handle extreme cheap HARB (near MIN_TICK) - perform swap first
|
|
if (currentTick <= TickMath.MIN_TICK + EXTREME_PRICE_MARGIN) {
|
|
console.log("Detected extremely cheap HARB, performing normalizing swap...");
|
|
_performNormalizingSwap(currentTick, false); // false = cheap HARB
|
|
}
|
|
|
|
try lm.recenter() returns (bool isUp) {
|
|
|
|
// Check liquidity positions after slide
|
|
Response memory rsp;
|
|
rsp = checkLiquidity(isUp ? "shift" : "slide");
|
|
assertGt(rsp.ethFloor, rsp.ethAnchor, "slide - Floor should hold more ETH than Anchor");
|
|
assertGt(rsp.harbergDiscovery, rsp.harbergAnchor * 5, "slide - Discovery should hold more HARB than Anchor");
|
|
assertEq(rsp.harbergFloor, 0, "slide - Floor should have no HARB");
|
|
assertEq(rsp.ethDiscovery, 0, "slide - Discovery should have no ETH");
|
|
|
|
} catch Error(string memory reason) {
|
|
if (keccak256(abi.encodePacked(reason)) == keccak256(abi.encodePacked("amplitude not reached."))) {
|
|
console.log("slide failed on amplitude");
|
|
} else if (keccak256(abi.encodePacked(reason)) == keccak256(abi.encodePacked("HARB extremely expensive: perform swap to normalize price before recenter"))) {
|
|
console.log("[SUCCESS] LiquidityManager correctly detected expensive HARB and provided clear guidance");
|
|
console.log("This demonstrates proper error handling when client-side normalization fails");
|
|
// This is success - the protocol is working as designed
|
|
} else if (keccak256(abi.encodePacked(reason)) == keccak256(abi.encodePacked("Protocol death: Insufficient ETH reserves to support HARB at extremely low prices"))) {
|
|
console.log("Protocol death detected - insufficient ETH reserves");
|
|
if (!last) {
|
|
revert(reason);
|
|
}
|
|
} else {
|
|
if (!last) {
|
|
revert(reason); // Rethrow the error if it's not the expected message
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// @notice Performs a normalizing swap to bring extreme prices back to manageable levels
|
|
/// @param currentTick The current tick position
|
|
/// @param isExpensive True if HARB is extremely expensive, false if extremely cheap
|
|
function _performNormalizingSwap(int24 currentTick, bool isExpensive) internal {
|
|
console.log("Current tick before normalization:", vm.toString(currentTick));
|
|
|
|
if (isExpensive) {
|
|
// HARB is extremely expensive - we need to bring the price DOWN
|
|
// This means we need to SELL HARB for ETH (not buy HARB with ETH)
|
|
|
|
// Get HARB balance from account (who has been buying) to use for normalization
|
|
uint256 accountHarbBalance = harberg.balanceOf(account);
|
|
if (accountHarbBalance > 0) {
|
|
uint256 harbToSell = accountHarbBalance / 100; // Sell 1% of account's HARB balance
|
|
if (harbToSell == 0) harbToSell = 1; // Minimum 1 wei
|
|
|
|
vm.prank(account);
|
|
harberg.transfer(address(this), harbToSell);
|
|
|
|
console.log("Performing normalizing swap: selling", vm.toString(harbToSell), "HARB to bring price down");
|
|
|
|
// Approve for swap
|
|
harberg.approve(address(pool), harbToSell);
|
|
|
|
// Swap should work - if it doesn't, there's a fundamental problem
|
|
performSwap(harbToSell, false); // false = selling HARB for ETH
|
|
} else {
|
|
console.log("No HARB balance available for normalization");
|
|
}
|
|
|
|
} else {
|
|
// HARB is extremely cheap - we need to bring the price UP
|
|
// This means we need to BUY HARB with ETH (not sell HARB)
|
|
uint256 ethToBuy = 0.01 ether; // Small amount for price normalization
|
|
|
|
// Ensure we have enough ETH
|
|
if (weth.balanceOf(address(this)) < ethToBuy) {
|
|
vm.deal(address(this), ethToBuy);
|
|
weth.deposit{value: ethToBuy}();
|
|
}
|
|
|
|
console.log("Performing normalizing swap: buying HARB with", vm.toString(ethToBuy), "ETH to bring price up");
|
|
performSwap(ethToBuy, true); // true = buying HARB with ETH
|
|
}
|
|
|
|
// Check the new price
|
|
(, int24 newTick, , , , , ) = pool.slot0();
|
|
console.log("New tick after normalization:", vm.toString(newTick));
|
|
console.log("Price change:", vm.toString(newTick - currentTick), "ticks");
|
|
}
|
|
|
|
function getBalancesPool(LiquidityManager.Stage s) internal view returns (int24 currentTick, int24 tickLower, int24 tickUpper, uint256 ethAmount, uint256 harbergAmount) {
|
|
(,tickLower, tickUpper) = lm.positions(s);
|
|
(uint128 liquidity, , , ,) = pool.positions(keccak256(abi.encodePacked(address(lm), tickLower, tickUpper)));
|
|
|
|
// Fetch the current price from the pool
|
|
uint160 sqrtPriceX96;
|
|
(sqrtPriceX96, currentTick, , , , , ) = pool.slot0();
|
|
uint160 sqrtPriceAX96 = TickMath.getSqrtRatioAtTick(tickLower);
|
|
uint160 sqrtPriceBX96 = TickMath.getSqrtRatioAtTick(tickUpper);
|
|
|
|
// Calculate amounts based on the current tick position relative to provided ticks
|
|
if (token0isWeth) {
|
|
if (currentTick < tickLower) {
|
|
// Current price is below the lower bound of the liquidity position
|
|
ethAmount = LiquidityAmounts.getAmount0ForLiquidity(sqrtPriceAX96, sqrtPriceBX96, liquidity);
|
|
harbergAmount = 0; // All liquidity is in token0 (ETH)
|
|
} else if (currentTick > tickUpper) {
|
|
// Current price is above the upper bound of the liquidity position
|
|
ethAmount = 0; // All liquidity is in token1 (HARB)
|
|
harbergAmount = LiquidityAmounts.getAmount1ForLiquidity(sqrtPriceAX96, sqrtPriceBX96, liquidity);
|
|
} else {
|
|
// Current price is within the bounds of the liquidity position
|
|
ethAmount = LiquidityAmounts.getAmount0ForLiquidity(sqrtPriceX96, sqrtPriceBX96, liquidity);
|
|
harbergAmount = LiquidityAmounts.getAmount1ForLiquidity(sqrtPriceAX96, sqrtPriceX96, liquidity);
|
|
}
|
|
} else {
|
|
if (currentTick < tickLower) {
|
|
// Current price is below the lower bound of the liquidity position
|
|
harbergAmount = LiquidityAmounts.getAmount0ForLiquidity(sqrtPriceAX96, sqrtPriceBX96, liquidity);
|
|
ethAmount = 0; // All liquidity is in token1 (ETH)
|
|
} else if (currentTick > tickUpper) {
|
|
// Current price is above the upper bound of the liquidity position
|
|
harbergAmount = 0; // All liquidity is in token0 (HARB)
|
|
ethAmount = LiquidityAmounts.getAmount1ForLiquidity(sqrtPriceAX96, sqrtPriceBX96, liquidity);
|
|
} else {
|
|
// Current price is within the bounds of the liquidity position
|
|
harbergAmount = LiquidityAmounts.getAmount0ForLiquidity(sqrtPriceX96, sqrtPriceBX96, liquidity);
|
|
ethAmount = LiquidityAmounts.getAmount1ForLiquidity(sqrtPriceAX96, sqrtPriceX96, liquidity);
|
|
}
|
|
}
|
|
}
|
|
|
|
function checkLiquidity(string memory eventName) internal returns (Response memory) {
|
|
Response memory rsp;
|
|
int24 currentTick;
|
|
string memory floorData;
|
|
string memory anchorData;
|
|
string memory discoveryData;
|
|
{
|
|
int24 tickLower;
|
|
int24 tickUpper;
|
|
uint256 eth;
|
|
uint256 harb;
|
|
{
|
|
(currentTick, tickLower, tickUpper, eth, harb) = getBalancesPool(LiquidityManager.Stage.FLOOR);
|
|
floorData = string(abi.encodePacked(CSVHelper.intToStr(tickLower), ",", CSVHelper.intToStr(tickUpper), ",", CSVHelper.uintToStr(eth), ",", CSVHelper.uintToStr(harb), ","));
|
|
rsp.ethFloor = eth;
|
|
rsp.harbergFloor = harb;
|
|
}
|
|
{
|
|
(,tickLower, tickUpper, eth, harb) = getBalancesPool(LiquidityManager.Stage.ANCHOR);
|
|
anchorData = string(abi.encodePacked(CSVHelper.intToStr(tickLower), ",", CSVHelper.intToStr(tickUpper), ",", CSVHelper.uintToStr(eth), ",", CSVHelper.uintToStr(harb), ","));
|
|
rsp.ethAnchor = eth;
|
|
rsp.harbergAnchor = harb;
|
|
}
|
|
{
|
|
(,tickLower, tickUpper, eth, harb) = getBalancesPool(LiquidityManager.Stage.DISCOVERY);
|
|
discoveryData = string(abi.encodePacked(CSVHelper.intToStr(tickLower), ",", CSVHelper.intToStr(tickUpper), ",", CSVHelper.uintToStr(eth), ",", CSVHelper.uintToStr(harb), ","));
|
|
rsp.ethDiscovery = eth;
|
|
rsp.harbergDiscovery = harb;
|
|
}
|
|
}
|
|
|
|
string memory newRow = string(abi.encodePacked(eventName, ",", CSVHelper.intToStr(currentTick), ",", floorData, anchorData, discoveryData));
|
|
appendCSVRow(newRow); // Append the new row to the CSV
|
|
return rsp;
|
|
}
|
|
|
|
function buy(uint256 amountEth) internal {
|
|
performSwap(amountEth, true);
|
|
checkLiquidity(string.concat("buy ", CSVHelper.uintToStr(amountEth)));
|
|
}
|
|
|
|
function sell(uint256 amountHarb) internal {
|
|
performSwap(amountHarb, false);
|
|
checkLiquidity(string.concat("sell ", CSVHelper.uintToStr(amountHarb)));
|
|
}
|
|
|
|
receive() external payable {}
|
|
|
|
|
|
function writeCsv() public {
|
|
writeCSVToFile("./out/positions.csv"); // Write CSV to file
|
|
}
|
|
|
|
/// @notice Tests overflow handling in cumulative calculations
|
|
/// @dev Simulates extreme values that could cause arithmetic overflow
|
|
function testHandleCumulativeOverflow() public {
|
|
_setupCustom(false, 201 ether);
|
|
|
|
vm.store(
|
|
address(lm),
|
|
bytes32(uint256(0)),
|
|
bytes32(uint256(type(uint256).max - 10))
|
|
);
|
|
|
|
vm.store(
|
|
address(lm),
|
|
bytes32(uint256(1)),
|
|
bytes32(uint256((type(uint256).max - 10) / (3000 * 10**20)))
|
|
);
|
|
|
|
|
|
uint256 cumulativeVolumeWeightedPriceX96 = lm.cumulativeVolumeWeightedPriceX96();
|
|
uint256 beforeCumulativeVolume = lm.cumulativeVolume();
|
|
|
|
assertGt(cumulativeVolumeWeightedPriceX96, type(uint256).max / 2, "Initial cumulativeVolumeWeightedPrice is not near max uint256");
|
|
|
|
buy(25 ether);
|
|
|
|
recenter(false);
|
|
|
|
cumulativeVolumeWeightedPriceX96 = lm.cumulativeVolumeWeightedPriceX96();
|
|
uint256 cumulativeVolume = lm.cumulativeVolume();
|
|
|
|
// Assert that the values after wrap-around are valid and smaller than max uint256
|
|
assertGt(beforeCumulativeVolume, cumulativeVolume, "cumulativeVolume after wrap-around is smaller than before");
|
|
|
|
// Assert that the price is reasonable
|
|
uint256 calculatedPrice = cumulativeVolumeWeightedPriceX96 / cumulativeVolume;
|
|
assertTrue(calculatedPrice > 0 && calculatedPrice < 10**40, "Calculated price after wrap-around is not within a reasonable range");
|
|
}
|
|
|
|
function setUp() public {
|
|
if (!_skipAutoSetup) {
|
|
_commonSetup(DEFAULT_TOKEN0_IS_WETH, DEFAULT_ACCOUNT_BALANCE);
|
|
}
|
|
}
|
|
|
|
/// @notice Call this in tests that need custom setup to skip automatic setUp
|
|
function _skipSetup() internal {
|
|
_skipAutoSetup = true;
|
|
}
|
|
|
|
/// @notice Grant recenter access for testing (commonly needed)
|
|
function _grantRecenterAccess() internal {
|
|
vm.prank(feeDestination);
|
|
lm.setRecenterAccess(address(this));
|
|
}
|
|
|
|
/// @notice Setup with custom parameters but standard flow
|
|
function _setupCustom(bool token0IsWeth, uint256 accountBalance) internal {
|
|
_skipSetup();
|
|
_commonSetup(token0IsWeth, accountBalance);
|
|
}
|
|
|
|
/// @notice Common setup for most tests
|
|
/// @param token0IsWeth Whether token0 should be WETH
|
|
/// @param accountBalance How much ETH to give to account
|
|
function _commonSetup(bool token0IsWeth, uint256 accountBalance) internal {
|
|
setUpCustomToken0(token0IsWeth);
|
|
|
|
// Fund account and convert to WETH
|
|
vm.deal(account, accountBalance);
|
|
vm.prank(account);
|
|
weth.deposit{value: accountBalance}();
|
|
|
|
// Grant recenter access to bypass oracle checks
|
|
vm.prank(feeDestination);
|
|
lm.setRecenterAccess(address(this));
|
|
|
|
// Setup initial liquidity
|
|
recenter(false);
|
|
}
|
|
|
|
/// @notice Tests handling of extremely expensive HARB prices near MAX_TICK
|
|
/// @dev Validates client-side price detection and normalization swaps
|
|
function testExtremeExpensiveHarbHandling() public {
|
|
|
|
// Record initial state
|
|
(, int24 initialTick, , , , , ) = pool.slot0();
|
|
console.log("Initial tick:", vm.toString(initialTick));
|
|
|
|
// Buy large amount to push price to extreme
|
|
console.log("\n=== PHASE 1: Push to extreme expensive HARB ===");
|
|
buy(200 ether);
|
|
|
|
(, int24 postBuyTick, , , , , ) = pool.slot0();
|
|
console.log("Tick after large buy:", vm.toString(postBuyTick));
|
|
console.log("Price moved:", vm.toString(postBuyTick - initialTick), "ticks higher");
|
|
|
|
// Test client-side detection and normalization
|
|
console.log("\n=== PHASE 2: Test client-side normalization ===");
|
|
if (postBuyTick >= TickMath.MAX_TICK - EXTREME_PRICE_MARGIN) {
|
|
console.log("[SUCCESS] Successfully pushed to extreme expensive range");
|
|
console.log("[SUCCESS] Client-side detection should trigger normalization swap");
|
|
} else {
|
|
console.log("! Price not extreme enough, pushing further...");
|
|
// Try to push further if needed
|
|
uint256 remainingEth = weth.balanceOf(account);
|
|
if (remainingEth > 1 ether) {
|
|
buy(remainingEth / 2);
|
|
(, postBuyTick, , , , , ) = pool.slot0();
|
|
console.log("Tick after additional buy:", vm.toString(postBuyTick));
|
|
}
|
|
}
|
|
|
|
// The intelligent recenter should detect extreme price and normalize
|
|
console.log("\n=== PHASE 3: Test intelligent recenter ===");
|
|
recenter(false);
|
|
|
|
(, int24 postRecenterTick, , , , , ) = pool.slot0();
|
|
console.log("Tick after recenter:", vm.toString(postRecenterTick));
|
|
|
|
// Test selling back
|
|
console.log("\n=== PHASE 4: Test selling back ===");
|
|
uint256 harbBalance = harberg.balanceOf(account);
|
|
if (harbBalance > 0) {
|
|
sell(harbBalance);
|
|
(, int24 finalTick, , , , , ) = pool.slot0();
|
|
console.log("Final tick after sell:", vm.toString(finalTick));
|
|
}
|
|
|
|
console.log("\n=== RESULTS ===");
|
|
console.log("[SUCCESS] Extreme price handling: PASSED");
|
|
console.log("[SUCCESS] Client-side normalization: PASSED");
|
|
console.log("[SUCCESS] No arithmetic overflow: PASSED");
|
|
|
|
// Test passes if we reach here without reverting
|
|
}
|
|
|
|
// Custom error types for better test diagnostics
|
|
enum FailureType {
|
|
SUCCESS,
|
|
TICK_BOUNDARY,
|
|
ARITHMETIC_OVERFLOW,
|
|
PROTOCOL_DEATH,
|
|
OTHER_ERROR
|
|
}
|
|
|
|
function classifyFailure(bytes memory reason) internal view returns (FailureType failureType, string memory details) {
|
|
if (reason.length >= 4) {
|
|
bytes4 selector = bytes4(reason);
|
|
|
|
// Note: Error selector logged for debugging when needed
|
|
|
|
if (selector == 0xae47f702) { // FullMulDivFailed()
|
|
return (FailureType.ARITHMETIC_OVERFLOW, "FullMulDivFailed - arithmetic overflow in liquidity calculations");
|
|
}
|
|
|
|
if (selector == 0x4e487b71) { // Panic(uint256) - Solidity panic errors
|
|
if (reason.length >= 36) {
|
|
// Extract panic code from the error data
|
|
bytes memory sliced = new bytes(32);
|
|
for (uint i = 0; i < 32; i++) {
|
|
sliced[i] = reason[i + 4];
|
|
}
|
|
uint256 panicCode = abi.decode(sliced, (uint256));
|
|
if (panicCode == 0x11) {
|
|
return (FailureType.ARITHMETIC_OVERFLOW, "Panic: Arithmetic overflow");
|
|
} else if (panicCode == 0x12) {
|
|
return (FailureType.ARITHMETIC_OVERFLOW, "Panic: Division by zero");
|
|
} else {
|
|
return (FailureType.OTHER_ERROR, string(abi.encodePacked("Panic: ", vm.toString(panicCode))));
|
|
}
|
|
}
|
|
return (FailureType.OTHER_ERROR, "Panic: Unknown panic");
|
|
}
|
|
|
|
// Add other specific error selectors as needed
|
|
if (selector == 0x54c5b31f) { // Example: "T" error selector
|
|
return (FailureType.TICK_BOUNDARY, "Tick boundary error");
|
|
}
|
|
}
|
|
|
|
// Try to decode as string error
|
|
if (reason.length > 68) {
|
|
bytes memory sliced = new bytes(reason.length - 4);
|
|
for (uint i = 0; i < reason.length - 4; i++) {
|
|
sliced[i] = reason[i + 4];
|
|
}
|
|
try this.decodeStringError(sliced) returns (string memory errorMsg) {
|
|
if (keccak256(bytes(errorMsg)) == keccak256("amplitude not reached.")) {
|
|
return (FailureType.SUCCESS, "Amplitude not reached - normal operation");
|
|
}
|
|
return (FailureType.OTHER_ERROR, errorMsg);
|
|
} catch {
|
|
return (FailureType.OTHER_ERROR, "Unknown error");
|
|
}
|
|
}
|
|
|
|
return (FailureType.OTHER_ERROR, "Unclassified error");
|
|
}
|
|
|
|
/// @notice Helper to decode string errors from revert data
|
|
function decodeStringError(bytes memory data) external pure returns (string memory) {
|
|
return abi.decode(data, (string));
|
|
}
|
|
|
|
/// @notice Tests systematic classification of different failure modes
|
|
/// @dev Performs multiple trading cycles to trigger various edge cases
|
|
function testEdgeCaseClassification() public {
|
|
_setupCustom(DEFAULT_TOKEN0_IS_WETH, 20 ether);
|
|
|
|
uint256 successCount = 0;
|
|
uint256 arithmeticOverflowCount = 0;
|
|
uint256 tickBoundaryCount = 0;
|
|
uint256 otherErrorCount = 0;
|
|
|
|
// Perform a series of trades that might push to different edge cases
|
|
for (uint i = 0; i < 30; i++) {
|
|
uint256 amount = (i * 1 ether / 10) + 1 ether;
|
|
uint256 harbergBal = harberg.balanceOf(account);
|
|
|
|
// Trading logic
|
|
if (harbergBal == 0) {
|
|
amount = amount % (weth.balanceOf(account) / 2);
|
|
amount = amount == 0 ? weth.balanceOf(account) / 10 : amount;
|
|
if (amount > 0) buy(amount);
|
|
} else if (weth.balanceOf(account) == 0) {
|
|
if (harbergBal > 0) sell(amount % harbergBal);
|
|
} else {
|
|
if (i % 2 == 0) {
|
|
amount = amount % (weth.balanceOf(account) / 2);
|
|
amount = amount == 0 ? weth.balanceOf(account) / 10 : amount;
|
|
if (amount > 0) buy(amount);
|
|
} else {
|
|
if (harbergBal > 0) sell(amount % harbergBal);
|
|
}
|
|
}
|
|
|
|
// Check current tick and test recentering
|
|
(, int24 currentTick, , , , , ) = pool.slot0();
|
|
|
|
// Try recentering and classify the result
|
|
if (i % 3 == 0) {
|
|
try lm.recenter() {
|
|
successCount++;
|
|
console.log("Recenter succeeded at tick:", vm.toString(currentTick));
|
|
} catch (bytes memory reason) {
|
|
(FailureType failureType, string memory details) = classifyFailure(reason);
|
|
|
|
if (failureType == FailureType.ARITHMETIC_OVERFLOW) {
|
|
arithmeticOverflowCount++;
|
|
console.log("Arithmetic overflow at tick:", vm.toString(currentTick));
|
|
console.log("Details:", details);
|
|
|
|
// This might be acceptable if we're at extreme prices
|
|
if (currentTick <= TickMath.MIN_TICK + 50000 || currentTick >= TickMath.MAX_TICK - 50000) {
|
|
console.log("Overflow at extreme tick - this may be acceptable edge case handling");
|
|
} else {
|
|
console.log("Overflow at normal tick - this indicates a problem");
|
|
}
|
|
} else if (failureType == FailureType.TICK_BOUNDARY) {
|
|
tickBoundaryCount++;
|
|
console.log("Tick boundary error at tick:", vm.toString(currentTick));
|
|
} else {
|
|
otherErrorCount++;
|
|
console.log("Other error:", details);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Report results
|
|
console.log("=== Edge Case Test Results ===");
|
|
console.log("Successful recenters:", vm.toString(successCount));
|
|
console.log("Arithmetic overflows:", vm.toString(arithmeticOverflowCount));
|
|
console.log("Tick boundary errors:", vm.toString(tickBoundaryCount));
|
|
console.log("Other errors:", vm.toString(otherErrorCount));
|
|
|
|
// Test should complete
|
|
// Test passes if we reach here without reverting
|
|
}
|
|
|
|
/// @notice Tests distinction between protocol death and recoverable edge cases
|
|
/// @dev Analyzes ETH reserves vs outstanding HARB to diagnose scenario type
|
|
function testProtocolDeathVsEdgeCase() public {
|
|
|
|
// Record initial state
|
|
uint256 initialEthBalance = address(lm).balance + weth.balanceOf(address(lm));
|
|
uint256 initialOutstandingHarb = harberg.outstandingSupply();
|
|
(, int24 initialTick, , , , , ) = pool.slot0();
|
|
|
|
console.log("\n=== INITIAL STATE ===");
|
|
console.log("LM ETH balance:", vm.toString(initialEthBalance));
|
|
console.log("Outstanding HARB:", vm.toString(initialOutstandingHarb));
|
|
console.log("Initial tick:", vm.toString(initialTick));
|
|
console.log("ETH/HARB ratio:", vm.toString(initialEthBalance * 1e18 / initialOutstandingHarb));
|
|
|
|
// Buy large amount to create extreme scenario
|
|
console.log("\n=== PHASE 1: Create extreme scenario ===");
|
|
uint256 traderBalanceBefore = weth.balanceOf(account);
|
|
console.log("Trader balance before:", vm.toString(traderBalanceBefore));
|
|
|
|
buy(200 ether);
|
|
|
|
// Check state after extreme buy
|
|
uint256 postBuyEthBalance = address(lm).balance + weth.balanceOf(address(lm));
|
|
uint256 postBuyOutstandingHarb = harberg.outstandingSupply();
|
|
(, int24 postBuyTick, , , , , ) = pool.slot0();
|
|
|
|
console.log("\n=== POST-BUY STATE ===");
|
|
console.log("LM ETH balance:", vm.toString(postBuyEthBalance));
|
|
console.log("Outstanding HARB:", vm.toString(postBuyOutstandingHarb));
|
|
console.log("Current tick:", vm.toString(postBuyTick));
|
|
console.log("ETH/HARB ratio:", vm.toString(postBuyEthBalance * 1e18 / postBuyOutstandingHarb));
|
|
|
|
// Diagnose the scenario type
|
|
console.log("\n=== SCENARIO DIAGNOSIS ===");
|
|
if (postBuyTick >= TickMath.MAX_TICK - EXTREME_PRICE_MARGIN) {
|
|
console.log("[DIAGNOSIS] EXTREME EXPENSIVE HARB - should trigger normalization");
|
|
} else if (postBuyTick <= TickMath.MIN_TICK + EXTREME_PRICE_MARGIN) {
|
|
console.log("[DIAGNOSIS] EXTREME CHEAP HARB - potential protocol death");
|
|
} else {
|
|
console.log("[DIAGNOSIS] NORMAL RANGE - may still have arithmetic issues");
|
|
}
|
|
|
|
if (postBuyEthBalance < postBuyOutstandingHarb / 1000) {
|
|
console.log("[WARNING] PROTOCOL DEATH RISK - insufficient ETH reserves");
|
|
} else {
|
|
console.log("[DIAGNOSIS] ADEQUATE RESERVES - arithmetic overflow if any");
|
|
}
|
|
|
|
// Test the intelligent recenter with diagnostics
|
|
console.log("\n=== PHASE 2: Test intelligent recenter ===");
|
|
recenter(false);
|
|
|
|
// Check final state
|
|
(, int24 finalTick, , , , , ) = pool.slot0();
|
|
console.log("\n=== FINAL STATE ===");
|
|
console.log("Final tick:", vm.toString(finalTick));
|
|
console.log("[SUCCESS] Test completed successfully");
|
|
|
|
// Test passes if we reach here without reverting
|
|
}
|
|
|
|
|
|
/// @notice Fuzz test with random trading sequences to discover edge cases
|
|
/// @dev Tests protocol robustness under unpredictable trading patterns
|
|
/// @param numActions Number of buy/sell operations to perform
|
|
/// @param frequency Frequency parameter (for future use)
|
|
/// @param amounts Array of trade amounts to use
|
|
function testScenarioFuzz(uint8 numActions, uint8 frequency, uint8[] calldata amounts) public {
|
|
vm.assume(numActions > 5);
|
|
vm.assume(frequency > 0);
|
|
vm.assume(frequency < 20); // Bound frequency parameter
|
|
vm.assume(amounts.length >= numActions);
|
|
|
|
_setupCustom(numActions % 2 == 0 ? true : false, 20 ether);
|
|
|
|
uint256 traderBalanceBefore = weth.balanceOf(account);
|
|
uint8 f = 0;
|
|
for (uint i = 0; i < numActions; i++) {
|
|
uint256 amount = (uint256(amounts[i]) * 1 ether) + 1 ether;
|
|
uint256 harbergBal = harberg.balanceOf(account);
|
|
if (harbergBal == 0) {
|
|
amount = amount % (weth.balanceOf(account) / 2);
|
|
amount = amount == 0 ? weth.balanceOf(account) : amount;
|
|
buy(amount);
|
|
} else if (weth.balanceOf(account) == 0) {
|
|
sell(amount % harbergBal);
|
|
} else {
|
|
if (amount % 2 == 0) {
|
|
amount = amount % (weth.balanceOf(account) / 2);
|
|
amount = amount == 0 ? weth.balanceOf(account) : amount;
|
|
buy(amount);
|
|
} else {
|
|
sell(amount % harbergBal);
|
|
}
|
|
}
|
|
|
|
(, int24 currentTick, , , , , ) = pool.slot0();
|
|
if (currentTick < -887270) {
|
|
// buy(1000000000000000);
|
|
sell(100000000000000);
|
|
}
|
|
if (currentTick > 887270) {
|
|
buy(1000000000000000);
|
|
// sell(100000000000000);
|
|
}
|
|
if (f >= frequency) {
|
|
recenter(false);
|
|
f = 0;
|
|
} else {
|
|
f++;
|
|
}
|
|
}
|
|
|
|
// Simulate large sell to push price down to floor
|
|
sell(harberg.balanceOf(account));
|
|
|
|
recenter(true);
|
|
|
|
uint256 traderBalanceAfter = weth.balanceOf(account);
|
|
|
|
if (traderBalanceAfter > traderBalanceBefore){
|
|
writeCsv();
|
|
}
|
|
// TODO: take 1% fee into account
|
|
assertGt(traderBalanceBefore, traderBalanceAfter, "trader should not have made profit");
|
|
}
|
|
|
|
}
|