feat: isSettlementAllowedWithDetails() and getVaultWithDetails()

contracts/core/Controller.sol

@@ -542,7 +542,7 @@ contract Controller is Initializable, OwnableUpgradeSafe, ReentrancyGuardUpgrade
      * @param _expiry otoken expiry timestamp
      * @return True if the oToken has expired AND all oracle prices at the expiry timestamp have been finalized, False if not
      */
-    function isSettlementAllowed(
+    function isSettlementAllowedWithDetails(
         address _underlying,
         address _strike,
         address _collateral,
@@ -555,6 +555,27 @@ contract Controller is Initializable, OwnableUpgradeSafe, ReentrancyGuardUpgrade
         return isUnderlyingFinalized && isStrikeFinalized && isCollateralFinalized;
     }
 
+    /**
+     * @dev return if an expired oToken contract’s settlement price has been finalized
+     * @param _otoken address of the oToken
+     * @return True if the oToken has expired AND all oracle prices at the expiry timestamp have been finalized, False if not
+     */
+    function isSettlementAllowed(address _otoken) public view returns (bool) {
+        OtokenInterface otoken = OtokenInterface(_otoken);
+
+        address underlying = otoken.underlyingAsset();
+        address strike = otoken.strikeAsset();
+        address collateral = otoken.collateralAsset();
+
+        uint256 expiry = otoken.expiryTimestamp();
+
+        bool isUnderlyingFinalized = oracle.isDisputePeriodOver(underlying, expiry);
+        bool isStrikeFinalized = oracle.isDisputePeriodOver(strike, expiry);
+        bool isCollateralFinalized = oracle.isDisputePeriodOver(collateral, expiry);
+
+        return isUnderlyingFinalized && isStrikeFinalized && isCollateralFinalized;
+    }
+
     /**
      * @notice get the number of vaults for a specified account owner
      * @param _accountOwner account owner address
@@ -878,7 +899,7 @@ contract Controller is Initializable, OwnableUpgradeSafe, ReentrancyGuardUpgrade
         // only allow redeeming expired otoken
         require(now >= expiry, "CO28");
 
-        require(isSettlementAllowed(underlying, strike, collateral, expiry), "CO29");
+        require(isSettlementAllowedWithDetails(underlying, strike, collateral, expiry), "CO29");
 
         uint256 payout = getPayout(_args.otoken, _args.amount);
 
@@ -925,7 +946,7 @@ contract Controller is Initializable, OwnableUpgradeSafe, ReentrancyGuardUpgrade
 
         // do not allow settling vault with un-expired otoken
         require(now >= expiry, "CO31");
-        require(isSettlementAllowed(underlying, strike, collateral, expiry), "CO29");
+        require(isSettlementAllowedWithDetails(underlying, strike, collateral, expiry), "CO29");
 
         (uint256 payout, bool isValidVault) = calculator.getExcessCollateral(vault, typeVault);
 

docs/contracts-documentation/core/Controller.md

@@ -56,7 +56,7 @@ Contract that controls the Gamma Protocol and the interaction of all sub contrac
 
 - `getPayout(address _otoken, uint256 _amount) (public)`
 
-- `isSettlementAllowed(address _underlying, address _strike, address _collateral, uint256 _expiry) (public)`
+- `isSettlementAllowedWithDetails(address _underlying, address _strike, address _collateral, uint256 _expiry) (public)`
 
 - `getAccountVaultCounter(address _accountOwner) (external)`
 
@@ -376,7 +376,7 @@ get an oToken's payout/cash value after expiry, in the collateral asset
 
 - amount of collateral to pay out
 
-### Function `isSettlementAllowed(address _underlying, address _strike, address _collateral, uint256 _expiry) → bool public`
+### Function `isSettlementAllowedWithDetails(address _underlying, address _strike, address _collateral, uint256 _expiry) → bool public`
 
 return if an expired oToken is ready to be settled, only true when price for underlying,
 

test/unit-tests/controller.test.ts

@@ -3770,7 +3770,7 @@ contract(
 
         const expectedResutl = false
         assert.equal(
-          await controllerProxy.isSettlementAllowed(underlying, strike, collateral, expiryTimestamp),
+          await controllerProxy.isSettlementAllowedWithDetails(underlying, strike, collateral, expiryTimestamp),
           expectedResutl,
           'Price is not finalized because dispute period is not over yet',
         )
@@ -3802,7 +3802,7 @@ contract(
 
         const expectedResutl = true
         assert.equal(
-          await controllerProxy.isSettlementAllowed(underlying, strike, collateral, expiryTimestamp),
+          await controllerProxy.isSettlementAllowedWithDetails(underlying, strike, collateral, expiryTimestamp),
           expectedResutl,
           'Price is not finalized',
         )