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.

Sign up for GitHub

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

Jump to bottom

Fix public immutable state #449

Merged
merged 3 commits into from
Sep 30, 2024
Merged

Fix public immutable state #449

merged 3 commits into from
Sep 30, 2024

Conversation

prateekdefi
Copy link

EdNoepel
EdNoepel reviewed Sep 25, 2024
View reviewed changes
Copy link
Contributor

@EdNoepel EdNoepel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe merge target should be v2.3-fix-review instead of 2.3.

Note that PE-1682 adds additional keep configs. I will move those from ctor to initializer in my [ed/pe-1682](https://github.com/equilibria-xyz/perennial-v2/tree/ed/pe-1682) branch. We'll need to resolve a merge conflict there when this comes together.

@prateekdefi prateekdefi changed the base branch from v2.3 to v2.3-fix-review September 26, 2024 07:21
EdNoepel
EdNoepel approved these changes Sep 26, 2024
View reviewed changes
Copy link
Contributor

@EdNoepel EdNoepel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Happy to help merge this with PR #451 .

arjun-io
arjun-io reviewed Sep 26, 2024
View reviewed changes
Copy link
Collaborator

@arjun-io arjun-io left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one nit but lgtm overall

packages/perennial-account/contracts/Controller_Incentivized.sol
@@ -36,30 +36,31 @@ abstract contract Controller_Incentivized is Controller, IRelayer, Kept {
KeepConfig public keepConfig;

/// @dev Handles relayed messages for nonce cancellation
IVerifierBase public nonceManager;
IVerifierBase public immutable nonceManager;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we move this above the mutable keepConfig just to make the storage layout clearer?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 7faab93

@github-actions GitHub Actions
Copy link

[Periphery] Unit Test Coverage Report

Coverage after merging prateek/fix-immutable-state into v2.3-fix-review will be
65.48%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/perennial-account/contracts
   Account.sol27.78%100%22.22%29.63%103, 108–109, 58, 64, 67–68, 71, 76–78, 81, 83–84, 89, 94–97
   AccountVerifier.sol100%100%100%100%
   Controller.sol66.98%100%77.27%64.29%100, 103–106, 108–109, 160, 207, 220, 225, 228–229, 231, 233–235, 239–241, 244, 252–256, 262–263, 98–99
   Controller_Arbitrum.sol0%100%0%0%23, 35
   Controller_Incentivized.sol0%100%0%0%100, 106–109, 117, 119–121, 131–132, 134, 137, 147–148, 150, 153, 163–164, 166, 169, 179–180, 182, 185, 195–196, 198, 201, 205–206, 218–219, 222, 225, 45, 59–63, 71–72, 80–82, 90–91, 94–96, 99
packages/perennial-account/contracts/libs
   RebalanceLib.sol0%100%0%0%24, 27, 29, 31, 34
packages/perennial-account/contracts/test
   RebalanceConfigTester.sol100%100%100%100%
packages/perennial-account/contracts/types
   Action.sol100%100%100%100%
   DeployAccount.sol100%100%100%100%
   MarketTransfer.sol100%100%100%100%
   RebalanceConfig.sol100%100%100%100%
   RebalanceConfigChange.sol100%100%100%100%
   RelayedAccessUpdateBatch.sol100%100%100%100%
   RelayedGroupCancellation.sol100%100%100%100%
   RelayedNonceCancellation.sol100%100%100%100%
   RelayedOperatorUpdate.sol100%100%100%100%
   RelayedSignerUpdate.sol100%100%100%100%
   Withdrawal.sol100%100%100%100%
packages/perennial-extensions/contracts
   Coordinator.sol100%100%100%100%
   MultiInvoker.sol89.51%100%92.31%88.89%161, 163, 183, 186, 255, 360, 374, 392, 394, 396, 398, 88–89
   MultiInvoker_Arbitrum.sol0%100%0%0%37, 45
   MultiInvoker_Optimism.sol0%100%0%0%37, 45
packages/perennial-extensions/contracts/types
   TriggerOrder.sol96.43%100%100%95.83%55
packages/perennial-oracle/contracts
   Oracle.sol100%100%100%100%
   OracleFactory.sol93.55%100%88.89%95.45%62
packages/perennial-oracle/contracts/chainlink
   ChainlinkFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/keeper
   KeeperFactory.sol87.36%100%78.57%89.04%164–165, 167–168, 211, 238, 82–83
   KeeperOracle.sol72%100%70.59%72.41%107, 158, 160–162, 164, 166–170, 173–174, 214, 70, 84
packages/perennial-oracle/contracts/keeper/libs
   DedupLib.sol100%100%100%100%
packages/perennial-oracle/contracts/keeper/types
   KeeperOracleParameter.sol100%100%100%100%
   PriceResponse.sol100%100%100%100%
packages/perennial-oracle/contracts/metaquants
   MetaQuantsFactory.sol0%100%0%0%19, 30–31, 33–36, 38, 40, 42, 44–45, 54
packages/perennial-oracle/contracts/payoff
   Inverse.sol100%100%100%100%
   PowerHalf.sol100%100%100%100%
   PowerTwo.sol100%100%100%100%
packages/perennial-oracle/contracts/pyth
   PythFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/types
   OracleParameter.sol100%100%100%100%
packages/perennial-order/contracts
   Manager.sol90.54%100%94.44%89.29%190, 194, 196, 199, 218–219
   Manager_Arbitrum.sol100%100%100%100%
   OrderVerifier.sol100%100%100%100%
packages/perennial-order/contracts/test
   TriggerOrderTester.sol100%100%100%100%
packages/perennial-order/contracts/types
   Action.sol100%100%100%100%
   CancelOrderAction.sol100%100%100%100%
   InterfaceFee.sol100%100%100%100%
   PlaceOrderAction.sol100%100%100%100%
   TriggerOrder.sol100%100%100%100%
packages/perennial-vault/contracts
   Vault.sol0%100%0%0%104–105, 113–114, 123, 125, 132, 134, 140, 142–143, 146, 152–153, 155, 157–158, 165–167, 175–179, 186, 188, 190, 196, 198, 200–203, 206, 212–213, 219–220, 226–227, 229–230, 237–238, 240–242, 256–257, 259–262, 268–269, 271–273, 291–292, 295–305, 308, 311–313, 316–318, 320, 327, 337–338, 345, 348, 352–353, 359–360, 363, 366, 370, 383, 385, 393–398, 407, 413, 430, 444, 446–449, 451, 453–454, 457–459, 463–465, 468–470, 477–479, 486, 499–500, 503, 60, 62–65, 71, 78, 85, 92, 98
   VaultFactory.sol0%100%0%0%30–31, 36, 50, 54–56, 58, 65–66
packages/perennial-vault/contracts/libs
   StrategyLib.sol0%100%0%0%119–120, 122–123, 125–129, 135, 138–139, 153, 156, 160, 162, 165, 167, 179–183, 185–186, 188–189, 191, 197, 199, 202–205, 208, 93–98
packages/perennial-vault/contracts/types
   Account.sol100%100%100%100%
   Checkpoint.sol100%100%100%100%
   Registration.sol100%100%100%100%
   VaultParameter.sol100%100%100%100%
packages/perennial-verifier/contracts
   Verifier.sol100%100%100%100%
packages/perennial-verifier/contracts/types
   AccessUpdate.sol100%100%100%100%
   AccessUpdateBatch.sol100%100%100%100%
   Intent.sol100%100%100%100%
   OperatorUpdate.sol100%100%100%100%
   SignerUpdate.sol100%100%100%100%

@github-actions GitHub Actions
Copy link

[Core] Integration Test Coverage Report

Coverage after merging prateek/fix-immutable-state into v2.3-fix-review will be
96.76%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/perennial/contracts
   Market.sol97.21%92%97.78%99.53%111, 111–112, 117, 131, 172, 224, 695, 867
   MarketFactory.sol98.91%96.88%100%100%85
packages/perennial/contracts/interfaces
   IMarket.sol100%100%100%100%
   IMarketFactory.sol100%100%100%100%
   IOracleProvider.sol100%100%100%100%
   IOracleProviderFactory.sol100%100%100%100%
packages/perennial/contracts/libs
   CheckpointLib.sol100%100%100%100%
   InvariantLib.sol63.16%50%100%88.89%110, 116–117, 39–40, 42–43, 43, 43, 43, 52, 56, 56, 64, 69–70, 70, 84–85, 85, 99
   MagicValueLib.sol63.16%50%100%62.50%61–64, 64, 64–65
   VersionLib.sol98.76%95.83%100%99.18%441–442
packages/perennial/contracts/types
   Checkpoint.sol74.07%50%100%100%55–61
   Global.sol79.69%53.57%100%100%140–152
   Guarantee.sol84.75%61.11%90.91%96.67%174–176, 199–202, 86
   Local.sol82.14%50%100%100%91–95
   MarketParameter.sol77.78%50%100%86.67%82–83, 85–86, 96–97
   OracleReceipt.sol100%100%100%100%
   OracleVersion.sol100%100%100%100%
   Order.sol85.12%63.79%96.77%96.20%100, 104, 104, 110–111, 163, 183, 183, 241, 397–402, 473–475, 501–506
   Position.sol78.07%57.69%87.10%82.46%111, 148, 203, 216, 300, 334–336, 352–354, 357, 357, 357, 357, 357–358, 360–361, 418, 439
   ProtocolParameter.sol74.19%50%100%100%66–68, 74–78
   RiskParameter.sol69.12%47.37%100%96.30%133, 139, 141, 147, 149, 151, 153, 155, 157, 160, 160, 160–161, 171–178
   Version.sol70.27%50%100%100%103–124

@github-actions GitHub Actions
Copy link

[Periphery] Integration Test Coverage Report

Coverage after merging prateek/fix-immutable-state into v2.3-fix-review will be
93.64%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/perennial-account/contracts
   Account.sol100%100%100%100%
   AccountVerifier.sol90.48%100%90.91%90%32
   Controller.sol89.62%100%90.91%89.29%141, 149, 275, 278, 282–284, 293, 310
   Controller_Arbitrum.sol100%100%100%100%
   Controller_Incentivized.sol100%100%100%100%
packages/perennial-account/contracts/libs
   RebalanceLib.sol100%100%100%100%
packages/perennial-account/contracts/test
   RebalanceConfigTester.sol0%100%0%0%10, 14
packages/perennial-account/contracts/types
   Action.sol100%100%100%100%
   DeployAccount.sol100%100%100%100%
   MarketTransfer.sol100%100%100%100%
   RebalanceConfig.sol20%100%33.33%14.29%34–35, 43–44, 46, 50
   RebalanceConfigChange.sol88.89%100%100%87.50%43
   RelayedAccessUpdateBatch.sol100%100%100%100%
   RelayedGroupCancellation.sol100%100%100%100%
   RelayedNonceCancellation.sol100%100%100%100%
   RelayedOperatorUpdate.sol100%100%100%100%
   RelayedSignerUpdate.sol100%100%100%100%
   Withdrawal.sol100%100%100%100%
packages/perennial-extensions/contracts
   Coordinator.sol0%100%0%0%18, 24–25, 31–32, 38–40, 47–48
   MultiInvoker.sol100%100%100%100%
   MultiInvoker_Arbitrum.sol0%100%0%0%37, 45
   MultiInvoker_Optimism.sol0%100%0%0%37, 45
packages/perennial-extensions/contracts/types
   TriggerOrder.sol96.43%100%100%95.83%55
packages/perennial-oracle/contracts
   Oracle.sol67.12%100%68.42%66.67%108–109, 118, 145, 168–169, 171, 173–174, 185, 187, 192–193, 57–58, 65, 91, 96
   OracleFactory.sol93.55%100%88.89%95.45%70
packages/perennial-oracle/contracts/chainlink
   ChainlinkFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/keeper
   KeeperFactory.sol95.40%100%85.71%97.26%211, 76
   KeeperOracle.sol97.33%100%94.12%98.28%84
packages/perennial-oracle/contracts/keeper/libs
   DedupLib.sol100%100%100%100%
packages/perennial-oracle/contracts/keeper/types
   KeeperOracleParameter.sol93.75%100%100%92.31%57
   PriceResponse.sol100%100%100%100%
packages/perennial-oracle/contracts/metaquants
   MetaQuantsFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/payoff
   Inverse.sol0%100%0%0%9
   PowerHalf.sol0%100%0%0%11
   PowerTwo.sol100%100%100%100%
packages/perennial-oracle/contracts/pyth
   PythFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/types
   OracleParameter.sol100%100%100%100%
packages/perennial-order/contracts
   Manager.sol100%100%100%100%
   Manager_Arbitrum.sol100%100%100%100%
   OrderVerifier.sol100%100%100%100%
packages/perennial-order/contracts/test
   TriggerOrderTester.sol0%100%0%0%17, 21, 25, 29
packages/perennial-order/contracts/types
   Action.sol100%100%100%100%
   CancelOrderAction.sol100%100%100%100%
   InterfaceFee.sol100%100%100%100%
   PlaceOrderAction.sol100%100%100%100%
   TriggerOrder.sol95.35%100%100%93.94%117, 47
packages/perennial-vault/contracts
   Vault.sol100%100%100%100%
   VaultFactory.sol100%100%100%100%
packages/perennial-vault/contracts/libs
   StrategyLib.sol100%100%100%100%
packages/perennial-vault/contracts/types
   Account.sol100%100%100%100%
   Checkpoint.sol100%100%100%100%
   Registration.sol100%100%100%100%
   VaultParameter.sol100%100%100%100%

@github-actions GitHub Actions
Copy link

[Periphery] Combined Test Coverage Report

Coverage after merging prateek/fix-immutable-state into v2.3-fix-review will be
99.32%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/perennial-account/contracts
   Account.sol100%100%100%100%
   AccountVerifier.sol100%100%100%100%
   Controller.sol100%100%100%100%
   Controller_Arbitrum.sol100%100%100%100%
   Controller_Incentivized.sol100%100%100%100%
packages/perennial-account/contracts/libs
   RebalanceLib.sol100%100%100%100%
packages/perennial-account/contracts/test
   RebalanceConfigTester.sol100%100%100%100%
packages/perennial-account/contracts/types
   Action.sol100%100%100%100%
   DeployAccount.sol100%100%100%100%
   MarketTransfer.sol100%100%100%100%
   RebalanceConfig.sol100%100%100%100%
   RebalanceConfigChange.sol100%100%100%100%
   RelayedAccessUpdateBatch.sol100%100%100%100%
   RelayedGroupCancellation.sol100%100%100%100%
   RelayedNonceCancellation.sol100%100%100%100%
   RelayedOperatorUpdate.sol100%100%100%100%
   RelayedSignerUpdate.sol100%100%100%100%
   Withdrawal.sol100%100%100%100%
packages/perennial-extensions/contracts
   Coordinator.sol100%100%100%100%
   MultiInvoker.sol100%100%100%100%
   MultiInvoker_Arbitrum.sol0%100%0%0%37, 45
   MultiInvoker_Optimism.sol0%100%0%0%37, 45
packages/perennial-extensions/contracts/types
   TriggerOrder.sol96.43%100%100%95.83%55
packages/perennial-oracle/contracts
   Oracle.sol100%100%100%100%
   OracleFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/chainlink
   ChainlinkFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/keeper
   KeeperFactory.sol97.70%100%92.86%98.63%211
   KeeperOracle.sol97.33%100%94.12%98.28%84
packages/perennial-oracle/contracts/keeper/libs
   DedupLib.sol100%100%100%100%
packages/perennial-oracle/contracts/keeper/types
   KeeperOracleParameter.sol100%100%100%100%
   PriceResponse.sol100%100%100%100%
packages/perennial-oracle/contracts/metaquants
   MetaQuantsFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/payoff
   Inverse.sol100%100%100%100%
   PowerHalf.sol100%100%100%100%
   PowerTwo.sol100%100%100%100%
packages/perennial-oracle/contracts/pyth
   PythFactory.sol100%100%100%100%
packages/perennial-oracle/contracts/types
   OracleParameter.sol100%100%100%100%
packages/perennial-order/contracts
   Manager.sol100%100%100%100%
   Manager_Arbitrum.sol100%100%100%100%
   OrderVerifier.sol100%100%100%100%
packages/perennial-order/contracts/test
   TriggerOrderTester.sol100%100%100%100%
packages/perennial-order/contracts/types
   Action.sol100%100%100%100%
   CancelOrderAction.sol100%100%100%100%
   InterfaceFee.sol100%100%100%100%
   PlaceOrderAction.sol100%100%100%100%
   TriggerOrder.sol100%100%100%100%
packages/perennial-vault/contracts
   Vault.sol100%100%100%100%
   VaultFactory.sol100%100%100%100%
packages/perennial-vault/contracts/libs
   StrategyLib.sol100%100%100%100%
packages/perennial-vault/contracts/types
   Account.sol100%100%100%100%
   Checkpoint.sol100%100%100%100%
   Registration.sol100%100%100%100%
   VaultParameter.sol100%100%100%100%
packages/perennial-verifier/contracts
   Verifier.sol100%100%100%100%
packages/perennial-verifier/contracts/types
   AccessUpdate.sol100%100%100%100%
   AccessUpdateBatch.sol100%100%100%100%
   Intent.sol100%100%100%100%
   OperatorUpdate.sol100%100%100%100%
   SignerUpdate.sol100%100%100%100%

@github-actions GitHub Actions
Copy link

[Core] Unit Test Coverage Report

Coverage after merging prateek/fix-immutable-state into v2.3-fix-review will be
98.92%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/perennial/contracts
   Market.sol98.88%98%97.78%99.53%111–112, 131
   MarketFactory.sol100%100%100%100%
packages/perennial/contracts/interfaces
   IMarket.sol100%100%100%100%
   IMarketFactory.sol100%100%100%100%
   IOracleProvider.sol100%100%100%100%
   IOracleProviderFactory.sol100%100%100%100%
packages/perennial/contracts/libs
   CheckpointLib.sol100%100%100%100%
   InvariantLib.sol100%100%100%100%
   MagicValueLib.sol100%100%100%100%
   VersionLib.sol100%100%100%100%
packages/perennial/contracts/types
   Checkpoint.sol100%100%100%100%
   Global.sol96.88%92.86%100%100%146, 148
   Guarantee.sol100%100%100%100%
   Local.sol100%100%100%100%
   MarketParameter.sol100%100%100%100%
   OracleReceipt.sol100%100%100%100%
   OracleVersion.sol100%100%100%100%
   Order.sol98.21%94.83%100%100%100, 104, 400
   Position.sol89.47%84.62%96.77%87.72%352–354, 357, 357, 357, 357, 357–358, 360–361
   ProtocolParameter.sol100%100%100%100%
   RiskParameter.sol97.06%94.74%100%100%139, 174
   Version.sol100%100%100%100%

@github-actions GitHub Actions
Copy link

[Core] Combined Test Coverage Report

Coverage after merging prateek/fix-immutable-state into v2.3-fix-review will be
98.92%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/perennial/contracts
   Market.sol99.22%100%97.62%99.53%112
   MarketFactory.sol100%100%100%100%
packages/perennial/contracts/libs
   CheckpointLib.sol100%100%100%100%
   InvariantLib.sol100%100%100%100%
   MagicValueLib.sol100%100%100%100%
   VersionLib.sol100%100%100%100%
packages/perennial/contracts/types
   Checkpoint.sol100%100%100%100%
   Global.sol100%100%100%100%
   Guarantee.sol100%100%100%100%
   Local.sol100%100%100%100%
   MarketParameter.sol100%100%100%100%
   Order.sol100%100%100%100%
   Position.sol90.24%100%96%87.72%352–354, 357–358, 360–361
   ProtocolParameter.sol100%100%100%100%
   RiskParameter.sol100%100%100%100%
   Version.sol100%100%100%100%

@prateekdefi prateekdefi merged commit 354a930 into v2.3-fix-review Sep 30, 2024
19 checks passed
@prateekdefi prateekdefi deleted the prateek/fix-immutable-state branch September 30, 2024 06:34
@sherlock-admin2 sherlock-admin2 mentioned this pull request Oct 3, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kbrizzle kbrizzle kbrizzle approved these changes

@arjun-io arjun-io arjun-io approved these changes

@EdNoepel EdNoepel EdNoepel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@prateekdefi @kbrizzle @arjun-io @EdNoepel