Define custom errors for the checks

The ERC4626 already uses custom errors, so it would be nice to have them here for consistency.
thesis · Dec 12, 2023 · 331c1d3 · 331c1d3
1 parent 7516de4
commit 331c1d3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 26 deletions.
diff --git a/core/contracts/Acre.sol b/core/contracts/Acre.sol
@@ -31,6 +31,9 @@ contract Acre is ERC4626, Ownable {
         uint256 maximumTotalAssets
     );
 
+    error StakingAmountLessThanMin(uint256 amount, uint256 min);
+    error InvalidStakingParameter();
+
     constructor(
         IERC20 tbtc
     ) ERC4626(tbtc) ERC20("Acre Staked Bitcoin", "stBTC") Ownable(msg.sender) {
@@ -52,15 +55,9 @@ contract Acre is ERC4626, Ownable {
         uint256 maximumTotalAssets
     ) external onlyOwner {
         // TODO: Introduce a parameters update process.
-        require(
-            minimumDepositAmount > 0,
-            "Minimum deposit amount must be greater than zero"
-        );
-
-        require(
-            maximumTotalAssets > 0,
-            "Maximum total assets amount must be greater than zero"
-        );
+        if (minimumDepositAmount <= 0 || maximumTotalAssets <= 0) {
+            revert InvalidStakingParameter();
+        }
 
         stakingParameters.minimumDepositAmount = minimumDepositAmount;
         stakingParameters.maximumTotalAssets = maximumTotalAssets;
@@ -72,10 +69,12 @@ contract Acre is ERC4626, Ownable {
         uint256 assets,
         address receiver
     ) public override returns (uint256) {
-        require(
-            assets >= stakingParameters.minimumDepositAmount,
-            "Amount is less than minimum"
-        );
+        if (assets < stakingParameters.minimumDepositAmount) {
+            revert StakingAmountLessThanMin(
+                assets,
+                stakingParameters.minimumDepositAmount
+            );
+        }
 
         return super.deposit(assets, receiver);
     }
@@ -84,10 +83,14 @@ contract Acre is ERC4626, Ownable {
         uint256 shares,
         address receiver
     ) public override returns (uint256) {
-        require(
-            previewMint(shares) >= stakingParameters.minimumDepositAmount,
-            "Amount is less than minimum"
-        );
+        uint256 assets = previewMint(shares);
+
+        if (assets < stakingParameters.minimumDepositAmount) {
+            revert StakingAmountLessThanMin(
+                assets,
+                stakingParameters.minimumDepositAmount
+            );
+        }
 
         return super.mint(shares, receiver);
     }

diff --git a/core/test/Acre.test.ts b/core/test/Acre.test.ts
@@ -167,7 +167,7 @@ describe("Acre", () => {
             acre
               .connect(staker1)
               .stake(amountToStake, staker1.address, referral),
-          ).to.revertedWith("Amount is less than minimum")
+          ).to.revertedWithCustomError(acre, "StakingAmountLessThanMin")
         })
       })
 
@@ -188,7 +188,7 @@ describe("Acre", () => {
             acre
               .connect(staker1)
               .stake(amountToStake, staker1.address, referral),
-          ).to.revertedWith("Amount is less than minimum")
+          ).to.revertedWithCustomError(acre, "StakingAmountLessThanMin")
         })
       })
 
@@ -534,7 +534,7 @@ describe("Acre", () => {
         it("should take into account the min deposit amount parameter and revert", async () => {
           await expect(
             acre.connect(staker1).mint(sharesToMint, staker1.address),
-          ).to.be.revertedWith("Amount is less than minimum")
+          ).to.be.revertedWithCustomError(acre, "StakingAmountLessThanMin")
         })
       },
     )
@@ -596,9 +596,7 @@ describe("Acre", () => {
                   minimumDepositAmount,
                   validMaximumTotalAssetsAmount,
                 ),
-            ).to.be.revertedWith(
-              "Minimum deposit amount must be greater than zero",
-            )
+            ).to.be.revertedWithCustomError(acre, "InvalidStakingParameter")
           })
         })
       })
@@ -615,9 +613,7 @@ describe("Acre", () => {
                   validMinimumDepositAmount,
                   maximumTotalAssets,
                 ),
-            ).to.be.revertedWith(
-              "Maximum total assets amount must be greater than zero",
-            )
+            ).to.be.revertedWithCustomError(acre, "InvalidStakingParameter")
           })
         })
       })