feat: enable CCTP functionality (#2)

Author: SidestreamStrongStrawberry

.gitignore

@@ -7,6 +7,11 @@ out/
 /broadcast/*/*/run-[0-9]*.json
 /broadcast/**/dry-run/
 
+# Ignores development address logs
+!/script/output
+/script/output/*/output-[0-9]*.json
+/script/output/*/dry-run/*.json
+
 # Docs
 docs/
 

README.md

@@ -6,7 +6,7 @@ Easily deploy the Sky allocation system and Spark ALM controller to any EVM-comp
 
 - [`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`
+- Mock contracts: `vat`, `usdsJoin`, `usds`, `sUsds`, `jug`, `usdsDai`, `dai`, `daiJoin`, `psmLite`
 
 ## Prerequisites
 
@@ -21,21 +21,25 @@ To deploy and configure contracts to the Avalanche Fuji public testnet:
     - 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`
+2. Set correct variables inside `script/input/{CHAIN_ID}/input.json` based on the "Configuration Variables" section below
 
-3. Dry-run a transaction to determine the amount of required gas
+3. Create correct output folders in `script` (`script/output/{CHAIN_ID}/dry-run/`) to log created contracts address correctly
+
+4. 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. Get enough gas tokens using a faucet
+
+6. (optional) Required for CCTP testing: Get enough testnet USDC from [Circle USDC faucet](https://faucet.circle.com/). This is required by the LitePSM mock contract which expects USDC to be present on the deployer wallet.
 
-5. Deploy, configure and verify contracts
+7. 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 
+8. (optional) Commit generated `broadcast/SetUpAll.s.sol/11155111/run-latest.json` and `script/output/11155111/output-latest.json` to record deployed contract addresses 
 
 
 ## Environment Variables
@@ -69,6 +73,18 @@ To deploy and configure contracts to the Avalanche Fuji public testnet:
      forge script script/SetUpAll.s.sol:SetUpAll --fork-url ${CHAIN} -vv
      `````
 
+### `input.json` Configuration Variables
+
+| Variable                | Description                                                                                                                        |
+|-------------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| `ilk`                   | Collateral type identifier (e.g., `"ALLOCATOR_STAR_A"`)                                                                           |
+| `usdcUnitSize`          | Amount of USDC (in smallest units, e.g., wei) to use for testing (default: 10)                                                    |
+| `cctpDestinationDomain` | CCTP destination domain ID for cross-chain messaging ([see supported domains](https://developers.circle.com/cctp/solana-programs#devnet-program-addresses))|
+| `cctpTokenMessenger`    | Address of the CCTP Token Messenger contract on the target chain ([see EVM contracts](https://developers.circle.com/cctp/evm-smart-contracts#tokenmessenger-testnet))         |
+| `cctpRecipient`         | USDC token account of the CCTP transfer recipient in HEX, decode can be done using tools like [this](https://appdevtools.com/base58-encoder-decoder). _It should correspond to the destination domain_ |
+| `usdc`                  | Address of the USDC token contract on the target chain ([see contract addresses](https://developers.circle.com/stablecoins/usdc-contract-addresses)) |
+| `relayer`               | Address of the relayer to be used by the ALM controller                                                                           |
+
 
 ### Running Tests
 

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

@@ -7,7 +7,8 @@ optimizer = true
 optimizer_runs = 200
 verbosity = 1
 fs_permissions = [
-    { access = "read", path = "./script/input/"}
+    { access = "read", path = "./script/input/"},
+    { access = "read-write", path = "./script/output/"}
 ]
 [rpc_endpoints]
 fuji = "${FUJI_RPC_URL}"

foundry.toml

@@ -20,16 +20,20 @@ contract SetUpAll is Script {
     function setUp() public {}
 
     function run() public {
+        vm.setEnv("FOUNDRY_EXPORTS_OVERWRITE_LATEST", "true");
+
         VmSafe.Wallet memory deployer = vm.createWallet(vm.envUint("PRIVATE_KEY"));
+
         address admin = deployer.addr;
 
         string memory config = ScriptTools.loadConfig("input");
         bytes32 ilk = ScriptTools.stringToBytes32(config.readString(".ilk"));
+        address usdc = config.readAddress(".usdc");
 
         vm.startBroadcast(deployer.privateKey);
 
         // 1. Deploy mock contracts
-        MockContracts memory mocks = SetUpAllLib.deployMockContracts();
+        MockContracts memory mocks = SetUpAllLib.deployMockContracts(usdc, admin);
 
         // 2. Deploy AllocatorSystem
         AllocatorSharedInstance memory sharedInstance = AllocatorDeploy.deployShared(deployer.addr, admin);
@@ -40,23 +44,44 @@ contract SetUpAll is Script {
         address[] memory relayers = new address[](1);
         relayers[0] = config.readAddress(".relayer");
 
-        ControllerInstance memory controllerInstance = SetUpAllLib.setUpAllocatorAndALMController({
+        SetUpAllLib.AllocatorSetupParams memory params = SetUpAllLib.AllocatorSetupParams({
             ilk: ilk,
             ilkInstance: ilkInstance,
             sharedInstance: sharedInstance,
-            mocks: mocks,
             admin: admin,
+            mocks: mocks,
             cctp: config.readAddress(".cctpTokenMessenger"),
             relayers: relayers
         });
+        ControllerInstance memory controllerInstance = SetUpAllLib.setUpAllocatorAndALMController(params);
 
         // 4. Set up rate limits for the controller
-        SetUpAllLib.setMainnetControllerRateLimits({
-            controllerInstance: controllerInstance,
-            usdcUnitSize: config.readUint(".usdcUnitSize"),
-            susds: address(mocks.susds)
-        });
+        SetUpAllLib.setMainnetControllerRateLimits(
+            SetUpAllLib.RateLimitParams({
+                controllerInstance: controllerInstance,
+                usdcUnitSize: config.readUint(".usdcUnitSize"),
+                susds: address(mocks.susds),
+                cctpDestinationDomain: uint32(config.readUint(".cctpDestinationDomain")),
+                cctpRecipient: config.readBytes32(".cctpRecipient")
+            })
+        );
 
         vm.stopBroadcast();
+
+        // 5. Log contract addresses
+        bool isBroadCast = vm.isContext(VmSafe.ForgeContext.ScriptBroadcast);
+        string memory outputSlug = isBroadCast ? "output" : "dry-run/output";
+        ScriptTools.exportContract(outputSlug, "almProxy", controllerInstance.almProxy);
+        ScriptTools.exportContract(outputSlug, "controller", controllerInstance.controller);
+        ScriptTools.exportContract(outputSlug, "rateLimits", controllerInstance.rateLimits);
+        ScriptTools.exportContract(outputSlug, "dai", mocks.dai);
+        ScriptTools.exportContract(outputSlug, "daiJoin", mocks.daiJoin);
+        ScriptTools.exportContract(outputSlug, "daiUsds", mocks.daiUsds);
+        ScriptTools.exportContract(outputSlug, "usds", mocks.usds);
+        ScriptTools.exportContract(outputSlug, "usdsJoin", mocks.usdsJoin);
+        ScriptTools.exportContract(outputSlug, "susds", mocks.susds);
+        ScriptTools.exportContract(outputSlug, "vat", mocks.vat);
+        ScriptTools.exportContract(outputSlug, "jug", mocks.jug);
+        ScriptTools.exportContract(outputSlug, "psm", mocks.psm);
     }
 }

script/SetUpAll.s.sol

@@ -1,6 +1,9 @@
 {
-  "relayer": "0x5B4724De84203cB05F126a29D92065Ad08f7F34B",
-  "cctpTokenMessenger": "0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5",
   "ilk": "ALLOCATOR_STAR_A",
-  "usdcUnitSize": 10
+  "usdcUnitSize": 10,
+  "cctpDestinationDomain": "5",
+  "cctpTokenMessenger": "0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5",
+  "cctpRecipient": "0x98997f46cd297f909c83b8b140d7725d00e61413ad5942760e8cb819acbcd7ce",
+  "usdc": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
+  "relayer": "0x9b688229dfdf12dbc98d3096cc66c13fe11c81f4"
 }

script/input/11155111/input.json

@@ -1,6 +1,9 @@
 {
-  "relayer": "0x1234567890abcdef1234567890abcdef12345678",
-  "cctpTokenMessenger": "0xeb08f243E5d3FCFF26A9E38Ae5520A669f4019d0",
   "ilk": "ALLOCATOR_STAR_A",
-  "usdcUnitSize": 10
+  "usdcUnitSize": 10,
+  "cctpDestinationDomain": "5",
+  "cctpTokenMessenger": "0xeb08f243E5d3FCFF26A9E38Ae5520A669f4019d0",
+  "cctpRecipient": "0x98997f46cd297f909c83b8b140d7725d00e61413ad5942760e8cb819acbcd7ce",
+  "usdc": "0x5425890298aed601595a70AB815c96711a31Bc65",
+  "relayer": "0x9b688229dfdf12dbc98d3096cc66c13fe11c81f4"
 }

script/input/43113/input.json

@@ -0,0 +1,14 @@
+{
+  "almProxy": "0xa2124b543565174b43ba8a16ED017967B1d6738F",
+  "controller": "0x2eE1fC29649f12bD924FE30084EeA6f55BB6C1f1",
+  "dai": "0x497950ad3b4D39375dB7Ae26a22C0455068e8304",
+  "daiJoin": "0x52F3E481DE4DfD63042e80ba56f38B923145D6C1",
+  "daiUsds": "0xC675c2a38a7221a441B702DA1863e7Cc9B234845",
+  "jug": "0x4a05900747c408467b4d8667589190b1a3bA2AB5",
+  "psm": "0xF5c24AfD262297DC304Af4827053a12E66E18974",
+  "rateLimits": "0x7DebC9036aC033a75fB466e97368f4613B92E8d0",
+  "susds": "0xF0214867b8004f12D254d2261aB066D3E1C0272c",
+  "usds": "0x43C22430f8B017650553752f1924A2550185d051",
+  "usdsJoin": "0xA857e55a12868a0E9F73b0b8B0afD1f81c7F6579",
+  "vat": "0x10E15DD253d0F5981D1860C8151dfDBb8BbF802C"
+}