Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development & testing of curve adaptor integration with newer curve pools #190

Closed

Conversation

0xEinCodes
Copy link
Contributor

Core changes:

Development and testing of curve adaptor so it is compatible with newer curve pools

  1. Specific Pools Strategists are interested in:

The key implementation difference is to accommodate the new function signature for add_liquidity, and remove_liquidity, where it requires a change to the CurveHelper.sol file such that it can handle encoding uint256[] dynamically sized arrays vs now where it can only handle fixed size arrays.

Tests were written to ensure that the new curve pool integration does not break anything else, and that it works as designed.

  • Handling dynamic array params requirements with new pool versions
  • Handling incorrect array enum param (Ex. fixed when it should be dynamic)

Discussion Topics

  1. What type of testing is required for this extra implementation adjustment?
  2. What “custom” aspects apply to the pools of interest? Some may include: reentrancy, etc.
    1. weeth/weth:
    2. ezETH/weth:
    3. eeth/eth:
    4. weeth/rsweth:

@0xEinCodes 0xEinCodes self-assigned this Mar 16, 2024
Copy link
Contributor

coderabbitai bot commented Mar 16, 2024

Important

Auto Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@0xEinCodes
Copy link
Contributor Author

TODO:

  • Continue troubleshooting new test file
    • Happy path tests
    • Reversion tests with wrong enum for pool
    • Log what tests fail without the reverts from the curveAdaptor
  • Let Crispy know that the happy path and basic reversion tests are done
  • Carry out any other tests that are needed
  • Finalize by documenting further notes about the curve adaptor for future folks

@0xEinCodes
Copy link
Contributor Author

0xEinCodes commented Mar 16, 2024

Assessment of Other Tests to Apply for these Curve Adaptor Adjustments (based on original tests):

  1. _curveLPAsAccountingAsset() tests are worthwhile because it is making sure things behave properly for having the new pool LPTs as holding positions.
  2. withdrawLogic() - tests base functionality of withdraw and accounting aspects for curveAdaptor with the different types of pools. I guess what we could do is add a new curve pool type into it and run similar tests.
  3. testWithdrawWithReentrancy() - uses helper _checkForReentrancyOnWithdraw() --> worth checking with new pools too. Essentially the tests check pools to see if they revert or not by Curve's design when folks try to re-enter when removing liquidity with ETH pools. --> Is it worth doing for non ETH pools?
  4. testSlippageRevertsNoETH - also worth checking. It compares against a constructor specified slippage amount for the curvePools
  5. testSlippageRevertsWithETH - "
  6. _verifyReentrancyProtectionWorks() - checks that slots being specified as 2 will properly prevent reentrancy, they should lock.

Reverts

  1. testInteractingWithPositionThatIsNotUsed() - already tested so I think it's not needed for these extra tests.
  2. testMismatchedArrayLengths() - "
  3. testUsingNormalFunctionsToInteractWithETHCurvePool() - need a bit of an explainer on this one.
  4. testCellarMakingCallsToProxyFunctions() - I think we should test this simply with a new pool
  5. testAddingCurvePositionsWithWeirdDecimals() - already tested so I think it's not needed for these extra tests.
  6. testRepeatingNativeEthTwiceInInputArray() - "
  7. testHelperReentrancyLock() - Worth testing with new pools maybe?
  8. testCellarWithoutOracleTryingToUseCurvePosition() - revisit with Crispy
  9. testNoSpecifiedEnum() - gotta do it
  10. testMaliciousStrategistUsingWrongCoinsArray() - review w/ crispy

@0xEinCodes
Copy link
Contributor Author

0xEinCodes commented Mar 25, 2024

This PR is put on the backburner for now as other priorities are being handled. Notes on where things were left off:

@0xEinCodes 0xEinCodes closed this Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant