refactor: remove and inline calculatePremiumPerYear

NexusMutual · Dec 2, 2024 · 444f58e · 444f58e
1 parent 43aeb12
commit 444f58e
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 156 deletions.
diff --git a/contracts/interfaces/IStakingProducts.sol b/contracts/interfaces/IStakingProducts.sol
@@ -77,25 +77,13 @@ interface IStakingProducts {
     StakedProduct memory product,
     uint period,
     uint coverAmount,
-    uint initialCapacityUsed,
     uint totalCapacity,
     uint targetPrice,
     uint currentBlockTimestamp,
     uint nxmPerAllocationUnit,
-    uint allocationUnitsPerNxm,
     uint targetPriceDenominator
   ) external pure returns (uint premium, StakedProduct memory);
 
-  function calculatePremiumPerYear(
-    uint basePrice,
-    uint coverAmount,
-    uint initialCapacityUsed,
-    uint totalCapacity,
-    uint nxmPerAllocationUnit,
-    uint allocationUnitsPerNxm,
-    uint targetPriceDenominator
-  ) external pure returns (uint);
-
   /* ========== STAKING POOL CREATION ========== */
 
   function stakingPool(uint poolId) external view returns (IStakingPool);

diff --git a/contracts/mocks/generic/StakingProductsGeneric.sol b/contracts/mocks/generic/StakingProductsGeneric.sol
@@ -40,11 +40,7 @@ contract StakingProductsGeneric is IStakingProducts {
     revert("Unsupported");
   }
 
-  function calculatePremium(StakedProduct memory, uint, uint, uint, uint, uint, uint, uint, uint, uint) public virtual pure returns (uint, StakedProduct memory) {
-    revert("Unsupported");
-  }
-
-  function calculatePremiumPerYear(uint, uint, uint, uint, uint, uint, uint) public virtual pure returns (uint) {
+  function calculatePremium(StakedProduct memory, uint, uint, uint, uint, uint, uint, uint) public virtual pure returns (uint, StakedProduct memory) {
     revert("Unsupported");
   }
 

diff --git a/contracts/mocks/modules/StakingPool/SKMockStakingProducts.sol b/contracts/mocks/modules/StakingPool/SKMockStakingProducts.sol
@@ -319,12 +319,12 @@ contract SKMockStakingProducts is StakingProductsGeneric, MasterAwareV2, Multica
     uint productId,
     uint period,
     uint coverAmount,
-    uint initialCapacityUsed,
+    uint /*initialCapacityUsed*/,   // TODO: deprecated 
     uint totalCapacity,
     uint globalMinPrice,
     bool useFixedPrice,
     uint nxmPerAllocationUnit,
-    uint allocationUnitsPerNXM
+    uint /*allocationUnitsPerNXM*/  // TODO: deprecated
   ) public override returns (uint premium) {
 
     StakedProduct memory product = _products[poolId][productId];
@@ -338,12 +338,10 @@ contract SKMockStakingProducts is StakingProductsGeneric, MasterAwareV2, Multica
       product,
       period,
       coverAmount,
-      initialCapacityUsed,
       totalCapacity,
       targetPrice,
       block.timestamp,
       nxmPerAllocationUnit,
-      allocationUnitsPerNXM,
       TARGET_PRICE_DENOMINATOR
     );
 
@@ -374,12 +372,10 @@ contract SKMockStakingProducts is StakingProductsGeneric, MasterAwareV2, Multica
     StakedProduct memory product,
     uint period,
     uint coverAmount,
-    uint initialCapacityUsed,
     uint totalCapacity,
     uint targetPrice,
     uint currentBlockTimestamp,
     uint nxmPerAllocationUnit,
-    uint allocationUnitsPerNxm,
     uint targetPriceDenominator
   ) public override pure returns (uint premium, StakedProduct memory) {
 
@@ -401,36 +397,14 @@ contract SKMockStakingProducts is StakingProductsGeneric, MasterAwareV2, Multica
     product.bumpedPrice = (basePrice + priceBump).toUint96();
     product.bumpedPriceUpdateTime = uint32(currentBlockTimestamp);
 
-    // use calculated base price and apply surge pricing if applicable
-    uint premiumPerYear = calculatePremiumPerYear(
-      basePrice,
-      coverAmount,
-      initialCapacityUsed,
-      totalCapacity,
-      nxmPerAllocationUnit,
-      allocationUnitsPerNxm,
-      targetPriceDenominator
-    );
+    // cover amount has 2 decimals (100 = 1 unit)
+    // scale coverAmount to 18 decimals and apply price percentage
+    uint premiumPerYear = coverAmount * nxmPerAllocationUnit * basePrice / targetPriceDenominator;
 
     // calculate the premium for the requested period
     return (premiumPerYear * period / 365 days, product);
   }
 
-  function calculatePremiumPerYear(
-    uint basePrice,
-    uint coverAmount,
-    uint /*initialCapacityUsed*/, //TODO: depricated
-    uint /*totalCapacity*/,  // TODO: depricated
-    uint nxmPerAllocationUnit,
-    uint /*allocationUnitsPerNxm*/, // TODO: depricated
-    uint targetPriceDenominator
-  ) public override pure returns (uint) {
-    // cover amount has 2 decimals (100 = 1 unit)
-    // scale coverAmount to 18 decimals and apply price percentage
-    uint premium = coverAmount * nxmPerAllocationUnit * basePrice / targetPriceDenominator;
-    return premium;
-  }
-
   /* dependencies */
 
   function changeDependentContractAddress() external {

diff --git a/contracts/modules/staking/StakingProducts.sol b/contracts/modules/staking/StakingProducts.sol
@@ -369,12 +369,12 @@ contract StakingProducts is IStakingProducts, MasterAwareV2, Multicall {
     uint productId,
     uint period,
     uint coverAmount,
-    uint initialCapacityUsed,
+    uint /*initialCapacityUsed*/,   // TODO: deprecated
     uint totalCapacity,
     uint globalMinPrice,
     bool useFixedPrice,
     uint nxmPerAllocationUnit,
-    uint allocationUnitsPerNXM
+    uint /*allocationUnitsPerNXM*/  // TODO: deprecated
   ) public returns (uint premium) {
 
     if (msg.sender != StakingPoolLibrary.getAddress(stakingPoolFactory, poolId)) {
@@ -392,12 +392,10 @@ contract StakingProducts is IStakingProducts, MasterAwareV2, Multicall {
       product,
       period,
       coverAmount,
-      initialCapacityUsed,
       totalCapacity,
       targetPrice,
       block.timestamp,
       nxmPerAllocationUnit,
-      allocationUnitsPerNXM,
       TARGET_PRICE_DENOMINATOR
     );
 
@@ -446,12 +444,10 @@ contract StakingProducts is IStakingProducts, MasterAwareV2, Multicall {
     StakedProduct memory product,
     uint period,
     uint coverAmount,
-    uint initialCapacityUsed,
     uint totalCapacity,
     uint targetPrice,
     uint currentBlockTimestamp,
     uint nxmPerAllocationUnit,
-    uint allocationUnitsPerNxm,
     uint targetPriceDenominator
   ) public pure returns (uint premium, StakedProduct memory) {
 
@@ -470,36 +466,14 @@ contract StakingProducts is IStakingProducts, MasterAwareV2, Multicall {
     product.bumpedPrice = (basePrice + priceBump).toUint96();
     product.bumpedPriceUpdateTime = uint32(currentBlockTimestamp);
 
-    // use calculated base price and apply surge pricing if applicable
-    uint premiumPerYear = calculatePremiumPerYear(
-      basePrice,
-      coverAmount,
-      initialCapacityUsed,
-      totalCapacity,
-      nxmPerAllocationUnit,
-      allocationUnitsPerNxm,
-      targetPriceDenominator
-    );
+    // cover amount has 2 decimals (100 = 1 unit)
+    // scale coverAmount to 18 decimals and apply price percentage
+    uint premiumPerYear = coverAmount * nxmPerAllocationUnit * basePrice / targetPriceDenominator;
 
     // calculate the premium for the requested period
     return (premiumPerYear * period / 365 days, product);
   }
 
-  function calculatePremiumPerYear(
-    uint basePrice,
-    uint coverAmount,
-    uint /*initialCapacityUsed*/, // TODO: depricated
-    uint /*totalCapacity*/, // TODO: depricated
-    uint nxmPerAllocationUnit,
-    uint /*allocationUnitsPerNxm*/, // TODO: depricated
-    uint targetPriceDenominator
-  ) public pure returns (uint) {
-    // cover amount has 2 decimals (100 = 1 unit)
-    // scale coverAmount to 18 decimals and apply price percentage
-    uint premium = coverAmount * nxmPerAllocationUnit * basePrice / targetPriceDenominator;
-    return premium;
-  }
-
   /* ========== STAKING POOL CREATION ========== */
 
   function stakingPool(uint poolId) public view returns (IStakingPool) {