feat: FeeFlowControllerUtil

Author: kasperpawlowski

script/11_FeeFlow.s.sol

@@ -4,9 +4,10 @@ pragma solidity ^0.8.0;
 
 import {ScriptUtils} from "./utils/ScriptUtils.s.sol";
 import {FeeFlowController} from "fee-flow/FeeFlowController.sol";
+import {FeeFlowControllerUtil} from "../src/Util/FeeFlowControllerUtil.sol";
 
 contract FeeFlow is ScriptUtils {
-    function run() public broadcast returns (address feeFlowController) {
+    function run() public broadcast returns (address feeFlowController, address feeFlowControllerUtil) {
         string memory inputScriptFileName = "11_FeeFlow_input.json";
         string memory outputScriptFileName = "11_FeeFlow_output.json";
         string memory json = getScriptFile(inputScriptFileName);
@@ -18,11 +19,12 @@ contract FeeFlow is ScriptUtils {
         uint256 priceMultiplier = vm.parseJsonUint(json, ".priceMultiplier");
         uint256 minInitPrice = vm.parseJsonUint(json, ".minInitPrice");
 
-        feeFlowController =
+        (feeFlowController, feeFlowControllerUtil) =
             execute(evc, initPrice, paymentToken, paymentReceiver, epochPeriod, priceMultiplier, minInitPrice);
 
         string memory object;
         object = vm.serializeAddress("feeFlow", "feeFlowController", feeFlowController);
+        object = vm.serializeAddress("feeFlow", "feeFlowControllerUtil", feeFlowControllerUtil);
         vm.writeJson(object, string.concat(vm.projectRoot(), "/script/", outputScriptFileName));
     }
 
@@ -34,8 +36,8 @@ contract FeeFlow is ScriptUtils {
         uint256 epochPeriod,
         uint256 priceMultiplier,
         uint256 minInitPrice
-    ) public broadcast returns (address feeFlowController) {
-        feeFlowController =
+    ) public broadcast returns (address feeFlowController, address feeFlowControllerUtil) {
+        (feeFlowController, feeFlowControllerUtil) =
             execute(evc, initPrice, paymentToken, paymentReceiver, epochPeriod, priceMultiplier, minInitPrice);
     }
 
@@ -47,11 +49,12 @@ contract FeeFlow is ScriptUtils {
         uint256 epochPeriod,
         uint256 priceMultiplier,
         uint256 minInitPrice
-    ) public returns (address feeFlowController) {
+    ) public returns (address feeFlowController, address feeFlowControllerUtil) {
         feeFlowController = address(
             new FeeFlowController(
                 evc, initPrice, paymentToken, paymentReceiver, epochPeriod, priceMultiplier, minInitPrice
             )
         );
+        feeFlowControllerUtil = address(new FeeFlowControllerUtil(address(feeFlowController)));
     }
 }

script/50_CoreAndPeriphery.s.sol

@@ -682,13 +682,15 @@ contract CoreAndPeriphery is BatchBuilder, SafeMultisendBuilder {
             console.log("- At least one of the Periphery factories contracts already deployed. Skipping...");
         }
 
-        if (peripheryAddresses.feeFlowController == address(0)) {
+        if (
+            peripheryAddresses.feeFlowController == address(0) && peripheryAddresses.feeFlowControllerUtil == address(0)
+        ) {
             address paymentToken = bridgeAddresses.oftAdapter == address(0) ? getWETHAddress() : tokenAddresses.EUL;
 
             if (input.feeFlowInitPrice != 0 && paymentToken != address(0)) {
-                console.log("+ Deploying FeeFlow...");
+                console.log("+ Deploying FeeFlowController and FeeFlowControllerUtil...");
                 FeeFlow deployer = new FeeFlow();
-                peripheryAddresses.feeFlowController = deployer.deploy(
+                (peripheryAddresses.feeFlowController, peripheryAddresses.feeFlowControllerUtil) = deployer.deploy(
                     coreAddresses.evc,
                     input.feeFlowInitPrice,
                     paymentToken,
@@ -698,7 +700,9 @@ contract CoreAndPeriphery is BatchBuilder, SafeMultisendBuilder {
                     FEE_FLOW_MIN_INIT_PRICE
                 );
             } else {
-                console.log("! feeFlowInitPrice or paymentToken is not set for FeeFlow deployment. Skipping...");
+                console.log(
+                    "! feeFlowInitPrice or paymentToken is not set for FeeFlowController and FeeFlowControllerUtil deployment. Skipping..."
+                );
             }
 
             address feeReceiver = peripheryAddresses.feeFlowController == address(0)

script/utils/ScriptUtils.s.sol

@@ -77,6 +77,7 @@ abstract contract PeripheryAddressesLib is ScriptExtended {
         address swapper;
         address swapVerifier;
         address feeFlowController;
+        address feeFlowControllerUtil;
         address evkFactoryPerspective;
         address governedPerspective;
         address escrowedCollateralPerspective;
@@ -106,6 +107,7 @@ abstract contract PeripheryAddressesLib is ScriptExtended {
         result = vm.serializeAddress("peripheryAddresses", "swapper", Addresses.swapper);
         result = vm.serializeAddress("peripheryAddresses", "swapVerifier", Addresses.swapVerifier);
         result = vm.serializeAddress("peripheryAddresses", "feeFlowController", Addresses.feeFlowController);
+        result = vm.serializeAddress("peripheryAddresses", "feeFlowControllerUtil", Addresses.feeFlowControllerUtil);
         result = vm.serializeAddress("peripheryAddresses", "evkFactoryPerspective", Addresses.evkFactoryPerspective);
         result = vm.serializeAddress("peripheryAddresses", "governedPerspective", Addresses.governedPerspective);
         result = vm.serializeAddress(
@@ -149,6 +151,7 @@ abstract contract PeripheryAddressesLib is ScriptExtended {
             swapper: getAddressFromJson(json, ".swapper"),
             swapVerifier: getAddressFromJson(json, ".swapVerifier"),
             feeFlowController: getAddressFromJson(json, ".feeFlowController"),
+            feeFlowControllerUtil: getAddressFromJson(json, ".feeFlowControllerUtil"),
             evkFactoryPerspective: getAddressFromJson(json, ".evkFactoryPerspective"),
             governedPerspective: getAddressFromJson(json, ".governedPerspective"),
             escrowedCollateralPerspective: getAddressFromJson(json, ".escrowedCollateralPerspective"),