feat/custodian settlement flow adjustment

.gas-snapshot

@@ -1,5 +1,3 @@
-DiffFuzzTestStarportLib:testSpentToReceived((uint8,address,uint256,uint256)[]) (runs: 256, μ: 880420, ~: 883377)
-DiffFuzzTestStarportLib:testUnboundSpentToReceived((uint8,address,uint256,uint256)[]) (runs: 256, μ: 232899, ~: 237832)
 IntegrationTestCaveats:testOriginateUnapprovedFulfiller() (gas: 341293)
 IntegrationTestCaveats:testOriginateWBorrowerApproval() (gas: 298091)
 IntegrationTestCaveats:testOriginateWCaveats() (gas: 272268)
@@ -15,30 +13,36 @@ IntegrationTestCaveats:testRefinanceWCaveatsInvalidSalt() (gas: 381151)
 IntegrationTestCaveats:testRefinanceWLenderApproval() (gas: 405713)
 PausableNonReentrantImpl:test() (gas: 2442)
 PausableNonReentrantImpl:testReentrancy() (gas: 2735)
-TestAstariaV1Loan:testNewLoanERC721CollateralDefaultTermsRecallBase() (gas: 1024388)
-TestAstariaV1Loan:testNewLoanERC721CollateralDefaultTermsRecallLender() (gas: 708447)
-TestAstariaV1Loan:testNewLoanERC721CollateralDefaultTermsRecallLiquidation() (gas: 747164)
-TestAstariaV1Settlement:testGetAuctionStart() (gas: 433653)
-TestAstariaV1Settlement:testGetAuctionStartNotStarted() (gas: 433226)
-TestAstariaV1Settlement:testGetCurrentAuctionPrice() (gas: 448508)
-TestAstariaV1Settlement:testGetCurrentAuctionPriceNoAuction() (gas: 436857)
-TestAstariaV1Settlement:testGetSettlementDutchAuctionSettlementAbove() (gas: 490478)
-TestAstariaV1Settlement:testGetSettlementFailedDutchAuction() (gas: 448831)
-TestAstariaV1Settlement:testGetSettlementLoanNotRecalled() (gas: 439333)
-TestAstariaV1Settlement:testV1SettlementHandlerExecute() (gas: 419840)
-TestAstariaV1Settlement:testV1SettlementHandlerValidate() (gas: 419952)
-TestAstariaV1Settlement:testV1SettlementHandlerValidateInvalidHandler() (gas: 420076)
-TestAstariaV1Status:testCannotRecallTwice() (gas: 580716)
-TestAstariaV1Status:testCannotWithdrawLoanHasNotBeenRefinanced() (gas: 425689)
-TestAstariaV1Status:testCannotWithdrawWithdrawDoesNotExist() (gas: 432118)
-TestAstariaV1Status:testGenerateRecallConsideration() (gas: 481554)
-TestAstariaV1Status:testInvalidRecallInvalidStakeType() (gas: 507879)
-TestAstariaV1Status:testInvalidRecallLoanDoesNotExist() (gas: 523886)
-TestAstariaV1Status:testIsActive() (gas: 432838)
-TestAstariaV1Status:testIsRecalledInsideWindow() (gas: 571509)
-TestAstariaV1Status:testIsRecalledOutsideWindow() (gas: 569410)
-TestAstariaV1Status:testRecallRateActiveRecall() (gas: 557048)
-TestAstariaV1Status:testRecallRateEmptyRecall() (gas: 430492)
+TestAstariaV1Loan:testNewLoanERC721CollateralDefaultTermsRecallBase() (gas: 1021044)
+TestAstariaV1Loan:testNewLoanERC721CollateralDefaultTermsRecallLender() (gas: 727567)
+TestAstariaV1Loan:testNewLoanERC721CollateralDefaultTermsRecallLiquidation() (gas: 1404892)
+TestAstariaV1Pricing:testGetRefiannceConsiderationValidEqualRate() (gas: 146135)
+TestAstariaV1Pricing:testGetRefiannceConsiderationValidHigherRate() (gas: 158343)
+TestAstariaV1Pricing:testGetRefiannceConsiderationValidLowerRate() (gas: 153372)
+TestAstariaV1Pricing:testGetRefinanceConsiderationAsBorrowerZeroRate() (gas: 81159)
+TestAstariaV1Pricing:testGetRefinanceConsiderationInsufficientRefinance() (gas: 108010)
+TestAstariaV1Pricing:testGetRefinanceConsiderationInvalidRefinance() (gas: 88264)
+TestAstariaV1Pricing:testGetRefinanceConsiderationZeroRate() (gas: 138753)
+TestAstariaV1Settlement:testGetAuctionStart() (gas: 433631)
+TestAstariaV1Settlement:testGetAuctionStartNotStarted() (gas: 433204)
+TestAstariaV1Settlement:testGetCurrentAuctionPrice() (gas: 448460)
+TestAstariaV1Settlement:testGetCurrentAuctionPriceNoAuction() (gas: 436835)
+TestAstariaV1Settlement:testGetSettlementDutchAuctionSettlementAbove() (gas: 490360)
+TestAstariaV1Settlement:testGetSettlementFailedDutchAuction() (gas: 448783)
+TestAstariaV1Settlement:testGetSettlementLoanNotRecalled() (gas: 439311)
+TestAstariaV1Settlement:testV1SettlementHandlerValidate() (gas: 419948)
+TestAstariaV1Settlement:testV1SettlementHandlerValidateInvalidHandler() (gas: 420072)
+TestAstariaV1Status:testCannotRecallTwice() (gas: 580032)
+TestAstariaV1Status:testCannotWithdrawLoanHasNotBeenRefinanced() (gas: 425604)
+TestAstariaV1Status:testCannotWithdrawWithdrawDoesNotExist() (gas: 432033)
+TestAstariaV1Status:testGenerateRecallConsideration() (gas: 481274)
+TestAstariaV1Status:testInvalidRecallInvalidStakeType() (gas: 507301)
+TestAstariaV1Status:testInvalidRecallLoanDoesNotExist() (gas: 523544)
+TestAstariaV1Status:testIsActive() (gas: 432647)
+TestAstariaV1Status:testIsRecalledInsideWindow() (gas: 570785)
+TestAstariaV1Status:testIsRecalledOutsideWindow() (gas: 568686)
+TestAstariaV1Status:testRecallRateActiveRecall() (gas: 556515)
+TestAstariaV1Status:testRecallRateEmptyRecall() (gas: 430301)
 TestBorrowerEnforcer:testBERevertAdditionalTransfers() (gas: 73195)
 TestBorrowerEnforcer:testBERevertInvalidLoanTerms() (gas: 78316)
 TestBorrowerEnforcer:testBEValidLoanTerms() (gas: 69518)
@@ -50,20 +54,20 @@ TestCompoundInterest:testRateTooLowZero() (gas: 68419)
 TestCustodian:testCannotLazyMintTwice() (gas: 76686)
 TestCustodian:testCannotMintInvalidLoanInvalidCustodian() (gas: 66861)
 TestCustodian:testCannotMintInvalidLoanValidCustodian() (gas: 72489)
-TestCustodian:testCustodySelector() (gas: 2728398)
+TestCustodian:testCustodySelector() (gas: 2721382)
 TestCustodian:testDefaultCustodySelectorRevert() (gas: 70083)
-TestCustodian:testGenerateOrderInvalidHandlerExecution() (gas: 133050)
-TestCustodian:testGenerateOrderRepay() (gas: 171915)
-TestCustodian:testGenerateOrderRepayAsRepayApprovedBorrower() (gas: 197518)
-TestCustodian:testGenerateOrderRepayERC1155AndERC20AndNative() (gas: 833690)
-TestCustodian:testGenerateOrderRepayERC1155AndERC20AndNativeHandlerAuthorized() (gas: 757868)
-TestCustodian:testGenerateOrderRepayERC1155WithRevert() (gas: 516666)
+TestCustodian:testGenerateOrderInvalidHandlerExecution() (gas: 158631)
+TestCustodian:testGenerateOrderRepay() (gas: 177918)
+TestCustodian:testGenerateOrderRepayAsRepayApprovedBorrower() (gas: 203521)
+TestCustodian:testGenerateOrderRepayERC1155AndERC20AndNative() (gas: 843195)
+TestCustodian:testGenerateOrderRepayERC1155AndERC20AndNativeHandlerAuthorized() (gas: 757730)
+TestCustodian:testGenerateOrderRepayERC1155WithRevert() (gas: 522668)
 TestCustodian:testGenerateOrderRepayInvalidHookAddress() (gas: 90335)
 TestCustodian:testGenerateOrderRepayInvalidHookReturnType() (gas: 84652)
 TestCustodian:testGenerateOrderRepayNotBorrower() (gas: 96426)
-TestCustodian:testGenerateOrderSettlement() (gas: 146907)
-TestCustodian:testGenerateOrderSettlementHandlerAuthorized() (gas: 155902)
-TestCustodian:testGenerateOrderSettlementNoActiveLoan() (gas: 155924)
+TestCustodian:testGenerateOrderSettlement() (gas: 150387)
+TestCustodian:testGenerateOrderSettlementHandlerAuthorized() (gas: 155833)
+TestCustodian:testGenerateOrderSettlementNoActiveLoan() (gas: 155836)
 TestCustodian:testGenerateOrderSettlementUnauthorized() (gas: 94410)
 TestCustodian:testGenerateOrdersWithLoanStartAtBlockTimestampInvalidLoan() (gas: 453017)
 TestCustodian:testGetBorrower() (gas: 76234)
@@ -75,11 +79,11 @@ TestCustodian:testNonPayableFunctions() (gas: 225792)
 TestCustodian:testOnlySeaport() (gas: 17895)
 TestCustodian:testPayableFunctions() (gas: 41667)
 TestCustodian:testPreviewOrderNoActiveLoan() (gas: 98786)
-TestCustodian:testPreviewOrderRepay() (gas: 227648)
-TestCustodian:testPreviewOrderSettlement() (gas: 178524)
+TestCustodian:testPreviewOrderRepay() (gas: 231173)
+TestCustodian:testPreviewOrderSettlement() (gas: 182004)
 TestCustodian:testPreviewOrderSettlementInvalidFufliller() (gas: 100823)
 TestCustodian:testPreviewOrderSettlementInvalidRepayer() (gas: 106856)
-TestCustodian:testRatifyOrder() (gas: 178410)
+TestCustodian:testRatifyOrder() (gas: 184413)
 TestCustodian:testSeaportMetadata() (gas: 8567)
 TestCustodian:testSetRepayApproval() (gas: 37861)
 TestCustodian:testSupportsInterface() (gas: 9450)
@@ -91,33 +95,31 @@ TestLenderEnforcer:testLERevertInvalidLoanTerms() (gas: 78341)
 TestLenderEnforcer:testLEValidLoanTerms() (gas: 69496)
 TestLenderEnforcer:testLEValidLoanTermsAnyBorrower() (gas: 69494)
 TestLenderEnforcer:testLEValidLoanTermsWithAdditionalTransfers() (gas: 70740)
-TestLoanCombinations:testLoan20For721SimpleInterestDutchFixedRepay() (gas: 537008)
-TestLoanCombinations:testLoan20for20SimpleInterestDutchFixedRepay() (gas: 524637)
-TestLoanCombinations:testLoan721for20SimpleInterestDutchFixedRepay() (gas: 554832)
-TestLoanCombinations:testLoanAstariaSettlementRepay() (gas: 544574)
-TestLoanCombinations:testLoanSimpleInterestEnglishFixed() (gas: 550050)
+TestLoanCombinations:testLoan20For721SimpleInterestDutchFixedRepay() (gas: 543033)
+TestLoanCombinations:testLoan20for20SimpleInterestDutchFixedRepay() (gas: 530662)
+TestLoanCombinations:testLoan721for20SimpleInterestDutchFixedRepay() (gas: 560856)
+TestLoanCombinations:testLoanAstariaSettlementRepay() (gas: 550598)
+TestLoanCombinations:testLoanSimpleInterestEnglishFixed() (gas: 561586)
 TestNewLoan:testBuyNowPayLater() (gas: 2832923)
 TestNewLoan:testNewLoanERC721CollateralDefaultTerms2() (gas: 394541)
 TestNewLoan:testNewLoanERC721CollateralLessDebtThanOffered() (gas: 2348)
 TestNewLoan:testNewLoanRefinanceNew() (gas: 207)
 TestNewLoan:testNewLoanViaOriginatorBorrowerApprovalAndLenderApproval() (gas: 305741)
 TestNewLoan:testNewLoanViaOriginatorLenderApproval() (gas: 358465)
-TestNewLoan:testSettleLoan() (gas: 608050)
+TestNewLoan:testSettleLoan() (gas: 611574)
 TestPausableNonReentrant:testNotOwner() (gas: 21254)
 TestPausableNonReentrant:testPauseAndUnpause() (gas: 22555)
 TestPausableNonReentrant:testReentrancy() (gas: 15360)
 TestPausableNonReentrant:testUnpauseWhenNotPaused() (gas: 12582)
-TestRefStarportLib:testSpentToReceived() (gas: 13315)
-TestRefStarportLib:testValidateSalt(address,bytes32) (runs: 256, μ: 33865, ~: 33865)
-TestRepayLoan:testRepayLoanApprovedRepayer() (gas: 629456)
-TestRepayLoan:testRepayLoanBase() (gas: 565750)
+TestRepayLoan:testRepayLoanApprovedRepayer() (gas: 635481)
+TestRepayLoan:testRepayLoanBase() (gas: 571775)
 TestRepayLoan:testRepayLoanGenerateOrderNotSeaport() (gas: 402462)
-TestRepayLoan:testRepayLoanInSettlement() (gas: 550056)
-TestRepayLoan:testRepayLoanInvalidRepayer() (gas: 564465)
-TestRepayLoan:testRepayLoanThatDoesNotExist() (gas: 837042)
-TestSimpleInterestPricing:test_calculateInterest() (gas: 808192)
-TestSimpleInterestPricing:test_getPaymentConsideration() (gas: 889476)
-TestSimpleInterestPricing:test_getRefinanceConsideration() (gas: 883676)
+TestRepayLoan:testRepayLoanInSettlement() (gas: 550078)
+TestRepayLoan:testRepayLoanInvalidRepayer() (gas: 564487)
+TestRepayLoan:testRepayLoanThatDoesNotExist() (gas: 843133)
+TestSimpleInterestPricing:test_calculateInterest() (gas: 800891)
+TestSimpleInterestPricing:test_getPaymentConsideration() (gas: 882219)
+TestSimpleInterestPricing:test_getRefinanceConsideration() (gas: 876412)
 TestStarport:testActive() (gas: 67100)
 TestStarport:testAdditionalTransfers() (gas: 295920)
 TestStarport:testCannotIssueSameLoanTwice() (gas: 336999)
@@ -149,8 +151,6 @@ TestStarport:testTokenURI() (gas: 65021)
 TestStarport:testTokenURIInvalidLoan() (gas: 13394)
 TestStarport:testTransferFromFail() (gas: 80066)
 TestStarport:testUnpause() (gas: 16309)
-TestStarportLib:testSpentToReceived() (gas: 13315)
-TestStarportLib:testValidateSalt(address,bytes32) (runs: 256, μ: 33865, ~: 33865)
 TestStrategistOriginator:testEncodeWithAccountCounter() (gas: 12307)
 TestStrategistOriginator:testGetStrategistData() (gas: 1471010)
 TestStrategistOriginator:testIncrementCounterAsStrategist() (gas: 18676)

.github/workflows/lint_test.yml

@@ -32,7 +32,7 @@ jobs:
         run: forge test -vvv
 
       - name: Snapshot
-        run: forge snapshot --check
+        run: forge snapshot --check --no-match-path '*fuzz*'
 
 
 

src/BNPLHelper.sol

@@ -15,7 +15,6 @@ import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
 import {Seaport} from "seaport/contracts/Seaport.sol";
 import {Starport} from "./Starport.sol";
 import {CaveatEnforcer} from "./enforcers/CaveatEnforcer.sol";
-import "forge-std/console.sol";
 
 interface IVault {
     function flashLoan(

src/Custodian.sol

@@ -34,7 +34,6 @@ import {Settlement} from "starport-core/settlement/Settlement.sol";
 import {Pricing} from "starport-core/pricing/Pricing.sol";
 import {Starport} from "starport-core/Starport.sol";
 import {StarportLib, Actions} from "starport-core/lib/StarportLib.sol";
-import "forge-std/console2.sol";
 
 contract Custodian is ERC721, ContractOffererInterface {
     using {StarportLib.getId} for Starport.Loan;
@@ -223,6 +222,7 @@ contract Custodian is ERC721, ContractOffererInterface {
             consideration = StarportLib.mergeSpentItemsToReceivedItems(payment, loan.issuer, carry, loan.originator);
 
             _settleLoan(loan);
+            _settlementExecute(loan, fulfiller);
         } else if (action == Actions.Settlement && !Status(loan.terms.status).isActive(loan)) {
             address authorized;
             //add in originator fee
@@ -237,18 +237,11 @@ contract Custodian is ERC721, ContractOffererInterface {
                 _setOfferApprovalsWithSeaport(offer);
             } else if (authorized == loan.terms.settlement || authorized == loan.issuer) {
                 _moveCollateralToAuthorized(loan.collateral, authorized);
-                _beforeSettlementHandlerHook(loan);
-                if (
-                    authorized == loan.terms.settlement
-                        && Settlement(loan.terms.settlement).execute(loan, fulfiller) != Settlement.execute.selector
-                ) {
-                    revert InvalidHandlerExecution();
-                }
-                _afterSettlementHandlerHook(loan);
             } else {
                 revert InvalidFulfiller();
             }
             _settleLoan(loan);
+            _settlementExecute(loan, fulfiller);
         } else {
             revert InvalidAction();
         }
@@ -401,6 +394,20 @@ contract Custodian is ERC721, ContractOffererInterface {
         }
     }
 
+    /**
+     * @dev settle the loan with the LoanManager
+     *
+     * @param loan              The the loan that is settled
+     * @param fulfiller      The address executing seaport
+     */
+    function _settlementExecute(Starport.Loan memory loan, address fulfiller) internal virtual {
+        _beforeSettlementHandlerHook(loan);
+        if (Settlement(loan.terms.settlement).execute(loan, fulfiller) != Settlement.execute.selector) {
+            revert InvalidHandlerExecution();
+        }
+        _afterSettlementHandlerHook(loan);
+    }
+
     /**
      * @dev settle the loan with the LoanManager
      *

src/enforcers/AstariaV1LenderEnforcer.sol

@@ -6,7 +6,6 @@ import {Starport} from "starport-core/Starport.sol";
 import {BasePricing} from "starport-core/pricing/BasePricing.sol";
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
 import {StarportLib} from "starport-core/lib/StarportLib.sol";
-import "forge-std/console2.sol";
 
 contract AstariaV1LenderEnforcer is LenderEnforcer {
     using FixedPointMathLib for uint256;

src/lib/RefStarportLib.sol

@@ -3,7 +3,6 @@ pragma solidity ^0.8.17;
 import {ItemType, ReceivedItem, SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 
 import {Starport} from "starport-core/Starport.sol";
-import "forge-std/console.sol";
 
 enum Actions {
     Nothing,

src/lib/StarportLib.sol

@@ -2,13 +2,12 @@ pragma solidity ^0.8.17;
 
 import {ItemType, ReceivedItem, SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Starport} from "starport-core/Starport.sol";
-import "forge-std/console.sol";
+
 import {ERC721} from "solady/src/tokens/ERC721.sol";
 import {ERC20} from "solady/src/tokens/ERC20.sol";
 import {ERC1155} from "solady/src/tokens/ERC1155.sol";
 import {SafeTransferLib} from "solady/src/utils/SafeTransferLib.sol";
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
-import "forge-std/console2.sol";
 
 enum Actions {
     Nothing,

src/pricing/AstariaV1Pricing.sol

@@ -21,7 +21,7 @@ contract AstariaV1Pricing is CompoundInterestPricing {
 
     error InsufficientRefinance();
 
-    function getRefinanceConsideration(Starport.Loan memory loan, bytes memory newPricingData, address fulfiller)
+    function getRefinanceConsideration(Starport.Loan memory loan, bytes calldata newPricingData, address fulfiller)
         external
         view
         virtual
@@ -35,19 +35,18 @@ contract AstariaV1Pricing is CompoundInterestPricing {
         // borrowers can refinance a loan at any time
         if (fulfiller != loan.borrower) {
             // check if a recall is occuring
-            AstariaV1Status hook = AstariaV1Status(loan.terms.status);
-            Details memory newDetails = abi.decode(newPricingData, (Details));
-            if (hook.isRecalled(loan)) {
-                uint256 rate = hook.getRecallRate(loan);
-                // offered loan did not meet the terms of the recall auction
-                if (newDetails.rate > rate) {
-                    revert InsufficientRefinance();
-                }
-            }
-            // recall is not occuring
-            else {
+            AstariaV1Status status = AstariaV1Status(loan.terms.status);
+
+            if (!status.isRecalled(loan)) {
                 revert InvalidRefinance();
             }
+            Details memory newDetails = abi.decode(newPricingData, (Details));
+            uint256 rate = status.getRecallRate(loan);
+            // offered loan did not meet the terms of the recall auction
+            if (newDetails.rate > rate) {
+                revert InsufficientRefinance();
+            }
+
             Details memory oldDetails = abi.decode(loan.terms.pricingData, (Details));
 
             uint256 proportion;
@@ -57,14 +56,14 @@ contract AstariaV1Pricing is CompoundInterestPricing {
             // recaller stake is refunded
             if (newDetails.rate > oldDetails.rate) {
                 proportion = 1e18;
-                (receiver,) = hook.recalls(loanId);
+                (receiver,) = status.recalls(loanId);
             } else {
                 // scenario where the recaller is penalized
                 // essentially the old lender and the new lender split the stake of the recaller
                 // split is proportional to the difference in rate
                 proportion = 1e18 - (oldDetails.rate - newDetails.rate).divWad(oldDetails.rate);
             }
-            recallConsideration = hook.generateRecallConsideration(loan, proportion, fulfiller, receiver);
+            recallConsideration = status.generateRecallConsideration(loan, proportion, fulfiller, receiver);
         }
 
         (repayConsideration, carryConsideration) = getPaymentConsideration(loan);

src/pricing/BasePricing.sol

@@ -25,7 +25,6 @@ import {Pricing} from "starport-core/pricing/Pricing.sol";
 import {ReceivedItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Status} from "starport-core/status/Status.sol";
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
-import "forge-std/console2.sol";
 
 import {BaseStatus} from "starport-core/status/BaseStatus.sol";
 import {StarportLib} from "starport-core/lib/StarportLib.sol";
@@ -48,8 +47,11 @@ abstract contract BasePricing is Pricing {
         returns (SpentItem[] memory repayConsideration, SpentItem[] memory carryConsideration)
     {
         Details memory details = abi.decode(loan.terms.pricingData, (Details));
-        if (details.carryRate > 0) carryConsideration = new SpentItem[](loan.debt.length);
-        else carryConsideration = new SpentItem[](0);
+        if (details.carryRate > 0) {
+            carryConsideration = new SpentItem[](loan.debt.length);
+        } else {
+            carryConsideration = new SpentItem[](0);
+        }
         repayConsideration = new SpentItem[](loan.debt.length);
 
         uint256 i = 0;

src/pricing/BaseRecallPricing.sol

@@ -26,7 +26,6 @@ import {ReceivedItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Status} from "starport-core/status/Status.sol";
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
-import "forge-std/console2.sol";
 
 import {BaseStatus} from "starport-core/status/BaseStatus.sol";
 import {StarportLib} from "starport-core/lib/StarportLib.sol";