build: deploy scripts

.gitignore

@@ -3,9 +3,7 @@ cache/
 out/
 
 # Ignores development broadcast logs
-!/broadcast
-/broadcast/*/31337/
-/broadcast/**/dry-run/
+/broadcast
 
 # Dotenv file
 .env

README.md

@@ -1 +1,114 @@
 # Harvest Universal Liquidator Mainnet
+
+This is the gateway for all Harvest strategies to execute swaps with multiple Dexes.
+
+## Get Started
+
+1.  Fill in the environment variables.
+
+    ```bash
+    cp .env.example .env
+    ```
+
+2.  Set up dependencies.
+
+    ```bash
+    yarn
+    ```
+
+## Prerequisites
+
+- [Foundry](https://github.com/foundry-rs/foundry)
+
+## Test locally
+
+```bash
+forge test -vvv
+```
+
+## Deploy
+
+While deploying locally, set up the local node with `anvil`. Make sure that the address from the private key has enough gas to deploy or use one of the ten addresses with the `MNEMONIC` set up with `anvil`.
+
+```bash
+source .env
+anvil -m $MNEMONIC
+or
+anvil -m $MNEMONIC --fork-url <RPC_URL>
+```
+
+Create a corresponding network section inside `deployed-addresses.json`.
+
+```json
+  "<template-for-new-network>": {
+    "UniversalLiquidator": "",
+    "UniversalLiquidatorRegistry": "",
+    "UniV3Dex": "",
+    "BalancerDex": "",
+    "SushiswapDex": "",
+    "CurveDex": "",
+    "BancorV2Dex": "",
+    "<new-address-item-to-store>": ""
+  },
+```
+
+Deploy contracts with corresponding scripts.
+
+```bash
+./script/_scripts.sh script/<SCRIPTS.s.sol>
+```
+
+---
+
+There are 5 scripts to deploy:
+
+- _script/SystemBase.s.sol_
+- _script/Dex.s.sol_
+- _script/Path.s.sol_
+- _script/Pool.s.sol_
+- _script/Fee.s.sol_
+
+Executing each script will require a few configurations:
+
+Determine the Network.
+
+```bash
+Which network do you want to deploy to?
+Options: local, eth-mainnet, eth-sepolia, arb-mainnet, arb-goerli, polygon-mainnet, polygon-mumbai
+```
+
+Determine whether or not to broadcast, if the network is not local.
+
+```bash
+Broadcast? [y/n]...
+```
+
+Determine whether or not to verify, if the network is not local.
+
+```bash
+Verify contract? [y/n]...
+```
+
+Determine the profile to use.
+
+```bash
+Profile? [default/optimized]...
+```
+
+(With Dex.s.sol) Determine which Dex to deploy.
+
+```bash
+Which dex do you want to deploy? (Ex: UniV3Dex, the contract name)
+```
+
+(With Dex.s.sol) Determine the name for the Dex.
+
+```bash
+Which name do you want to represent the dex? (Ex: uniV3)
+```
+
+(With Path.s.sol, Pool.s.sol, or Fee.s.sol) Determine the config parameters file for setting up. There are three example files for reference: _Paths.0000.json_, _Pools.0000.json_, and _Fees.0000.json_.
+
+```bash
+Setup with which file? (Ex: Paths.0000.json)
+```

foundry.toml

@@ -4,7 +4,7 @@ optimizer = false
 fs_permissions = [{ access = "read-write", path = "./"}]
 
 [profile.optimized]
-optimizer = true
+optimizer = false
 optimizer_runs = 10000
 fs_permissions = [{ access = "read-write", path = "./"}]
 

script/Dex.s.sol

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.17;
+
+import "forge-std/Script.sol";
+import "forge-std/StdJson.sol";
+import "openzeppelin/utils/Strings.sol";
+
+import "../src/interfaces/IUniversalLiquidatorRegistry.sol";
+
+import "../src/core/dexes/UniV3Dex.sol";
+import "../src/core/dexes/BalancerDex.sol";
+import "../src/core/dexes/SushiswapDex.sol";
+import "../src/core/dexes/CurveDex.sol";
+import "../src/core/dexes/BancorV2Dex.sol";
+
+contract DexScript is Script {
+    using stdJson for string;
+    using Strings for uint256;
+
+    address _registry;
+    address _newDex;
+
+    function run() public {
+        vm.startBroadcast();
+        preDeploy();
+        deploy();
+        postDeploy();
+        vm.stopBroadcast();
+    }
+
+    function deploy() public {
+        if (keccak256(bytes(vm.envString("DEX"))) == keccak256(bytes("UniV3Dex"))) {
+            UniV3Dex uniV3Dex = new UniV3Dex();
+            console.log("UniV3Dex: ", address(uniV3Dex));
+            IUniversalLiquidatorRegistry(_registry).addDex(bytes32(bytes(vm.envString("DEX_NAME"))), address(uniV3Dex));
+            _newDex = address(uniV3Dex);
+        } else if (keccak256(bytes(vm.envString("DEX"))) == keccak256(bytes("BalancerDex"))) {
+            BalancerDex balancerDex = new BalancerDex();
+            console.log("BalancerDex: ", address(balancerDex));
+            IUniversalLiquidatorRegistry(_registry).addDex(bytes32(bytes(vm.envString("DEX_NAME"))), address(balancerDex));
+            _newDex = address(balancerDex);
+        } else if (keccak256(bytes(vm.envString("DEX"))) == keccak256(bytes("SushiswapDex"))) {
+            SushiswapDex sushiswapDex = new SushiswapDex();
+            console.log("SushiswapDex: ", address(sushiswapDex));
+            IUniversalLiquidatorRegistry(_registry).addDex(bytes32(bytes(vm.envString("DEX_NAME"))), address(sushiswapDex));
+            _newDex = address(sushiswapDex);
+        } else if (keccak256(bytes(vm.envString("DEX"))) == keccak256(bytes("CurveDex"))) {
+            CurveDex curveDex = new CurveDex();
+            console.log("CurveDex: ", address(curveDex));
+            IUniversalLiquidatorRegistry(_registry).addDex(bytes32(bytes(vm.envString("DEX_NAME"))), address(curveDex));
+            _newDex = address(curveDex);
+        } else if (keccak256(bytes(vm.envString("DEX"))) == keccak256(bytes("BancorV2Dex"))) {
+            BancorV2Dex bancorV2Dex = new BancorV2Dex();
+            console.log("BancorV2Dex: ", address(bancorV2Dex));
+            IUniversalLiquidatorRegistry(_registry).addDex(bytes32(bytes(vm.envString("DEX_NAME"))), address(bancorV2Dex));
+            _newDex = address(bancorV2Dex);
+        } else {
+            console.log("Dex not found");
+        }
+    }
+
+    /**
+     * @notice Check if the key exist in deployed-addresses.json file
+     */
+    function preDeploy() public {
+        string memory root = vm.projectRoot();
+        string memory path = string.concat(root, "/script/deployed-addresses.json");
+        string memory json = vm.readFile(path);
+
+        _registry = json.readAddress(string.concat(string.concat(".", vm.envString("NETWORK")), ".UniversalLiquidatorRegistry"));
+        json.readString(string.concat(string.concat(".", vm.envString("NETWORK")), string.concat(".", vm.envString("DEX"))));
+    }
+
+    /**
+     * @notice Write the deployed addresses to the deployed-addresses.json file
+     */
+    function postDeploy() public {
+        string memory root = vm.projectRoot();
+        string memory path = string.concat(root, "/script/deployed-addresses.json");
+
+        string memory key = string.concat(string.concat(".", vm.envString("NETWORK")), string.concat(".", vm.envString("DEX")));
+        string memory dexId = vm.envString("DEX_NAME");
+        string memory dexAddr = uint256(uint160(_newDex)).toHexString(20);
+        key.serialize("id", dexId);
+        string memory value = key.serialize("address", dexAddr);
+        value.write(path, key);
+    }
+}

script/Fee.s.sol

@@ -0,0 +1,56 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.17;
+
+import "forge-std/Script.sol";
+import "forge-std/StdJson.sol";
+
+struct FeePair {
+    address buyToken;
+    string description;
+    string dexName;
+    uint256 fee;
+    address sellToken;
+}
+
+contract FeeScript is Script {
+    using stdJson for string;
+
+    string _json;
+    string _config;
+
+    function run() public {
+        vm.startBroadcast();
+        preDeploy();
+        deploy();
+        vm.stopBroadcast();
+    }
+
+    function deploy() public {
+        FeePair[] memory _fees = abi.decode(_config.parseRaw(""), (FeePair[]));
+        for (uint256 i; i < _fees.length;) {
+            string memory dexName = _fees[i].dexName;
+            address _dexAddr = _json.readAddress(string.concat(".", vm.envString("NETWORK"), ".", dexName, ".address"));
+            if (keccak256(bytes(dexName)) == keccak256(bytes("UniV3Dex"))) {
+                (bool success, bytes memory data) = _dexAddr.call(
+                    abi.encodeWithSignature("setFee(address,address,uint24)", _fees[i].sellToken, _fees[i].buyToken, _fees[i].fee)
+                );
+                if (!success) {
+                    console2.log("curve setPool failed: ");
+                    console2.logBytes(data);
+                }
+            }
+
+            unchecked {
+                ++i;
+            }
+        }
+    }
+
+    /**
+     * @notice Check if the key exist in deployed-addresses.json file
+     */
+    function preDeploy() public {
+        _json = vm.readFile(string.concat(vm.projectRoot(), "/script/deployed-addresses.json"));
+        _config = vm.readFile(string.concat(vm.projectRoot(), "/script/config/", vm.envString("SETUP_FILE")));
+    }
+}

script/Path.s.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.17;
+
+import "forge-std/Script.sol";
+import "forge-std/StdJson.sol";
+
+import "../src/interfaces/IUniversalLiquidatorRegistry.sol";
+
+struct DexSetting {
+    string dexName;
+    address[] paths;
+}
+
+struct TokenPair {
+    address buyToken;
+    string description;
+    DexSetting[] dexSetup;
+    address sellToken;
+}
+
+contract PathScript is Script {
+    using stdJson for string;
+
+    address _registry;
+    string _json;
+    string _config;
+
+    function run() public {
+        vm.startBroadcast();
+        preDeploy();
+        deploy();
+        vm.stopBroadcast();
+    }
+
+    function deploy() public {
+        TokenPair[] memory _tokenPairs = abi.decode(_config.parseRaw(""), (TokenPair[]));
+        for (uint256 i; i < _tokenPairs.length;) {
+            for (uint256 j; j < _tokenPairs[i].dexSetup.length;) {
+                string memory _dexName =
+                    _json.readString(string.concat(".", vm.envString("NETWORK"), ".", _tokenPairs[i].dexSetup[j].dexName, ".id"));
+                bytes32 dexId = bytes32(bytes(_dexName));
+                IUniversalLiquidatorRegistry(_registry).setPath(dexId, _tokenPairs[i].dexSetup[j].paths);
+                unchecked {
+                    ++j;
+                }
+            }
+
+            unchecked {
+                ++i;
+            }
+        }
+    }
+
+    /**
+     * @notice Check if the key exist in deployed-addresses.json file
+     */
+    function preDeploy() public {
+        _json = vm.readFile(string.concat(vm.projectRoot(), "/script/deployed-addresses.json"));
+        _config = vm.readFile(string.concat(vm.projectRoot(), "/script/config/", vm.envString("SETUP_FILE")));
+
+        _registry = _json.readAddress(string.concat(".", vm.envString("NETWORK"), ".UniversalLiquidatorRegistry"));
+    }
+}