-
Notifications
You must be signed in to change notification settings - Fork 16
/
VeBALFeeDiscountHookExample.t.sol
291 lines (234 loc) · 11.7 KB
/
VeBALFeeDiscountHookExample.t.sol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity ^0.8.24;
import "forge-std/Test.sol";
import { IVault } from "@balancer-labs/v3-interfaces/contracts/vault/IVault.sol";
import { IVaultAdmin } from "@balancer-labs/v3-interfaces/contracts/vault/IVaultAdmin.sol";
import { IVaultErrors } from "@balancer-labs/v3-interfaces/contracts/vault/IVaultErrors.sol";
import {
HooksConfig,
LiquidityManagement,
PoolRoleAccounts,
TokenConfig
} from "@balancer-labs/v3-interfaces/contracts/vault/VaultTypes.sol";
import { CastingHelpers } from "@balancer-labs/v3-solidity-utils/contracts/helpers/CastingHelpers.sol";
import { ArrayHelpers } from "@balancer-labs/v3-solidity-utils/contracts/test/ArrayHelpers.sol";
import { FixedPoint } from "@balancer-labs/v3-solidity-utils/contracts/math/FixedPoint.sol";
import { BaseVaultTest } from "@balancer-labs/v3-vault/test/foundry/utils/BaseVaultTest.sol";
import { PoolMock } from "@balancer-labs/v3-vault/contracts/test/PoolMock.sol";
import { PoolFactoryMock } from "@balancer-labs/v3-vault/contracts/test/PoolFactoryMock.sol";
import { RouterMock } from "@balancer-labs/v3-vault/contracts/test/RouterMock.sol";
import { VeBALFeeDiscountHookExample } from "../../contracts/VeBALFeeDiscountHookExample.sol";
contract VeBALFeeDiscountHookExampleTest is BaseVaultTest {
using CastingHelpers for address[];
using FixedPoint for uint256;
using ArrayHelpers for *;
uint256 internal daiIdx;
uint256 internal usdcIdx;
// Maximum swap fee of 10%
uint64 public constant MAX_SWAP_FEE_PERCENTAGE = 10e16;
address payable internal trustedRouter;
function setUp() public override {
super.setUp();
(daiIdx, usdcIdx) = getSortedIndexes(address(dai), address(usdc));
// Grants LP the ability to change the static swap fee percentage.
authorizer.grantRole(vault.getActionId(IVaultAdmin.setStaticSwapFeePercentage.selector), lp);
}
function createHook() internal override returns (address) {
trustedRouter = payable(router);
// lp will be the owner of the hook. Only LP is able to set hook fee percentages.
vm.prank(lp);
address veBalFeeHook = address(
new VeBALFeeDiscountHookExample(IVault(address(vault)), address(factoryMock), address(veBAL), trustedRouter)
);
vm.label(veBalFeeHook, "VeBAL Fee Hook");
return veBalFeeHook;
}
function testRegistryWithWrongFactory() public {
address veBalFeePool = _createPoolToRegister();
TokenConfig[] memory tokenConfig = vault.buildTokenConfig(
[address(dai), address(usdc)].toMemoryArray().asIERC20()
);
uint32 pauseWindowEndTime = IVaultAdmin(address(vault)).getPauseWindowEndTime();
uint32 bufferPeriodDuration = IVaultAdmin(address(vault)).getBufferPeriodDuration();
uint32 pauseWindowDuration = pauseWindowEndTime - bufferPeriodDuration;
address unauthorizedFactory = address(deployPoolFactoryMock(IVault(address(vault)), pauseWindowDuration));
vm.expectRevert(
abi.encodeWithSelector(
IVaultErrors.HookRegistrationFailed.selector,
poolHooksContract,
veBalFeePool,
unauthorizedFactory
)
);
_registerPoolWithHook(veBalFeePool, tokenConfig, unauthorizedFactory);
}
function testCreationWithWrongFactory() public {
address veBalFeePool = _createPoolToRegister();
TokenConfig[] memory tokenConfig = vault.buildTokenConfig(
[address(dai), address(usdc)].toMemoryArray().asIERC20()
);
vm.expectRevert(
abi.encodeWithSelector(
IVaultErrors.HookRegistrationFailed.selector,
poolHooksContract,
veBalFeePool,
address(factoryMock)
)
);
_registerPoolWithHook(veBalFeePool, tokenConfig, address(factoryMock));
}
function testSuccessfulRegistry() public {
// Register with the allowed factory.
address veBalFeePool = factoryMock.createPool("Test Pool", "TEST");
TokenConfig[] memory tokenConfig = vault.buildTokenConfig(
[address(dai), address(usdc)].toMemoryArray().asIERC20()
);
vm.expectEmit();
emit VeBALFeeDiscountHookExample.VeBALFeeDiscountHookExampleRegistered(
poolHooksContract,
address(factoryMock),
veBalFeePool
);
_registerPoolWithHook(veBalFeePool, tokenConfig, address(factoryMock));
HooksConfig memory hooksConfig = vault.getHooksConfig(veBalFeePool);
assertEq(hooksConfig.hooksContract, poolHooksContract, "Wrong poolHooksContract");
assertEq(hooksConfig.shouldCallComputeDynamicSwapFee, true, "shouldCallComputeDynamicSwapFee is false");
}
function testSwapWithoutVeBal() public {
assertEq(veBAL.balanceOf(bob), 0, "Bob has veBAL");
_doSwapAndCheckBalances(trustedRouter);
}
function testSwapWithVeBal() public {
// Mint 1 veBAL to Bob, so he's able to receive the fee discount.
veBAL.mint(bob, 1);
assertGt(veBAL.balanceOf(bob), 0, "Bob does not have veBAL");
_doSwapAndCheckBalances(trustedRouter);
}
function testQueryAndCompareWithSwapWithoutVeBal() public {
assertEq(veBAL.balanceOf(bob), 0, "Bob has veBAL");
// Since the Vault has no swap fee, the fee will stay in the pool.
uint256 swapFeePercentage = MAX_SWAP_FEE_PERCENTAGE;
vm.prank(lp);
vault.setStaticSwapFeePercentage(pool, swapFeePercentage);
uint256 exactAmountIn = poolInitAmount / 100;
// PoolMock uses linear math with a rate of 1, so amountIn == amountOut when no fees are applied.
uint256 expectedAmountOut = exactAmountIn;
// Bob does not get a discount since it does not have VeBal.
uint256 expectedHookFee = exactAmountIn.mulDown(swapFeePercentage);
// The hook fee will remain in the pool, so the expected amountOut discounts the fees.
expectedAmountOut -= expectedHookFee;
vm.prank(bob, address(0));
uint256 amountOut = router.querySwapSingleTokenExactIn(pool, dai, usdc, exactAmountIn, bytes(""));
assertEq(amountOut, expectedAmountOut, "Wrong veBal hook fee");
}
function testQueryAndCompareWithSwapWithVeBal() public {
// Mint 1 veBAL to Bob, so he's able to receive the fee discount.
veBAL.mint(bob, 1);
assertGt(veBAL.balanceOf(bob), 0, "Bob does not have veBAL");
// Since the Vault has no swap fee, the fee will stay in the pool.
uint256 swapFeePercentage = MAX_SWAP_FEE_PERCENTAGE;
vm.prank(lp);
vault.setStaticSwapFeePercentage(pool, swapFeePercentage);
uint256 exactAmountIn = poolInitAmount / 100;
// PoolMock uses linear math with a rate of 1, so amountIn == amountOut when no fees are applied.
uint256 expectedAmountOut = exactAmountIn;
// Bob has veBAL and the router is trusted, so Bob gets a 50% discount (divide by 2).
uint256 expectedHookFee = exactAmountIn.mulDown(swapFeePercentage) / 2;
// The hook fee will remain in the pool, so the expected amountOut discounts the fees.
expectedAmountOut -= expectedHookFee;
vm.prank(bob, address(0));
uint256 amountOut = router.querySwapSingleTokenExactIn(pool, dai, usdc, exactAmountIn, bytes(""));
assertEq(amountOut, expectedAmountOut, "Wrong veBal hook fee");
}
function testSwapWithVeBalAndUntrustedRouter() public {
// Mint 1 veBAL to Bob, so he's able to receive the fee discount.
veBAL.mint(bob, 1);
assertGt(veBAL.balanceOf(bob), 0, "Bob does not have veBAL");
// Create an untrusted router
address payable untrustedRouter = payable(deployRouterMock(IVault(address(vault)), weth, permit2));
vm.label(untrustedRouter, "untrusted router");
// Allows permit2 to move DAI tokens from Bob to untrustedRouter.
vm.prank(bob);
permit2.approve(address(dai), untrustedRouter, type(uint160).max, type(uint48).max);
// Even if Bob has veBAL, since he is using an untrusted router, he will get no discount.
_doSwapAndCheckBalances(untrustedRouter);
}
function _doSwapAndCheckBalances(address payable routerToUse) private {
// Since the Vault has no swap fee, the fee will stay in the pool.
uint256 swapFeePercentage = MAX_SWAP_FEE_PERCENTAGE;
vm.prank(lp);
vault.setStaticSwapFeePercentage(pool, swapFeePercentage);
uint256 exactAmountIn = poolInitAmount / 100;
// PoolMock uses linear math with a rate of 1, so amountIn == amountOut when no fees are applied.
uint256 expectedAmountOut = exactAmountIn;
// If Bob has veBAL and the Router is trusted, Bob gets a 50% discount.
bool shouldGetDiscount = routerToUse == trustedRouter && veBAL.balanceOf(bob) > 0;
uint256 expectedHookFee = exactAmountIn.mulDown(swapFeePercentage) / (shouldGetDiscount ? 2 : 1);
// The hook fee will remain in the pool, so the expected amountOut discounts the fees.
expectedAmountOut -= expectedHookFee;
BaseVaultTest.Balances memory balancesBefore = getBalances(bob);
vm.prank(bob);
RouterMock(routerToUse).swapSingleTokenExactIn(
pool,
dai,
usdc,
exactAmountIn,
expectedAmountOut,
MAX_UINT256,
false,
bytes("")
);
BaseVaultTest.Balances memory balancesAfter = getBalances(bob);
// Bob's balance of DAI is supposed to decrease, since DAI is the token in
assertEq(
balancesBefore.userTokens[daiIdx] - balancesAfter.userTokens[daiIdx],
exactAmountIn,
"Bob's DAI balance is wrong"
);
// Bob's balance of USDC is supposed to increase, since USDC is the token out
assertEq(
balancesAfter.userTokens[usdcIdx] - balancesBefore.userTokens[usdcIdx],
expectedAmountOut,
"Bob's USDC balance is wrong"
);
// Vault's balance of DAI is supposed to increase, since DAI was added by Bob
assertEq(
balancesAfter.vaultTokens[daiIdx] - balancesBefore.vaultTokens[daiIdx],
exactAmountIn,
"Vault's DAI balance is wrong"
);
// Vault's balance of USDC is supposed to decrease, since USDC was given to Bob
assertEq(
balancesBefore.vaultTokens[usdcIdx] - balancesAfter.vaultTokens[usdcIdx],
expectedAmountOut,
"Vault's USDC balance is wrong"
);
// Pool deltas should equal vault's deltas
assertEq(
balancesAfter.poolTokens[daiIdx] - balancesBefore.poolTokens[daiIdx],
exactAmountIn,
"Pool's DAI balance is wrong"
);
assertEq(
balancesBefore.poolTokens[usdcIdx] - balancesAfter.poolTokens[usdcIdx],
expectedAmountOut,
"Pool's USDC balance is wrong"
);
}
// Registry tests require a new pool, because an existing pool may be already registered
function _createPoolToRegister() private returns (address newPool) {
newPool = address(deployPoolMock(IVault(address(vault)), "VeBAL Fee Pool", "veBALFeePool"));
vm.label(newPool, "VeBAL Fee Pool");
}
function _registerPoolWithHook(address exitFeePool, TokenConfig[] memory tokenConfig, address factory) private {
PoolRoleAccounts memory roleAccounts;
LiquidityManagement memory liquidityManagement;
PoolFactoryMock(factory).registerPool(
exitFeePool,
tokenConfig,
roleAccounts,
poolHooksContract,
liquidityManagement
);
}
}