Add Inverted Quoter for AMO fork test. #2210

clement-ux · 2024-08-29T15:50:31Z

Description

Calculating the amount of tokens to swap for rebalancing is not easy and always changes in the fork test, as the pool situation changes too.
Using a quoter that performs a binary search to find the amount to swap, to push the price in the correct range in the AMO, will contribute to the stability of the fork test.

Code Change Checklist

This PR doesn't change the code, it only changes the test.

github-actions · 2024-08-29T15:51:04Z

	Warnings
⚠️	👀 This PR needs at least 2 reviewers

Generated by 🚫 dangerJS against d146df8

codecov · 2024-08-29T15:57:19Z

Codecov Report

Attention: Patch coverage is 0% with 142 lines in your changes missing coverage. Please review.

Project coverage is 54.22%. Comparing base (0d3474f) to head (d146df8).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
contracts/contracts/utils/AerodromeAMOQuoter.sol	0.00%	142 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2210      +/-   ##
==========================================
- Coverage   56.32%   54.22%   -2.10%     
==========================================
  Files          77       78       +1     
  Lines        3867     4009     +142     
  Branches      767     1047     +280     
==========================================
- Hits         2178     2174       -4     
- Misses       1686     1832     +146     
  Partials        3        3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

openzeppelin-code · 2024-08-29T16:08:40Z

Add Inverted Quoter for AMO fork test.

Generated at commit: 920099bcfd86026ed5bab79d06a0a48a98a4e220

🚨 Report Summary

	Severity Level	Results
Contracts	Critical High Medium Low Note Total	3 3 0 18 43 67
Dependencies	Critical High Medium Low Note Total	0 0 0 0 0 0

For more details view the full report in OpenZeppelin Code Inspector

sparrowDom · 2024-08-30T10:59:25Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js

+      const currentPrice = await aerodromeAmoStrategy.getPoolX96Price();
+      const priceTick0 = await aerodromeAmoStrategy.sqrtRatioX96TickLower();
+      const priceTick1 = await aerodromeAmoStrategy.sqrtRatioX96TickHigher();
+      const targetPrice = priceTick0 * 0.2 + priceTick1 * 0.8;


nit: these lines of code repeat a couple of times. You could make a helper function that only returns the amount to swap and direction?

Also could the AMO quoter get reference to the pool and figure out the current price and the direction of the swap by itself?

sparrowDom · 2024-08-30T11:26:14Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

+contract AerodromeAMOQuoter {
+    QuoterHelper public quoterHelper;
+
+    constructor() {


constructor should probably also contain the amoStrategy as a parameter and clPool (underlying aerodrome slipstream pool)

sparrowDom · 2024-08-30T12:26:04Z

I left a couple of comments, but generally I would adjust the api between the fork tests and the quoter a little. The code that is issuing the call from the fork test doesn't really need to pass any variables to the quoter. The Quoter should be constructed using the pool & strategy contract and be able to figure out the direction and the amounts to swap on its own.

Separately from that some of the fork tests also also try to move the price in the pool close to left tick boundary or right tick boundary. Do you think you could also write a helper functions so we don't have those swap values hardcoded and needing to adjust them frequently?

sparrowDom · 2024-08-30T12:29:23Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js

+    const value = transferEvent.args.value;
+    await oethbVault
+      .connect(await impersonateAndFund(addresses.base.governor))
+      .setStrategistAddr(addresses.base.strategist);


I think it would be better to read the active strategist address from the vault await oethbVault.strategistAddr() before changing it. And whatever the first function returns set it here. Just so that you return things to their initial state whatever that is.

contracts/contracts/utils/AerodromeAMOQuoter.sol

clement-ux · 2024-08-30T13:40:04Z

I left a couple of comments, but generally I would adjust the api between the fork tests and the quoter a little. The code that is issuing the call from the fork test doesn't really need to pass any variables to the quoter. The Quoter should be constructed using the pool & strategy contract and be able to figure out the direction and the amounts to swap on its own.

Ok got it, no problem it makes sense.

Separately from that some of the fork tests also also try to move the price in the pool close to left tick boundary or right tick boundary. Do you think you could also write a helper functions so we don't have those swap values hardcoded and needing to adjust them frequently?

I had already built a quoter that gave the quantity to be exchanged to reach a certain price, I can integrate it without any problem, sure ;)

…ion.

clement-ux · 2024-08-31T22:14:09Z

Separately from that some of the fork tests also also try to move the price in the pool close to left tick boundary or right tick boundary. Do you think you could also write a helper functions so we don't have those swap values hardcoded and needing to adjust them frequently?

I've updated some tests with the quoter that returns the amount to swap to reach a certain price. Let me know if you want me to apply it to other tests that I might have missed. 😉

sparrowDom

Did a pass please take a look

contracts/contracts/utils/AerodromeAMOQuoter.sol

sparrowDom · 2024-09-04T10:27:48Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

+        uint160 sqrtPriceCurrentX96,
+        uint160 sqrtPriceTargetX96
+    ) public pure returns (bool) {
+        uint256 allowedVariance = (sqrtPriceTargetX96 *


I am not sure this is the correct method to calculate variance. Can you share your thoughts on how you got to this? Here I am comparing the way I approached variance and the result this function returns. The results differ in 3 orders of magnitude:

Tick -1 x96: 79224201403219477170569942574 Tick 0 x96: 79228162514264337593543950336 Diff X96: [tick -1 x96] - [tick 0 x96] Diff X96: 3961111044860422974007762 variance 1% : Diff / 100 variance method 1: 39611110448604229740078 // solidity shell uint256 PERCENTAGE_BASE = 1e27; uint256 ALLOWED_VARIANCE_PERCENTAGE = 1e18; uint160 sqrtPriceTargetX96 = 79224201403219477170569942574; uint256 allowedVariance = (sqrtPriceTargetX96 * ALLOWED_VARIANCE_PERCENTAGE) / PERCENTAGE_BASE; variance method 2: 79224201403219477170 variance method 1: 39611110448604229740078 variance method 2: 79224201403219477170

I'm not sure I really understand your point as I don't think we are comparing the same thing at the end.

On my side I'm calculating the "variance" around the target price, while you calculate the "variance" as the difference between two ticks. That's why there is a that huge difference I will say.

I see, I guess I am interested in the logic behind how the variance is calculated. In other words why the approach to calculate variance from the total x96 format number.

For example my logic behind why to specify variance in a way where the difference between to ticks represented 100% of the variance is:

we deposit our whole liquidity in the [-1,0] ticker

when we calculate the WETH to OETHb share of the liquidity the 1 tick spacing (the width of the ticker) represents 100% of the liquidity range

meaning that 5% in the price variance calculation will also represent 5% of the WETH liquidity share in the ticker range.

Ok I see, no problem, I've updated it. Let me know if you prefer it like this.

contracts/contracts/utils/AerodromeAMOQuoter.sol

sparrowDom · 2024-09-04T13:28:15Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

+    /// --- FUNCTIONS
+    ////////////////////////////////////////////////////////////////
+    /// @notice This call can only end with a revert.
+    function getAmountToSwapBeforeRebalance() public {


This is cool, would be really useful to also have a function getAmountToSwapBeforeRebalance(uint256 overrideBottomWethShare, uint256 overrideTopWethShare). And the function should just issue a temporary change to the allowed WETH share interval.

The reason it is useful to have this function is to be able to test for failure in our fork tests when say, the rebalance ends up in having 10% above or below the desired WETH share amounts. Currently we hardcode those amounts in tests and I am afraid we will need to adjusts the tests constantly when other LP providers enter the pool

Indeed that's a great idea! I'm doing it 😉

Done, let me know what you think of it.

…other.

sparrowDom · 2024-09-11T12:24:30Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

+    /// @param overrideTopWethShare New value for the allowedWethShareEnd on AMO.
+    ///         Use type(uint256).max to keep same value.
+    /// @return data Data struct with the amount and the number of iterations
+    function quoteAmountToSwapBeforeRebalance(


awesome stuff!

sparrowDom · 2024-09-11T12:27:37Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js

@@ -46,6 +48,12 @@ describe("ForkTest: Aerodrome AMO Strategy empty pool setup (Base)", function ()
    await oethb
      .connect(rafael)
      .approve(aeroSwapRouter.address, oethUnits("1000"));
+
+    await deployWithConfirmation("AerodromeAMOQuoter", [


this will fit better in here:

origin-dollar/contracts/test/_fixture-base.js

Line 4 in f0d0ace

const { isFork, isBaseFork, oethUnits } = require("./helpers");

sparrowDom · 2024-09-11T12:29:56Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

+import { IQuoterV2 } from "../interfaces/aerodrome/IQuoterV2.sol";
+import { IAMOStrategy } from "../interfaces/aerodrome/IAMOStrategy.sol";
+
+contract QuoterHelper {


can you add a small comment here why the QuoterHelper is required. It might not be immediately obvious to others that try/catch in solidity requires a separate contract in order to function

sparrowDom · 2024-09-11T14:14:07Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

        if (sqrtPriceCurrentX96 > sqrtPriceTargetX96) {
-            return sqrtPriceCurrentX96 - sqrtPriceTargetX96 <= allowedVariance;
+            return (sqrtPriceCurrentX96 - sqrtPriceTargetX96) * PERCENTAGE_BASE  <= ALLOWED_VARIANCE_PERCENTAGE * range;


cool that makes sense.
nit: Maybe a slightly more "natural" way to express it would be:

return (sqrtPriceCurrentX96 - sqrtPriceTargetX96) <= range * ALLOWED_VARIANCE_PERCENTAGE / PERCENTAGE_BASE;

Yes I agree, I was to avoid rounding issue. But I've no problem to change it.

sparrowDom · 2024-09-11T14:25:42Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js

-          true, // _swapWETH
-          oethUnits("0.0009")
-        )
+        rebalance(value.mul("200").div("100"), direction, 0)


we can change this by fetching the swap amount by setting the price of the say tick 1 and tick -2 from the quoter

I'm sorry, I didn't get what do you mean. You could explain it another way please?

Sorry, for a bad initial comment :)

So what this test is doing is trying to trigger an error where too much funds would be swapped and the result would be a price out of tick. The way it is currently done is getting amount to swap to reach an ok target balance and multiplying the value by 2. While that might work right now I am afraid it doesn't make the test super robust, since there are probably base mainnet values where where this test won't trigger a fail.

Now ignore my initial comment.

I think the goal should be to get values in the test that will be always out of bounds no matter what the state of the mainnet base is.
You could probably achieve that by calling: quoteAmountToSwapBeforeRebalance(0.98e18, 1e18) and then multiplying that value by 2. Of if you can think of a more robust method yourself might be even better?

Ideally we would set a price out of bounds. Say they price of the pool at ticker 1 (which is out of bounds) and get the value we need to swap for to reach that ticker when rebalancing.

Thanks!
I've applied some changes, let me know what do you think of it 😉

You could probably achieve that by calling: quoteAmountToSwapBeforeRebalance(0.98e18, 1e18) and then multiplying that value by 2.

I didn't multiplied it by 2, I just used the value obtained, otherwise I'll have push the price outside of bounds.
I used 0.90/0.92 for share instead of 0.98/1 due to this.

origin-dollar/contracts/contracts/strategies/aerodrome/AerodromeAMOStrategy.sol

Line 295 in 944bb28

require(_allowedWethShareEnd < 0.95 ether, "Invalid interval end");

Those changes look cool thanks, good thinking on how to bring the swap liquidity to the edge of the tick and not go over.

My previous comment would actually apply better for testing this test Should be reverted trying to rebalance and we are not in the correct tick that is failing on fork tests. Which should trigger when the rebalance crosses the tick boundary.
Would you mind adding the tick boundary tests for both directions please (crossing -1 tick going into -2 one. And crossing 0 tick going into tick 1). There are also a couple of other tests that are failing.
But I think the approach is solid now 💪

I've fixed the failing test (due to the new timelock mostly).

I've preferred to push the price at tick -2 and then try to rebalance without swapping to force reverting on OutsideExpectedTickRange instead of PoolRebalanceOutOfBounds that will occur if I were modifying WethShareStart/End.

So there are now two tests:

when the pool is at tick -2 and we try to rebalance with swappingAmount == 0.

when the pool is at tick 1 and we try to rebalance with swappingAmount == 0.

Let me know if this is ok for you, or if you prefer another approach 😉

nice that is also a cool approach without needing to drastically change the functionality

sparrowDom · 2024-09-11T14:27:31Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js

@@ -723,7 +785,11 @@ describe("ForkTest: Aerodrome AMO Strategy (Base)", function () {
      });

      await expect(
-        rebalance(oethUnits("4.99"), true, oethUnits("4"))
+        rebalance(
+          (await weth.balanceOf(await aerodromeAmoStrategy.clPool())).mul("2"),


sparrowDom · 2024-09-11T14:43:36Z

@clement-ux did another pass

sparrowDom · 2024-09-16T09:37:51Z

contracts/contracts/utils/AerodromeAMOQuoter.sol

+    function _quoteAmountToSwapBeforeRebalance(
+        uint256 overrideBottomWethShare,
+        uint256 overrideTopWethShare
+    ) public returns (Data memory data) {


nit: was this supposed to be internal?

Indeed, fixed!

sparrowDom · 2024-09-17T09:26:32Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js

      expect(await weth.balanceOf(aerodromeAmoStrategy.address)).to.lte(
-        BigNumber.from("1000")
+        BigNumber.from("1000000")


@clement-ux can you add comments to these tests specifying the math/logic around why these are so high?

sparrowDom · 2024-09-17T09:29:29Z

contracts/test/strategies/aerodrome-amo.base.fork-test.js


    await expect(
      aerodromeAmoStrategy
        .connect(strategist)
-        .rebalance(oethUnits("0"), false, oethUnits("0"))
+        .rebalance(oethUnits("0"), direction, oethUnits("0"))
+    ).to.be.revertedWith("OutsideExpectedTickRange");


nit: you can also check for the tick value here now that the error contains it

sparrowDom · 2024-09-17T09:30:21Z

Couple of minor comments and a merge conflict. Then I am happy to do a final pass. Good job on this one

…for-AMO-fork-tests

* remove unneeded var * fix unit tests * fix some slither stuff * fix fork test * fix bug when swap amount too small. fix bug when no liquidity in AMO pool to reach tick * remove not needed quoter functions. Correct the tests * remove * return * prettier * add ability to chai to parse custom errors * de-nest test file * correct min values

…for-AMO-fork-tests

clement-ux added 3 commits August 29, 2024 17:44

feat: add inverted quoter for rebalancing.

d29dc6f

test: use quoter for AMO rebalancing.

4e9d161

chore: increase gas limit for test for AMO quoter.

8810a77

sparrowDom reviewed Aug 30, 2024

View reviewed changes

contracts/contracts/utils/AerodromeAMOQuoter.sol Show resolved Hide resolved

clement-ux added 4 commits August 30, 2024 18:10

fix: remove arguments from quoter call.

5e7df11

fix: set strategist back to origin strategist for quoter.

9b91a6a

feat: add AMO quoter for amountToSwapToReachPrice.

585b40a

feat: add quoter for moving price in AMO tests and upgrade swap funct…

4390da3

…ion.

sparrowDom reviewed Sep 4, 2024

View reviewed changes

clement-ux added 5 commits September 4, 2024 16:31

docs: add descriptions to functions.

aea2198

feat: add overrideWethShare on quoteAmountToSwapBeforeRebalance.

bf51ef9

fix: use dictionnary syntax to call function that has same name as an…

c502ed6

…other.

fix: increase max iteration for quoter.

7383e79

fix: failling test.

ffa2d8e

sparrowDom reviewed Sep 11, 2024

View reviewed changes

clement-ux added 3 commits September 11, 2024 15:09

fix: move AMOQuoter to fixture.

280f6b4

feat: add more comments.

8abb412

fix: rethink variance calculation for AMO Quoter.

3e076b9

sparrowDom reviewed Sep 11, 2024

View reviewed changes

clement-ux added 4 commits September 11, 2024 17:17

fix: give more WETH at start and simplifies swap.

a4d585b

fix: remove unused import.

ef2bf26

fix: _minTokenReceived is 99% of amountToSwap.

2d663be

fix: refactor % comparison.

80d115b

sparrowDom reviewed Sep 16, 2024

View reviewed changes

clement-ux added 6 commits September 16, 2024 11:54

fix: change public into internal.

6b72dc9

fix: adjust quoteAmountToSwapBeforeRebalance for custom shares.

944bb28

fix: split boundaries for quoter.

26035cc

fix: fetch governor before impersonning.

ea44472

fix: increase tolereance eth remaining in AMO after withdraw.

d6d386a

fix: fix failing test and add description.

aa3bb5b

sparrowDom reviewed Sep 17, 2024

View reviewed changes

clement-ux and others added 3 commits September 17, 2024 11:46

fix: add doc for edge case in withdraw.

29c18b5

Merge branch 'master' into clement/add-quoter-for-AMO-fork-tests

f1c84b0

fix: adjust test with latest values.

10e1ba8

sparrowDom marked this pull request as ready for review September 24, 2024 09:40

sparrowDom requested review from DanielVF, naddison36 and shahthepro as code owners September 24, 2024 09:40

sparrowDom force-pushed the clement/add-quoter-for-AMO-fork-tests branch from 3c85d1a to 10e1ba8 Compare September 24, 2024 23:36

sparrowDom added 3 commits September 25, 2024 01:37

Merge remote-tracking branch 'origin/master' into clement/add-quoter-…

920099b

…for-AMO-fork-tests

Merge remote-tracking branch 'origin/master' into clement/add-quoter-…

d146df8

…for-AMO-fork-tests

sparrowDom merged commit 210a0c2 into master Sep 30, 2024
12 of 18 checks passed

sparrowDom deleted the clement/add-quoter-for-AMO-fork-tests branch September 30, 2024 08:37

Add Inverted Quoter for AMO fork test. #2210

Add Inverted Quoter for AMO fork test. #2210

Conversation

clement-ux commented Aug 29, 2024

Description

Code Change Checklist

github-actions bot commented Aug 29, 2024 • edited Loading

codecov bot commented Aug 29, 2024 • edited Loading

Codecov Report

openzeppelin-code bot commented Aug 29, 2024 • edited Loading

Add Inverted Quoter for AMO fork test.

🚨 Report Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sparrowDom commented Aug 30, 2024

Choose a reason for hiding this comment

clement-ux commented Aug 30, 2024

clement-ux commented Aug 31, 2024 • edited Loading

sparrowDom left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clement-ux Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clement-ux Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sparrowDom commented Sep 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sparrowDom commented Sep 17, 2024

github-actions bot commented Aug 29, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

openzeppelin-code bot commented Aug 29, 2024 •

edited

Loading

clement-ux commented Aug 31, 2024 •

edited

Loading

clement-ux Sep 4, 2024 •

edited

Loading

clement-ux Sep 16, 2024 •

edited

Loading