feat: Add Maverick V2 adapter and substreams (#167)

Co-authored-by: Thales <thales@datarevenue.com>
Co-authored-by: zizou <111426680+flopell@users.noreply.github.com>
This commit is contained in:
Zach
2025-05-23 23:07:15 +08:00
committed by GitHub
parent a7841af383
commit fb0a57bf07
32 changed files with 12082 additions and 0 deletions

View File

@@ -0,0 +1,290 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {
IERC20,
SafeERC20
} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
/// @title MaverickV2SwapAdapter
/// @notice Adapter for swapping tokens on MaverickV2 pools.
contract MaverickV2SwapAdapter is ISwapAdapter {
using SafeERC20 for IERC20;
IMaverickV2Factory public immutable factory;
IMaverickV2Quoter public immutable quoter;
/// @notice Constructor to initialize the adapter with factory, quoter, and
/// WETH addresses.
/// @param factory_ The address of the MaverickV2 factory.
/// @param _quoter The address of the MaverickV2 quoter.
constructor(address factory_, address _quoter) {
factory = IMaverickV2Factory(factory_);
quoter = IMaverickV2Quoter(_quoter);
}
receive() external payable {}
/// @inheritdoc ISwapAdapter
function price(
bytes32 poolId,
address sellToken,
address,
uint256[] memory specifiedAmounts
) external override returns (Fraction[] memory calculatedPrices) {
calculatedPrices = new Fraction[](specifiedAmounts.length);
IMaverickV2Pool pool = IMaverickV2Pool(address(bytes20(poolId)));
for (uint256 i = 0; i < specifiedAmounts.length; i++) {
calculatedPrices[i] = priceAt(pool, sellToken, specifiedAmounts[i]);
}
return calculatedPrices;
}
/// @notice Calculate the price of a token at a specified amount.
/// @param pool The pool to calculate the price for.
/// @param sellToken The token to calculate the price for.
/// @param sellAmount The amount of the token to calculate the price for.
/// @return calculatedPrice The calculated price of the token.
function priceAt(
IMaverickV2Pool pool,
address sellToken,
uint256 sellAmount
) public returns (Fraction memory calculatedPrice) {
bool isTokenAIn = (sellToken == address(pool.tokenA()));
int32 tickLimit = isTokenAIn
? pool.getState().activeTick + 100
: pool.getState().activeTick - 100;
(uint256 amountIn, uint256 amountOut,) = quoter.calculateSwap(
pool, uint128(sellAmount), isTokenAIn, false, tickLimit
);
calculatedPrice = Fraction(amountOut, amountIn);
}
/// @inheritdoc ISwapAdapter
function swap(
bytes32 poolId,
address sellToken,
address,
OrderSide side,
uint256 specifiedAmount
) external override returns (Trade memory trade) {
if (specifiedAmount == 0) {
return trade;
}
IMaverickV2Pool pool = IMaverickV2Pool(address(bytes20(poolId)));
bool isTokenAIn = sellToken == address(pool.tokenA());
int32 tickLimit = isTokenAIn
? pool.getState().activeTick + 100
: pool.getState().activeTick - 100;
uint256 gasBefore = gasleft();
if (side == OrderSide.Buy) {
trade.calculatedAmount =
buy(pool, isTokenAIn, tickLimit, specifiedAmount);
trade.price = priceAt(pool, sellToken, trade.calculatedAmount);
} else {
trade.calculatedAmount =
sell(pool, isTokenAIn, tickLimit, specifiedAmount);
trade.price = priceAt(pool, sellToken, specifiedAmount);
}
trade.gasUsed = gasBefore - gasleft();
return trade;
}
/// @notice Buy tokens from a pool.
/// @param pool The pool to buy from.
/// @param isTokenAIn Whether token A is the input token.
/// @param tickLimit The tick limit for the swap.
/// @param specifiedAmount The amount of the token to buy.
/// @return calculatedAmount The amount of the token bought.
function buy(
IMaverickV2Pool pool,
bool isTokenAIn,
int32 tickLimit,
uint256 specifiedAmount
) internal returns (uint256 calculatedAmount) {
IMaverickV2Pool.SwapParams memory swapParams = IMaverickV2Pool
.SwapParams({
amount: specifiedAmount,
tokenAIn: isTokenAIn,
exactOutput: true,
tickLimit: tickLimit
});
// callback data is the sender address
bytes memory data = abi.encode(msg.sender);
(uint256 amountIn,) = pool.swap(msg.sender, swapParams, data);
return amountIn;
}
/// @notice Sell tokens to a pool.
/// @param pool The pool to sell to.
/// @param isTokenAIn Whether token A is the input token.
/// @param tickLimit The tick limit for the swap.
/// @param specifiedAmount The amount of the token to sell.
/// @return calculatedAmount The amount of the token sold.
function sell(
IMaverickV2Pool pool,
bool isTokenAIn,
int32 tickLimit,
uint256 specifiedAmount
) internal returns (uint256 calculatedAmount) {
IMaverickV2Pool.SwapParams memory swapParams = IMaverickV2Pool
.SwapParams({
amount: specifiedAmount,
tokenAIn: isTokenAIn,
exactOutput: false,
tickLimit: tickLimit
});
// callback data is the sender address
bytes memory data = abi.encode(msg.sender);
(, uint256 amountOut) = pool.swap(msg.sender, swapParams, data);
return amountOut;
}
/// @notice MaverickV2SwapCallback is the callback function for MaverickV2
/// pools.
/// @param tokenIn The token being swapped.
/// @param amountIn The amount of the token being swapped.
/// @param data The data passed to the callback.
function maverickV2SwapCallback(
IERC20 tokenIn,
uint256 amountIn,
uint256,
bytes calldata data
) external {
require(
factory.isFactoryPool(IMaverickV2Pool(msg.sender)), "NotFactoryPool"
);
address payer = abi.decode(data, (address));
tokenIn.safeTransferFrom(payer, msg.sender, amountIn);
}
/// @inheritdoc ISwapAdapter
function getLimits(bytes32 poolId, address sellToken, address buyToken)
external
view
override
returns (uint256[] memory limits)
{
IMaverickV2Pool pool = IMaverickV2Pool(address(bytes20(poolId)));
IMaverickV2Pool.State memory state = pool.getState();
limits = new uint256[](2);
uint256 r0 = state.reserveA;
uint256 r1 = state.reserveB;
if (sellToken < buyToken) {
limits[0] = r0;
limits[1] = r1;
} else {
limits[0] = r1;
limits[1] = r0;
}
}
/// @inheritdoc ISwapAdapter
function getCapabilities(bytes32, address, address)
external
pure
override
returns (Capability[] memory capabilities)
{
capabilities = new Capability[](3);
capabilities[0] = Capability.SellOrder;
capabilities[1] = Capability.BuyOrder;
capabilities[2] = Capability.PriceFunction;
}
/// @inheritdoc ISwapAdapter
function getTokens(bytes32 poolId)
external
view
override
returns (address[] memory tokens)
{
tokens = new address[](2);
IMaverickV2Pool pool = IMaverickV2Pool(address(bytes20(poolId)));
tokens[0] = address(pool.tokenA());
tokens[1] = address(pool.tokenB());
}
/// @inheritdoc ISwapAdapter
function getPoolIds(uint256 offset, uint256 limit)
external
view
override
returns (bytes32[] memory ids)
{
IMaverickV2Pool[] memory pools = factory.lookup(offset, offset + limit);
ids = new bytes32[](pools.length);
for (uint256 i = 0; i < pools.length; i++) {
ids[i] = bytes20((address(pools[i])));
}
}
}
interface IMaverickV2Pool {
struct SwapParams {
uint256 amount;
bool tokenAIn;
bool exactOutput;
int32 tickLimit;
}
struct State {
uint128 reserveA;
uint128 reserveB;
int64 lastTwaD8;
int64 lastLogPriceD8;
uint40 lastTimestamp;
int32 activeTick;
bool isLocked;
uint32 binCounter;
uint8 protocolFeeRatioD3;
}
function fee(bool tokenAIn) external view returns (uint256);
function tokenA() external view returns (IERC20);
function tokenB() external view returns (IERC20);
function factory() external view returns (IMaverickV2Factory);
function getState() external view returns (State memory);
function swap(
address recipient,
SwapParams memory params,
bytes calldata data
) external returns (uint256 amountIn, uint256 amountOut);
}
interface IMaverickV2Factory {
function isFactoryPool(IMaverickV2Pool pool) external view returns (bool);
function lookup(uint256 startIndex, uint256 endIndex)
external
view
returns (IMaverickV2Pool[] memory pools);
}
interface IWETH9 is IERC20 {
/// @notice Deposit ether to get wrapped ether
function deposit() external payable;
/// @notice Withdraw wrapped ether to get ether
function withdraw(uint256) external;
}
interface IMaverickV2Quoter {
function calculateSwap(
IMaverickV2Pool pool,
uint128 amount,
bool tokenAIn,
bool exactOutput,
int32 tickLimit
)
external
returns (uint256 amountIn, uint256 amountOut, uint256 gasEstimate);
}

View File

@@ -0,0 +1,26 @@
# information about the author helps us reach out in case of issues.
author:
name: Zach
email: zachchou016@gmail.com
# Protocol Constants
constants:
# The expected average gas cost of a swap
protocol_gas: 30000
# Minimum capabilities we can expect, individual pools may extend these
capabilities:
- SellSide
- BuySide
- PriceFunction
# The file containing the adapter contract
contract: MaverickV2SwapAdapter.sol
# Deployment instances used to generate chain specific bytecode.
instances:
- chain:
name: mainnet
id: 1
arguments:
- "0x0A7e848Aca42d879EF06507Fca0E7b33A0a63c1e"
- "0xb40AfdB85a07f37aE217E7D6462e609900dD8D7A"

View File

@@ -0,0 +1,295 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import "./AdapterTest.sol";
import "forge-std/Test.sol";
import "src/interfaces/ISwapAdapterTypes.sol";
import "src/libraries/FractionMath.sol";
import "src/maverick-v2/MaverickV2SwapAdapter.sol";
contract MaverickV2SwapAdapterTest is AdapterTest {
using FractionMath for Fraction;
MaverickV2SwapAdapter adapter;
address constant WETH = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
address constant QUOTER = 0xb40AfdB85a07f37aE217E7D6462e609900dD8D7A;
address constant FACTORY = 0x0A7e848Aca42d879EF06507Fca0E7b33A0a63c1e;
address constant USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
address constant GHO = 0x40D16FC0246aD3160Ccc09B8D0D3A2cD28aE6C2f;
address constant GHO_USDC_POOL = 0x14Cf6D2Fe3E1B326114b07d22A6F6bb59e346c67;
uint256 constant TEST_ITERATIONS = 10;
uint256 constant GHO_BALANCE = 100_000 * 1e18;
uint256 constant USDC_BALANCE = 100_000 * 1e6;
function setUp() public {
uint256 forkBlock = 22096000;
vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock);
adapter = new MaverickV2SwapAdapter(FACTORY, QUOTER);
vm.label(address(adapter), "MaverickV2SwapAdapter");
vm.label(WETH, "WETH");
vm.label(QUOTER, "Quoter");
vm.label(FACTORY, "Factory");
vm.label(USDC, "USDC");
vm.label(GHO, "GHO");
vm.label(GHO_USDC_POOL, "GHO_USDC_POOL");
}
function testGetLimits() public view {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256[] memory limits = adapter.getLimits(pair, GHO, USDC);
assertEq(limits.length, 2);
assertGt(limits[0], 0, "Limit for sell token should be greater than 0");
assertGt(limits[1], 0, "Limit for buy token should be greater than 0");
}
function testPriceFuzz(uint256 amount0, uint256 amount1) public {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256[] memory limits = adapter.getLimits(pair, GHO, USDC);
vm.assume(amount0 < limits[0]);
vm.assume(amount1 < limits[0]);
vm.assume(amount0 > 1e16);
vm.assume(amount1 > 1e16);
uint256[] memory amounts = new uint256[](2);
amounts[0] = amount0;
amounts[1] = amount1;
Fraction[] memory prices = adapter.price(pair, GHO, USDC, amounts);
for (uint256 i = 0; i < prices.length; i++) {
assertGt(prices[i].numerator, 0);
assertGt(prices[i].denominator, 0);
}
}
function testPrice() public {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256[] memory amounts = new uint256[](1);
amounts[0] = 10e18; // 10 GHO
Fraction[] memory prices = adapter.price(pair, GHO, USDC, amounts);
assertEq(prices.length, 1);
assertGt(
prices[0].numerator, 0, "Price numerator should be greater than 0"
);
assertGt(
prices[0].denominator,
0,
"Price denominator should be greater than 0"
);
}
function testPriceDecreasing() public {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256[] memory amounts = new uint256[](TEST_ITERATIONS);
for (uint256 i = 0; i < TEST_ITERATIONS; i++) {
amounts[i] = 100 * (i + 1) * 10 ** 18;
}
Fraction[] memory prices = adapter.price(pair, GHO, USDC, amounts);
for (uint256 i = 0; i < TEST_ITERATIONS - 1; i++) {
assertGe(prices[i].compareFractions(prices[i + 1]), 1); // same bin
// price are same
assertGt(prices[i].denominator, 0);
assertGt(prices[i + 1].denominator, 0);
}
}
function testSwapSell() public {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256 amount = 10e18; // 10 GHO
deal(GHO, address(this), GHO_BALANCE);
deal(USDC, address(this), USDC_BALANCE);
// Approve adapter to spend WETH
vm.prank(address(this));
IERC20(GHO).approve(address(adapter), amount);
Trade memory trade =
adapter.swap(pair, GHO, USDC, OrderSide.Sell, amount);
assertGt(
trade.calculatedAmount,
0,
"Calculated amount should be greater than 0"
);
assertGt(
trade.price.numerator, 0, "Price numerator should be greater than 0"
);
assertGt(
trade.price.denominator,
0,
"Price denominator should be greater than 0"
);
assertGt(trade.gasUsed, 0, "Gas used should be greater than 0");
}
function testSwapBuy() public {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256 amount = 100e18; // buy 100 GHO
deal(GHO, address(this), GHO_BALANCE);
deal(USDC, address(this), USDC_BALANCE);
// Approve adapter to spend USDC
vm.prank(address(this));
IERC20(USDC).approve(address(adapter), USDC_BALANCE);
Trade memory trade =
adapter.swap(pair, USDC, GHO, OrderSide.Buy, amount);
assertGt(
trade.calculatedAmount,
0,
"Calculated amount should be greater than 0"
);
assertGt(
trade.price.numerator, 0, "Price numerator should be greater than 0"
);
assertGt(
trade.price.denominator,
0,
"Price denominator should be greater than 0"
);
assertGt(trade.gasUsed, 0, "Gas used should be greater than 0");
}
function testSwapFuzz(uint256 specifiedAmount, bool isBuy) public {
OrderSide side = isBuy ? OrderSide.Buy : OrderSide.Sell;
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256[] memory limits = adapter.getLimits(pair, GHO, USDC);
if (side == OrderSide.Buy) {
// specify buy usdc amount
vm.assume(specifiedAmount < limits[1]);
deal(GHO, address(this), type(uint256).max);
IERC20(GHO).approve(address(adapter), type(uint256).max);
} else {
// specify sell gho amount
vm.assume(specifiedAmount < limits[0]);
deal(GHO, address(this), specifiedAmount);
IERC20(GHO).approve(address(adapter), specifiedAmount);
}
uint256 usdc_balance = IERC20(USDC).balanceOf(address(this));
uint256 gho_balance = IERC20(GHO).balanceOf(address(this));
Trade memory trade =
adapter.swap(pair, GHO, USDC, side, specifiedAmount);
if (trade.calculatedAmount > 0) {
if (side == OrderSide.Buy) {
assertEq(
specifiedAmount,
IERC20(USDC).balanceOf(address(this)) - usdc_balance
);
assertEq(
trade.calculatedAmount,
gho_balance - IERC20(GHO).balanceOf(address(this))
);
} else {
assertEq(
specifiedAmount,
gho_balance - IERC20(GHO).balanceOf(address(this))
);
assertEq(
trade.calculatedAmount,
IERC20(USDC).balanceOf(address(this)) - usdc_balance
);
}
}
}
function testSwapSellIncreasing() public {
executeIncreasingSwaps(OrderSide.Sell);
}
function testSwapBuyIncreasing() public {
executeIncreasingSwaps(OrderSide.Buy);
}
function executeIncreasingSwaps(OrderSide side) internal {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
uint256[] memory amounts = new uint256[](TEST_ITERATIONS);
for (uint256 i = 0; i < TEST_ITERATIONS; i++) {
if (side == OrderSide.Sell) {
amounts[i] = 100 * (i + 1) * 10 ** 6; // specify sell usdc
} else {
amounts[i] = 100 * (i + 1) * 10 ** 18; // specify buy gho
}
}
deal(GHO, address(this), GHO_BALANCE);
deal(USDC, address(this), USDC_BALANCE);
Trade[] memory trades = new Trade[](TEST_ITERATIONS);
uint256 beforeSwap;
for (uint256 i = 0; i < TEST_ITERATIONS; i++) {
beforeSwap = vm.snapshot();
IERC20(USDC).approve(address(adapter), USDC_BALANCE);
trades[i] = adapter.swap(pair, USDC, GHO, side, amounts[i]);
vm.revertTo(beforeSwap);
}
for (uint256 i = 1; i < TEST_ITERATIONS - 1; i++) {
assertLe(trades[i].calculatedAmount, trades[i + 1].calculatedAmount);
assertLe(trades[i].gasUsed, trades[i + 1].gasUsed);
assertEq(trades[i].price.compareFractions(trades[i + 1].price), 1);
}
}
function testGetCapabilities() public view {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
Capability[] memory capabilities =
adapter.getCapabilities(pair, GHO, USDC);
assertEq(capabilities.length, 3);
assertEq(uint256(capabilities[0]), uint256(Capability.SellOrder));
assertEq(uint256(capabilities[1]), uint256(Capability.BuyOrder));
assertEq(uint256(capabilities[2]), uint256(Capability.PriceFunction));
}
function testGetTokens() public view {
bytes32 pair = bytes32(bytes20(GHO_USDC_POOL));
address[] memory tokens = adapter.getTokens(pair);
assertEq(tokens.length, 2);
assertEq(tokens[0], GHO);
assertEq(tokens[1], USDC);
}
function testGetPoolIds() public view {
uint256 offset = 0;
uint256 limit = 10;
bytes32[] memory poolIds = adapter.getPoolIds(offset, limit);
assertLe(
poolIds.length,
limit,
"Number of pool IDs should be less than or equal to limit"
);
if (poolIds.length > 0) {
assertGt(uint256(poolIds[0]), 0, "Pool ID should be greater than 0");
}
}
function testMavV2PoolBehaviour() public {
bytes32[] memory poolIds = new bytes32[](1);
poolIds[0] = bytes32(bytes20(GHO_USDC_POOL));
runPoolBehaviourTest(adapter, poolIds);
}
}