Test case optimization #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
TechnoGeek01
commented
Feb 5, 2024
•
TechnoGeek01
commented
- Use fuzz pattern/for loops pattern, for lockup and nonLockup farms.
- Code reuse using helper functions.
- Remove redundant code.
- Naming convention.
Changes to gas cost
🧾 Summary (10% most significant diffs)
Full diff report 👇
|
parv3213
reviewed
Feb 6, 2024
bayou020
reviewed
Feb 6, 2024
parv3213
reviewed
Feb 9, 2024
arcantheon
reviewed
Feb 12, 2024
arcantheon
reviewed
Feb 12, 2024
arcantheon
reviewed
Feb 12, 2024
arcantheon
reviewed
Feb 12, 2024
arcantheon
reviewed
Feb 12, 2024
arcantheon
reviewed
Feb 12, 2024
arcantheon
reviewed
Feb 12, 2024
parv3213
force-pushed
the
test/optimization
branch
from
5e05acd to
2d21b12
Compare
arcantheon
approved these changes
Feb 13, 2024
arcantheon
reviewed
Feb 15, 2024
parv3213
approved these changes
Feb 16, 2024
YashP16
added a commit
that referenced
this pull request
Jul 12, 2024
* moved uniswap and balancer under e20 farms * Added FARM_ID * Initiated BaseFarm Test * small update * Improvements * Improvements * fix: Deployment artifacts file naming convention * fix: Deployment artifacts file naming convention * Make BaseFarm abstract * used custom errors instead of require statements * Add CI and husky. Other setup like USDsV2. * Upper case constant variables * Use forge fmt to format files - Although skipping pre-commit for this commit, as formatted files may cause conflicts later * Update solhint and fix solhint warnings * Update CI * optimized greater than zero checks for unsigned integers * used unchecked in places where underflows are not possible. The if statements enclosing the calculations make sure they don't underflow * Fix valid token check * Remove `farmStartTime` * Make `claimRewards(uint256 _depositId)` call `claimRewards(address _account, uint256 _depositId)` internally * Add `_farmNotClosed` to `updateFarmStartTime` and `closeFarm` * removed oldRewardRate from RewardRateUpdated event as it can be calculated from subgraph * cached array length to save gas * Lint fix * Remove `getRewardTokens` * Make `factory` immutable * RewardAdded event in BaseFarm might require account which added the rewards. Added it as comments. Need to review * Added depositId and removed tokenid,expirydate from CooldownInitiated event as they can be processed * added depositId and removed tokenId,starttime in PoolUnsubscribed event as they can be processed * optimized RewardsClaimed event to make it emit only once instead of twice in the _claimRewards function * fixed rewardsForEachSubs nested array as mentioned in previous commit's comment. Also removed fundIds array from the RewardsClaimed event as fundId values are 0 and 1 * format of if statement condition is updated in updateFarmStartTime function for consistency. No change in functionality. Co-authored-by: Parv Garg <parv3213@gmail.com> * caching msg.sender will cost more gas than directly using it * caching msg.sender will cost more gas than directly using it * Added farm token check in recover erc20 * started testing * created farms * Added two directories in gitignore * Added contributing.md * Added engineering dev room * Updated README.md * Added farm factory registration requirement * added more test cases * added coverage-minimum command * Added farm id in e20 farm * Updated discounted fees * removed initialization of loop vars * Update contracts/e20-farms/BaseE20Farm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * perf(deposit fn): code optimisation * replaced memory var account with msg.sender * Updated userDeposit from memory to storage * Update variables storage spaces to save gas * Added more test cases * Added deposit tests * (test:Balancer E20 Farms) Coverage 80% * integrated sushiswap V3 into demeter * added more BaseFarm tests * Fix failing build due to merge * change filename to avoid conflicts with windows * Added Withdraw test cases * removed a unnecessary comment in the RewardAdded emit * used custom errors instead of require statements * removed duplicate custom error * reused files from uniswapV3 * fixed arguments in Demeter_SushiV3FarmDeployer's constructor * formatted Demeter_SushiV3FarmDeployer.sol to make it consistent with other files * naming convention fix. CoolDown changed to Cooldown * in RewardRateUpdated event marked rwdToken as indexed * in CooldownInitiated event included indexed tokenid and expiry instead of depositid as tokenid is unique * Added chore * Update .gitignore Co-authored-by: Parv Garg <parv3213@gmail.com> * Resolved @parv3213 Comments * PR Fixes * Fix package.json * Format contracts * Add husky to dev dependencies * fix(Demeter Base Farm): Updated Test Cases Updated Test Cases According to the new Contract Architecture, BREAKING CHANGE: * fix: removed Console from imports * fix: Removed Console import from BaseFarm test file * Fix file paths * Format code * Fix CI * Fix gitignore * forge install: forge-std v1.7.1 * Simplify `foundry.toml` * Fix file import * test(Balancer Test Cases): Added Missing test cases Added Claim Rewards and some view Functions test cases * modularized sushi v3 and uni v3 codes * fix: Resolve review comments * sushiswapv3 FARM_ID name fix Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * uniswapv3 FARM_ID name fix Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * NPFM() return type fix Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Revert "NPFM() return type fix" This reverts commit c2cb9a9. * fix(BaseFarm Test Files): Fixed Repeated GetPoolAddress Method on Test Files * Fix forge lib and removing unnecessary file * Fix solhint errors * forge install: forge-std v1.7.1 * Fix lint error * Add solhint checks to CI * Remove prettier dependencies * Update PR-CI and and * Format code from `prettier` script * Format code using `prettier` script * Turn `contract-name-camelcase` off in solhint * Fix solhint warnings * Remove comment * refactor(contracts): Make initiateCooldown and withdraw() accessible from BaseFarm * test(utils): Add network configuration for tests * test: Restructure test cases to make them modular * test: Remove old test cases * Fix import path in BaseE20Farm.t.sol * test: Add setup modifier for tests * feat(BaseFarm): Added a Non Zero Amount Check Added a non Zero amount check in Add Rewards function * test(BalancerFarm): Fixed not working test cases * Solhint Functions ordering fixes * fix(Commit Conflicts): Fixed Commit Conflicts on test Cases * Multiple fixes - Uniswap pool initialization order in BaseUniV3Farm - Make `NFPM` and `UNIV3_FACTORY` public view - Add required interfaces for UniswapV3 - Rename `Demeter_UniV3FarmDeployer` to `Demeter_SushiV3FarmDeployer` * Add UniV3 Farm tests * feat(Fuzzing tests): added fuzzing amounts tests * Rename by adding `.t.sol` to tests * feat(Balancer Farm): Added Test Cases Imports * feat(Base Farm): Added Missing test cases * feat(BaseE20Farm): Added Reverting Test Cases * Updated BaseFarmDeployer * Updated other deployers * Updated farm factory * Updated param in function getFees * feat(BaseSetup): Fixed Owner= User Bug, Added More Actors , Added Factory Variable * fix(BaseFarm): Owner actor shouldn't be user * fix(FarmFactory): Added test cases for Farm Factory * fix(BaseE20Farm): Fixed test cases when User Prank is not owner * fix(BaseFarm): Minor Prank Fix * Check for `_isNonZeroAmt` before `_farmNotClosed` * Fix/improve tests * fix(FarmFactory test cases): Solved Mehul's comments * Updated Readme * Add Multicall functionality to BaseFarm contract with tests * fix(BaseFarm.t.sol ): Fix Parv's comments - Fixed RevertsWhen Naming convetion - Fixed ExpectEmit Failed assertions - Added Maths tests * fix(BaseE20Farm.t.sol ): Added Maths tests Added Maths tests for increase Deposit and withdraw Partially functions * fix(BalancerFarn.t.sol ): Fixed Parv's Comment - Added a check on Farm ID - Added Deposit Maths check * fix(BaseFarm.t.sol ): Typo fix test_deposit_noLockupFarm_revertsWhen_NoLiquidityInPosition fix * fix(BaseFarm.t.sol BaseFarm.t.sol): Fixes Parv's Comments * fix(BaseFarm.sol): Removed 0 amount Function check * Fix solhint errors in tests * Fix tests failing after merge * getFeeParams external call updates * Fixed test cases * feat(BaseFarm.t.sol): Fixed ERC20Recover Coverage, Added two edge cases - Fixed erc20Recover coverage - Added two claim rewards edge cases * feat(BaseE20Farm.t.sol): Added ERC20Recover Specific Logic * feat(BalancerFarm.t.sol): Fixed ERC20Recover Specific Import * feat(SushiV3Farm.t.sol): added ERC20Recover Import * Merge remote-tracking branch 'origin/dev' into test/demeter-uniV3Farm * Resolve solhint errors * Rearrange _SetupFarmTest in BalancerFarm.t.sol * Fix stack-too-deep error by adding NonfungiblePositionManagerUtils - Sperax/Utility#2 * Add more MultiCall tests * Add tests supporting BaseFarm coverage * feat(BaseFarm): Remove Redundant check - Remove Redundant check on _subscribeRewardFund & _unsubscribeRewardFund * Refactor: Remove `uniswapUtils` & `nfpmUtils` from `UniswapPoolData`. * Remove coverage-minimum script from package.json * test(BaseFarm): Added Assertions Added Claim Rewards Balances Assertions * updated vault address in Arbitrum.t.sol (#30) * Unique deposit ID and event data optimisation (#27) * Code changes for unique depositId * Updated test cases * Added indexed parameter depositId * Added a view function to get deposits of a user * Removed getMyDeposit and deposit updates * event data optimizations * Code doc improvements * Test cases compilation error fixes * subscription to depend on deposit id * Added deposits assignment before sub reward fund * fix(deposit): storage write instead of memory * Updated test cases * fixed events in test files * fix(event data): totalRewardsClaimed to refer from storage instead of memory * Removed logs * Added revert in getDeposit function * updated test cases as per latest change in code * fixed test cases * Added PoolSubscribed event * added miscellaneous test cases to check if one user's withdrawal of deposit affects other user's deposit * added test cases in initiatecooldowntest to make sure someone else other than the depositor cannot initiate cooldown * added missing emit event tests * added missing event test in test_initiateCooldown_LockupFarm test case. * added test cases to make sure one user's withdraw doesn't affect other users' subscriptions and deposits * fixed a test case * Gas optimisations * Fixed review comments * updated variable name * Removed tokenId and simplified further * Fixed test cases * renamed mapping and updated _deposit function * updated variable names instead of integer literals * renamed test function names * fixed a redundancy in test case * optimized event testing * fixed a event testing * Updated updateTokenManager function and event name * gas optimisations and code improvements * Gas optimisation and function name change * renamed updateRewardData function name * Added mistakenly removed test case back --------- Co-authored-by: mehultuteja <reachmehultuteja@gmail.com> Co-authored-by: TechnoGeek01 <rsudharsangames@gmail.com> Co-authored-by: YashP16 <yash.pitroda786@gmail.com> * ci(github): Update CI to report gas difference (#34) Using Rubilmax/foundry-gas-diff * Revert "ci(github): Update CI to report gas difference (#34)" (#35) This reverts commit 778bdc8. * Feature to increase/ decrease liquidity from Camelot position while being staked in Demeter. (#26) * Added increase and decrease liquidity func * Fixed deployment and base errors * Fixed errors * Fixed all the pending test cases * Added onNFTAddToPosition * Added a view function for getting amounts * Added onNFTWithdraw function * test(BaseFarm): Added DepositIncreased/Decreased Events * fix(CamelotFarm): Small Bug Fix * test(CamelotFarm): Added test cases Increase/ Decrease Deposit test cases * Updated test case to fix failure * test(CamelotFarm): Added test cases Increase/ Decrease Deposit test cases * Merge branch 'dev' into feat/camelot-farm-liq * test(CamelotFarm): Added test cases Increase/ Decrease Deposit test cases * test(CamelotFarm): Added Test Cases - Coverage is 98% - Checked Maths on increase / Decrease Deposit * Added Camelot Addresses * fix(CamelotFarm.t.sol): Fixed Assets Naming - Fixed Assets Naming - Removed Constants from the test file * Fix RecoverERC20E20FarmTest * Updated Camelot interface file name * Update contracts/camelot/Demeter_CamelotFarm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Added update call and removed comments * Removed redundant calls * fix(Fix commented Tests): Fixed commented tests * Updated test cases * Refactor removeLiquidity function to use named parameters * Moved subscriptions updater in abstract contract * Updated tests for OperableDeposit changes * updated docs for OperableDeposit changes * fix(Test Cases): Fix function names to use proper capitalization * perf(test): approval and naming conventions * perf(Farms): approval function call and naming convention * Fix function names to use proper capitalization * Refactor deposit tests in Demeter_CamelotFarmTest * refactor(CamelotFarm Testing): refractored test cases * Add GetDepositTest and MulticallTest to DemeterCamelotFarmInheritTest * Remove unused test cases in BaseE20Farm.t.sol --------- Co-authored-by: mehultuteja <reachmehultuteja@gmail.com> Co-authored-by: Dayaa <m.d.e.boutalbi@me.com> Co-authored-by: Parv3213 <parv3213@gmail.com> * ci(github): Update CI to report gas difference (#36) Using Rubilmax/foundry-gas-diff * feat/basefarm-upgrades (#25) * added farm expiry and extension feature with extension fees * standardization * reordered functions as per solhint standards and errors * fixed a bug in extendFarmEndTime function * fixed a bug in extendFarmEndTime function * updated function name for collecting extension fee * optimization * added some test cases * updated test case * added farm extension test cases * added ExtensionFeeCollected event test case * optimized updateFarmStartTime function * optimized FarmEndTimeUpdated emit * changed visibility of _collectExtensionFee in BaseFarm as private * added constant for initial farm extension * removed getFees function in BaseFarmDeployer as it's redundant * removed FarmEndTimeUpdated emit in updateFarmStartTime function as it can be processed until farm starts * added nonReentrant modifier to extendFarmEndTime function * optimization * fixed test cases * function reordering to fix solhint errors * added some missing assertions in FarmFactory.t.sol test cases * removed unnecessary logs and comments * event optimization * updateFarmStartTime function optimization * destructured farmInstance.iniitialize parameters * extendFarmEndTime function gas optimization * renamed the function extendFarmEndTime to extendFarmDuration * removed creator field in ExtensionFeeCollected event * fixed a bug * renamed the function _farmNotClosedOrExpired to _farmNotClosedOrNotExpired * added more test cases * added some missing closeFarm test cases. * updated missing natspec * renamed the function _farmNotClosedOrNotExpired to _isFarmActive * removed unnecessary fuzzing * updated usds vault address to the latest one * added internal function for farm expiry validation * added test cases for some edge cases * decoupled farm expiry feature in a separate abstract contract * fixed solhint warnings * decoupled farm expiry status function * comment cleanup * decoupled farmFactory state variable * fixed some solhint errors * fixed solhint warnings * moved FarmNotYetStarted from BaseFarm to BaseFarmExpiry * improved test cases * made fee variables configurable in FarmFactory.t.sol * fixed test_claimRewards_max_rewards test case * renamed contract BaseFarmExpiry to BaseFarmWithExpiry * removed logs * added internal function _updateFarmStartTime * update * added missing test inheritances * natspec update * abstracted farm expiry test cases * added constants instead of hardcoded values * update * Natspec update Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * Natspec update Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * added zero checks in updateFeeParams function of FarmFactory.sol * updated natspec * Revert "added zero checks in updateFeeParams function of FarmFactory.sol" This reverts commit 9c080d3. * added some missing test cases * fixed fuzz runs in foundry.toml * expiry test cases restructure * updated natspec * updated natspec * updated natspec * test case optimization and redundancy removal * improved test cases --------- Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * Draft changes for chain agnostic contracts (#32) * Draft changes for chain agnostic contracts * fix(contracts): Fix problems * fix: Bug fixes * fix: Optimisation fixes * fix(tests): fix failing tests * fixed BaseE20Farm.t.sol test cases * test fix * fixed Demeter_CamelotFarm.t.sol test cases --------- Co-authored-by: TechnoGeek01 <rsudharsangames@gmail.com> * Storage, DataTypes separation and OperableDeposit simplification (#38) * Storage, DataTypes separation and OperableDeposit simplification * updated test cases to support separated DataTypes * Usage of storage variables for gas optimization * Using named imports instead of default * abstracted contract BaseFarmStorage * Moved OperableDeposit under features * Removed constant parameters * Restructured computeRewards function's return data in BaseFarm.sol (#39) * restructured computeRewards return data * updated natspec * function naming convention fix and restructuring (#40) * function naming convention changes * restructured functions * updated natspec * bug fix * functions rename * function restructuring * unused variable cleanup in test file * function restructuring * Demeter UniswapV3 Farm upgrades (#21) * Add liquidity management functions to UniswapV3 interface * Remove DepositInCooldown error and reuse DepositIsInCooldown * Add increaseDeposit and withdrawPartially functions for UniV3 Farm * Add ActiveLiquidityBaseV3Farm - Farm that distributes rewards only for active liquidity - Withdraw from locked position is allowed when liquidity is not active * Fix tests after merge * Rename `ActiveLiquidityBaseUniV3Farm` to `BaseUniV3ActiveLiquidityFarm` * refactor(BaseUniV3Farm): Use NFPM utils to resolve stack-too-deep error * test(BaseUniV3): add tests for increase/decrease liquidity * test: bugfix and tests for BaseUniV3ActiveLiquidityFarm * refactor: modularize BaseFarm and reduce duplicate code in BaseUniV3ActiveLiquidityFarm * refactor and natspec fix * Optimise contracts/uniswapV3/BaseUniV3ActiveLiquidityFarm.sol Co-authored-by: Sudharsan R <34187497+TechnoGeek01@users.noreply.github.com> * test: add missing test * bug fix * refactor: remove unchecked * Update lastSecondsInside data type to uint32 * Update contracts/camelot/Demeter_CamelotFarm.sol Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * Update contracts/camelot/Demeter_CamelotFarm.sol Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * Refactor deposit token ID usage in Demeter_CamelotFarm.sol --------- Co-authored-by: Sudharsan R <34187497+TechnoGeek01@users.noreply.github.com> Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * Abstracting NFT farms (BaseE721Farm.sol) (#42) * refactor(farms): moved initiateCooldown to BaseFarm * refactor(camelot): uncommented interface and override in contract * Removed unused variables * Added BaseE721Farm.sol * Updated tests to reflect nftContract name update * Moved common functionality to base and documentation update * Updated test cases to support the changes * moved _validateDeposit check under _withdraw() * updated inheritance hierarchy * updated natspec and removed virtual keyword * Moved camelot and uniV3 under e721 farms * moved nft tests under e721-farms and added BaseE721Farm * removed unneeded typecasting * refactored tests and moved common ones under BaseE721Farm.t.sol * fixed imports related issues * Merge branch 'dev' into feat/e721-farms * fix: Fix imports * fix: Fix imports --------- Co-authored-by: mehultuteja <reachmehultuteja@gmail.com> Co-authored-by: Parv3213 <parv3213@gmail.com> * BaseFarm Optimizations (#33) * perf(BaseFarm): Optimizations * perf(BaseFarm): Optimizations * Test case optimization (#41) * test case optimization * test case optimization * test case optimization * fix * naming convention fix * removed unnecessary fuzz in negative test cases * rename and restructure of test cases * removed asserts and emit tests from deposit helper function and wrote separate tests * helper function optimization * added camelot deposit test * cleanup * added missing test contract inheritance * rename * remove unnecessary fuzz for negative cases * fuzz functions rename * update * test optimization * optimization * optimization * cleanup * optimization * rename * optimization * rename * cleanup * update * rename revert tests for consistency * refactor(test): Remove redundant code from uniV3 test files * refactor(contracts/BaseE20Farm): Remove redundancy in `recoverERC20` function * refactor(test): Simplify test hierarchy --------- Co-authored-by: Parv3213 <parv3213@gmail.com> Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * fix(BaseFarm._setupFarm): Updated check for rwdTokens.length (#47) * fix(BaseFarm._setupFarm): Fixed the check for rwdTokens.length * Updated test cases for reward token data check bug fix --------- Co-authored-by: mehultuteja <reachmehultuteja@gmail.com> * optimized cooldown period (#45) * optimized cooldown period * refactor Co-authored-by: Parv Garg <parv3213@gmail.com> * updated natspec * fix * rename * restructure * updated _validateCooldownPeriod * variable name simplification * optimization --------- Co-authored-by: Parv Garg <parv3213@gmail.com> * code reuse optimization. (#48) * optimization * optimization * rename * optimization * removed redundant check and did optimization * rename * decrease deposit further abstraction * increase deposit further abstraction * fix * rename of contracts, files, variables, etc (#46) * renamed BaseFarmWithExpiry to ExpirableFarm * Removed Base from all the farm names * renamed factory to registry * rename * update * renamed camelot farms similar to univ2 and univ3 * natspec update * natspec update * removed forge docs * removed Demeter_ from farm names * added Demeter ascii logo in our contracts * name fix * rename * name standardization * Enabling fixed APR reward tokens for Demeter Protocol (#50) * Initial version of DemeterRewarder contract * Added fixed APR struct in DataTypes * Added farmRegistered in farm registry's interface * Added USDs oracle's interface * Added apr description * Demeter rewarder contract all functionalities * First draft of DemeterRewarder * Updated IFarmFactory -> IFarmRegistry * Updated logo * Added getTokenAmounts function for DemeterRewarder * Implemented getTokenAmounts for CamelotV2 * Refactored from reward pool to individual rewarder * Added natspec * Implemented getTokenAmounts for univ2 and univ3 * Added call to _transferOwnership() * Added rewards budget functionality * Added a sample test script to test the functionality * removed redundant variable declaration * Removed farm registered function from interface * removed redundant transfer ownership call * Reconfigured _normalizeAmount to cache decimals * Updated isFarmValid check * Removed adjustment of rewardsPerSec * Updated variable names introduced a constant for 1 weeks * Added to farm validation logic * Updated naming convention * Made E20Farm abstract * Fixed rewardRate bug * Renamed struct and event name * Added FixedAPRRewarderSPA * Final version of FixedAPRRewarderSPA * Rewarder improvisation updated and bug fixes * Fixed APR rewarder for Legacy farms with simulation script * Added recover erc20 and updated calibrateRewards * Added total reward rate * Added FarmRewardConfigParams * Fixed failing test case * Cached baseTokens indexes in farm's asset tokens * Updated test script * file restructuring, improved naming * Arch change in Rewarder and legacy rewarder * Added getRewardTokens test * Added _isConfigured check and updateAPR function * Updated function name * Naming convention improvement and gas optimization. * Update contracts/rewarder/RewarderFactory.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Update contracts/rewarder/RewarderFactory.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Added nonReentrant and made rewardTokens internal * Added Average price consultation instead of spot * Updated Uniswap utils * Added test cases for rewarder * Added isConfigured check in calibrateReward * feat(calibrateReward): Added calibration restriction functionality * Added a dependency comment * Added update config test cases --------- Co-authored-by: mehultuteja <reachmehultuteja@gmail.com> Co-authored-by: Parv Garg <parv3213@gmail.com> * optimized Uni V3 claim fee (#54) * optimized claim fee * asserted claim swap fee for uniswap v3 * added asserts for claim swap fee * named imports * Camelot V3 (#52) * added Camelot V3 * initial test setup * added camelot v3 nfpm utils contract address * test fix * added test cases * update * optimization -> removed unnecessary dependency contract * update * tested edge cases -> farm functionality after tickspacing change * update * fix * update * cleanup * removed unnecessary nfpmutils contract * Revert "removed unnecessary nfpmutils contract" This reverts commit 1a53eb8. * reintroduced camelot utils as it's required later * update * added rewarder functionality for camelot v3 * fix * updated camelot utils contract address * cleanup * removed unused package * rename * cleanup * cleanup * added gettokenamounts test * update * improved camelot fee test case * removed redundant test cases * code reuse * removed redundant code * updated initialize with a single struct param * named imports * natspec update * natspec update --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Perf/solidity version to 0.8.24 (#55) * Updated openzeppelin version * Upgraded version and fixed ReentrancyGuard path * Ownable constructor param added * Updated UniV3 initialize params * Updated solhint compiler version * Fixed breaking changes and solhint warnings * Removed underscores from struct member's definition * perf: minor changes * Updated OZ dependencies --------- Co-authored-by: Parv3213 <parv3213@gmail.com> * fixed a test case (#56) * fixed a test case * update naming * testing improvement (#59) * fixed a camelot v3 test case * test optimization * Test/demeter rewarder (#57) * Initial version of DemeterRewarder contract * Added fixed APR struct in DataTypes * Added farmRegistered in farm registry's interface * Added USDs oracle's interface * Added apr description * Demeter rewarder contract all functionalities * First draft of DemeterRewarder * Updated IFarmFactory -> IFarmRegistry * Updated logo * Added getTokenAmounts function for DemeterRewarder * Implemented getTokenAmounts for CamelotV2 * Refactored from reward pool to individual rewarder * Added natspec * Implemented getTokenAmounts for univ2 and univ3 * Added call to _transferOwnership() * Added rewards budget functionality * Added a sample test script to test the functionality * removed redundant variable declaration * Removed farm registered function from interface * removed redundant transfer ownership call * Reconfigured _normalizeAmount to cache decimals * Updated isFarmValid check * Removed adjustment of rewardsPerSec * Updated variable names introduced a constant for 1 weeks * Added to farm validation logic * Updated naming convention * Made E20Farm abstract * Fixed rewardRate bug * Renamed struct and event name * Added FixedAPRRewarderSPA * Final version of FixedAPRRewarderSPA * Rewarder improvisation updated and bug fixes * Fixed APR rewarder for Legacy farms with simulation script * Added recover erc20 and updated calibrateRewards * Added total reward rate * Added FarmRewardConfigParams * Fixed failing test case * Cached baseTokens indexes in farm's asset tokens * Updated test script * file restructuring, improved naming * Arch change in Rewarder and legacy rewarder * Added getRewardTokens test * Added _isConfigured check and updateAPR function * Updated function name * Naming convention improvement and gas optimization. * Update contracts/rewarder/RewarderFactory.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Update contracts/rewarder/RewarderFactory.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Added nonReentrant and made rewardTokens internal * Added Average price consultation instead of spot * Updated Uniswap utils * Added test cases for rewarder * Added isConfigured check in calibrateReward * feat(calibrateReward): Added calibration restriction functionality * Added a dependency comment * Added update config test cases * Merge branch 'dev' into test/Demeter-rewarder * Completed rewarder test cases * variable naming updated * Updated var names --------- Co-authored-by: mehultuteja <reachmehultuteja@gmail.com> Co-authored-by: Parv Garg <parv3213@gmail.com> Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Natspec update for demeter protocol. (#58) * updated natspec * updated natspec for TokenUtils.sol * correction * update * update * natspec consistency update * Update contracts/e20-farms/E20Farm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Update contracts/e721-farms/E721Farm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Update contracts/e721-farms/camelotV2/CamelotV2Farm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * added demeter logo in TokenUtils.sol * update * update --------- Co-authored-by: Parv Garg <parv3213@gmail.com> * Farm optimisations (#60) * Optimised Farm * Updated test cases * Update contracts/Farm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Update contracts/Farm.sol --------- Co-authored-by: Parv Garg <parv3213@gmail.com> * feat: Use OpenZeppelin SafeCast for preventing unexpected cases (#62) * Audit Fixes: QS-1 (#61) * feat: Add failing test for deposit before farm start time * bug: if `lastFundUpdateTime` is greater than block time, return 0. Instead of underflow. * fix: Fix multiple time related problem: 1. Add `farmStartTime` in place of `lastFundUpdateTime` 2. Change logic when `lastFundUpdateTime` is updated. This is added to fix problems in UniV3ActiveFarm 3. Fixed testcases for the changes * chore: better comments * chore: rename `_currentFarmStartTime` to `currentFarmStartTime` * bug: add check if `lastFundUpdateTime == 0`, if so return 0. This will update lastFundUpdateTime = block.timestamp in the same transaction, and will start accruing rewards from from the next tx onwards * Audit Fixes: QS-9 (#63) * refactor: Update privilege address mapping name in FarmRegistry.sol for clarity * chore: rename `_userAddress` to `_user` --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * fix(Rewarder): consider acculumated rewards instead of balance (#65) Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-7 (#66) * perf(Reward rate calculation): Fixed precision loss * Added formula in comment for rewardRate calculation --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-8 (#67) * feat(RewarderFactory): added a function to update the rewarderImplementation * Added rewarder factory test cases * Moved ORACLE declaration to Arbitrum.t.sol --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-13 (#68) * fix(Rewarder): added a function to call farm.recoverRewardFunds * Added test cases for recoverRewardFundsOfFarm of Rewarder contract --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes: QS-3 (#64) * QS-3: Introduced depositTs to prevent rewards inflation * Used variable to access depositTs * Updated test cases * perf(test): Removed redundant test * Renamed error --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-17 and rewardRate precision bug (#70) * fix(Rewarder): added a function to call farm.recoverRewardFunds * Added test cases for recoverRewardFundsOfFarm of Rewarder contract * fix(NormalizeAmountRewarder): handle >18 precision and adjusts total value * Added and updated test cases * refactor(formatting): Rewarder * refactor(Rewarder): _normalizeAmount does not need to check decimals as it is added while configuration * perf(Rewarder): _normalizeAmount uses REWARD_TOKEN_DECIMALS directly from storage * Revert "perf(Rewarder): _normalizeAmount uses REWARD_TOKEN_DECIMALS directly from storage" This reverts commit c86cf2c401d0d7cfa1f5e35c65c6a41fbd17db24. * Updated test cases * perf(Rewarder): _normalizeAmount uses REWARD_TOKEN_DECIMALS directly from storage --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Moved transfer at the end (#71) Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-16 (#73) * Updated precision assignment to make it consistent with APR_PRECISION * Fixed implementation contract's meaningful state * Revert "Fixed implementation contract's meaningful state" This reverts commit cd42a5b. * fix: make `_updateFarmRewardData` public and rename to `updateFarmRewardData` (#74) 1. `updateFarmRewardData` will allow users/dapp to call this function externally to accrue rewards. 2. `updateFarmRewardData` function can now also be triggered externally before `farmEndTime` to accrue user rewards. Which otherwise cannot be accrued after farm expiry. Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * feat: remove LegacyFarmRewarder (#81) * Audit Fixed QS-14 (#72) * perf(Farms): removed repetitive inheritence * fix(state of implementation contracts) * fix: make `_updateFarmRewardData` public and rename to `updateFarmRewardData` (#74) 1. `updateFarmRewardData` will allow users/dapp to call this function externally to accrue rewards. 2. `updateFarmRewardData` function can now also be triggered externally before `farmEndTime` to accrue user rewards. Which otherwise cannot be accrued after farm expiry. Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> * feat: remove LegacyFarmRewarder (#81) * atomic inheritence, operable deposit and expirable farms * revert: reverting all changes related to changing initializer modifier - This change is better suited for another PR * refactor(recoverERC20): internal function instead of external function * Moved onlyOwner modifier to the lower level function call * refactor(E20 farms): initialization * Update contracts/Farm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> --------- Co-authored-by: Parv Garg <parv3213@gmail.com> * Audit Fixes QS-11 (#77) * perf: Add error for insufficient liquidity in OperableDeposit contract * perf: Validate reward token before accessing reward rates and balance * feat: Add error for already registered farm * feat: Add input validations for `updateFarmImplementation` * bug: fix `computeRewards` calculations to include rewards already accrued in previous subscriptions - This bug was noticed when rewardRates are high. So `test_claimRewards` is modified to test with max reward rates. - Max reward rates can only be upto uint128, this will be enforced in coming commits * fix: limit reward rate to `uint128` - This is to ensure other logical error do not occur with an exceptionally large value of rewardRate - One test case is failing * feat: Add input validation for registerFarm function --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-10 (#75) * perf(Farms): removed repetitive inheritence * fix(state of implementation contracts) * Commented unneeded contracts * Updated dependencies * Moved transfer at the end (#71) Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-17 and rewardRate precision bug (#70) * fix(Rewarder): added a function to call farm.recoverRewardFunds * Added test cases for recoverRewardFundsOfFarm of Rewarder contract * fix(NormalizeAmountRewarder): handle >18 precision and adjusts total value * Added and updated test cases * refactor(formatting): Rewarder * refactor(Rewarder): _normalizeAmount does not need to check decimals as it is added while configuration * perf(Rewarder): _normalizeAmount uses REWARD_TOKEN_DECIMALS directly from storage * Revert "perf(Rewarder): _normalizeAmount uses REWARD_TOKEN_DECIMALS directly from storage" This reverts commit c86cf2c401d0d7cfa1f5e35c65c6a41fbd17db24. * Updated test cases * perf(Rewarder): _normalizeAmount uses REWARD_TOKEN_DECIMALS directly from storage --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Moved initializer modifier in the external initialize function * Removed unneeded code * fix: Add ExpirableFarm to CamelotV2Farm, CamelotV3Farm, and UniV3Farm --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> Co-authored-by: Parv3213 <parv3213@gmail.com> * Audit Fixes QS-S-2 (#78) * perf: use existing `PREC` in place of `PRECISION` * perf: rename `PREC` to `PRECISION` for clarity * perf: caching lpToken, token0 and token1 for further gas-optimization * Revert "perf: caching lpToken, token0 and token1 for further gas-optimization" This reverts commit ff5646a. * fix: rebase missed changes * feat: Make `farms` and `deployerList` internal The code changes add two internal arrays, `farms` and `deployerList`, to the `FarmRegistry` contract. These arrays will be used to track the registered farms and deployers respectively. This change is necessary to improve the efficiency and organization of the contract. * Improved code documentation (#79) * fix: limit farm extension duration to prevent exceeding maximum extension limit (#82) The commit fixes a bug where the farm extension duration was not being properly limited, allowing it to exceed the maximum extension limit. The code now checks if the new farm end time exceeds the maximum extension limit and reverts the transaction with the "DurationExceeded" error if it does. This ensures that the farm extension duration stays within the allowed range. * Audit Fixes: QS-S-5 (#83) * Added FarmEndTimeUpdated to updateFarmStartTime * Updated test cases * Update contracts/features/ExpirableFarm.sol Co-authored-by: Parv Garg <parv3213@gmail.com> * Added a space --------- Co-authored-by: Parv Garg <parv3213@gmail.com> Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixed: Best Practices (#80) * perf: remove Unchecked loop increments recommended by QS * perf: remove Unchecked loop increments from other places * chore: Update tick range validation to use constants * perf: caching lpToken, token0 and token1 for further gas-optimization * perf: mark all address parameters as indexed * fix: use events definitions directly from contracts - this ensures we have the events dynamically updated * fix: resolve solhint warnings --------- Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> * Audit Fixes QS-S-3 (#84) * feat: Farm inherits for IFarm. * feat: use IFarm or other abstract import to call functions on Farm in test files * feat: FarmRegistry inherits for IFarmRegistry. Use IFarmRegistry for calling functions from FarmRegistry in tests. * feat: RewarderFactory inherits for IRewarderFactory. Use IRewarderFactory for calling functions from RewarderFactory in tests. * feat: Rewarder inherits for IRewarder. Use IRewarder for calling functions from Rewarder in tests. * Solc upgrade to 0.8.26 (#85) * chore(all-contracts): upgraded solc to 0.8.26 * Updated solc version for IRewarder * Added a functionality to claimRewardsTo another account (#86) * feat(claimRewards): Added an option to send rewards to another account * Updated test cases * Updated test cases * Move claimPoolFee from UniV3Farm and CamelotV3Farm to E721Farm (#87) * Moved claimPoolFee from Uni, Camelot farms to E721 Farm * Updated test cases * refactor(UniV3 and CamelotV3): Moved claimPoolFee as a separate feature * Updated test cases * Deploy/demeter (#88) * feat(CamelotV3Farm): Non expirable version * Updated test cases for Camelot v3 non expirable farms * Removed commented code * Added brownie utils contracts * Added configuration for FarmRegistry, Rewarder and CamelotV3Deployer * refactor(contracts): Make TokenUtils functions internal * refactor(scripts ): Use oz packages in deployment script * Brownie config changes * Deployment data for Demeter v2 initial deployment * Removed useless py files and tests * Added audit report * Added preset script and farm creation constant * Removed comments and added farm in preset * Removed unneeded line --------- Co-authored-by: Yash Pitroda <yash.pitroda786@gmail.com> --------- Co-authored-by: mehultuteja <arcantheon@gmail.com> Co-authored-by: Dayaa <m.d.e.boutalbi@me.com> Co-authored-by: Parv3213 <parv3213@gmail.com> Co-authored-by: TechnoGeek01 <rsudharsangames@gmail.com> Co-authored-by: Sudharsan R <34187497+TechnoGeek01@users.noreply.github.com> Co-authored-by: arcantheon <140178288+arcantheon@users.noreply.github.com> Co-authored-by: mehultuteja <reachmehultuteja@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.