ref(fulfillment-vault): upgrading fv to pay keeper on fill-order call

SocksNFlops · SocksNFlops · commit 65dd5259b2cd · 2025-12-15T12:42:23.000-08:00
diff --git a/broadcast/UpgradeFulfillmentVault.s.sol/999/run-1765830030.json b/broadcast/UpgradeFulfillmentVault.s.sol/999/run-1765830030.json
diff --git a/broadcast/UpgradeFulfillmentVault.s.sol/999/run-1765830279.json b/broadcast/UpgradeFulfillmentVault.s.sol/999/run-1765830279.json
diff --git a/broadcast/UpgradeFulfillmentVault.s.sol/999/run-latest.json b/broadcast/UpgradeFulfillmentVault.s.sol/999/run-latest.json
diff --git a/lcov.info b/lcov.info
diff --git a/script/BaseScript.s.sol b/script/BaseScript.s.sol
@@ -16,6 +16,7 @@ contract BaseScript is Script {
 
   function setUp() public virtual {
     deployerAddress = vm.envAddress("DEPLOYER_ADDRESS");
+    console.log("Deployer address: %s", deployerAddress);
     // deployerPrivateKey = vm.envUint("DEPLOYER_PRIVATE_KEY");
     isTest = vm.envBool("IS_TEST");
 
diff --git a/script/UpgradeFulfillmentVault.s.sol b/script/UpgradeFulfillmentVault.s.sol
@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {BaseScript} from "./BaseScript.s.sol";
+import {console} from "forge-std/console.sol";
+import {FulfillmentVault} from "../src/FulfillmentVault.sol";
+import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+
+contract UpgradeFulfillmentVaultScript is BaseScript {
+  FulfillmentVault public fulfillmentVault;
+
+  function setUp() public virtual override {
+    super.setUp();
+    fulfillmentVault = FulfillmentVault(payable(vm.envAddress("FULFILLMENT_VAULT_ADDRESS")));
+    console.log("Fulfillment vault currently deployed at: %s", address(fulfillmentVault));
+  }
+
+  function run() public virtual override {
+    vm.startBroadcast();
+    upgradeFulfillmentVault();
+    vm.stopBroadcast();
+  }
+
+  function upgradeFulfillmentVault() public {
+    // Deploy the new implementation of the fulfillmentVault
+    FulfillmentVault fulfillmentVaultImplementation = new FulfillmentVault();
+
+    // Console log the new implementation address
+    console.log("New fulfillment vault implementation deployed at: %s", address(fulfillmentVaultImplementation));
+
+    // Upgrade the fulfillmentVault to the new implementation
+    fulfillmentVault.upgradeToAndCall(address(fulfillmentVaultImplementation), "");
+  }
+}
diff --git a/src/FulfillmentVault.sol b/src/FulfillmentVault.sol
@@ -251,5 +251,10 @@ contract FulfillmentVault is LiquidityVault, IFulfillmentVault {
     // Emit event
     emit OrderFilled(index, hintPrevIds);
     IOrderPool(orderPool()).processOrders(indices, hintPrevIdsList);
+    // Send collected fees to the keeper by sending the native balance
+    (bool success,) = _msgSender().call{value: address(this).balance}("");
+    if (!success) {
+      revert FailedToWithdrawNativeGas(address(this).balance);
+    }
   }
 }
diff --git a/src/RolloverVault.sol b/src/RolloverVault.sol
@@ -132,7 +132,7 @@ contract RolloverVault is LiquidityVault, IRolloverVault {
       uint256 ogPoolConsolBalance = IERC20(consol()).balanceOf(address(ogPool));
       uint256 ogPoolBalance = ogPool.balanceOf(address(this));
       total += Math.mulDiv(ogPoolBalance, ogPoolUsdxBalance, ogPoolTotalSupply)
-      + Math.mulDiv(ogPoolBalance, ogPoolConsolBalance, ogPoolTotalSupply);
+        + Math.mulDiv(ogPoolBalance, ogPoolConsolBalance, ogPoolTotalSupply);
     }
     // Add the USDX and Consol balances that are currently in the rollover vault
     total += IERC20(usdx()).balanceOf(address(this)) + IERC20(consol()).balanceOf(address(this));
diff --git a/src/Router.sol b/src/Router.sol
@@ -206,13 +206,14 @@ contract Router is
     if (creationRequest.base.isCompounding) {
       for (uint256 i = 0; i < creationRequest.base.originationPools.length; i++) {
         // If compounding, need to collect 1/2 of the collateral amount + commission fee (this is in the form of collateral)
-        collateralCollected += IOriginationPool(creationRequest.base.originationPools[i])
-          .calculateReturnAmount((creationRequest.base.collateralAmounts[i] + 1) / 2);
+        collateralCollected += IOriginationPool(creationRequest.base.originationPools[i]).calculateReturnAmount(
+          (creationRequest.base.collateralAmounts[i] + 1) / 2
+        );
         (uint256 _cost, uint8 _collateralDecimals) =
           _calculateCost(creationRequest.collateral, creationRequest.base.collateralAmounts[i] / 2);
         collateralDecimals = _collateralDecimals;
-        paymentAmount += (2 * _cost)
-          - IOriginationPool(creationRequest.base.originationPools[i]).calculateReturnAmount(_cost);
+        paymentAmount +=
+          (2 * _cost) - IOriginationPool(creationRequest.base.originationPools[i]).calculateReturnAmount(_cost);
       }
     } else {
       for (uint256 i = 0; i < creationRequest.base.originationPools.length; i++) {
@@ -355,13 +356,9 @@ contract Router is
    * @param oPoolConfigId The OPoolConfigId of the origination pool config
    * @return originationPool The origination pool
    */
-  function _getOrCreateOriginationPool(OPoolConfigId oPoolConfigId)
-    internal
-    returns (IOriginationPool originationPool)
-  {
-    originationPool = IOriginationPool(
-      IOriginationPoolScheduler(originationPoolScheduler).predictOriginationPool(oPoolConfigId)
-    );
+  function _getOrCreateOriginationPool(OPoolConfigId oPoolConfigId) internal returns (IOriginationPool originationPool) {
+    originationPool =
+      IOriginationPool(IOriginationPoolScheduler(originationPoolScheduler).predictOriginationPool(oPoolConfigId));
     if (!IOriginationPoolScheduler(originationPoolScheduler).isRegistered(address(originationPool))) {
       IOriginationPool(IOriginationPoolScheduler(originationPoolScheduler).deployOriginationPool(oPoolConfigId));
     }
diff --git a/src/interfaces/IFulfillmentVault/IFulfillmentVault.sol b/src/interfaces/IFulfillmentVault/IFulfillmentVault.sol
@@ -3,13 +3,14 @@ pragma solidity ^0.8.20;
 
 import {ILiquidityVault} from "../ILiquidityVault/ILiquidityVault.sol";
 import {IFulfillmentVaultEvents} from "./IFulfillmentVaultEvents.sol";
+import {IFulfillmentVaultErrors} from "./IFulfillmentVaultErrors.sol";
 
 /**
  * @title IFulfillmentVault
  * @author @SocksNFlops
  * @notice Interface for FulfillmentVault, a vault that facilitates liquidity provisioning for fulfilling purchase orders in the OrderPool.
  */
-interface IFulfillmentVault is ILiquidityVault, IFulfillmentVaultEvents {
+interface IFulfillmentVault is ILiquidityVault, IFulfillmentVaultEvents, IFulfillmentVaultErrors {
   /**
    * @notice Gets the address of the wrapped native token
    * @return The address of the wrapped native token (i.e., whype: 0x555...)
diff --git a/src/interfaces/IFulfillmentVault/IFulfillmentVaultErrors.sol b/src/interfaces/IFulfillmentVault/IFulfillmentVaultErrors.sol
@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+/**
+ * @title IFulfillmentVaultErrors
+ * @author @SocksNFlops
+ * @notice Interface for errors emitted by FulfillmentVaults.
+ */
+interface IFulfillmentVaultErrors {
+  /**
+   * @notice Thrown when the fulfillment vault fails to withdraw native gas
+   * @param amount The amount of native gas to withdraw
+   */
+  error FailedToWithdrawNativeGas(uint256 amount);
+}
diff --git a/test/BaseTest.t.sol b/test/BaseTest.t.sol
@@ -253,6 +253,11 @@ contract BaseTest is Test {
     orderPool.setMaximumOrderDuration(opMaximumOrderDuration);
     vm.stopPrank();
 
+    // Set the gas fee for the order pool
+    vm.startPrank(admin);
+    orderPool.setGasFee(0.01e18);
+    vm.stopPrank();
+
     // Set the order pool in the general manager
     vm.startPrank(admin);
     generalManager.setOrderPool(address(orderPool));
diff --git a/test/FulfillmentVault.t.sol b/test/FulfillmentVault.t.sol
@@ -880,12 +880,14 @@ contract FulfillmentVaultTest is BaseTest {
     {
       // Calculate the amount of usdx to collect from the borrower
       (, uint256 requiredUsdxCollected,,) = router.calculateCollectedAmounts(creationRequest);
+      // Mint 0.01e18 of native tokens to the borrower
+      deal(address(borrower), 0.01e18);
       // Mint the required usdt (NOT usdx) to the borrower and approve it to the router
       vm.startPrank(borrower);
       uint256 usdtAmount = router.convert(address(usdx), address(usdt), requiredUsdxCollected);
       deal(address(usdt), borrower, usdtAmount);
       usdt.approve(address(router), usdtAmount);
-      router.requestMortgage{value: 0}(address(usdt), creationRequest, false, 2576e18);
+      router.requestMortgage{value: 0.01e18}(address(usdt), creationRequest, false, 2576e18);
       vm.stopPrank();
     }
 
@@ -1029,6 +1031,9 @@ contract FulfillmentVaultTest is BaseTest {
       vm.stopPrank();
     }
 
+    // Validate that the keeper doesn't have any native balance right now
+    assertEq(address(keeper).balance, 0, "Caller should have no native balance right now");
+
     // Keeper fills the order from the order pool
     {
       uint256 index = 0;
@@ -1046,5 +1051,8 @@ contract FulfillmentVaultTest is BaseTest {
     assertApproxEqAbs(
       usdx.balanceOf(address(fulfillmentVault)), 5_050e18, 1000e18, "FulfillmentVault should have ~5_050 usdx"
     );
+
+    // Validate keeper has received the gas fee in native tokens
+    assertEq(address(keeper).balance, 0.01e18, "Caller should have received the gas fee in native tokens");
   }
 }
diff --git a/test/Router.t.sol b/test/Router.t.sol
@@ -185,10 +185,13 @@ contract RouterTest is BaseTest {
       vm.stopPrank();
     }
 
+    // Deal 0.01e18 of native tokens to the borrower
+    deal(address(borrower), 0.01e18);
+
     // Borrower calls requestMortgage (using usdt NOT usdx)
     vm.startPrank(borrower);
     (uint256 collateralCollected, uint256 usdxCollected, uint256 paymentAmount, uint8 collateralDecimals) =
-      router.requestMortgage{value: 0}(address(usdt), creationRequest, false, 2576e18); // Don't need to pay any fees yet
+      router.requestMortgage{value: 0.01e18}(address(usdt), creationRequest, false, 2576e18); // Don't need to pay any fees yet
     vm.stopPrank();
 
     // Calculate expectedPaymentAmount
@@ -254,15 +257,14 @@ contract RouterTest is BaseTest {
 
     // Calculate the amount of collateral to collect from the borrower
     (uint256 requiredCollateralCollected,,,) = router.calculateCollectedAmounts(creationRequest);
-    // Deel the required amount of HYPE to the user
-    vm.deal(borrower, requiredCollateralCollected);
-    whype.approve(address(router), requiredCollateralCollected);
+    // Deel the required amount of HYPE to the user (plus 0.01e18 for the gas fee)
+    vm.deal(borrower, requiredCollateralCollected + 0.01e18);
     vm.stopPrank();
 
     // Borrower calls requestMortgage (using usdt NOT usdx)
     vm.startPrank(borrower);
     (uint256 collateralCollected, uint256 usdxCollected, uint256 paymentAmount, uint8 collateralDecimals) =
-      router.requestMortgage{value: requiredCollateralCollected}(address(whype), creationRequest, true, 51e18); // Don't need to pay any fees yet
+      router.requestMortgage{value: requiredCollateralCollected + 0.01e18}(address(whype), creationRequest, true, 51e18); // Don't need to pay any fees yet
     vm.stopPrank();
 
     // Calculate expectedPaymentAmount

Original file line number	Diff line number	Diff line change
`@@ -251,5 +251,10 @@ contract FulfillmentVault is LiquidityVault, IFulfillmentVault {`
`251`	`251`	`// Emit event`
`252`	`252`	`emit OrderFilled(index, hintPrevIds);`
`253`	`253`	`IOrderPool(orderPool()).processOrders(indices, hintPrevIdsList);`
	`254`	`+ // Send collected fees to the keeper by sending the native balance`
	`255`	`+ (bool success,) = _msgSender().call{value: address(this).balance}("");`
	`256`	`+ if (!success) {`
	`257`	`+ revert FailedToWithdrawNativeGas(address(this).balance);`
	`258`	`+ }`
`254`	`259`	`}`
`255`	`260`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ contract RolloverVault is LiquidityVault, IRolloverVault {`
`132`	`132`	`uint256 ogPoolConsolBalance = IERC20(consol()).balanceOf(address(ogPool));`
`133`	`133`	`uint256 ogPoolBalance = ogPool.balanceOf(address(this));`
`134`	`134`	`total += Math.mulDiv(ogPoolBalance, ogPoolUsdxBalance, ogPoolTotalSupply)`
`135`		`- + Math.mulDiv(ogPoolBalance, ogPoolConsolBalance, ogPoolTotalSupply);`
	`135`	`+ + Math.mulDiv(ogPoolBalance, ogPoolConsolBalance, ogPoolTotalSupply);`
`136`	`136`	`}`
`137`	`137`	`// Add the USDX and Consol balances that are currently in the rollover vault`
`138`	`138`	`total += IERC20(usdx()).balanceOf(address(this)) + IERC20(consol()).balanceOf(address(this));`