scripts

Author: haythemsellami

.env.example

@@ -0,0 +1,11 @@
+# Private key to interact with contracts using scripts inside /script
+WALLET_PRIVATE_KEY=0xa26..
+# RPC
+MAINNET_RPC_URL="https://"
+ARBITRUM_RPC_URL="https://"
+BASE_RPC_URL="https://"
+
+# Explorer API Key
+ETHERSCAN_MAINNET_API_KEY=adada
+ETHERSCAN_ARBITRUM_API_KEY=adada
+ETHERSCAN_BASE_API_KEY=adada

.gitignore

@@ -6,6 +6,7 @@ out/
 !/broadcast
 /broadcast/*/31337/
 /broadcast/**/dry-run/
+broadcast/
 
 # Dotenv file
 .env

README.md

@@ -44,6 +44,11 @@ forge test
 forge coverage
 ```
 
+## Private Deployment
+
+- EulerSwapFactory: 0xB6cFe9b23d18A034cE925Ee84b97D20a52Db1940
+- EulerSwapPeriphery: 0x7fc1edF54d86DfAA90F1069E81D4B520A2A44d2B
+
 ## Safety
 
 This software is experimental and is provided "as is" and "as available".

foundry.toml

@@ -6,5 +6,18 @@ solc = "0.8.27"
 optimizer = true
 optimizer_runs = 10000
 gas_reports = ["*"]
+fs_permissions = [{ access = "read", path = "./"}]
+
+[doc]
+out = "foundry-docs/"
+title = "EulerSwap Contracts Documentation"
+
+[rpc_endpoints]
+mainnet = "${MAINNET_RPC_URL}"
+base = "${BASE_RPC_URL}"
+
+[etherscan]
+mainnet = { key = "${ETHERSCAN_MAINNET_API_KEY}" }
+base = { key = "${ETHERSCAN_BASE_API_KEY}" }
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

script/DeployPool.s.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.0;
+
+import {ScriptUtil} from "./ScriptUtil.s.sol";
+import {IEulerSwapFactory, EulerSwapFactory} from "../src/EulerSwapFactory.sol";
+
+/// @title Script to deploy EulerSwapFactory & EulerSwapPeriphery.
+contract DeployPool is ScriptUtil {
+    function run() public {
+        // load wallet
+        uint256 deployerKey = vm.envUint("WALLET_PRIVATE_KEY");
+        address deployerAddress = vm.rememberKey(deployerKey);
+
+        // load JSON file
+        string memory inputScriptFileName = "DeployPool_input.json";
+        string memory json = _getJsonFile(inputScriptFileName);
+
+        EulerSwapFactory factory = EulerSwapFactory(vm.parseJsonAddress(json, ".factory"));
+        IEulerSwapFactory.DeployParams memory params = IEulerSwapFactory.DeployParams({
+            vault0: vm.parseJsonAddress(json, ".vault0"),
+            vault1: vm.parseJsonAddress(json, ".vault1"),
+            swapAccount: vm.parseJsonAddress(json, ".swapAccount"),
+            fee: vm.parseJsonUint(json, ".fee"),
+            priceX: vm.parseJsonUint(json, ".priceX"),
+            priceY: vm.parseJsonUint(json, ".priceY"),
+            concentrationX: vm.parseJsonUint(json, ".concentrationX"),
+            concentrationY: vm.parseJsonUint(json, ".concentrationY"),
+            debtLimit0: uint112(vm.parseJsonUint(json, ".debtLimit0")),
+            debtLimit1: uint112(vm.parseJsonUint(json, ".debtLimit1"))
+        });
+
+        vm.startBroadcast(deployerAddress);
+
+        address pool = factory.deployPool(params);
+
+        string memory outputScriptFileName = "DeployPool_output.json";
+
+        string memory object;
+        object = vm.serializeAddress("factory", "deployedPool", pool);
+
+        vm.writeJson(object, string.concat(vm.projectRoot(), "/script/", outputScriptFileName));
+
+        vm.stopBroadcast();
+    }
+}

script/DeployProtocol.s.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.0;
+
+import {ScriptUtil} from "./ScriptUtil.s.sol";
+import {EulerSwapFactory} from "../src/EulerSwapFactory.sol";
+import {EulerSwapPeriphery} from "../src/EulerSwapPeriphery.sol";
+
+/// @title Script to deploy EulerSwapFactory & EulerSwapPeriphery.
+contract DeployProtocol is ScriptUtil {
+    function run() public {
+        // load wallet
+        uint256 deployerKey = vm.envUint("WALLET_PRIVATE_KEY");
+        address deployerAddress = vm.rememberKey(deployerKey);
+
+        // load JSON file
+        string memory inputScriptFileName = "DeployProtocol_input.json";
+        string memory json = _getJsonFile(inputScriptFileName);
+
+        address evc = vm.parseJsonAddress(json, ".evc");
+
+        vm.startBroadcast(deployerAddress);
+
+        new EulerSwapFactory();
+        new EulerSwapPeriphery(evc);
+
+        vm.stopBroadcast();
+    }
+}

script/README.md

@@ -0,0 +1,13 @@
+# Forge scripts
+
+Every script takes inputs via a `ScriptName_input.json` file inside the json directory.
+
+Before running the scripts, please make sure to fill the `.env` file following the `.env.example`. The main env variables for the script to succefully run, are `WALLET_PRIVATE_KEY` and the `NETWORK_RPC_URL`.
+
+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`
+

script/ScriptUtil.s.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.0;
+
+import "forge-std/Script.sol";
+
+contract ScriptUtil is Script {
+    function _getJsonFile(string memory _jsonFile) internal view returns (string memory) {
+        return vm.readFile(_getJsonFilePath(_jsonFile));
+    }
+
+    function _getJsonFilePath(string memory _jsonFile) private view returns (string memory) {
+        string memory root = vm.projectRoot();
+        return string.concat(root, "/script/json/", _jsonFile);
+    }
+}

script/json/DeployPool_input.json

@@ -0,0 +1,13 @@
+{
+    "factory": "0xB6cFe9b23d18A034cE925Ee84b97D20a52Db1940",
+    "vault0": "0xa66957e58b60d6b92b850c8773a9ff9b0ba96a65",
+    "vault1": "0x4212e01c7c8e1c21dea6030c74ae2084f5337bd1",
+    "swapAccount": "0x0C9a3dd6b8F28529d72d7f9cE918D493519EE383",
+    "fee": 0,
+    "priceX": 1e18,
+    "priceY": 1e18,
+    "concentrationX": 0.4e18,
+    "concentrationY": 0.85e18,
+    "debtLimit0": "1000000000",
+    "debtLimit1": "1000000000"
+}

script/json/DeployProtocol_input.json

@@ -0,0 +1,3 @@
+{
+    "evc": "0x0C9a3dd6b8F28529d72d7f9cE918D493519EE383"
+}