Ubiquity Pool Security Monitor

packages/contracts/src/dollar/monitors/PoolLiquidityMonitor.sol

@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.19;
+
+import {Modifiers} from "../libraries/LibAppStorage.sol";
+import {SafeMath} from "@openzeppelin/contracts/utils/math/SafeMath.sol";
+import {DEFAULT_ADMIN_ROLE} from "../libraries/Constants.sol";
+import {LibUbiquityPool} from "../libraries/LibUbiquityPool.sol";
+import "forge-std/console.sol";
+
+contract PoolLiquidityMonitor is Modifiers {
+    using SafeMath for uint256;
+
+    address public defenderRelayer;
+    uint256 public liquidityVertex;
+    bool public monitorPaused;
+    uint256 public thresholdPercentage;
+
+    event LiquidityVertexUpdated(uint256 collateralLiquidity);
+    event MonitorPaused(uint256 collateralLiquidity, uint256 diffPercentage);
+    event VertexDropped();
+    event PausedToggled(bool paused);
+
+    modifier onlyAuthorized() {
+        require(
+            msg.sender == defenderRelayer,
+            "Not authorized: Only Defender Relayer allowed"
+        );
+        _;
+    }
+
+    function setThresholdPercentage(
+        uint256 _newThresholdPercentage
+    ) external onlyAdmin {
+        thresholdPercentage = _newThresholdPercentage;
+    }
+
+    function setDefenderRelayer(
+        address _newDefenderRelayer
+    ) external onlyAdmin {
+        defenderRelayer = _newDefenderRelayer;
+    }
+
+    function togglePaused() external onlyAdmin {
+        monitorPaused = !monitorPaused;
+        emit PausedToggled(monitorPaused);
+    }
+
+    function dropLiquidityVertex() external onlyAdmin {
+        uint256 currentCollateralLiquidity = LibUbiquityPool
+            .collateralUsdBalance();
+
+        require(currentCollateralLiquidity > 0, "Insufficient liquidity");
+
+        liquidityVertex = currentCollateralLiquidity;
+
+        emit VertexDropped();
+    }
+
+    function checkLiquidityVertex() external onlyAuthorized {
+        uint256 currentCollateralLiquidity = LibUbiquityPool
+            .collateralUsdBalance();
+
+        require(currentCollateralLiquidity > 0, "Insufficient liquidity");
+        require(!monitorPaused, "Monitor paused");
+
+        if (currentCollateralLiquidity > liquidityVertex) {
+            liquidityVertex = currentCollateralLiquidity;
+
+            emit LiquidityVertexUpdated(liquidityVertex);
+        } else {
+            uint256 liquidityDiffPercentage = liquidityVertex
+                .sub(currentCollateralLiquidity)
+                .mul(100)
+                .div(liquidityVertex);
+
+            if (liquidityDiffPercentage >= thresholdPercentage) {
+                monitorPaused = true;
+
+                // Pause the UbiquityDollarToken
+                // Pause LibUbiquityPool by disabling collateral
+
+                emit MonitorPaused(
+                    currentCollateralLiquidity,
+                    liquidityDiffPercentage
+                );
+            }
+        }
+    }
+}

packages/contracts/test/diamond/DiamondTest.t.sol

@@ -19,7 +19,7 @@ contract TestDiamond is DiamondTestSetup {
     }
 
     function testHasMultipleFacets() public {
-        assertEq(facetAddressList.length, 19);
+        assertEq(facetAddressList.length, 20);
     }
 
     function testFacetsHaveCorrectSelectors() public {

packages/contracts/test/diamond/DiamondTestSetup.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.19;
 
+import "forge-std/Test.sol";
+
 import {IERC165} from "@openzeppelin/contracts/interfaces/IERC165.sol";
 import {Diamond, DiamondArgs} from "../../src/dollar/Diamond.sol";
 import {ERC1155Ubiquity} from "../../src/dollar/core/ERC1155Ubiquity.sol";
@@ -31,6 +33,7 @@ import {MockERC20} from "../../src/dollar/mocks/MockERC20.sol";
 import {DiamondInit} from "../../src/dollar/upgradeInitializers/DiamondInit.sol";
 import {DiamondTestHelper} from "../helpers/DiamondTestHelper.sol";
 import {UUPSTestHelper} from "../helpers/UUPSTestHelper.sol";
+import {PoolLiquidityMonitor} from "../../src/dollar/monitors/PoolLiquidityMonitor.sol";
 import {CREDIT_NFT_MANAGER_ROLE, CREDIT_TOKEN_BURNER_ROLE, CREDIT_TOKEN_MINTER_ROLE, CURVE_DOLLAR_MANAGER_ROLE, DOLLAR_TOKEN_BURNER_ROLE, DOLLAR_TOKEN_MINTER_ROLE, GOVERNANCE_TOKEN_BURNER_ROLE, GOVERNANCE_TOKEN_MANAGER_ROLE, GOVERNANCE_TOKEN_MINTER_ROLE, STAKING_SHARE_MINTER_ROLE} from "../../src/dollar/libraries/Constants.sol";
 
 /**
@@ -61,6 +64,7 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
     StakingFacet stakingFacet;
     StakingFormulasFacet stakingFormulasFacet;
     UbiquityPoolFacet ubiquityPoolFacet;
+    PoolLiquidityMonitor poolLiquidityMonitor;
 
     // diamond facet implementation instances (should not be used in tests, use only on upgrades)
     AccessControlFacet accessControlFacetImplementation;
@@ -82,6 +86,7 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
     StakingFacet stakingFacetImplementation;
     StakingFormulasFacet stakingFormulasFacetImplementation;
     UbiquityPoolFacet ubiquityPoolFacetImplementation;
+    PoolLiquidityMonitor poolLiquidityMonitorImplementation;
 
     // facet names with addresses
     string[] facetNames;
@@ -114,6 +119,7 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
     bytes4[] selectorsOfStakingFacet;
     bytes4[] selectorsOfStakingFormulasFacet;
     bytes4[] selectorsOfUbiquityPoolFacet;
+    bytes4[] selectorsOfPoolLiquidityMonitor;
 
     /// @notice Deploys diamond and connects facets
     function setUp() public virtual {
@@ -183,6 +189,10 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
             "/out/UbiquityPoolFacet.sol/UbiquityPoolFacet.json"
         );
 
+        selectorsOfPoolLiquidityMonitor = getSelectorsFromAbi(
+            "/out/PoolLiquidityMonitor.sol/PoolLiquidityMonitor.json"
+        );
+
         // deploy facet implementation instances
         accessControlFacetImplementation = new AccessControlFacet();
         bondingCurveFacetImplementation = new BondingCurveFacet();
@@ -203,6 +213,7 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
         stakingFacetImplementation = new StakingFacet();
         stakingFormulasFacetImplementation = new StakingFormulasFacet();
         ubiquityPoolFacetImplementation = new UbiquityPoolFacet();
+        poolLiquidityMonitorImplementation = new PoolLiquidityMonitor();
 
         // prepare diamond init args
         diamondInit = new DiamondInit();
@@ -225,7 +236,8 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
             "OwnershipFacet",
             "StakingFacet",
             "StakingFormulasFacet",
-            "UbiquityPoolFacet"
+            "UbiquityPoolFacet",
+            "PoolLiquidityMonitor"
         ];
         DiamondInit.Args memory initArgs = DiamondInit.Args({
             admin: admin,
@@ -245,7 +257,7 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
             )
         });
 
-        FacetCut[] memory cuts = new FacetCut[](19);
+        FacetCut[] memory cuts = new FacetCut[](20);
 
         cuts[0] = (
             FacetCut({
@@ -387,6 +399,14 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
             })
         );
 
+        cuts[19] = (
+            FacetCut({
+                facetAddress: address(poolLiquidityMonitorImplementation),
+                action: FacetCutAction.Add,
+                functionSelectors: selectorsOfPoolLiquidityMonitor
+            })
+        );
+
         // deploy diamond
         vm.prank(owner);
         diamond = new Diamond(_args, cuts);
@@ -417,6 +437,7 @@ abstract contract DiamondTestSetup is DiamondTestHelper, UUPSTestHelper {
         stakingFacet = StakingFacet(address(diamond));
         stakingFormulasFacet = StakingFormulasFacet(address(diamond));
         ubiquityPoolFacet = UbiquityPoolFacet(address(diamond));
+        poolLiquidityMonitor = PoolLiquidityMonitor(address(diamond));
 
         // get all addresses
         facetAddressList = diamondLoupeFacet.facetAddresses();