Feat: deploy scripts

.gitignore

@@ -2,10 +2,13 @@
 cache/
 out/
 
-# Ignores development broadcast logs
-!/broadcast
-/broadcast/*/31337/
-/broadcast/**/dry-run/
+# Ignores broadcast logs
+/broadcast
+
+# Ignores script config
+/script/input/*/*.json
+!/script/input/*/template-*.json
+/script/output/*/*.json
 
 # Docs
 docs/

.gitmodules

@@ -12,4 +12,4 @@
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
 [submodule "lib-0_6_x/dss-vest"]
 	path = lib-0_6_x/dss-vest
-	url = https://github.com/makerdao/dss-vest.git
+	url = https://github.com/makerdao/dss-vest.git

.prettierrc.json

@@ -1,6 +1,19 @@
 {
   "printWidth": 120,
+  "plugins": ["prettier-plugin-solidity"],
   "overrides": [
+    {
+      "files": ["src/**/*.sol", "script/**/*.sol"],
+      "options": {
+        "compiler": "0.8.19"
+      }
+    },
+    {
+      "files": "src-0_6_x/**/*.sol",
+      "options": {
+        "compiler": "0.6.12"
+      }
+    },
     {
       "files": [
         "*.json"

.solhint.json

@@ -5,16 +5,18 @@
   ],
   "rules": {
     "prettier/prettier": "warn",
-    "max-line-length": "off",
     "check-send-result": "off",
-    "not-rely-on-time": "off",
-    "multiple-sends": "off",
+    "custom-errors": "off",
     "compiler-version": "off",
     "func-visibility": [
       "warn",
       {
         "ignoreConstructors": true
       }
-    ]
+    ],
+    "max-line-length": "off",
+    "multiple-sends": "off",
+    "not-rely-on-time": "off",
+    "one-contract-per-file": "off"
   }
 }

bash/forge-script.sh

@@ -16,14 +16,18 @@ run_script() {
 
 	local RESPONSE=
 	# Log the command being issued, making sure not to expose the password
-	log "forge script --json --sender "$FOUNDRY_ETH_FROM" --keystore "$FOUNDRY_ETH_KEYSTORE_FILE" $(sed 's/ .*$/ [REDACTED]/' <<<"${PASSWORD_OPT[@]}")" $(printf ' %q' "$@")
+	log "forge script --sender "$FOUNDRY_ETH_FROM" --keystore "$FOUNDRY_ETH_KEYSTORE_FILE" $(sed 's/ .*$/ [REDACTED]/' <<<"${PASSWORD_OPT[@]}")" $(printf ' %q' "$@")
 	# Currently `forge create` sends the logs to stdout instead of stderr.
 	# This makes it hard to compose its output with other commands, so here we are:
 	# 1. Duplicating stdout to stderr through `tee`
 	# 2. Extracting only the address of the deployed contract to stdout
-	RESPONSE=$(forge script --json --sender "$FOUNDRY_ETH_FROM" --keystore "$FOUNDRY_ETH_KEYSTORE_FILE" "${PASSWORD_OPT[@]}" "$@" | tee >(cat 1>&2))
+	RESPONSE=$(forge script --sender "$FOUNDRY_ETH_FROM" --keystore "$FOUNDRY_ETH_KEYSTORE_FILE" "${PASSWORD_OPT[@]}" "$@" | tee >(cat 1>&2))
 
-	jq -Rr 'fromjson?' <<<"$RESPONSE"
+	if grep -- '--json' <<<"$@" >/dev/null; then
+		jq -Rr 'fromjson?' <<<"$RESPONSE"
+	else
+		echo "$RESPONSE"
+	fi
 }
 
 check-required-etherscan-api-key() {

foundry.toml

@@ -4,7 +4,7 @@ out = 'out'
 script = 'script'
 libs = ['lib']
 solc_version = '0.8.19'
-optimizer = false
+optimizer = true
 fs_permissions = [
     { access = "read", path = "./out/" },
     { access = "read", path = "./script/input/" },

package.json

@@ -11,7 +11,7 @@
     "prettier": "^2.8.7",
     "prettier-plugin-solidity": "^1.1.3",
     "prettier-plugin-toml": "^0.3.1",
-    "solhint": "^3.4.1",
+    "solhint": "^3.6.2",
     "solhint-plugin-prettier": "^0.0.5"
   },
   "scripts": {

script/CheckStakingRewardsDeploy.s.sol

@@ -0,0 +1,98 @@
+// SPDX-FileCopyrightText: © 2023 Dai Foundation <www.daifoundation.org>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+pragma solidity ^0.8.0;
+
+import {Script} from "forge-std/Script.sol";
+import {stdJson} from "forge-std/StdJson.sol";
+import {ScriptTools} from "dss-test/ScriptTools.sol";
+
+import {ConfigReader} from "./helpers/Config.sol";
+
+interface WardsLike {
+    function wards(address who) external view returns (uint256);
+}
+
+interface VestedRewardsDistributionLike {
+    function vestId() external view returns (uint256);
+}
+
+interface StakingRewardsLike {
+    function owner() external view returns (address);
+
+    function stakingToken() external view returns (address);
+
+    function rewardsToken() external view returns (address);
+
+    function rewardsDistribution() external view returns (address);
+}
+
+interface DssVestWithGemLike {
+    function gem() external view returns (address);
+
+    function tot(uint256 vestId) external view returns (uint256);
+
+    function bgn(uint256 vestId) external view returns (uint256);
+
+    function clf(uint256 vestId) external view returns (uint256);
+
+    function fin(uint256 vestId) external view returns (uint256);
+
+    function usr(uint256 vestId) external view returns (address);
+
+    function valid(uint256 _id) external view returns (bool);
+}
+
+contract CheckStakingRewardsDeployScript is Script {
+    using stdJson for string;
+    using ScriptTools for string;
+
+    function run() external returns (bool) {
+        ConfigReader reader = new ConfigReader(ScriptTools.loadConfig());
+
+        address admin = reader.readAddress(".admin");
+        address ngt = reader.readAddress(".ngt");
+        address nst = reader.readAddress(".nst");
+        address dist = reader.readAddress(".dist");
+        address farm = reader.readAddress(".farm");
+        address vest = reader.readAddress(".vest");
+        uint256 vestId = reader.readUint(".vestId");
+        uint256 vestTot = reader.readUint(".vestTot");
+        uint256 vestBgn = reader.readUint(".vestBgn");
+        uint256 vestTau = reader.readUint(".vestTau");
+        uint256 vestEta = reader.readUint(".vestEta");
+
+        require(WardsLike(dist).wards(admin) == 1, "vested-rewards-distribution/pause-proxy-not-relied");
+        require(VestedRewardsDistributionLike(dist).vestId() == vestId, "vested-rewards-distribution/invalid-vest-id");
+
+        require(StakingRewardsLike(farm).owner() == admin, "staking-rewards/pause-proxy-not-owner");
+        require(StakingRewardsLike(farm).rewardsToken() == ngt, "staking-rewards/invalid-rewards-token");
+        require(StakingRewardsLike(farm).stakingToken() == nst, "staking-rewards/invalid-rewards-token");
+        require(StakingRewardsLike(farm).rewardsDistribution() == dist, "staking-rewards/invalid-rewards-distribution");
+
+        require(WardsLike(ngt).wards(vest) == 1, "ngt/dss-vest-not-ward");
+
+        require(WardsLike(vest).wards(admin) == 1, "dss-vest/pause-proxy-not-relied");
+        require(DssVestWithGemLike(vest).gem() == ngt, "dss-vest/invalid-gem");
+        require(DssVestWithGemLike(vest).valid(vestId), "dss-vest/invalid-vest-id");
+        require(DssVestWithGemLike(vest).usr(vestId) == dist, "dss-vest/wrong-dist");
+        require(DssVestWithGemLike(vest).tot(vestId) == vestTot, "dss-vest/invalid-tot");
+        require(DssVestWithGemLike(vest).bgn(vestId) == vestBgn, "dss-vest/invalid-bgn");
+        require(DssVestWithGemLike(vest).clf(vestId) == vestBgn + vestEta, "dss-vest/invalid-eta");
+        require(DssVestWithGemLike(vest).fin(vestId) == vestBgn + vestTau, "dss-vest/invalid-tau");
+
+        return true;
+    }
+}

script/StakingRewardsDeploy.s.sol

@@ -0,0 +1,96 @@
+// SPDX-FileCopyrightText: © 2023 Dai Foundation <www.daifoundation.org>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+pragma solidity ^0.8.0;
+
+import {Script} from "forge-std/Script.sol";
+import {stdJson} from "forge-std/StdJson.sol";
+import {ScriptTools} from "dss-test/ScriptTools.sol";
+
+import {ConfigReader} from "./helpers/Config.sol";
+import {StakingRewardsDeploy, StakingRewardsDeployParams} from "./dependencies/StakingRewardsDeploy.sol";
+import {
+    VestedRewardsDistributionDeploy,
+    VestedRewardsDistributionDeployParams
+} from "./dependencies/VestedRewardsDistributionDeploy.sol";
+import {StakingRewardsInit, StakingRewardsInitParams} from "./dependencies/StakingRewardsInit.sol";
+import {
+    VestedRewardsDistributionInit,
+    VestedRewardsDistributionInitParams
+} from "./dependencies/VestedRewardsDistributionInit.sol";
+import {VestInit, VestInitParams, VestCreateParams} from "./dependencies/VestInit.sol";
+
+contract StakingRewardsDeployScript is Script {
+    using stdJson for string;
+    using ScriptTools for string;
+
+    string internal constant NAME = "StakingRewards";
+
+    function run() external {
+        ConfigReader reader = new ConfigReader(ScriptTools.loadConfig());
+
+        address admin = reader.readAddress(".admin");
+        address ngt = reader.readAddress(".ngt");
+        address nst = reader.readAddress(".nst");
+        address dist = reader.readAddressOptional(".dist");
+        address farm = reader.readAddressOptional(".farm");
+        address vest = reader.readAddressOptional(".vest");
+        uint256 vestTot = reader.readUintOptional(".vestTot");
+        uint256 vestBgn = reader.readUintOptional(".vestBgn");
+        uint256 vestTau = reader.readUintOptional(".vestTau");
+        uint256 vestEta = reader.readUintOptional(".vestEta");
+
+        vm.startBroadcast();
+
+        if (vest == address(0)) {
+            vest = deployCode("DssVest.sol:DssVestMintable", abi.encode(ngt));
+            VestInit.init(VestInitParams({vest: vest, cap: type(uint256).max}));
+        }
+
+        if (farm == address(0)) {
+            farm = StakingRewardsDeploy.deploy(
+                StakingRewardsDeployParams({owner: admin, stakingToken: nst, rewardsToken: ngt})
+            );
+        }
+
+        if (dist == address(0)) {
+            dist = VestedRewardsDistributionDeploy.deploy(
+                VestedRewardsDistributionDeployParams({deployer: msg.sender, owner: admin, vest: vest, farm: farm})
+            );
+        }
+
+        StakingRewardsInit.init(StakingRewardsInitParams({farm: farm, dist: dist}));
+
+        uint256 vestId;
+
+        if (vestTot > 0) {
+            vestId = VestInit.create(
+                VestCreateParams({vest: vest, usr: dist, tot: vestTot, bgn: vestBgn, tau: vestTau, eta: vestEta})
+            );
+
+            VestedRewardsDistributionInit.init(VestedRewardsDistributionInitParams({dist: dist, vestId: vestId}));
+        }
+
+        vm.stopBroadcast();
+
+        ScriptTools.exportContract(NAME, "admin", admin);
+        ScriptTools.exportContract(NAME, "dist", dist);
+        ScriptTools.exportContract(NAME, "farm", farm);
+        ScriptTools.exportContract(NAME, "ngt", ngt);
+        ScriptTools.exportContract(NAME, "nst", nst);
+        ScriptTools.exportContract(NAME, "vest", vest);
+        ScriptTools.exportContract(NAME, "vestId", address(uint160(vestId)));
+    }
+}

script/dependencies/SDAODeploy.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+pragma solidity ^0.8.0;
+
+import {ScriptTools} from "dss-test/ScriptTools.sol";
+import {SDAO} from "../../src/SDAO.sol";
+
+library SDAODeploy {
+    function deploy(
+        address deployer,
+        address owner,
+        string memory name,
+        string memory symbol
+    ) internal returns (address token) {
+        token = address(new SDAO(name, symbol));
+
+        ScriptTools.switchOwner(token, deployer, owner);
+    }
+}