[SC-57] Gnosis Chain Deploy

.github/workflows/test.yml

@@ -36,7 +36,13 @@ jobs:
 
       - name: Run Forge tests
         env:
-          ETH_RPC_URL: ${{secrets.ETH_RPC_URL}}
+          MAINNET_RPC_URL: ${{secrets.MAINNET_RPC_URL}}
+          OPTIMISM_RPC_URL: ${{secrets.OPTIMISM_RPC_URL}}
+          ARBITRUM_ONE_RPC_URL: ${{secrets.ARBITRUM_ONE_RPC_URL}}
+          ARBITRUM_NOVA_RPC_URL: ${{secrets.ARBITRUM_NOVA_RPC_URL}}
+          GNOSIS_CHAIN_RPC_URL: ${{secrets.GNOSIS_CHAIN_RPC_URL}}
+          BASE_RPC_URL: ${{secrets.BASE_RPC_URL}}
+          GOERLI_RPC_URL: ${{secrets.GOERLI_RPC_URL}}
         run: |
           forge test -vvv
         id: test

.gitmodules

@@ -24,3 +24,6 @@
 [submodule "lib/dss-test"]
 	path = lib/dss-test
 	url = https://github.com/makerdao/dss-test
+[submodule "lib/governance-crosschain-bridges"]
+	path = lib/governance-crosschain-bridges
+	url = https://github.com/marsfoundation/governance-crosschain-bridges

Makefile

@@ -1,3 +1,7 @@
 deploy      :; forge script script/DeploySpark.s.sol:DeploySpark --rpc-url ${ETH_RPC_URL} --sender ${ETH_FROM} --broadcast --verify --slow
 deploy-sce  :; forge script script/DeploySparkConfigEngine.s.sol:DeploySparkConfigEngine --optimizer-runs 200 --rpc-url ${ETH_RPC_URL} --sender ${ETH_FROM} --broadcast --verify --slow
 deploy-pool :; forge script script/DeployPoolImplementation.s.sol:DeployPoolImplementation --rpc-url ${ETH_RPC_URL} --sender ${ETH_FROM} --broadcast --verify --slow
+
+# Special case for verifier url and we remove --slow
+deploy-gnosis :; ETHERSCAN_API_KEY=${GNOSISSCAN_API_KEY} forge script script/DeploySpark.s.sol:DeploySpark --rpc-url ${ETH_RPC_URL} --sender ${ETH_FROM} --broadcast --verify --verifier-url "https://api.gnosisscan.io/api"
+deploy-sce-gnosis :; ETHERSCAN_API_KEY=${GNOSISSCAN_API_KEY} forge script script/DeploySparkConfigEngine.s.sol:DeploySparkConfigEngine --optimizer-runs 200 --rpc-url ${ETH_RPC_URL} --sender ${ETH_FROM} --broadcast --verify --verifier-url "https://api.gnosisscan.io/api"

README.md

@@ -11,6 +11,36 @@ Deploy Spark Lend (Custom Instance): `INSTANCE_ID=<Custom Instance Name> ETH_RPC
 Deploy Config Engine (Custom Instance): `INSTANCE_ID=<Custom Instance Name> ETH_RPC_URL=<YOUR RPC ENDPOINT> make deploy-engine`  
 Deploy Pool Upgrade: `ETH_RPC_URL=<YOUR RPC ENDPOINT> make deploy-pool` (Please note you need to set the proper `POOL_REVISION` in `Pool.sol`)  
 
+Please note there may be some custom configs so please check the `Makefile`.
+
+## Full Instructions to Deploy
+
+These instructions assume that an `admin` L2 Executor governance relay has already been deployed. If you haven't deployed this already then please follow the instructions to deploy in https://github.com/marsfoundation/spark-gov-relay .
+
+As deployer:
+
+1. Create directory `script/input/<CHAINID>/`.
+1. Copy `primary.json` from `script/input/100/` to your newly created directory.
+1. Update relevant fields in the json. `admin` will usually point to the L2 Executor governance relay.
+1. Run `ETH_RPC_URL=<YOUR RPC ENDPOINT> make deploy` to deploy an empty instance of Spark Lend.
+1. This will generate an output file in `script/output/<CHAINID>/primary-<TIMESTAMP>.json`. Rename this to `primary-latest.json`.
+1. Inside `script/output/<CHAINID>/` create the directory `broadcast`.
+1. Copy the broadcast file generated from `broadcast/DeploySpark.s.sol/<CHAINID>/run-latest.json` into the newly created broadcast directory. Rename it to `primary-<DATE>.json`. This broadcast file will be used to validate the deploy by reviewers.
+1. Run `ETH_RPC_URL=<YOUR RPC ENDPOINT> make deploy-engine` to deploy an instance of the config engine.
+1. This will generate an output file in `script/output/<CHAINID>/primary-sce-<TIMESTAMP>.json`. Rename this to `primary-sce-latest.json`.
+1. Copy the broadcast file generated from `broadcast/DeploySparkConfigEngine.s.sol/<CHAINID>/run-latest.json` into the broadcast directory. Rename it to `primary-sce-<DATE>.json`.
+1. Copy the file `test/deploys/100/primary/SparkDeploy_20230714_GnosisPrimary.t.sol` to `test/deploys/<CHAINID>/primary/SparkDeploy_<DATE>_<CHAINNAME>Primary.t.sol`.
+1. Update the file as necessary. Tests should pass.
+1. Notify the reviewers that the deploy is ready for review.
+
+As reviewer:
+
+1. Verify the deployer followed all steps above.
+1. Verify all contract addresses in the json files makes sense. IE `admin` is the L2 Executor. `pool` is the pool proxy, etc.
+1. Run `forge test`. This will ensure the deployment configuration was done correctly, and will check most of the permissions (not all - you need to check some manually below).
+1. Verify the bytecode of all deployed contracts for both the Spark Lend and Config Engine Deploys. (see detailed instructions below on how to do this)
+1. Manually verify no extra permissions have been added on the `ACLManager`. The automated checks will prove that `admin` has access and `deployer` doesn't, but the `deployer` may have added another address in an intermediate transaction. In the transactions tab for the `ACLManager` ensure that only the proper adds and removes that correspond to the deployer script are present with either the address `deployer` (which should be the deployer address) and the `admin`.
+
 ## Verifying Bytecode on Deploys
 
 ### To Install
@@ -21,7 +51,7 @@ Deploy Pool Upgrade: `ETH_RPC_URL=<YOUR RPC ENDPOINT> make deploy-pool` (Please
 
 ### To Run
 
-Run `./validate-deploy.sh path/to/broadcast.json` (Be sure to `forge build` with proper settings first)
+Run `./validate-deploy.sh path/to/broadcast.json --local` (Be sure to `forge build` with proper settings first)
 
 If you want to delete previously verified contracts then run `rm -rf /tmp/sourcify/repository/contracts/*`
 

script/input/100/primary.json

@@ -0,0 +1,7 @@
+{
+    "admin": "0xc4218C1127cB24a0D6c1e7D25dc34e10f2625f5A",
+    "marketId": "Spark Protocol - Gnosis Chain - Primary",
+    "nativeToken": "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d",
+    "nativeTokenOracle": "0x678df3415fc31947dA4324eC63212874be5a82f8",
+    "daiToken": "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d"
+}