Remove PSM and ERC20allocator, Consolidate GRLM and GSERL

.circleci/config.yml

@@ -47,7 +47,7 @@ jobs:
           name: Finish setting up env
           command: echo "export PATH=$PATH:$(pwd)/.foundry/bin" >> /home/circleci/.bashrc
       - run:
-          name: Install Foundry
+          name: Download Foundry
           command: curl -L https://foundry.paradigm.xyz | bash; source /home/circleci/.bashrc; $HOME/.foundry/bin/foundryup
       - run:
           name: Run tests

foundry.toml

@@ -12,7 +12,7 @@ script = 'script'
 libs = ['node_modules', 'script', 'src/external', 'src/v1']
 
 [fuzz]
-runs = 5000
+runs = 50
 max_test_rejects = 100000
 
 [invariant]

slither/slither-10-21-v2.txt

@@ -96,7 +96,7 @@ Parameter PermissionsV2.isGovernor(address)._address (contracts/core/Permissions
 Parameter PermissionsV2.isGuardian(address)._address (contracts/core/PermissionsV2.sol#247) is not in mixedCase
 Parameter PermissionsV2.isLocker(address)._address (contracts/core/PermissionsV2.sol#255) is not in mixedCase
 Parameter PermissionsV2.isPCVGuard(address)._address (contracts/core/PermissionsV2.sol#262) is not in mixedCase
-Parameter PermissionsV2.isRateLimitedMinter(address)._address (contracts/core/PermissionsV2.sol#270) is not in mixedCase
+Parameter PermissionsV2.isPsmMinter(address)._address (contracts/core/PermissionsV2.sol#270) is not in mixedCase
 Parameter PermissionsV2.isRateLimitedRedeemer(address)._address (contracts/core/PermissionsV2.sol#279) is not in mixedCase
 Function IRateLimitedV2.MAX_RATE_LIMIT_PER_SECOND() (contracts/utils/IRateLimitedV2.sol#11) is not in mixedCase
 Reference: https://github.com/crytic/slither/wiki/Detector-Documentation#conformance-to-solidity-naming-conventions

src/Constants.sol

@@ -28,6 +28,9 @@ library Constants {
     /// @notice Wei per ETH, i.e. 10**18
     uint256 public constant ETH_GRANULARITY = 1e18;
 
+    /// @notice Wei per ETH, i.e. 10**18
+    int256 public constant ETH_GRANULARITY_INT = 1e18;
+
     /// @notice number of decimals in ETH, 18
     uint256 public constant ETH_DECIMALS = 18;
 }

src/core/CoreV2.sol

@@ -8,7 +8,6 @@ import {ICoreV2} from "@voltprotocol/core/ICoreV2.sol";
 import {IPCVOracle} from "@voltprotocol/oracle/IPCVOracle.sol";
 import {PermissionsV2} from "@voltprotocol/core/PermissionsV2.sol";
 import {IGlobalRateLimitedMinter} from "@voltprotocol/rate-limits/IGlobalRateLimitedMinter.sol";
-import {IGlobalSystemExitRateLimiter} from "@voltprotocol/rate-limits/IGlobalSystemExitRateLimiter.sol";
 import {IGlobalReentrancyLock, GlobalReentrancyLock} from "@voltprotocol/core/GlobalReentrancyLock.sol";
 
 /// @title Source of truth for VOLT Protocol
@@ -24,9 +23,6 @@ contract CoreV2 is ICoreV2, PermissionsV2 {
     /// @notice address of the global rate limited minter
     IGlobalRateLimitedMinter public globalRateLimitedMinter;
 
-    /// @notice address of the global system exit rate limiter
-    IGlobalSystemExitRateLimiter public globalSystemExitRateLimiter;
-
     /// @notice address of the pcv oracle
     IPCVOracle public pcvOracle;
 
@@ -83,20 +79,6 @@ contract CoreV2 is ICoreV2, PermissionsV2 {
         emit PCVOracleUpdate(oldPCVOracle, address(newPCVOracle));
     }
 
-    /// @notice governor only function to set the Global Rate Limited Minter
-    /// @param newGlobalSystemExitRateLimiter new volt global rate limited minter
-    function setGlobalSystemExitRateLimiter(
-        IGlobalSystemExitRateLimiter newGlobalSystemExitRateLimiter
-    ) external onlyGovernor {
-        address oldGserl = address(globalSystemExitRateLimiter);
-        globalSystemExitRateLimiter = newGlobalSystemExitRateLimiter;
-
-        emit GlobalSystemExitRateLimiterUpdate(
-            oldGserl,
-            address(newGlobalSystemExitRateLimiter)
-        );
-    }
-
     /// @notice governor only function to set the Global Reentrancy Lock
     /// @param newGlobalReentrancyLock new global reentrancy lock
     function setGlobalReentrancyLock(

src/core/ICoreV2.sol

@@ -6,7 +6,6 @@ import {IVolt, IERC20} from "@voltprotocol/volt/IVolt.sol";
 import {IPermissionsV2} from "@voltprotocol/core/IPermissionsV2.sol";
 import {IGlobalReentrancyLock} from "@voltprotocol/core/IGlobalReentrancyLock.sol";
 import {IGlobalRateLimitedMinter} from "@voltprotocol/rate-limits/IGlobalRateLimitedMinter.sol";
-import {IGlobalSystemExitRateLimiter} from "@voltprotocol/rate-limits/IGlobalSystemExitRateLimiter.sol";
 
 /// @title Core Interface
 /// @author Volt Protocol
@@ -31,12 +30,6 @@ interface ICoreV2 is IPermissionsV2 {
         address indexed newPcvOracle
     );
 
-    /// @notice emitted when reference to global system exit rate limiter is updated
-    event GlobalSystemExitRateLimiterUpdate(
-        address indexed oldGserl,
-        address indexed newGserl
-    );
-
     /// @notice emitted when reference to global reentrancy lock is updated
     event GlobalReentrancyLockUpdate(
         address indexed oldGrl,
@@ -80,12 +73,6 @@ interface ICoreV2 is IPermissionsV2 {
         IGlobalRateLimitedMinter newGlobalRateLimitedMinter
     ) external;
 
-    /// @notice governor only function to set the Global Rate Limited Minter
-    /// @param newGlobalSystemExitRateLimiter new volt global rate limited minter
-    function setGlobalSystemExitRateLimiter(
-        IGlobalSystemExitRateLimiter newGlobalSystemExitRateLimiter
-    ) external;
-
     /// @notice governor only function to set the PCV Oracle
     /// @param newPCVOracle new volt pcv oracle
     function setPCVOracle(IPCVOracle newPCVOracle) external;

src/core/IPermissionsV2.sol

@@ -22,17 +22,7 @@ interface IPermissionsV2 is IAccessControl {
 
     function grantPCVGuard(address pcvGuard) external;
 
-    function grantRateLimitedMinter(address rateLimitedMinter) external;
-
-    function grantRateLimitedRedeemer(address rateLimitedRedeemer) external;
-
-    function grantSystemExitRateLimitDepleter(
-        address rateLimitedDepleter
-    ) external;
-
-    function grantSystemExitRateLimitReplenisher(
-        address rateLimitedReplenisher
-    ) external;
+    function grantPsmMinter(address rateLimitedMinter) external;
 
     function revokeMinter(address minter) external;
 
@@ -46,17 +36,7 @@ interface IPermissionsV2 is IAccessControl {
 
     function revokePCVGuard(address pcvGuard) external;
 
-    function revokeRateLimitedMinter(address rateLimitedMinter) external;
-
-    function revokeRateLimitedRedeemer(address rateLimitedRedeemer) external;
-
-    function revokeSystemExitRateLimitDepleter(
-        address rateLimitedDepleter
-    ) external;
-
-    function revokeSystemExitRateLimitReplenisher(
-        address rateLimitedReplenisher
-    ) external;
+    function revokePsmMinter(address rateLimitedMinter) external;
 
     // ----------- Revoker only state changing api -----------
 
@@ -76,19 +56,7 @@ interface IPermissionsV2 is IAccessControl {
 
     function isPCVGuard(address _address) external view returns (bool);
 
-    function isRateLimitedMinter(address _address) external view returns (bool);
-
-    function isRateLimitedRedeemer(
-        address _address
-    ) external view returns (bool);
-
-    function isSystemExitRateLimitReplenisher(
-        address _address
-    ) external view returns (bool);
-
-    function isSystemExitRateLimitDepleter(
-        address _address
-    ) external view returns (bool);
+    function isPsmMinter(address _address) external view returns (bool);
 
     // ----------- Predefined Roles -----------
 
@@ -115,15 +83,5 @@ interface IPermissionsV2 is IAccessControl {
 
     /// @notice granted to peg stability modules that will call in to deplete buffer
     /// and mint Volt
-    function RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE()
-        external
-        view
-        returns (bytes32);
-
-    /// @notice granted to peg stability modules that will call in to replenish the
-    /// buffer Volt is minted from
-    function RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE()
-        external
-        view
-        returns (bytes32);
+    function PSM_MINTER() external view returns (bytes32);
 }

src/core/PermissionsV2.sol

@@ -26,23 +26,9 @@ contract PermissionsV2 is IPermissionsV2, AccessControlEnumerable {
     /// @notice granted to EOA's to enable movement of funds to safety in an emergency
     bytes32 public constant PCV_GUARD_ROLE = keccak256("PCV_GUARD_ROLE");
 
-    /// @notice granted to peg stability modules that will call in to deplete buffer
-    /// and mint Volt
-    bytes32 public constant RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE =
-        keccak256("RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE");
-
-    /// @notice granted to peg stability modules that will call in to replenish the
-    /// buffer Volt is minted from
-    bytes32 public constant RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE =
-        keccak256("RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE");
-
-    /// @notice can replenish buffer through GlobalSystemExitRateLimiter
-    bytes32 public constant RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE =
-        keccak256("RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE");
-
-    /// @notice can delpete buffer through the GlobalSystemExitRateLimiter buffer
-    bytes32 public constant RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE =
-        keccak256("RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE");
+    /// @notice can replenish and deplete buffer through the GlobalRateLimiter.
+    /// replenishing burns Volt, depleting mints Volt
+    bytes32 public constant PSM_MINTER = keccak256("PSM_MINTER_ROLE");
 
     /// @notice granted to system smart contracts to enable the setting
     /// of reentrancy locks within the GlobalReentrancyLock contract
@@ -58,10 +44,7 @@ contract PermissionsV2 is IPermissionsV2, AccessControlEnumerable {
         _setRoleAdmin(GUARDIAN_ROLE, GOVERNOR_ROLE);
         _setRoleAdmin(LOCKER_ROLE, GOVERNOR_ROLE);
         _setRoleAdmin(PCV_GUARD_ROLE, GOVERNOR_ROLE);
-        _setRoleAdmin(RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE, GOVERNOR_ROLE);
-        _setRoleAdmin(RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE, GOVERNOR_ROLE);
-        _setRoleAdmin(RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE, GOVERNOR_ROLE);
-        _setRoleAdmin(RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE, GOVERNOR_ROLE);
+        _setRoleAdmin(PSM_MINTER, GOVERNOR_ROLE);
     }
 
     /// @notice callable only by governor
@@ -135,39 +118,10 @@ contract PermissionsV2 is IPermissionsV2, AccessControlEnumerable {
 
     /// @notice grants ability to mint Volt through the global rate limited minter
     /// @param rateLimitedMinter address to add as a minter in global rate limited minter
-    function grantRateLimitedMinter(
+    function grantPsmMinter(
         address rateLimitedMinter
     ) external override onlyGovernor {
-        _grantRole(RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE, rateLimitedMinter);
-    }
-
-    /// @notice grants ability to replenish buffer for minting Volt through the global rate limited minter
-    /// @param rateLimitedRedeemer address to add as a redeemer in global rate limited minter
-    function grantRateLimitedRedeemer(
-        address rateLimitedRedeemer
-    ) external override onlyGovernor {
-        _grantRole(RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE, rateLimitedRedeemer);
-    }
-
-    /// @notice grants ability to replenish buffer for funds exiting system through
-    /// the global system exit rate limiter
-    /// @param rateLimitedReplenisher address to add as a replenisher in global system exit rate limiter
-    function grantSystemExitRateLimitReplenisher(
-        address rateLimitedReplenisher
-    ) external override onlyGovernor {
-        _grantRole(
-            RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE,
-            rateLimitedReplenisher
-        );
-    }
-
-    /// @notice grants ability to deplete buffer for funds exiting system through
-    /// the global system exit rate limiter
-    /// @param rateLimitedDepleter address to add as a depleter in global system exit rate limiter
-    function grantSystemExitRateLimitDepleter(
-        address rateLimitedDepleter
-    ) external override onlyGovernor {
-        _grantRole(RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE, rateLimitedDepleter);
+        _grantRole(PSM_MINTER, rateLimitedMinter);
     }
 
     /// @notice revokes minter role from address
@@ -212,39 +166,10 @@ contract PermissionsV2 is IPermissionsV2, AccessControlEnumerable {
 
     /// @notice revokes ability to mint Volt through the global rate limited minter
     /// @param rateLimitedMinter ex minter in global rate limited minter
-    function revokeRateLimitedMinter(
+    function revokePsmMinter(
         address rateLimitedMinter
     ) external override onlyGovernor {
-        _revokeRole(RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE, rateLimitedMinter);
-    }
-
-    /// @notice revokes ability to replenish buffer for minting Volt through the global rate limited minter
-    /// @param rateLimitedRedeemer ex redeemer in global rate limited minter
-    function revokeRateLimitedRedeemer(
-        address rateLimitedRedeemer
-    ) external override onlyGovernor {
-        _revokeRole(
-            RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE,
-            rateLimitedRedeemer
-        );
-    }
-
-    /// @notice revokes ability to replenish buffer for funds exiting system through
-    /// the global system exit rate limiter
-    /// @param rateLimitedRedeemer ex replenisher in global system exit rate limiter
-    function revokeSystemExitRateLimitReplenisher(
-        address rateLimitedRedeemer
-    ) external override onlyGovernor {
-        _revokeRole(RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE, rateLimitedRedeemer);
-    }
-
-    /// @notice revokes ability to deplete buffer for funds exiting system through
-    /// the global system exit rate limiter
-    /// @param rateLimitedRedeemer ex depleter in global system exit rate limiter
-    function revokeSystemExitRateLimitDepleter(
-        address rateLimitedRedeemer
-    ) external override onlyGovernor {
-        _revokeRole(RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE, rateLimitedRedeemer);
+        _revokeRole(PSM_MINTER, rateLimitedMinter);
     }
 
     /// @notice revokes a role from address
@@ -322,36 +247,9 @@ contract PermissionsV2 is IPermissionsV2, AccessControlEnumerable {
     /// @notice checks if address has Volt Minter Role
     /// @param _address address to check
     /// @return true if _address has Volt Minter Role
-    function isRateLimitedMinter(
-        address _address
-    ) external view override returns (bool) {
-        return hasRole(RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE, _address);
-    }
-
-    /// @notice checks if address has Volt Redeemer Role
-    /// @param _address address to check
-    /// @return true if _address has Volt Redeemer Role
-    function isRateLimitedRedeemer(
-        address _address
-    ) external view override returns (bool) {
-        return hasRole(RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE, _address);
-    }
-
-    /// @notice checks if address has Volt Rate Limited Replenisher Role
-    /// @param _address address to check
-    /// @return true if _address has Volt Rate Limited Replenisher Role
-    function isSystemExitRateLimitReplenisher(
-        address _address
-    ) external view override returns (bool) {
-        return hasRole(RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE, _address);
-    }
-
-    /// @notice checks if address has Volt Rate Limited Depleter Role
-    /// @param _address address to check
-    /// @return true if _address has Volt Rate Limited Depleter Role
-    function isSystemExitRateLimitDepleter(
+    function isPsmMinter(
         address _address
     ) external view override returns (bool) {
-        return hasRole(RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE, _address);
+        return hasRole(PSM_MINTER, _address);
     }
 }

src/core/VoltRoles.sol

@@ -38,22 +38,9 @@ library VoltRoles {
 
     /// ----------- Rate limiters for Global System Entry / Exit ---------------
 
-    /// @notice can mint VOLT through GlobalRateLimitedMinter on a rate limit
-    bytes32 internal constant RATE_LIMIT_SYSTEM_ENTRY_DEPLETE =
-        keccak256("RATE_LIMIT_SYSTEM_ENTRY_DEPLETE_ROLE");
-
-    /// @notice can redeem VOLT and replenish the GlobalRateLimitedMinter buffer
-    /// @notice non custodial PSM role.
-    bytes32 internal constant RATE_LIMIT_SYSTEM_ENTRY_REPLENISH =
-        keccak256("RATE_LIMIT_SYSTEM_ENTRY_REPLENISH_ROLE");
-
-    /// @notice can delpete buffer through the GlobalSystemExitRateLimiter buffer
-    bytes32 internal constant RATE_LIMIT_SYSTEM_EXIT_DEPLETE =
-        keccak256("RATE_LIMIT_SYSTEM_EXIT_DEPLETE_ROLE");
-
-    /// @notice can replenish buffer through GlobalSystemExitRateLimiter
-    bytes32 internal constant RATE_LIMIT_SYSTEM_EXIT_REPLENISH =
-        keccak256("RATE_LIMIT_SYSTEM_EXIT_REPLENISH_ROLE");
+    /// @notice can replenish and deplete buffer through the GlobalRateLimiter.
+    /// replenishing burns Volt, depleting mints Volt
+    bytes32 internal constant PSM_MINTER = keccak256("PSM_MINTER_ROLE");
 
     /*///////////////////////////////////////////////////////////////
                                  Minor Roles