fixed rate irm

foundry.toml

@@ -15,12 +15,10 @@ fail_on_revert = true
 [profile.default.fmt]
 wrap_comments = true
 
-
 [profile.build]
 test = "/dev/null"
 script = "/dev/null"
 
-
 [profile.test]
 via_ir = false
 

hardhat.config.ts

@@ -30,7 +30,17 @@ const config: HardhatUserConfig = {
         settings: {
           optimizer: {
             enabled: true,
-            runs: 200,
+            runs: 999999,
+          },
+          viaIR: true,
+        },
+      },
+      {
+        version: "0.8.24",
+        settings: {
+          optimizer: {
+            enabled: true,
+            runs: 999999,
           },
           viaIR: true,
         },

src/AdaptiveCurveIrm.sol → src/adaptive-curve-irm/AdaptiveCurveIrm.sol

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.19;
 
-import {IIrm} from "../lib/morpho-blue/src/interfaces/IIrm.sol";
+import {IIrm} from "../../lib/morpho-blue/src/interfaces/IIrm.sol";
 import {IAdaptiveCurveIrm} from "./interfaces/IAdaptiveCurveIrm.sol";
 
 import {UtilsLib} from "./libraries/UtilsLib.sol";
 import {ErrorsLib} from "./libraries/ErrorsLib.sol";
-import {ExpLib} from "./libraries/adaptive-curve/ExpLib.sol";
+import {ExpLib} from "./libraries/ExpLib.sol";
 import {MathLib, WAD_INT as WAD} from "./libraries/MathLib.sol";
-import {ConstantsLib} from "./libraries/adaptive-curve/ConstantsLib.sol";
-import {MarketParamsLib} from "../lib/morpho-blue/src/libraries/MarketParamsLib.sol";
-import {Id, MarketParams, Market} from "../lib/morpho-blue/src/interfaces/IMorpho.sol";
-import {MathLib as MorphoMathLib} from "../lib/morpho-blue/src/libraries/MathLib.sol";
+import {ConstantsLib} from "./libraries/ConstantsLib.sol";
+import {MarketParamsLib} from "../../lib/morpho-blue/src/libraries/MarketParamsLib.sol";
+import {Id, MarketParams, Market} from "../../lib/morpho-blue/src/interfaces/IMorpho.sol";
+import {MathLib as MorphoMathLib} from "../../lib/morpho-blue/src/libraries/MathLib.sol";
 
 /// @title AdaptiveCurveIrm
 /// @author Morpho Labs

src/interfaces/IAdaptiveCurveIrm.sol → src/adaptive-curve-irm/interfaces/IAdaptiveCurveIrm.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.5.0;
 
-import {IIrm} from "../../lib/morpho-blue/src/interfaces/IIrm.sol";
-import {Id} from "../../lib/morpho-blue/src/interfaces/IMorpho.sol";
+import {IIrm} from "../../../lib/morpho-blue/src/interfaces/IIrm.sol";
+import {Id} from "../../../lib/morpho-blue/src/interfaces/IMorpho.sol";
 
 /// @title IAdaptiveCurveIrm
 /// @author Morpho Labs

src/libraries/adaptive-curve/ExpLib.sol → src/adaptive-curve-irm/libraries/ExpLib.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {WAD_INT} from "../MathLib.sol";
+import {WAD_INT} from "./MathLib.sol";
 
 /// @title ExpLib
 /// @author Morpho Labs

src/libraries/MathLib.sol → src/adaptive-curve-irm/libraries/MathLib.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {WAD} from "../../lib/morpho-blue/src/libraries/MathLib.sol";
+import {WAD} from "../../../lib/morpho-blue/src/libraries/MathLib.sol";
 
 int256 constant WAD_INT = int256(WAD);
 

src/fixed-rate-irm/FixedRateIrm.sol

@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.24;
+
+import {IIrm} from "../../lib/morpho-blue/src/interfaces/IIrm.sol";
+import {IFixedRateIrm} from "./interfaces/IFixedRateIrm.sol";
+
+import {MarketParamsLib} from "../../lib/morpho-blue/src/libraries/MarketParamsLib.sol";
+import {Id, MarketParams, Market} from "../../lib/morpho-blue/src/interfaces/IMorpho.sol";
+
+/* ERRORS */
+
+/// @dev Thrown when the rate is not already set for this market.
+string constant RATE_NOT_SET = "rate not set";
+/// @dev Thrown when the rate is already set for this market.
+string constant RATE_SET = "rate set";
+/// @dev Thrown when trying to set the rate at zero.
+string constant RATE_ZERO = "rate zero";
+
+/// @title FixedRateIrm
+/// @author Morpho Labs
+/// @custom:contact security@morpho.org
+contract FixedRateIrm is IFixedRateIrm {
+    using MarketParamsLib for MarketParams;
+
+    /* EVENTS */
+
+    /// @notice Emitted when a borrow rate is set.
+    event SetBorrowRate(Id indexed id, uint256 newBorrowRate);
+
+    /* STORAGE */
+
+    /// @notice Borrow rates.
+    mapping(Id => uint256) public borrowRateStored;
+
+    /* SETTER */
+
+    /// @notice Sets the borrow rate for a market.
+    /// @dev A rate can be set by anybody, but only once.
+    /// @dev `borrowRate` reverts on rate not set, so the rate needs to be set before the market creation.
+    function setBorrowRate(Id id, uint256 newBorrowRate) external {
+        require(borrowRateStored[id] == 0, RATE_SET);
+        require(newBorrowRate != 0, RATE_ZERO);
+
+        borrowRateStored[id] = newBorrowRate;
+
+        emit SetBorrowRate(id, newBorrowRate);
+    }
+
+    /* BORROW RATES */
+
+    /// @inheritdoc IIrm
+    function borrowRateView(MarketParams memory marketParams, Market memory) external view returns (uint256) {
+        uint256 borrowRateCached = borrowRateStored[marketParams.id()];
+        require(borrowRateCached != 0, RATE_NOT_SET);
+        return borrowRateCached;
+    }
+
+    /// @inheritdoc IIrm
+    /// @dev Reverts on not set rate, so the rate has to be set before the market creation.
+    function borrowRate(MarketParams memory marketParams, Market memory) external view returns (uint256) {
+        uint256 borrowRateCached = borrowRateStored[marketParams.id()];
+        require(borrowRateCached != 0, RATE_NOT_SET);
+        return borrowRateCached;
+    }
+}

src/fixed-rate-irm/interfaces/IFixedRateIrm.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.5.0;
+
+import {IIrm} from "../../../lib/morpho-blue/src/interfaces/IIrm.sol";
+import {Id} from "../../../lib/morpho-blue/src/interfaces/IMorpho.sol";
+
+/// @title IFixedRateIrm
+/// @author Morpho Labs
+/// @custom:contact security@morpho.org
+interface IFixedRateIrm is IIrm {
+    function borrowRateStored(Id id) external returns (uint256);
+    function setBorrowRate(Id id, uint256 newBorrowRate) external;
+}

test/forge/AdaptiveCurveIrmTest.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import "../../src/AdaptiveCurveIrm.sol";
+import "../../src/adaptive-curve-irm/AdaptiveCurveIrm.sol";
 
 import "../../lib/forge-std/src/Test.sol";
 

test/forge/ExpLibTest.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {MathLib, WAD_INT} from "../../src/libraries/MathLib.sol";
-import {ExpLib} from "../../src/libraries/adaptive-curve/ExpLib.sol";
+import {MathLib, WAD_INT} from "../../src/adaptive-curve-irm/libraries/MathLib.sol";
+import {ExpLib} from "../../src/adaptive-curve-irm/libraries/ExpLib.sol";
 import {wadExp} from "../../lib/solmate/src/utils/SignedWadMath.sol";
-import {ConstantsLib} from "../../src/libraries/adaptive-curve/ConstantsLib.sol";
+import {ConstantsLib} from "../../src/adaptive-curve-irm/libraries/ConstantsLib.sol";
 import {MathLib as MorphoMathLib} from "../../lib/morpho-blue/src/libraries/MathLib.sol";
 
 import "../../lib/forge-std/src/Test.sol";

test/forge/FixedRateIrmTest.sol

@@ -0,0 +1,70 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "../../src/fixed-rate-irm/FixedRateIrm.sol";
+
+import "../../lib/forge-std/src/Test.sol";
+
+contract FixedRateIrmTest is Test {
+    using MarketParamsLib for MarketParams;
+
+    event SetBorrowRate(Id indexed id, uint256 newBorrowRate);
+
+    FixedRateIrm public fixedRateIrm;
+
+    function setUp() external {
+        fixedRateIrm = new FixedRateIrm();
+    }
+
+    function testSetBorrowRate(Id id, uint256 newBorrowRate) external {
+        vm.assume(newBorrowRate != 0);
+
+        fixedRateIrm.setBorrowRate(id, newBorrowRate);
+        assertEq(fixedRateIrm.borrowRateStored(id), newBorrowRate);
+    }
+
+    function testSetBorrowRateEvent(Id id, uint256 newBorrowRate) external {
+        vm.assume(newBorrowRate != 0);
+
+        vm.expectEmit(true, true, true, true, address(fixedRateIrm));
+        emit SetBorrowRate(id, newBorrowRate);
+        fixedRateIrm.setBorrowRate(id, newBorrowRate);
+    }
+
+    function testSetBorrowRateAlreadySet(Id id, uint256 newBorrowRate1, uint256 newBorrowRate2) external {
+        vm.assume(newBorrowRate1 != 0);
+        vm.assume(newBorrowRate2 != 0);
+        fixedRateIrm.setBorrowRate(id, newBorrowRate1);
+        vm.expectRevert(bytes(RATE_SET));
+        fixedRateIrm.setBorrowRate(id, newBorrowRate2);
+    }
+
+    function testSetBorrowRateRateZero(Id id) external {
+        vm.expectRevert(bytes(RATE_ZERO));
+        fixedRateIrm.setBorrowRate(id, 0);
+    }
+
+    function testBorrowRate(MarketParams memory marketParams, Market memory market, uint256 newBorrowRate) external {
+        vm.assume(newBorrowRate != 0);
+        fixedRateIrm.setBorrowRate(marketParams.id(), newBorrowRate);
+        assertEq(fixedRateIrm.borrowRate(marketParams, market), newBorrowRate);
+    }
+
+    function testBorrowRateRateNotSet(MarketParams memory marketParams, Market memory market) external {
+        vm.expectRevert(bytes(RATE_NOT_SET));
+        fixedRateIrm.borrowRate(marketParams, market);
+    }
+
+    function testBorrowRateView(MarketParams memory marketParams, Market memory market, uint256 newBorrowRate)
+        external
+    {
+        vm.assume(newBorrowRate != 0);
+        fixedRateIrm.setBorrowRate(marketParams.id(), newBorrowRate);
+        assertEq(fixedRateIrm.borrowRateView(marketParams, market), newBorrowRate);
+    }
+
+    function testBorrowRateViewRateNotSet(MarketParams memory marketParams, Market memory market) external {
+        vm.expectRevert(bytes(RATE_NOT_SET));
+        fixedRateIrm.borrowRateView(marketParams, market);
+    }
+}

test/forge/UtilsLibTest.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import "../../src/libraries/UtilsLib.sol";
+import "../../src/adaptive-curve-irm/libraries/UtilsLib.sol";
 
 import "../../lib/forge-std/src/Test.sol";