feat: create deploy script

.env.dev

@@ -0,0 +1,3 @@
+FOUNDRY_ROOT_CHAINID = "43113" # Avalanche Fuji Testnet Chain ID
+PRIVATE_KEY = PRIVATE_KEY_PLACEHOLDER
+FUJI_RPC_URL = FUJI_RPC_URL_PLACEHOLDER

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Run Forge fmt
+        run: |
+          forge fmt --check
+        id: fmt
+
+      - name: Run Forge build
+        run: |
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/*/run-[0-9]*.json
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/dss-allocator"]
+	path = lib/dss-allocator
+	url = https://github.com/sky-ecosystem/dss-allocator
+[submodule "lib/dss-test"]
+	path = lib/dss-test
+	url = https://github.com/sky-ecosystem/dss-test
+[submodule "lib/sky-star-alm-controller"]
+	path = lib/sky-star-alm-controller
+	url = https://github.com/sidestream-tech/sky-star-alm-controller

Makefile

@@ -0,0 +1,16 @@
+set-up-dry-run:
+	@CHAIN=${chain}; \
+	if [ -z "$$CHAIN" ]; then CHAIN=fuji; fi; \
+	echo "Current chain: $$CHAIN"; \
+	forge script script/SetUpAll.s.sol:SetUpAll --fork-url $$CHAIN -vv
+
+set-up-run:
+	@CHAIN=${chain}; \
+	if [ -z "$$CHAIN" ]; then CHAIN=fuji; fi; \
+	echo "Current chain: $$CHAIN"; \
+	forge script script/SetUpAll.s.sol:SetUpAll --fork-url $$CHAIN -vv --broadcast --verify --slow 
+
+
+test-all:; forge test
+
+test-match:; forge test --match-test ${match} -vvv

README.md

@@ -1 +1,83 @@
-# sky-star-test-setup
+# Sky Star Test Setup
+
+Easily deploy the Sky allocation system and Spark ALM controller to any EVM-compatible chain, including all required mock contracts. This repository is designed to help Sky Stars test and validate contracts quickly. 
+
+## Included Deployments
+
+- [`dss-allocator`](https://github.com/sky-ecosystem/dss-allocator)
+- [`spark-alm-controller`](https://github.com/sparkdotfi/spark-alm-controller)
+- Mock contracts: `vat`, `usdsJoin`, `usds`, `sUsds`, `jug`, `usdsDai`, `dai`, `psmLite`
+
+## Prerequisites
+
+- [Foundry](https://book.getfoundry.sh/) must be installed.
+
+
+## Quick Start
+
+### 1. Prepare Environment
+
+- Copy the example environment file:
+    ```sh
+    cp .env.dev .env
+    ```
+- Edit `.env` and update the variables as described below.
+
+### 2. Update ilk name
+
+- Update `ilk` in [input.json](/script/input/43113/input.json)
+
+### 3. Simulate Transaction
+
+- Run a dry run (default: Avalanche Fuji):
+    ```sh
+    make set-up-dry-run
+    ```
+
+### 4. Execute transaction on Network
+
+- Broadcast the deployment and setup (default: Avalanche Fuji):
+    ```sh
+    make set-up-run
+    ```
+
+### 5. Document Results
+
+- Commit the generated output folder to record deployed contract addresses.
+
+
+## Environment Variables
+
+| Variable              | Description                                                                 |
+|-----------------------|-----------------------------------------------------------------------------|
+| `PRIVATE_KEY`         | Deployer's private key (used as admin for all contracts)                    |
+| `FOUNDRY_ROOT_CHAINID`| Chain ID for deployment                                                     |
+| `FUJI_RPC_URL`        | RPC URL for Avalanche Fuji                                                  |
+
+
+
+## Deploying to Other Chains
+
+1. Update `FOUNDRY_ROOT_CHAINID` in `.env`.
+2. Add the new RPC URL in `.env`.
+3. Add the new `rpc_endpoints` in [`foundry.toml`](./foundry.toml), e.g.:
+     ```toml
+     mainnet = "${MAINNET_RPC_URL}"
+     ```
+4. Specify the chain when running the script, e.g.:
+     ```sh
+     make deploy-dry-run chain='mainnet'
+     ```
+
+
+### Running Tests
+
+- Run all tests:
+    ```sh
+    make test-all
+    ```
+
+- Run a specific test by name:
+    ```sh
+    make test-match match="YourTestName"
+    ```

foundry.toml

@@ -0,0 +1,18 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+solc = "0.8.21"
+optimizer = true
+optimizer_runs = 200
+verbosity = 1
+fs_permissions = [
+    { access = "read", path = "./script/input/"}
+]
+[rpc_endpoints]
+fuji = "${FUJI_RPC_URL}"
+[etherscan]
+# https://testnet.snowtrace.io/documentation/recipes/foundry-verification
+fuji = { key = "verifyContract", chain = 43113, url = "https://api.routescan.io/v2/network/testnet/evm/43113/etherscan" }
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

script/SetUpAll.s.sol

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.21;
+
+import {Script, stdJson} from "forge-std/Script.sol";
+import {VmSafe} from "forge-std/Vm.sol";
+import {ScriptTools} from "dss-test/ScriptTools.sol";
+import {AllocatorDeploy} from "dss-allocator/deploy/AllocatorDeploy.sol";
+import {AllocatorSharedInstance, AllocatorIlkInstance} from "dss-allocator/deploy/AllocatorInstances.sol";
+import {MainnetControllerDeploy} from "sky-star-alm-controller/deploy/ControllerDeploy.sol";
+import {SetUpAllLib, MockContracts, ControllerInstance} from "script/libraries/SetUpAllLib.sol";
+
+interface MainnetControllerLike {
+    function LIMIT_USDS_MINT() external returns (bytes32);
+}
+
+contract SetUpAll is Script {
+    using stdJson for string;
+
+    uint256 internal constant WAD = 10 ** 18;
+
+    function setUp() public {}
+
+    function run() public {
+        string memory config = ScriptTools.loadConfig("input");
+        VmSafe.Wallet memory deployer = vm.createWallet(vm.envUint("PRIVATE_KEY"));
+        bytes32 ilk = ScriptTools.stringToBytes32(config.readString(".ilk"));
+        address admin = config.readAddress(".admin");
+        address cctpTokenMessenger = config.readAddress(".cctpTokenMessenger");
+
+        vm.startBroadcast(deployer.privateKey);
+        // 1. Deploy mock contracts
+        MockContracts memory mocks = SetUpAllLib.deployMockContracts();
+
+        // 2. Deploy AllocatorSystem
+        AllocatorSharedInstance memory sharedInstance = AllocatorDeploy.deployShared(deployer.addr, admin);
+        AllocatorIlkInstance memory ilkInstance =
+            AllocatorDeploy.deployIlk(deployer.addr, admin, sharedInstance.roles, ilk, address(mocks.usdsJoin));
+
+        // 2. Set up AllocatorSystem and set up
+        SetUpAllLib.setUpAllocatorSystem({
+            ilk: ilk,
+            ilkInstance: ilkInstance,
+            sharedInstance: sharedInstance,
+            mocks: mocks,
+            admin: admin
+        });
+
+        // 3. Deploy MainnetController
+        ControllerInstance memory controllerInstance = SetUpAllLib.deployAlmController({
+            admin: admin,
+            vault: ilkInstance.vault,
+            psm: mocks.psm,
+            daiUsds: mocks.daiUsds,
+            cctp: cctpTokenMessenger,
+            usds: mocks.usds
+        });
+
+        // 4. Set up ALM controller
+        address[] memory relayers = new address[](1);
+        relayers[0] = deployer.addr;
+        SetUpAllLib.setUpAlmController({
+            controllerInstance: controllerInstance,
+            ilkInstance: ilkInstance,
+            mocks: mocks,
+            admin: admin,
+            relayers: relayers,
+            cctpTokenMessenger: cctpTokenMessenger
+        });
+
+        // 5. Set up rate limits for the controller
+        SetUpAllLib.setMainnetControllerRateLimits({
+            controllerInstance: controllerInstance,
+            usdcUnitSize: config.readUint(".usdcUnitSize"),
+            susds: address(mocks.susds)
+        });
+
+        vm.stopBroadcast();
+    }
+}

script/input/43113/input.json

@@ -0,0 +1,6 @@
+{
+  "admin": "0x05c60a7Ea994964CF1D56c1E77B43A02afB33cCD",
+  "cctpTokenMessenger": "0xeb08f243E5d3FCFF26A9E38Ae5520A669f4019d0",
+  "ilk": "ALLOCATOR_STAR_A",
+  "usdcUnitSize": 10
+}