Merge pull request #120 from onflow/holyfuchs/small-fixes

Clean up naming, make rounding explicit, and remove non-ASCII chars

Author: holyfuchs

solidity/.solhint.json

@@ -2,7 +2,7 @@
   "extends": "solhint:recommended",
   "rules": {
     "func-visibility": ["warn", { "ignoreConstructors": true }],
-    "function-max-lines": ["warn", 60 ],
+    "function-max-lines": ["warn", 65 ],
     "gas-indexed-events": "off",
     "gas-strict-inequalities": "off",
     "import-path-check": "off",

solidity/deployments/mainnet.toml

@@ -5,7 +5,7 @@ chainId = 747
 
 # --- Tokens ---
 # WBTC
-collateral = "0x717DAE2BaF7656BE9a9B01deE31d571a9d4c9579"
+collateralToken = "0x717DAE2BaF7656BE9a9B01deE31d571a9d4c9579"
 # PYUSD0
 loanToken  = "0x99aF3EeA856556646C98c8B9b2548Fe815240750"
 # FUSDEV
@@ -32,14 +32,16 @@ healthFactorMaxTarget = "1430948419301164725"  # 860000000000000000 * 100 / 60.1
 healthFactorMax = "1433333333333333333"       # 860000000000000000 * 100 / 60    (LTV 60%)
 
 # --- FlowSwap V3 pool fee tiers ---
-feeYieldDebt = 100
-feeAssetDebt = 3000
+# Pool addresses are derived from swapFactory + these fees in ConfiguredScript.
+yieldLoanPoolFee = 100
+collateralLoanPoolFee = 3000
 
 # --- Periphery ---
+# yieldOracle: optional pre-deployed oracle; omit (or leave unset) to have
+# DeployVault deploy a fresh YieldTokenOracle reading the yield token's rate.
 yieldOracle  = "0x144F613490DD55C9844Ef139CFB9B63433dD349F"
 swapFactory  = "0xca6d7Bb03334bBf135902e1d919a5feccb461632"
-yieldDebtPool = "0x9196e243b7562B0866309013f2F9EB63F83A690f"
 
 # --- Timelocked emergency recovery ---
-# Delay (seconds) between scheduling and executing a recovery. 604800 = 7 days.
-recoveryDelay = 604800
+# Delay is now a contract constant (FCMVault.RECOVERY_DELAY = 7 days), no
+# longer configured here.

solidity/script/ConfiguredScript.s.sol

@@ -20,24 +20,27 @@ abstract contract ConfiguredScript is Script {
 
     struct Config {
         uint256 chainId;
-        address collateral;
+
+        address collateralToken;
         address loanToken;
         address yieldToken;
-        address marketOracle;
-        address marketIrm;
-        uint256 marketLltv;
-        uint24 feeYieldDebt;
-        uint24 feeAssetDebt;
+
         uint256 healthFactorMin;
-        uint256 healthFactorMax;
         uint256 healthFactorMinTarget;
+        uint256 healthFactorMax;
         uint256 healthFactorMaxTarget;
         uint256 yieldFactorMax;
-        address yieldOracle;
+
         address swapFactory;
-        address yieldDebtPool;
-        address assetDebtPool;
-        uint256 recoveryDelay;
+        address collateralLoanPool;
+        uint24 collateralLoanPoolFee;
+        address yieldLoanPool;
+        uint24 yieldLoanPoolFee;
+
+        address marketOracle;
+        address marketIrm;
+        uint256 marketLltv;
+        address yieldOracle;
     }
 
     function _loadConfig() internal view returns (Config memory c) {
@@ -51,33 +54,33 @@ abstract contract ConfiguredScript is Script {
             c.chainId == block.chainid, string.concat("config chainId does not match RPC chain (network=", network, ")")
         );
 
-        c.collateral = vm.parseTomlAddress(toml, ".collateral");
+        c.collateralToken = vm.parseTomlAddress(toml, ".collateralToken");
         c.loanToken = vm.parseTomlAddress(toml, ".loanToken");
         c.yieldToken = vm.parseTomlAddress(toml, ".yieldToken");
-        c.marketOracle = vm.parseTomlAddress(toml, ".marketOracle");
-        c.marketIrm = vm.parseTomlAddress(toml, ".marketIrm");
-        c.marketLltv = vm.parseTomlUint(toml, ".marketLltv");
-        c.feeYieldDebt = uint24(vm.parseTomlUint(toml, ".feeYieldDebt"));
-        c.feeAssetDebt = uint24(vm.parseTomlUint(toml, ".feeAssetDebt"));
+
         c.healthFactorMin = vm.parseTomlUint(toml, ".healthFactorMin");
         c.healthFactorMax = vm.parseTomlUint(toml, ".healthFactorMax");
         c.healthFactorMinTarget = vm.parseTomlUint(toml, ".healthFactorMinTarget");
         c.healthFactorMaxTarget = vm.parseTomlUint(toml, ".healthFactorMaxTarget");
         c.yieldFactorMax = vm.parseTomlUint(toml, ".yieldFactorMax");
-        c.yieldOracle = vm.parseTomlAddress(toml, ".yieldOracle");
+
         c.swapFactory = vm.parseTomlAddress(toml, ".swapFactory");
-        c.yieldDebtPool = vm.parseTomlAddress(toml, ".yieldDebtPool");
-        // Derived from the factory rather than a separate config field: the canonical
-        // collateral/loan pool at the asset/debt fee tier, which harvest's leg 2 routes
-        // through. Existence is asserted in `_requirePoolsExist`.
-        c.assetDebtPool = IUniswapV3Factory(c.swapFactory).getPool(c.collateral, c.loanToken, c.feeAssetDebt);
-        c.recoveryDelay = vm.parseTomlUint(toml, ".recoveryDelay");
+        c.collateralLoanPool =
+            IUniswapV3Factory(c.swapFactory).getPool(c.collateralToken, c.loanToken, c.collateralLoanPoolFee);
+        c.collateralLoanPoolFee = uint24(vm.parseTomlUint(toml, ".collateralLoanPoolFee"));
+        c.yieldLoanPool = IUniswapV3Factory(c.swapFactory).getPool(c.yieldToken, c.loanToken, c.yieldLoanPoolFee);
+        c.yieldLoanPoolFee = uint24(vm.parseTomlUint(toml, ".yieldLoanPoolFee"));
+
+        c.marketOracle = vm.parseTomlAddress(toml, ".marketOracle");
+        c.marketIrm = vm.parseTomlAddress(toml, ".marketIrm");
+        c.marketLltv = vm.parseTomlUint(toml, ".marketLltv");
+        c.yieldOracle = vm.parseTomlAddress(toml, ".yieldOracle");
     }
 
     function _marketParams(Config memory c) internal pure returns (MarketParams memory) {
         return MarketParams({
             loanToken: c.loanToken,
-            collateralToken: c.collateral,
+            collateralToken: c.collateralToken,
             oracle: c.marketOracle,
             irm: c.marketIrm,
             lltv: c.marketLltv
@@ -100,10 +103,10 @@ abstract contract ConfiguredScript is Script {
 
     /// @dev Both FlowSwap pools the vault trades on must exist.
     function _requirePoolsExist(Config memory c) internal view {
-        address yieldPool = IUniswapV3Factory(c.swapFactory).getPool(c.yieldToken, c.loanToken, c.feeYieldDebt);
+        address yieldPool = IUniswapV3Factory(c.swapFactory).getPool(c.yieldToken, c.loanToken, c.yieldLoanPoolFee);
         require(yieldPool != address(0), "yield/debt pool missing");
-        require(yieldPool == c.yieldDebtPool, "config yieldDebtPool does not match factory");
-        require(c.assetDebtPool != address(0), "asset/debt pool missing");
+        require(yieldPool == c.yieldLoanPool, "config yieldLoanPool does not match factory");
+        require(c.collateralLoanPool != address(0), "asset/debt pool missing");
     }
 
     /// @dev The account whose key signs broadcast transactions. Must be

solidity/script/DeployVault.s.sol

@@ -61,24 +61,23 @@ contract DeployVault is ConfiguredScript {
 
         FCMVault vault = new FCMVault(
             IFCMVault.InitParams({
-                collateral: IERC20(c.collateral),
+                collateralToken: IERC20(c.collateralToken),
                 loanToken: IERC20(c.loanToken),
                 yieldToken: IERC20(c.yieldToken),
-                marketOracle: c.marketOracle,
-                marketIrm: c.marketIrm,
-                marketLltv: c.marketLltv,
-                feeYieldDebt: c.feeYieldDebt,
-                feeAssetDebt: c.feeAssetDebt,
-                yieldDebtPool: c.yieldDebtPool,
-                assetDebtPool: c.assetDebtPool,
                 healthFactorMin: c.healthFactorMin,
-                healthFactorMax: c.healthFactorMax,
                 healthFactorMinTarget: c.healthFactorMinTarget,
+                healthFactorMax: c.healthFactorMax,
                 healthFactorMaxTarget: c.healthFactorMaxTarget,
                 yieldFactorMax: c.yieldFactorMax,
+                collateralLoanPool: c.collateralLoanPool,
+                collateralLoanPoolFee: c.collateralLoanPoolFee,
+                yieldLoanPool: c.yieldLoanPool,
+                yieldLoanPoolFee: c.yieldLoanPoolFee,
+                marketOracle: c.marketOracle,
+                marketIrm: c.marketIrm,
+                marketLltv: c.marketLltv,
                 yieldOracle: IOracle(yieldOracle),
-                admin: deployer,
-                recoveryDelay: c.recoveryDelay,
+                owner: deployer,
                 name: name,
                 symbol: symbol
             })
@@ -89,6 +88,9 @@ contract DeployVault is ConfiguredScript {
             vault.grantEarlyAccess(grantees[i]);
         }
         vault.setMaxTvl(maxTvl);
+        // maxSlippageBps defaults to 0 (not in InitParams); set the 1% production
+        // default here so rebalance swaps don't no-op against an off-oracle pool.
+        vault.setMaxSlippageBps(100);
         vm.stopBroadcast();
 
         console.log("=== deployment complete ===");

solidity/script/Status.s.sol

@@ -50,12 +50,13 @@ contract Status is ConfiguredScript {
 
     function _reportPools(Config memory c) internal view {
         console.log("--- FlowSwap pools");
-        address yieldPool = IUniswapV3Factory(c.swapFactory).getPool(c.yieldToken, c.loanToken, c.feeYieldDebt);
-        address assetPool = IUniswapV3Factory(c.swapFactory).getPool(c.collateral, c.loanToken, c.feeAssetDebt);
-        console.log("yield/debt pool (fee %s): %s", c.feeYieldDebt, yieldPool);
-        console.log("asset/debt pool (fee %s): %s", c.feeAssetDebt, assetPool);
-        if (yieldPool != c.yieldDebtPool) {
-            console.log("CONFIG MISMATCH: yieldDebtPool in config is %s", c.yieldDebtPool);
+        address yieldPool = IUniswapV3Factory(c.swapFactory).getPool(c.yieldToken, c.loanToken, c.yieldLoanPoolFee);
+        address assetPool =
+            IUniswapV3Factory(c.swapFactory).getPool(c.collateralToken, c.loanToken, c.collateralLoanPoolFee);
+        console.log("yield/debt pool (fee %s): %s", c.yieldLoanPoolFee, yieldPool);
+        console.log("asset/debt pool (fee %s): %s", c.collateralLoanPoolFee, assetPool);
+        if (yieldPool != c.yieldLoanPool) {
+            console.log("CONFIG MISMATCH: yieldLoanPool in config is %s", c.yieldLoanPool);
         }
         if (yieldPool != address(0)) {
             (, int24 tick,,,,,) = IUniswapV3Pool(yieldPool).slot0();
@@ -88,7 +89,7 @@ contract Status is ConfiguredScript {
         if (deployer == address(0)) return;
         console.log("--- Deployer %s", deployer);
         console.log("native FLOW (gas): %s", deployer.balance);
-        console.log("collateral balance: %s", IERC20(c.collateral).balanceOf(deployer));
+        console.log("collateral balance: %s", IERC20(c.collateralToken).balanceOf(deployer));
         console.log("loan token balance: %s", IERC20(c.loanToken).balanceOf(deployer));
     }
 }