Temple v2 deploy scripts

protocol/.gitignore

@@ -24,4 +24,7 @@ dist
 coverage
 coverage.json
 lcov.info
-report
+report
+
+# autogenerated fork args
+scripts/deploys/localhost/deploymentArgs

protocol/README.md

@@ -30,6 +30,45 @@ You can also run and test locally by replacing `yarn hardhat:testnet` with `yarn
 in order to setup the right local state
 
 
+
+#### Local Deployment
+
+The protocol app uses hardhat for development. The following steps will compile the contracts and deploy to a local hardhat node
+
+```bash
+# Compile the contracts
+yarn compile
+
+# Generate the typechain.
+yarn typechain
+
+The protocol test suite can be run without deploying to a local-node by running
+
+```bash
+# Run tests, no deployment neccessary
+yarn test
+```
+
+#### Local Forks
+
+##### 1. Temple V2 - TLC
+
+In one terminal window:
+```bash
+# Run a local node forked off mainnet
+yarn local-fork:mainnet
+```
+
+In another window run the following scripts:
+```bash
+# Deploy temple v2 contracts
+# This also include the transfer ownership script
+yarn local-fork:deploy:templev2
+
+# Then finally some forked mainnet tests for Temple v2
+yarn local-fork:test:templev2
+```
+
 ## VSCode Testing
 
 https://hardhat.org/guides/vscode-tests.html
@@ -46,3 +85,37 @@ tl;dr;
 3. For each category + finding, analyse and either:
    1. Fix the issue or
    2. If it's a false positive then ignore the finding by typing the list index number in the triage.
+
+
+## Temple V2 deployment
+
+The following are the steps to deploy temple v2 latest contracts to mainnet. Copy & paste each `npx hardhat run ...` command from `core`, `tlc`, `gnosis-strategy-1` & `ramos` in order to deploy to mainnet, after each successful deployment, please do the following:
+
+- (**mandatory**) Deploy each contract under `scripts/deploy/mainnet/v2/**/**.ts`, you can find various examples in `scripts/deploys/localhost/v2/deploy-localhost-forsk.sh`, please remember to use the mainnet network, e.g `npx hardhat run --network mainnet scripts/deploys/mainnet/v2/core/02-circuit-breaker-proxy.ts`. *NB you'll need to deploy first the core contracts. Remember to run the post-deployment scripts for each folder to setup the contract*
+- (**mandatory**) Copy newest generated contract address in its respective place under `scripts/deploys/mainnet/v2/core/contract-addressses.ts`
+- (**recommended**) Verify & publish contract src to etherscan:
+  ```
+  npx hardhat verify --network mainnet XXXX --constructor-args scripts/deploys/mainnet/deploymentArgs/XXXX.js
+  ```
+
+### 3. Commit & merge to main
+
+- 3.1 Create a new PR and commit the latest changes from above steps for another member(s) of the team to confirm
+
+### 4. Transfer ownership from deployer to multisigs
+
+- 4.1 Once msig addresses have been approved by temple core team, please update both EXECUTOR & RESCUER multisig addresses (`mainnet.**.**.**_MSIG`) in `scripts/deploys/mainnet/v2/contract-addresses.ts` file. Be aware that strategies may have different executor/rescuer msig.
+
+- 4.2 Transfer deployer ownership to predefined msig addresses on the step above with
+  ```
+  npx hardhat run --network mainnet scripts/deploys/mainnet/v2/post-deploy/999-transfer-ownership.ts
+  ```
+
+### 5. Initial rescuer & executor msig transactions
+
+The new rescuer & executor msig contract addresses would need to perform a set of initial transactions to be able to operate as expected, please find below the steps required:
+
+- 5.1 Update the transaction builder batch files `scripts/deploys/mainnet/v2/post-deploy/temple-v2-XXX-transactions-batch.json`, change all the placeholders `0xXXXX` for the relevant address in `scripts/deploys/mainnet/v2/contract-addresses.ts` under the mainnet network.
+
+- 5.2 Share the updated transaction builder batch file `temple-v2-XXX-transactions-batch.json` with any of the MC team members, that way they can import it in their safe app `https://app.safe.global/` > `transaction builder` and approve it accordingly. Please be sure to share each file accordingly to the msig address.
+

protocol/contracts/amo/Ramos.sol

@@ -74,7 +74,7 @@ contract Ramos is IRamos, TempleElevatedAccess, Pausable {
     /// @notice The Treasury Price Index (TPI) Oracle
     ITreasuryPriceIndexOracle public override tpiOracle;
 
-    /// @notice The vault from where to borrow and repay the Protocol Token
+    /// @notice The vault from where to borrow and repay the Protocol & Quote Token
     IRamosTokenVault public override tokenVault;
 
     /// @notice The percentage bounds (in bps) beyond which to rebalance up or down
@@ -180,7 +180,7 @@ contract Ramos is IRamos, TempleElevatedAccess, Pausable {
     }
 
     /**
-     * @notice Set the Treasury Price Index (TPI) Oracle
+     * @notice Set the token vault - where to borrow and repay the Protocol & Quote Tokens
      */
     function setTokenVault(address vault) external override onlyElevatedAccess {
         emit TokenVaultSet(vault);

protocol/contracts/interfaces/v2/templeLineOfCredit/ITempleLineOfCredit.sol

@@ -120,7 +120,7 @@ interface ITempleLineOfCredit is ITlcDataTypes, ITlcEventsAndErrors {
      * - When users repay, the DAI is repaid to the TRV 
      *      (reducing the dUSD debt of the TlcStrategy)
      * - When there is a liquidation, the seized Temple collateral is paid to the TRV
-     *      (reducing the dTEMPLE debt of the TlcStrategy)
+     *      (reducing the dUSD debt of the TlcStrategy)
      */
     function treasuryReservesVault() external view returns (ITreasuryReservesVault);
 

protocol/hardhat.config.ts

@@ -182,6 +182,10 @@ module.exports = {
             : [],
         gasPrice: 2000000000,
     },
+    anvil: {
+        url: "http://127.0.0.1:8545/",
+        accounts: "remote",
+    },
   },
   etherscan: {
 

protocol/package.json

@@ -6,6 +6,7 @@
   "author": "templeDOA",
   "license": "AGPL-3.0-or-later",
   "devDependencies": {
+    "@balancer-labs/sdk": "^1.1.2",
     "@ethersproject/bytes": "^5.7.0",
     "@gnosis.pm/safe-contracts": "^1.3.0",
     "@nomicfoundation/hardhat-chai-matchers": "^1.0.4",
@@ -61,6 +62,9 @@
     "hardhat": "hardhat",
     "local-metrics": "hardhat run --network localhost scripts/metrics.ts",
     "local-fork": "hardhat node --fork https://eth-mainnet.alchemyapi.io/v2/5uWfALq4t1xR49V3EW5bBZEE4xh97l-A --fork-block-number 13205117",
+    "local-fork:mainnet": "hardhat node --fork https://eth-mainnet.g.alchemy.com/v2/LjzU7NEw1jfJZSDBP10rGeg53cSlzscP --fork-block-number 17625800",
+    "local-fork:deploy:templev2": "$PWD/scripts/deploys/localhost/v2/deploy-localhost-fork.sh",
+    "local-fork:test:templev2": "hardhat run --network localhost scripts/deploys/localhost/v2/999-localhost-fork-test.ts",
     "forge-test": "forge test",
     "forge-coverage": "forge coverage",
     "forge-coverage-html": "forge coverage --report lcov && genhtml lcov.info -o report --branch-coverage --legend"

protocol/scripts/deploys/helpers.ts

@@ -564,6 +564,7 @@ const expectedEnvvars: { [key: string]: string[] } = {
   gnosisChiado: ['GNOSIS_CHIADO_ADDRESS_PRIVATE_KEY', 'GNOSIS_CHIADO_RPC_URL'],
   polygonMumbai: ['MUMBAI_ADDRESS_PRIVATE_KEY', 'MUMBAI_RPC_URL'],
   sepolia: ['SEPOLIA_ADDRESS_PRIVATE_KEY', 'SEPOLIA_RPC_URL'],
+  anvil: [],
   localhost: [],
 };