Updates Metis Minichef contract #1533
Conversation
WalkthroughThe changes primarily revolve around the integration of the Metis chain into the Synapse Interface. This includes the addition of Metis price fetching, updating addresses for the Metis chain, and modifying various components and utility functions to accommodate the new chain. The changes also involve refactoring and optimization of state management and data fetching in several components. Changes
Poem
TipsChat with CodeRabbit Bot (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1533 +/- ##
=============================================
Coverage 51.23324% 51.23324%
=============================================
Files 362 362
Lines 24691 24691
Branches 283 283
=============================================
Hits 12650 12650
Misses 10813 10813
Partials 1228 1228
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
abtestingalpha
force-pushed
the
fe/metis-minichef-update
branch
from
18cbd7d to
472f5db
Compare
Deploying with
|
| Latest commit: |
9c7c784
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c2263bc4.sanguine.pages.dev |
| Branch Preview URL: | https://fe-metis-minichef-update.sanguine.pages.dev |
abtestingalpha
force-pushed
the
fe/metis-minichef-update
branch
4 times, most recently
from
dcc4e48 to
1c182c8
Compare
* Updates minichef address * Fetches Metis price through chainlink aggregator * Updates APY calcs cased on Metis price
abtestingalpha
force-pushed
the
fe/metis-minichef-update
branch
from
1c182c8 to
a0f1b75
Compare
abtestingalpha
changed the title
abtestingalpha
requested review from
bigboydiamonds,
nautsimon and
aureliusbtc
as code owners
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 4
Configuration used: CodeRabbit UI
Files selected for processing (22)
- packages/synapse-interface/components/Pools/PoolActionOptions.tsx (1 hunks)
- packages/synapse-interface/components/Pools/PoolHeader.tsx (3 hunks)
- packages/synapse-interface/constants/chainlink.ts (1 hunks)
- packages/synapse-interface/constants/minichef.ts (1 hunks)
- packages/synapse-interface/constants/tokens/poolMaster.ts (32 hunks)
- packages/synapse-interface/contexts/UserProvider.tsx (2 hunks)
- packages/synapse-interface/pages/pool/PoolBody.tsx (2 hunks)
- packages/synapse-interface/pages/pools/PoolCard.tsx (4 hunks)
- packages/synapse-interface/pages/pools/PoolCards.tsx (1 hunks)
- packages/synapse-interface/pages/pools/index.tsx (3 hunks)
- packages/synapse-interface/pages/stake/StakeCard.tsx (12 hunks)
- packages/synapse-interface/pages/stake/StakeCardTitle.tsx (2 hunks)
- packages/synapse-interface/slices/priceDataSlice.ts (5 hunks)
- packages/synapse-interface/utils/actions/approveAndDeposit.tsx (1 hunks)
- packages/synapse-interface/utils/actions/approveAndStake.tsx (6 hunks)
- packages/synapse-interface/utils/actions/claimStake.tsx (3 hunks)
- packages/synapse-interface/utils/actions/getPoolApyData.ts (4 hunks)
- packages/synapse-interface/utils/actions/getPrices.ts (2 hunks)
- packages/synapse-interface/utils/actions/getStakedBalance.ts (2 hunks)
- packages/synapse-interface/utils/actions/withdrawStake.tsx (3 hunks)
- packages/synapse-interface/utils/hasAllPrices.ts (1 hunks)
- packages/synapse-interface/utils/types/index.tsx (4 hunks)
Files skipped from review due to trivial changes (3)
- packages/synapse-interface/components/Pools/PoolActionOptions.tsx
- packages/synapse-interface/constants/minichef.ts
- packages/synapse-interface/pages/pools/PoolCards.tsx
Additional comments: 62
packages/synapse-interface/constants/chainlink.ts (1)
- 7-13: The new
CHAINLINK_METIS_PRICE_ADDRESSESexport follows the existing pattern for price addresses for different chains. Ensure that the address '0xd4a5bb03b5d66d9bf81507379302ac2c2dfdfa6d' is correct and that it has been deployed on the METIS chain.packages/synapse-interface/contexts/UserProvider.tsx (2)
10-15: The new import
fetchMetisPriceis correctly added to the list of imports frompriceDataSlice.51-54: The new function call
fetchMetisPriceis correctly added to the list of dispatched actions whenisClientis true. Ensure that thefetchMetisPricefunction is implemented correctly and handles potential errors.packages/synapse-interface/utils/actions/approveAndDeposit.tsx (1)
- 46-52: The condition
token.addresses[pool.chainId] === zeroAddressis used to check if the token address is the zero address. If it is, the function returns early. This change seems to be a part of the logic modification related to token addresses. Ensure that this change doesn't break any existing functionality and that all token addresses are correctly set in thepoolobject.packages/synapse-interface/utils/actions/getPrices.ts (2)
12-18: The
getEthPricefunction has been updated to useCHAINLINK_ETH_PRICE_ADDRESSESdirectly. Ensure that theCHAINLINK_ETH_PRICE_ADDRESSESmapping contains the correct address for theETHchain.48-64: The
getMetisPricefunction has been added to retrieve the Metis price from Chainlink. Ensure that theCHAINLINK_METIS_PRICE_ADDRESSESmapping contains the correct address for theMETISchain.packages/synapse-interface/pages/pool/PoolBody.tsx (2)
55-62: Ensure that the
getStakedBalancefunction has been updated to accept the newpoolargument and that all calls to this function throughout the codebase have been updated to match the new signature.96-96: The options in the
PoolActionOptionscomponent have been modified from['Stake', 'Unstake', 'Claim SYN']to['Stake', 'Unstake', 'Claim']. Ensure that this change is reflected in the logic of thePoolActionOptionscomponent and that it doesn't break any existing functionality.packages/synapse-interface/pages/stake/StakeCardTitle.tsx (3)
5-9: The new import paths for
hasAllPricesanduseAppSelectorshould be verified to ensure they are correct and accessible.46-61: The
useEffecthook has been updated to usetoken.chainIdinstead ofconnectedChainIdandhasAllPrices(prices). Ensure that thetokenobject andhasAllPrices(prices)are always available when this effect runs.63-69: The
useMemohook has been updated to removeconnectedChainIdfrom its dependency array. Ensure that this change does not introduce any unintended side effects.packages/synapse-interface/utils/actions/approveAndStake.tsx (4)
16-22: The
miniChefAddressis now being fetched from thepoolobject. Ensure that thepoolobject is always populated with theminiChefAddressproperty before this function is called.33-38: The
approveErc20Tokenfunction now usesminiChefAddressfrom thepoolobject instead of theMINICHEF_ADDRESSESconstant. This change should be verified across the codebase to ensure that all calls to this function are updated accordingly.68-78: The
miniChefAddressis now being fetched from thepoolobject. Ensure that thepoolobject is always populated with theminiChefAddressproperty before this function is called.94-98: The
stakeLpTokenfunction now usesminiChefAddressfrom thepoolobject instead of theMINICHEF_ADDRESSESconstant. This change should be verified across the codebase to ensure that all calls to this function are updated accordingly.packages/synapse-interface/slices/priceDataSlice.ts (5)
4-8: The new
getMetisPricefunction is imported correctly.16-24: The
PriceDataStateinterface has been updated to includemetisPriceandisLoadingMetisPrice. Ensure that these new fields are used correctly throughout the codebase.32-40: The initial state has been updated to include
metisPriceandisLoadingMetisPrice. This is consistent with the changes to thePriceDataStateinterface.63-72: A new async thunk
fetchMetisPricehas been added to fetch and update the Metis price in the state. Ensure that this function is called at the appropriate times to keep the Metis price up-to-date.112-125: The reducer logic has been updated to handle the new Metis price fetching actions. This includes setting the loading state and updating the Metis price in the state. Ensure that errors are handled appropriately in the application when the
fetchMetisPriceaction is rejected.packages/synapse-interface/utils/actions/claimStake.tsx (2)
10-15: Ensure that all calls to
claimStakefunction throughout the codebase have been updated to match the new signature.34-34: The
lpAddressparameter in theharvestLpPoolfunction call has been changed fromMINICHEF_ADDRESSES[chainId]tominiChefAddress. Ensure that this change does not affect the functionality of theharvestLpPoolfunction.packages/synapse-interface/utils/actions/withdrawStake.tsx (3)
10-16: Ensure that all calls to
withdrawStakefunction throughout the codebase have been updated to match the new signature.17-17: The
miniChefAddressis being extracted from thepoolobject. Ensure that thepoolobject always has theminiChefAddressproperty and it is notnullorundefined.30-30: The
lpAddressis now being set tominiChefAddressfrom thepoolobject. Ensure that this change does not break any functionality and is consistent with the rest of the codebase.packages/synapse-interface/utils/types/index.tsx (4)
159-166: The
Tokenclass has been extended withcustomRewardTokenandminiChefAddressproperties. Ensure that these new properties are being used correctly throughout the codebase.211-218: The constructor of the
Tokenclass has been updated to acceptcustomRewardTokenandminiChefAddressproperties. Ensure that all instances of theTokenclass are being created with the updated constructor.252-259: The type of the constructor argument has been updated to include
customRewardTokenandminiChefAddressproperties. Ensure that the types are being used correctly throughout the codebase.307-314: The constructor of the
Tokenclass has been updated to initializecustomRewardTokenandminiChefAddressproperties. Ensure that these properties are being initialized correctly in all instances of theTokenclass.packages/synapse-interface/pages/pools/index.tsx (4)
19-25: New imports for
METIS_POOL_SWAP_TOKEN_MIGRATEDandMETIS_WETH_SWAP_TOKEN_MIGRATEDhave been added. Ensure these constants are correctly defined and exported in thepoolMasterfile.35-37: A new
migratedPoolsobject has been introduced. Ensure that the key1088correctly represents the chain ID for the Metis network.47-51: The
unIncentivizedPoolsobject has been modified to filter outMETIS_POOL_SWAP_TOKEN_MIGRATEDandMETIS_WETH_SWAP_TOKEN_MIGRATED. This logic seems correct as migrated pools should not be included in the list of unincentivized pools.89-100: A new section has been added to display migrated pools using
PoolCards. Ensure that thePoolCardscomponent can handle themigratedPoolsobject correctly.packages/synapse-interface/utils/actions/getStakedBalance.ts (4)
1-3: Imports have been updated to reflect the changes in the function signature and the usage of the
Tokentype.15-20: The function signature of
getStakedBalancehas been updated to include an additional parameterpool: Token. Ensure that all calls to this function throughout the codebase have been updated to match the new signature.21-21: The
miniChefContractAddressis now derived from thepoolparameter instead of theMINICHEF_ADDRESSESmapping. This change provides more flexibility as the address can now be dynamically determined based on thepoolargument.15-24: > Note: This review was outside of the patch, so it was mapped to the patch with the greatest overlap. Original lines [22-37]
The error handling in the
getStakedBalancefunction is appropriate. It catches any errors that occur during the execution of thereadContractsfunction and logs the error message. It also provides a default return value in case of an error.packages/synapse-interface/pages/pools/PoolCard.tsx (4)
39-57: The
getSinglePoolDataandgetPoolApyDatafunctions are called within auseEffecthook. Ensure that these functions handle potential errors properly and that the state updates are safe. Consider using a state machine or a similar pattern to handle the loading, success, and error states.59-76: The
getStakedBalancefunction now accepts an additionalpoolparameter. Ensure that all calls to this function throughout the codebase have been updated to match the new signature.171-174: The
ManageLpcomponent's action options now include "Claim" instead of "Claim SYN". This change should be reflected in the UI. Ensure that the UI updates correctly and that the user experience is not negatively affected.240-246: The
customRewardTokenproperty of theTokenclass is used here. Ensure that this property is correctly set for all instances of theTokenclass.packages/synapse-interface/constants/tokens/poolMaster.ts (3)
37-37: Ensure that the
MINICHEF_ADDRESSESconstant is correctly defined and exported in theminichefmodule.922-922: Ensure that the
MINICHEF_ADDRESSESconstant includes the correct addresses for each chain ID.900-922: Ensure that the new
TokenobjectsMETIS_WETH_SWAP_TOKEN_MIGRATEDandMETIS_POOL_SWAP_TOKEN_MIGRATEDare correctly defined and that all properties are correctly set. Also, verify that theminiChefAddressis correct for the migrated pools.packages/synapse-interface/components/Pools/PoolHeader.tsx (2)
51-53: The
ConnectedIndicatoris rendered only if the component is mounted and the connected chain's id matches the pool's chain id. This is a good practice as it ensures that the indicator is only shown when the user is connected to the correct chain for the pool.11-24: > Note: This review was outside of the patch, so it was mapped to the patch with the greatest overlap. Original lines [22-46]
The
canDepositcalculation is done usinguseMemowhich is a good practice as it prevents unnecessary recalculations. The calculation now depends on thebalancesAndAllowancesfrom the portfolio state which seems to be a more accurate way of determining if a deposit can be made.packages/synapse-interface/utils/actions/getPoolApyData.ts (8)
1-10: The import statements look fine. Ensure that the imported modules and constants are being used in the code.
17-27: The
Pricestype is well defined and covers all the necessary fields.29-33: The function signature of
getPoolApyDatahas been updated to include apricesparameter of typePrices. Ensure that all calls to this function throughout the codebase have been updated to match the new signature.42-44: The
minichefAddressis now assigned from thepoolToken.miniChefAddress. Ensure that thepoolTokenobject has theminiChefAddressproperty and it is of typeAddress.83-94: The data fetching and assignment operations look fine. The fallback values are correctly assigned in case of null or undefined results.
89-90: The
synPriceDataandmetisPriceare fetched either from thepricesparameter or by calling thegetSynPricesandgetMetisPricefunctions respectively. Ensure that thegetSynPricesandgetMetisPricefunctions return the expected data structure.136-140: The
usePriceis assigned based on thechainIdof thepoolToken. This logic seems fine. Ensure that theMETIS.idis correctly defined and matches the expectedchainIdfor Metis.142-145: The calculations for
usdPerWeek,weeklyAPR, andyearlyAPRlook fine. Ensure that thestakedTvlis correctly calculated and is not zero to avoid division by zero errors.packages/synapse-interface/pages/stake/StakeCard.tsx (8)
40-45: The
useStatehook is used to manage the state of deposit, withdraw, and showStake. Ensure that these states are updated correctly throughout the component.53-59: > Note: This review was outside of the patch, so it was mapped to the patch with the greatest overlap. Original lines [53-69]
The
useEffecthook is used to fetch the staked balance. Ensure that thegetStakedBalancefunction is updated to accept the newpoolparameter.
82-94: The
useEffecthook is used to fetch the token allowance and the staked balance. Ensure that thegetTokenAllowanceandgetStakedBalancefunctions are updated to accept the newpoolparameter.102-108: The
useEffecthook is used to fetch the token allowance. Ensure that thegetTokenAllowancefunction is updated to accept the newpoolparameter.148-157: The "SYN Earned" text and the token symbol are now dynamic based on the
customRewardTokenproperty of thepoolobject. Ensure that thecustomRewardTokenproperty is correctly set in thepoolobject.171-187: The "Claim SYN" button text is now dynamic based on the
customRewardTokenproperty of thepoolobject. Ensure that thecustomRewardTokenproperty is correctly set in thepoolobject.303-309: The
stakefunction now receives thepoolobject as an additional parameter. Ensure that thestakefunction is updated to accept this new parameter.327-333: The
withdrawStakefunction now receives thepoolobject as an additional parameter. Ensure that thewithdrawStakefunction is updated to accept this new parameter.
null
96e3b91e9cf892734deb3d180bbefb968a2ca34b: synapse-interface preview link
906ee2f88c4920d1f0d9d7a86ab7409537d3032a: synapse-interface preview link
5be7d3422190d8382022a35080ab1912fbfff190: synapse-interface preview link
8300571dfdc5c1359d25a194d970764977142940: synapse-interface preview link
81b98911dafbad04934ccf646bb39b425a33cd19: synapse-interface preview link
4bc7afbdd2dd343e2ae0149946e13c813ff51ee0: synapse-interface preview link
90d799961344b1a9ff315a0ba4391ea7cd882dbd: synapse-interface preview link
7a865969ea91fa5ed301ad0f46590325c5965aad: synapse-interface preview link
e9b713b59e092e35db807e288a9ebbda5e1e007a: synapse-interface preview link
010b6a8b70ed7bae91bd179a12a3181a845f1e59: synapse-interface preview link
Summary by CodeRabbit
PoolCardcomponent.PoolCardscomponent by removing unnecessary props and conditions related to price data.Tokenclass to includecustomRewardTokenandminiChefAddressproperties.getPoolApyDatafunction to include apricesparameter.METISchain in theMINICHEF_ADDRESSESmapping.