Merge pull request #102 from euler-xyz/deploy-pool-script-updates

Deploy pool script updates

Author: euler-mab

.gitignore

@@ -7,6 +7,7 @@ out/
 /broadcast/*/31337/
 /broadcast/**/dry-run/
 broadcast/
+script/json/DeployPool_output.json
 script/json/out/
 
 # Dotenv file

README.md

@@ -64,6 +64,9 @@ Uniswap4 Hook Compatible:
 - EulerSwapFactory: `0x45b146BC07c9985589B52df651310e75C6BE066A`
 - EulerSwapPeriphery: `0xdAAF468d84DD8945521Ea40297ce6c5EEfc7003a`
 
+## Getting Started
+
+The `script` folder contains scripts for deploying pools, as well as executing test trades on them. See the dedicated [README](./script/README.md)
 
 ## Safety
 

script/DeployPool.s.sol

@@ -20,6 +20,10 @@ contract DeployPool is ScriptUtil {
         string memory json = _getJsonFile(inputScriptFileName);
 
         EulerSwapFactory factory = EulerSwapFactory(vm.parseJsonAddress(json, ".factory"));
+
+        address pool = factory.poolByEulerAccount(eulerAccount);
+        require(pool == address(0), "EulerSwap pool is already installed for this account. Run the uninstall script first.");
+
         IEulerSwap.Params memory poolParams = IEulerSwap.Params({
             vault0: vm.parseJsonAddress(json, ".vault0"),
             vault1: vm.parseJsonAddress(json, ".vault1"),
@@ -31,16 +35,15 @@ contract DeployPool is ScriptUtil {
             concentrationX: vm.parseJsonUint(json, ".concentrationX"),
             concentrationY: vm.parseJsonUint(json, ".concentrationY"),
             fee: vm.parseJsonUint(json, ".fee"),
-            protocolFee: vm.parseJsonUint(json, ".protocolFee"),
-            protocolFeeRecipient: vm.parseJsonAddress(json, ".protocolFeeRecipient")
+            protocolFee: factory.protocolFee(),
+            protocolFeeRecipient: factory.protocolFeeRecipient()
         });
         IEulerSwap.InitialState memory initialState = IEulerSwap.InitialState({
             currReserve0: uint112(vm.parseJsonUint(json, ".currReserve0")),
             currReserve1: uint112(vm.parseJsonUint(json, ".currReserve1"))
         });
-        address eulerSwapImpl = vm.parseJsonAddress(json, ".eulerSwapImplementation");
 
-        bytes memory creationCode = MetaProxyDeployer.creationCodeMetaProxy(eulerSwapImpl, abi.encode(poolParams));
+        bytes memory creationCode = MetaProxyDeployer.creationCodeMetaProxy(factory.eulerSwapImpl(), abi.encode(poolParams));
         (address predictedPoolAddress, bytes32 salt) = HookMiner.find(
             address(address(factory)),
             uint160(
@@ -70,13 +73,13 @@ contract DeployPool is ScriptUtil {
         evc.batch(items);
         vm.stopBroadcast();
 
-        address pool = factory.poolByEulerAccount(eulerAccount);
+        pool = factory.poolByEulerAccount(eulerAccount);
 
         string memory outputScriptFileName = "DeployPool_output.json";
 
         string memory object;
         object = vm.serializeAddress("factory", "deployedPool", pool);
 
-        vm.writeJson(object, string.concat(vm.projectRoot(), "/script/json/out/", outputScriptFileName));
+        vm.writeJson(object, string.concat(vm.projectRoot(), "/script/json/", outputScriptFileName));
     }
 }

script/README.md

@@ -6,19 +6,23 @@ Before running the scripts, please make sure to fill the `.env` file following t
 
 After filling the `.env` file, make sure to run: `source .env` in your terminal.
 
-## Deploy protocol
-
-- Fill the `DeployProtocol_input.json` file with the needed inputs.
-- Run `forge script ./script/DeployProtocol.s.sol --rpc-url network_name --broadcast --slow`
-
 ## Deploy new pool
-
 - Fill the `DeployPool_input.json` file with the needed inputs.
-- In pool deployment, the `eulerAccount` address is the deployer address, so we derive the address from the attached private key in the `.env` file.
-- Run `forge script ./script/DeployPool.s.sol --rpc-url network_name --broadcast --slow`
+- The `eulerAccount` will be derived from the private key provided in `.env`. The account's position on Euler should be already set up.
+- Run `forge script ./script/DeployPool.s.sol --rpc-url network_name --broadcast --slow`, replacing `network_name` to match `_RPC_URL` environment variable (e.g. if running through `MAINNET_RPC_URL` replace `network_name` with `mainnet`)
+- The deployed pool address will be recorded in `./scripts/json/DeployPool_output.json` file
 
 ## Exact in swap
 
 - Fill the `SwapExactIn_input.json` file with the needed inputs.
-- Run `forge script ./script/SwapExactIn.s.sol --rpc-url network_name --broadcast --slow`
+- Run `forge script ./script/SwapExactIn.s.sol --rpc-url network_name --broadcast --slow`, replacing `network_name` to match `_RPC_URL` environment variable (e.g. if running through `MAINNET_RPC_URL` replace `network_name` with `mainnet`)
 
+## Uninstall pool
+
+- Fill the `UninstallPool_input.json` file with the factory address.
+- Run `forge script ./script/UninstallPool.s.sol --rpc-url network_name --broadcast --slow`, replacing `network_name` to match `_RPC_URL` environment variable (e.g. if running through `MAINNET_RPC_URL` replace `network_name` with `mainnet`)
+
+## Deploy protocol
+
+- Fill the `DeployProtocol_input.json` file with the needed inputs.
+- Run `forge script ./script/DeployProtocol.s.sol --rpc-url network_name --broadcast --slow`, replacing `network_name` to match `_RPC_URL` environment variable (e.g. if running through `MAINNET_RPC_URL` replace `network_name` with `mainnet`)

script/UninstallPool.s.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.0;
+
+import {ScriptUtil} from "./ScriptUtil.s.sol";
+import {IEulerSwapFactory, IEulerSwap, EulerSwapFactory} from "../src/EulerSwapFactory.sol";
+import {IEVC, IEulerSwap} from "../src/EulerSwap.sol";
+
+/// @title Script to uninstall a pool from an account.
+contract UninstallPool is ScriptUtil {
+    function run() public {
+        // load wallet
+        uint256 eulerAccountKey = vm.envUint("WALLET_PRIVATE_KEY");
+        address eulerAccount = vm.rememberKey(eulerAccountKey);
+
+        // load JSON file
+        string memory inputScriptFileName = "UninstallPool_input.json";
+        string memory json = _getJsonFile(inputScriptFileName);
+
+        EulerSwapFactory factory = EulerSwapFactory(vm.parseJsonAddress(json, ".factory"));
+
+        IEVC evc = IEVC(factory.EVC());
+        IEVC.BatchItem[] memory items = new IEVC.BatchItem[](2);
+
+        address pool = factory.poolByEulerAccount(eulerAccount);
+
+        items[0] = IEVC.BatchItem({
+            onBehalfOfAccount: address(0),
+            targetContract: address(evc),
+            value: 0,
+            data: abi.encodeCall(evc.setAccountOperator, (eulerAccount, pool, false))
+        });
+        items[1] = IEVC.BatchItem({
+            onBehalfOfAccount: eulerAccount,
+            targetContract: address(factory),
+            value: 0,
+            data: abi.encodeCall(EulerSwapFactory.uninstallPool, ())
+        });
+
+        vm.startBroadcast(eulerAccount);
+        evc.batch(items);
+        vm.stopBroadcast();
+    }
+}

script/json/DeployPool_input.json

@@ -1,6 +1,5 @@
 {
-    "factory": "0x52177559e6430396b9A7E2176Ef33b4e4052D125",
-    "eulerSwapImplementation": "0x0B8CD42911551882638f4C762A66570e1fAc624f",
+    "factory": "0xb013be1D0D380C13B58e889f412895970A2Cf228",
     "vault0": "0xa66957e58b60d6b92b850c8773a9ff9b0ba96a65",
     "vault1": "0x4212e01c7c8e1c21dea6030c74ae2084f5337bd1",
     "equilibriumReserve0": 2000e6,
@@ -9,9 +8,7 @@
     "priceY": 1e18,
     "concentrationX": 0.97e18,
     "concentrationY": 0.97e18,
-    "fee": 0,
-    "protocolFee": 0,
-    "protocolFeeRecipient": "0x0000000000000000000000000000000000000000",
     "currReserve0": 2000e6,
-    "currReserve1": 2000e6
+    "currReserve1": 2000e6,
+    "fee": 0.01e18
 }

script/json/UninstallPool_input.json

@@ -0,0 +1,3 @@
+{
+  "factory": "0xb013be1D0D380C13B58e889f412895970A2Cf228"
+}