feat: initial script to deploy and configure Allocator and ALM contracts (#1)

Co-authored-by: SidestreamColdMelon <[email protected]>

Author: SidestreamStrongStrawberry

.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,6 @@
+[submodule "lib/dss-allocator"]
+	path = lib/dss-allocator
+	url = https://github.com/sky-ecosystem/dss-allocator
+[submodule "lib/sky-star-alm-controller"]
+	path = lib/sky-star-alm-controller
+	url = https://github.com/sidestream-tech/sky-star-alm-controller

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
+
+To deploy and configure contracts to the Avalanche Fuji public testnet:
+
+1. Set environment variables
+    - Copy the example environment via `cp .env.dev .env`
+    - Edit `.env` to update the variables as described in the "Environment Variables" section below
+    
+2. Set the desired ALM `relayer` address inside `script/input/{CHAIN_ID}/input.json`
+
+3. Dry-run a transaction to determine the amount of required gas
+    ```sh
+    forge script script/SetUpAll.s.sol:SetUpAll --fork-url fuji -vv
+    ```
+
+4. Get enough gas tokens using a faucet
+
+5. Deploy, configure and verify contracts
+    ```sh
+    forge script script/SetUpAll.s.sol:SetUpAll --fork-url fuji -vv --broadcast --verify --slow
+    ```
+
+6. (optional) Commit 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` to use [chain id of the network](https://chainlist.org/) you're trying to deploy to. For example, to deploy to Sepolia that would be `11155111`
+2. Add new `*_RPC_URL` to the `.env` pointing to the PRC endpoint for the chain specified above, e.g:
+    ```toml
+    SEPOLIA_RPC_URL = "https://..."
+    ```
+3. Create `script/input/{CHAIN_ID}/input.json` file with relevant content
+4. Add the new verification endpoint to the [`foundry.toml`](./foundry.toml), e.g:
+     ```toml
+     sepolia = { key = "${ETHERSCAN_API_KEY}", chain = 11155111 }
+     ```
+5. Add the new `rpc_endpoints` in [`foundry.toml`](./foundry.toml), e.g.:
+     ```toml
+     sepolia = "${SEPOLIA_RPC_URL}"
+     ```
+6. Follow the "Quick start" section, while specifying the chain name under `--fork-url` (e.g. `sepolia`) when running the script, e.g.:
+     ```sh
+     forge script script/SetUpAll.s.sol:SetUpAll --fork-url ${CHAIN} -vv
+     `````
+
+
+### Running Tests
+
+- Run all tests:
+    ```sh
+    forge test
+    ```
+
+- Run a specific test by name:
+    ```sh
+    forge test --match-test ${YourTestName} -vvv
+    ```

broadcast/SetUpAll.s.sol/11155111/run-latest.json

@@ -0,0 +1,20 @@
+[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}"
+sepolia = "${SEPOLIA_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" }
+sepolia = {key = "${ETHERSCAN_API_KEY}", chain = 11155111 }
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options