feature: show debt and payout (#16)

* removing revert on not expired token to allow querying before exercise window

* showing debt and payout even if not yet expired

* snapshot

* fixing test

* removing commented out code

* reventing option from being exercised prior to expiry

* snapshot

Author: dsshap

.gas-snapshot

@@ -41,7 +41,7 @@ ChainlinkOracleInternalTests:testDecimalConversion0Decimals() (gas: 628)
 ChainlinkOracleInternalTests:testDecimalConversionDiffDecimals() (gas: 2138)
 ChainlinkOracleInternalTests:testDecimalConversionDiffDecimals2() (gas: 2046)
 ChainlinkOracleInternalTests:testDecimalConversionDiffDecimals3() (gas: 2046)
-ChainlinkOracleInternalTests:testDecimalConversionDiffDecimalsFuzz(uint8,uint8) (runs: 256, μ: 5264, ~: 5271)
+ChainlinkOracleInternalTests:testDecimalConversionDiffDecimalsFuzz(uint8,uint8) (runs: 256, μ: 5260, ~: 5271)
 ChainlinkOracleInternalTests:testDecimalConversionNormalDecimals() (gas: 808)
 ChainlinkOracleTest:testCannotGetSpotWhenAggregatorIsNotSet() (gas: 23300)
 ChainlinkOracleTest:testCannotGetSpotWhenAggregatorIsStale() (gas: 41702)
@@ -68,6 +68,7 @@ DecimalMathTest:testConversionScaleUp() (gas: 7854)
 DecimalMathTest:testMul(uint256,uint256) (runs: 256, μ: 8980, ~: 8980)
 DecimalMathTest:testMulOverflowInUncheck() (gas: 8345)
 Deploy:testChill() (gas: 120)
+Deploy:testChill() (gas: 98)
 Deploy:testUtils() (gas: 143)
 MockEngineV2:test() (gas: 162)
 MockOracle:test() (gas: 186)
@@ -96,10 +97,10 @@ PomaceAccessTest:testCannotUpdateRandomAccount() (gas: 23686)
 PomaceAccessTest:testForgeCoverageIgnoreThis() (gas: 208)
 PomaceAccessTest:testGranteeCanRevokeAccess() (gas: 35761)
 PomaceAccessTest:testUtils() (gas: 167)
-PomacePayoutTest:testCanGetBatchPayout() (gas: 107755)
-PomacePayoutTest:testCannotGetPayoutBeforeExpiry() (gas: 59845)
-PomacePayoutTest:testPayoutETHCollatCall() (gas: 64682)
-PomacePayoutTest:testPayoutUSDCollatPut() (gas: 64732)
+PomacePayoutTest:testCanGetBatchPayout() (gas: 107693)
+PomacePayoutTest:testCanGetPayoutBeforeExpiry() (gas: 61682)
+PomacePayoutTest:testPayoutETHCollatCall() (gas: 64651)
+PomacePayoutTest:testPayoutUSDCollatPut() (gas: 64701)
 PomacePayoutTest:testUtils() (gas: 144)
 PomaceProxyTest:testCanUpgradeToAnotherUUPSContract() (gas: 753600)
 PomaceProxyTest:testCannotUpgradeFromNonOwner() (gas: 16122)
@@ -114,16 +115,17 @@ PomaceRegistry:testRegisterAssetFromId1() (gas: 88175)
 PomaceRegistry:testRegisterAssetRecordDecimals() (gas: 88287)
 PomaceRegistry:testReturnAssetsFromProductId() (gas: 100852)
 PomaceRegistry:testReturnOptionDetailsFromTokenId() (gas: 97228)
-PomaceSettlementPriceDeductionTest:testSettleCallWithNonUnderlyingNorStrike() (gas: 1081068)
-PomaceSettlementPriceDeductionTest:testSettlePutWithNonUnderlyingNorStrike() (gas: 1033721)
+PomaceSettlementPriceDeductionTest:testSettleCallWithNonUnderlyingNorStrike() (gas: 1081113)
+PomaceSettlementPriceDeductionTest:testSettlePutWithNonUnderlyingNorStrike() (gas: 1033766)
 PomaceSettlementPriceDeductionTest:testUtils() (gas: 144)
-PomaceSettlementTest:testBatchSettleSameCollat() (gas: 186951)
+PomaceSettlementTest:testBatchSettleSameCollat() (gas: 186979)
 PomaceSettlementTest:testCannotMintExpiredOption() (gas: 25295)
 PomaceSettlementTest:testCannotMintOptionZeroExerciseWindow() (gas: 22640)
 PomaceSettlementTest:testCannotPassInInconsistentArray() (gas: 20608)
-PomaceSettlementTest:testSettleDiffCollat() (gas: 179373)
-PomaceSettlementTest:testSettleETHCollatCall() (gas: 127028)
-PomaceSettlementTest:testSettleUSDCollatPut() (gas: 138304)
+PomaceSettlementTest:testCannotSettleOptionBeforeExpiry() (gas: 67620)
+PomaceSettlementTest:testSettleDiffCollat() (gas: 179396)
+PomaceSettlementTest:testSettleETHCollatCall() (gas: 127042)
+PomaceSettlementTest:testSettleUSDCollatPut() (gas: 138316)
 PomaceSettlementTest:testUtils() (gas: 189)
 PomaceSettlementTestBase:testUtils() (gas: 144)
 ProductIdUtilTest:testFormatAndParseAreMirrored(uint8,uint8,uint8,uint8) (runs: 256, μ: 1025, ~: 1025)

src/core/Pomace.sol

@@ -401,6 +401,9 @@ contract Pomace is OwnableUpgradeable, ReentrancyGuardUpgradeable, UUPSUpgradeab
         internal
         returns (Balance memory, Balance memory)
     {
+        (,, uint64 expiry,,) = TokenIdUtil.parseTokenId(_tokenId);
+        if (block.timestamp < expiry) revert PM_NotExpired();
+
         (address engine_, uint8 debtId, uint256 debt, uint8 payoutId, uint256 payout) =
             getDebtAndPayout(_tokenId, _amount.toUint64());
 
@@ -461,8 +464,6 @@ contract Pomace is OwnableUpgradeable, ReentrancyGuardUpgradeable, UUPSUpgradeab
         (TokenType tokenType, uint32 productId, uint64 expiry, uint64 strikePrice, uint64 exerciseWindow) =
             TokenIdUtil.parseTokenId(_tokenId);
 
-        if (block.timestamp < expiry) revert PM_NotExpired();
-
         if (block.timestamp > expiry + exerciseWindow) return (address(0), 0, 0, 0, 0);
 
         (uint8 engineId, uint8 underlyingId, uint8 strikeId, uint8 collateralId) = productId.parseProductId();
@@ -551,8 +552,12 @@ contract Pomace is OwnableUpgradeable, ReentrancyGuardUpgradeable, UUPSUpgradeab
      * @param _expiry expiry timestamp
      */
     function _getSettlementPrice(address _base, address _quote, uint256 _expiry) internal view returns (uint256) {
-        (uint256 price, bool isFinalized) = oracle.getPriceAtExpiry(_base, _quote, _expiry);
-        if (!isFinalized) revert PM_PriceNotFinalized();
-        return price;
+        if (_expiry > block.timestamp) {
+            return oracle.getSpotPrice(_base, _quote);
+        } else {
+            (uint256 price, bool isFinalized) = oracle.getPriceAtExpiry(_base, _quote, _expiry);
+            if (!isFinalized) revert PM_PriceNotFinalized();
+            return price;
+        }
     }
 }

test/integration-tests/PomacePayoutTest.t.sol

@@ -11,11 +11,17 @@ import "../../src/config/constants.sol";
  * @dev test getDebtAndPayout function on different token types
  */
 contract PomacePayoutTest is EngineIntegrationFixture {
-    function testCannotGetPayoutBeforeExpiry() public {
-        uint256 tokenId = _mintCallOption(2000 * 1e6, usdcCollatProductId, 1 * UNIT);
+    function testCanGetPayoutBeforeExpiry() public {
+        uint256 tokenId = _mintCallOption(2000 * 1e6, wethCollatProductId, 1 * UNIT);
 
-        vm.expectRevert(PM_NotExpired.selector);
-        pomace.getDebtAndPayout(tokenId, uint64(1 * UNIT));
+        (address engine, uint8 debtId, uint256 debt, uint8 payoutId, uint256 payout) =
+            pomace.getDebtAndPayout(tokenId, uint64(1 * UNIT));
+
+        assertEq(engine, address(engine));
+        assertEq(debtId, usdcId);
+        assertEq(debt, 2000 * 1e6);
+        assertEq(payoutId, wethId);
+        assertEq(payout, 1 * 1e18);
     }
 
     function testPayoutETHCollatCall() public {

test/integration-tests/PomaceSettlement.t.sol

@@ -35,9 +35,18 @@ contract PomaceSettlementTestBase is EngineIntegrationFixture {
 }
 
 /**
- * @dev test getPayout function on different token types
+ * @dev test settle option function on different token types
  */
 contract PomaceSettlementTest is PomaceSettlementTestBase {
+    function testCannotSettleOptionBeforeExpiry() public {
+        uint256 tokenId = _mintCallOption(2000 * 1e6, wethCollatProductId, 1 * UNIT);
+
+        vm.warp(expiry - 1);
+
+        vm.expectRevert(PM_NotExpired.selector);
+        pomace.settleOption(address(this), tokenId, 1 * UNIT);
+    }
+
     function testSettleETHCollatCall() public {
         uint256 tokenId = _mintCallOption(2000 * 1e6, wethCollatProductId, 1 * UNIT);