Merge pull request #57 from smart-transaction/scripts/deploy-mev-time…

…-compute-and-flash-liquidity Deploy scripts for MEV time compute and flash liquidity
smart-transaction · Jul 31, 2024 · c1483c7 · c1483c7
2 parents 75c86a2 + 4ed2093
commit c1483c7
Show file tree

Hide file tree

Showing 25 changed files with 177 additions and 45 deletions.
diff --git a/script/test/CronCounter.s.sol → script/examples/CronCounter.s.sol b/script/test/CronCounter.s.sol → script/examples/CronCounter.s.sol
@@ -5,7 +5,6 @@ pragma solidity 0.8.26;
 import {Script} from "forge-std/Script.sol";
 import {BaseDeployer} from "../BaseDeployer.s.sol";
 import {CronCounter} from "test/examples/CronCounter.sol";
-import {MyErc20} from "test/examples/MyErc20.sol";
 
 /* solhint-disable no-console*/
 import {console2} from "forge-std/console2.sol";
@@ -51,10 +50,10 @@ contract DeployCronCounter is Script, BaseDeployer {
 
     /// @dev Function to perform actual deployment.
     function chainDeploySmartedContract() private broadcast(_deployerPrivateKey) {
-        address cronTwoCounter = address(new CronCounter{salt: _salt}(_callBreaker));
+        address cronCounter = address(new CronCounter{salt: _salt}(_callBreaker));
 
-        require(_create2addr == cronTwoCounter, "Address mismatch CronCounter");
+        require(_create2addr == cronCounter, "Address mismatch CronCounter");
 
-        console2.log("CronCounter deployed at address:", cronTwoCounter, "\n");
+        console2.log("CronCounter deployed at address:", cronCounter, "\n");
     }
 }
diff --git a/script/examples/FlashLiquidity.s.sol b/script/examples/FlashLiquidity.s.sol
@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: GPL-3.0
+
+pragma solidity 0.8.26;
+
+import {Script} from "forge-std/Script.sol";
+import {BaseDeployer} from "../BaseDeployer.s.sol";
+import {FlashLiquidity} from "test/examples/DeFi/FlashLiquidity.sol";
+
+/* solhint-disable no-console*/
+import {console2} from "forge-std/console2.sol";
+
+contract DeployFlashLiquidity is Script, BaseDeployer {
+    address private _callBreaker;
+
+    /// @dev Compute the CREATE2 addresses for contracts (proxy, counter).
+    /// @param salt The salt for the FlashLiquidity contract.
+    modifier computeCreate2(bytes32 salt) {
+        _callBreaker = vm.envAddress("CALL_BREAKER_ADDRESS");
+
+        _create2addr = computeCreate2Address(
+            salt, hashInitCode(type(FlashLiquidity).creationCode, abi.encode(_callBreaker, _ownerAddress))
+        );
+
+        _;
+    }
+
+    /// @dev Helper to iterate over chains and select fork.
+    /// @param deployForks The chains to deploy to.
+    /// @return address of the deployed contract
+    function createDeployMultichain(Chains[] memory deployForks)
+        internal
+        override
+        computeCreate2(_salt)
+        returns (address)
+    {
+        console2.log("FlashLiquidity create2 address:", _create2addr, "\n");
+
+        for (uint256 i; i < deployForks.length;) {
+            console2.log("Deploying FlashLiquidity to chain: ", uint256(deployForks[i]), "\n");
+
+            createSelectFork(deployForks[i]);
+
+            chainDeploySmartedContract();
+
+            unchecked {
+                ++i;
+            }
+        }
+        return _create2addr;
+    }
+
+    /// @dev Function to perform actual deployment.
+    function chainDeploySmartedContract() private broadcast(_deployerPrivateKey) {
+        address flashLiquidity = address(new FlashLiquidity{salt: _salt}(_callBreaker, _ownerAddress));
+
+        require(_create2addr == flashLiquidity, "Address mismatch FlashLiquidity");
+
+        console2.log("FlashLiquidity deployed at address:", flashLiquidity, "\n");
+    }
+}
diff --git a/script/examples/MEVTimeCompute.s.sol b/script/examples/MEVTimeCompute.s.sol
@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: GPL-3.0
+
+pragma solidity 0.8.26;
+
+import {Script} from "forge-std/Script.sol";
+import {BaseDeployer} from "../BaseDeployer.s.sol";
+import {MEVTimeCompute} from "test/examples/MEVOracle/MEVTimeCompute.sol";
+
+/* solhint-disable no-console*/
+import {console2} from "forge-std/console2.sol";
+
+contract DeployMEVTimeCompute is Script, BaseDeployer {
+    address private _callBreaker;
+
+    /// @dev Compute the CREATE2 addresses for contracts (proxy, counter).
+    /// @param salt The salt for the MEVTimeCompute contract.
+    modifier computeCreate2(bytes32 salt) {
+        _callBreaker = vm.envAddress("CALL_BREAKER_ADDRESS");
+
+         // passing 8 as a random divisor value for this example, can be updated with setters
+        _create2addr = computeCreate2Address(
+            salt, hashInitCode(type(MEVTimeCompute).creationCode, abi.encode(_callBreaker, 8))
+        );
+
+        _;
+    }
+
+    /// @dev Helper to iterate over chains and select fork.
+    /// @param deployForks The chains to deploy to.
+    /// @return address of the deployed contract
+    function createDeployMultichain(Chains[] memory deployForks)
+        internal
+        override
+        computeCreate2(_salt)
+        returns (address)
+    {
+        console2.log("MEVTimeCompute create2 address:", _create2addr, "\n");
+
+        for (uint256 i; i < deployForks.length;) {
+            console2.log("Deploying MEVTimeCompute to chain: ", uint256(deployForks[i]), "\n");
+
+            createSelectFork(deployForks[i]);
+
+            chainDeploySmartedContract();
+
+            unchecked {
+                ++i;
+            }
+        }
+        return _create2addr;
+    }
+
+    /// @dev Function to perform actual deployment.
+    function chainDeploySmartedContract() private broadcast(_deployerPrivateKey) {
+        // passing 8 as a random divisor value for this example, can be updated with setters
+        address mevTimeCompute = address(new MEVTimeCompute{salt: _salt}(_callBreaker, 8));
+
+        require(_create2addr == mevTimeCompute, "Address mismatch MEVTimeCompute");
+
+        console2.log("MEVTimeCompute contract deployed at address:", mevTimeCompute, "\n");
+    }
+}
diff --git a/script/test/SelfCheckout.s.sol → script/examples/SelfCheckout.s.sol b/script/test/SelfCheckout.s.sol → script/examples/SelfCheckout.s.sol
diff --git a/test/AssociatedDataStorage.t.sol b/test/AssociatedDataStorage.t.sol
@@ -2,7 +2,7 @@
 pragma solidity ^0.8.0;
 
 import {Test} from "forge-std/Test.sol";
-import {AssociatedDataStorage, AssociatedDataLib} from "../src/CallBreakerTypes.sol";
+import {AssociatedDataStorage, AssociatedDataLib} from "src/CallBreakerTypes.sol";
 
 contract AssociatedDataStorageTest is Test {
     AssociatedDataStorage assocData;

diff --git a/test/CronCounter.t.sol b/test/CronCounter.t.sol
@@ -6,8 +6,8 @@ import "forge-std/Vm.sol";
 
 import "./solve-lib/CronCounterLib.sol";
 
-import "../src/lamination/Laminator.sol";
-import "../src/timetravel/CallBreaker.sol";
+import "src/lamination/Laminator.sol";
+import "src/timetravel/CallBreaker.sol";
 
 contract CronTest is Test, CronCounterLib {
     address deployer;

diff --git a/test/FlashLiquidity.t.sol b/test/FlashLiquidity.t.sol
@@ -3,8 +3,7 @@
 pragma solidity 0.8.26;
 
 import "forge-std/Test.sol";
-import "../src/timetravel/CallBreaker.sol";
-import "../test/solve-lib/FlashLiquidityLib.sol";
+import "test/solve-lib/DeFi/FlashLiquidityLib.sol";
 
 contract FlashLiquidityTest is Test, FlashLiquidityLib {
     address deployer;

diff --git a/test/FlashPillTest.t.sol b/test/FlashPillTest.t.sol
@@ -3,8 +3,8 @@
 pragma solidity 0.8.26;
 
 import "forge-std/Test.sol";
-import "../src/timetravel/CallBreaker.sol";
-import "../test/examples/FlashPill.sol";
+import "src/timetravel/CallBreaker.sol";
+import "test/examples/FlashPill.sol";
 
 contract FlashPillTest is Test {
     CallBreaker private callbreaker;

diff --git a/test/NoopTurnerTest.t.sol b/test/NoopTurnerTest.t.sol
@@ -2,8 +2,8 @@
 pragma solidity 0.8.26;
 
 import "forge-std/Test.sol";
-import "../src/timetravel/CallBreaker.sol";
-import "../test/examples/NoopTurner.sol";
+import "src/timetravel/CallBreaker.sol";
+import "test/examples/NoopTurner.sol";
 
 contract NoopTurnerTest is Test {
     CallBreaker public callbreaker;

diff --git a/test/PnP.t.sol b/test/PnP.t.sol
@@ -3,9 +3,9 @@
 pragma solidity 0.8.26;
 
 import "forge-std/Test.sol";
-import "../src/timetravel/CallBreaker.sol";
-import "../test/examples/PnP.sol";
-import "../test/solve-lib/PnPLib.sol";
+import "src/timetravel/CallBreaker.sol";
+import "test/examples/PnP.sol";
+import "test/solve-lib/PnPLib.sol";
 
 contract PnPTest is Test, PnPLib {
     address deployer;

diff --git a/test/Sandwich.t.sol b/test/Sandwich.t.sol
@@ -6,8 +6,8 @@ import "forge-std/Vm.sol";
 
 import "./solve-lib/CronCounterLib.sol";
 
-import "../src/lamination/Laminator.sol";
-import "../src/timetravel/CallBreaker.sol";
+import "src/lamination/Laminator.sol";
+import "src/timetravel/CallBreaker.sol";
 
 contract CronTest is Test, CronCounterLib {
     address deployer;

diff --git a/test/SlippageProtection.t.sol b/test/SlippageProtection.t.sol
@@ -4,7 +4,7 @@ pragma solidity 0.8.26;
 
 import "forge-std/Test.sol";
 import "src/timetravel/CallBreaker.sol";
-import "test/solve-lib/SlippageProtectionLib.sol";
+import "test/solve-lib/DeFi/SlippageProtectionLib.sol";
 
 contract SlippageProtectionTest is Test, SlippageProtectionLib {
     address deployer;

diff --git a/test/examples/CronCounter.sol b/test/examples/CronCounter.sol
@@ -2,7 +2,7 @@
 
 pragma solidity 0.8.26;
 
-import "../../src/timetravel/SmarterContract.sol";
+import "src/timetravel/SmarterContract.sol";
 
 contract CronCounter is SmarterContract {
     mapping(address => uint256) private _counters;

diff --git a/test/examples/FlashLiquidity.sol → test/examples/DeFi/FlashLiquidity.sol b/test/examples/FlashLiquidity.sol → test/examples/DeFi/FlashLiquidity.sol
@@ -1,12 +1,14 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.26;
 
+import "forge-std/console.sol";
+
 import "openzeppelin/token/ERC20/ERC20.sol";
+import "test/utils/interfaces/IWeth.sol";
+import "test/utils/interfaces/ISwapRouter.sol";
 import "src/timetravel/CallBreaker.sol";
 import "src/timetravel/SmarterContract.sol";
 import "src/TimeTypes.sol";
-import "test/utils/interfaces/ISwapRouter.sol";
-import "test/utils/interfaces/IWeth.sol";
 
 address constant DAI = 0x6B175474E89094C44Da98b954EedeAC495271d0F;
 address constant WETH9 = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
@@ -67,6 +69,7 @@ contract FlashLiquidity is SmarterContract {
 
         // The call to `exactInputSingle` executes the swap.
         uint256 amountOut = router.exactInputSingle(params);
+        console.log("WETH", amountOut);
 
         // check whether or not
         CallObject memory callObj = CallObject({

diff --git a/test/examples/SwapPool.sol → test/examples/DeFi/SwapPool.sol b/test/examples/SwapPool.sol → test/examples/DeFi/SwapPool.sol
@@ -6,8 +6,8 @@ import "src/timetravel/SmarterContract.sol";
 import "src/TimeTypes.sol";
 import "test/utils/interfaces/ISwapRouter.sol";
 
-import {IWETH, IERC20} from "../utils/interfaces/IWeth.sol";
-import {IPositionManager} from "../utils/interfaces/IPositionManager.sol";
+import {IWETH, IERC20} from "test/utils/interfaces/IWeth.sol";
+import {IPositionManager} from "test/utils/interfaces/IPositionManager.sol";
 
 // pool fee, 0.3%.
 uint24 constant poolFee = 3000;
@@ -75,7 +75,7 @@ contract SwapPool is SmarterContract {
         });
 
         // The call to `exactInputSingle` executes the swap.
-        uint256 amountOut = router.exactInputSingle(params);
+        router.exactInputSingle(params);
 
         // check whether or not
         CallObject[] memory callObjs = new CallObject[](1);

diff --git a/test/examples/FlashPill.sol b/test/examples/FlashPill.sol
@@ -2,8 +2,8 @@
 pragma solidity 0.8.26;
 
 import "openzeppelin/token/ERC20/IERC20.sol";
-import "../../src/timetravel/CallBreaker.sol";
-import "../../src/timetravel/SmarterContract.sol";
+import "src/timetravel/CallBreaker.sol";
+import "src/timetravel/SmarterContract.sol";
 
 contract FlashPill is IERC20, SmarterContract {
     mapping(address => uint256) private _balances;

diff --git a/test/examples/MEVOracle/MEVTimeCompute.sol b/test/examples/MEVOracle/MEVTimeCompute.sol
@@ -10,6 +10,9 @@ contract MEVTimeCompute is SmarterContract {
     uint256 public initValue;
     uint256 public divisor;
 
+    event InitValueUpdated();
+    event DivisorUpdated();
+
     /**
      * @notice This is a basic example of performing a computation with a partial function application
      *     At solvetime, the solver can provide an additional value via. associatedData, and the contract
@@ -24,6 +27,12 @@ contract MEVTimeCompute is SmarterContract {
 
     function setInitValue(uint256 _initValue) external {
         initValue = _initValue;
+        emit InitValueUpdated();
+    }
+
+    function setDivisor(uint256 _divisor) external {
+        divisor = _divisor;
+        emit DivisorUpdated();
     }
 
     /**
@@ -49,7 +58,7 @@ contract MEVTimeCompute is SmarterContract {
         assertFutureCallTo(callObj, 1);
     }
 
-    function verifySolution() external {
+    function verifySolution() external view {
         require(initValue % divisor == 0, "Invalid Solution Provided");
     }
 }
diff --git a/test/examples/NoopTurner.sol b/test/examples/NoopTurner.sol
@@ -2,9 +2,9 @@
 
 pragma solidity 0.8.26;
 
-import "../../src/timetravel/CallBreaker.sol";
-import "../../src/timetravel/SmarterContract.sol";
-import "../../src/TimeTypes.sol";
+import "src/timetravel/CallBreaker.sol";
+import "src/timetravel/SmarterContract.sol";
+import "src/TimeTypes.sol";
 
 contract NoopTurner is SmarterContract {
     address private _callbreakerAddress;

diff --git a/test/examples/PnP.sol b/test/examples/PnP.sol
@@ -2,7 +2,7 @@
 
 pragma solidity 0.8.26;
 
-import "../../src/timetravel/CallBreaker.sol";
+import "src/timetravel/CallBreaker.sol";
 
 contract PnP {
     address private _callbreakerAddress;

diff --git a/test/solve-lib/CronCounterLib.sol b/test/solve-lib/CronCounterLib.sol
@@ -3,10 +3,10 @@ pragma solidity 0.8.26;
 
 import "forge-std/Vm.sol";
 
-import "../../src/lamination/Laminator.sol";
-import "../../src/timetravel/CallBreaker.sol";
-import "../../test/examples/CronCounter.sol";
-import "../../src/timetravel/SmarterContract.sol";
+import "src/lamination/Laminator.sol";
+import "src/timetravel/CallBreaker.sol";
+import "test/examples/CronCounter.sol";
+import "src/timetravel/SmarterContract.sol";
 
 // for the next year, every day:
 // tip the pusher with a little eth

diff --git a/test/solve-lib/FlashLiquidityLib.sol → test/solve-lib/DeFi/FlashLiquidityLib.sol b/test/solve-lib/FlashLiquidityLib.sol → test/solve-lib/DeFi/FlashLiquidityLib.sol
@@ -4,7 +4,7 @@ pragma solidity 0.8.26;
 import "src/lamination/Laminator.sol";
 import "src/timetravel/CallBreaker.sol";
 import "src/timetravel/SmarterContract.sol";
-import "test/examples/SwapPool.sol";
+import "test/examples/DeFi/SwapPool.sol";
 import "test/utils/MockERC20Token.sol";
 import "test/utils/MockSwapRouter.sol";
 import "test/utils/MockPositionManager.sol";

diff --git a/test/solve-lib/SlippageProtectionLib.sol → .../solve-lib/DeFi/SlippageProtectionLib.sol b/test/solve-lib/SlippageProtectionLib.sol → .../solve-lib/DeFi/SlippageProtectionLib.sol
@@ -3,7 +3,7 @@ pragma solidity 0.8.26;
 
 import "src/lamination/Laminator.sol";
 import "src/timetravel/CallBreaker.sol";
-import "test/examples/SwapPool.sol";
+import "test/examples/DeFi/SwapPool.sol";
 import "test/utils/MockERC20Token.sol";
 import "test/utils/MockSwapRouter.sol";
 import "test/utils/MockPositionManager.sol";

diff --git a/test/solve-lib/PnPLib.sol b/test/solve-lib/PnPLib.sol
@@ -3,10 +3,10 @@ pragma solidity 0.8.26;
 
 import "forge-std/Vm.sol";
 
-import "../../src/lamination/Laminator.sol";
-import "../../src/timetravel/CallBreaker.sol";
-import "../../test/examples/PnP.sol";
-import "../../src/timetravel/SmarterContract.sol";
+import "src/lamination/Laminator.sol";
+import "src/timetravel/CallBreaker.sol";
+import "src/timetravel/SmarterContract.sol";
+import "test/examples/PnP.sol";
 
 contract PnPLib {
     address payable public pusherLaminated;