Configurator

.github/workflows/run-scenarios.yaml

@@ -32,7 +32,7 @@ jobs:
             !deployments/**/relations.ts
             !deployments/**/configuration.json
             !deployments/**/migrations/*
-          key: deployments-v3
+          key: deployments-v4
 
       - name: Install packages
         run: yarn install --non-interactive --frozen-lockfile && yarn build

README.md

@@ -54,6 +54,15 @@ An example deployment command looks like:
 
 `yarn deploy --network fuji`
 
+## Vendor contracts
+
+Third-party contracts (e.g. OZ proxies) live under `contracts/vendor`.
+
+There are currently two Comet-related contracts that extend directly from the vendor contracts. The contracts are:
+
+1. **TransparentUpgradeableConfiguratorProxy**: This contract extends OZ's `TransparentUpgradeableProxy`. We override the `_beforeFallback` function so that the proxy's admin can directly call the implementation. We only need this feature for the Configurator's proxy.
+2. **CometProxyAdmin**: This contract extends OZ's `ProxyAdmin`. We created a new function called `deployAndUpgradeTo`, which calls `Configurator.deploy()` and upgrades Comet proxy's implementation to this newly deployed Comet contract. This function is needed so we can pass the address of the new Comet to the `Proxy.upgrade()` call in one transaction.
+
 ## Usage
 
 Look at the scripts section inside `package.json` to find all commands.

contracts/CometFactory.sol

@@ -5,7 +5,7 @@ import "./Comet.sol";
 import "./CometConfiguration.sol";
 
 contract CometFactory is CometConfiguration {
-    function clone(Configuration memory config) external returns (address) {
+    function clone(Configuration calldata config) external returns (address) {
         return address(new Comet(config));
     }
 }

contracts/CometProxyAdmin.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: XXX ADD VALID LICENSE
+pragma solidity ^0.8.11;
+
+import "./vendor/proxy/transparent/ProxyAdmin.sol";
+
+interface Deployable {
+  function deploy() external returns (address);
+}
+
+contract CometProxyAdmin is ProxyAdmin {
+    /**
+     * @dev Deploy a new Comet and upgrade the implementation of the Comet proxy.
+     *
+     * Requirements:
+     *
+     * - This contract must be the admin of `CometProxy`.
+     */
+    function deployAndUpgradeTo(Deployable configuratorProxy, TransparentUpgradeableProxy cometProxy) public virtual onlyOwner {
+        address newCometImpl = configuratorProxy.deploy();
+        upgrade(cometProxy, newCometImpl);
+    }
+} 

contracts/Configurator.sol

@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: XXX ADD VALID LICENSE
+pragma solidity ^0.8.11;
+
+import "./CometFactory.sol";
+import "./CometConfiguration.sol";
+import "./ConfiguratorStorage.sol";
+
+contract Configurator is ConfiguratorStorage {
+
+    /// @notice An event emitted when a new version Comet is deployed.
+    event CometDeployed(address newCometAddress); // XXX Get rid of uses of the `Comet` name
+    event AdminTransferred(address oldAdmin, address newAdmin);
+
+    /// @notice An error given unauthorized method calls
+    error Unauthorized();
+    error AlreadyInitialized();
+    error InvalidAddress();
+
+    /// @notice Initializes the storage for Configurator
+    function initialize(address _admin, address _factory, Configuration calldata _config) public {
+        if (version != 0) revert AlreadyInitialized();
+        if (_admin == address(0)) revert InvalidAddress();
+        if (_factory == address(0)) revert InvalidAddress();
+
+        admin = _admin;
+        factory = _factory;
+        configuratorParams = _config;
+        version = 1;
+    }
+
+    /// @notice Sets the factory for Configurator
+    /// @dev only callable by admin
+    function setFactory(address _factory) external {
+        if (msg.sender != admin) revert Unauthorized();
+        factory = _factory;
+    }
+
+    // XXX Define other setters for setting params
+    /// @dev only callable by admin
+    function setGovernor(address _governor) external {
+        if (msg.sender != admin) revert Unauthorized();
+        configuratorParams.governor = _governor;
+    }
+
+    // XXX What about removing an asset?
+    // XXX Should we check MAX_ASSETS here as well?
+    /// @dev only callable by admin
+    function addAsset(AssetConfig calldata asset) external {
+        if (msg.sender != admin) revert Unauthorized();
+        configuratorParams.assetConfigs.push(asset);
+    }
+
+    /// @notice Gets the configuration params
+    function getConfiguration() external view returns (Configuration memory) {
+        return configuratorParams;
+    }
+
+    /// @notice Deploy a new version of the Comet implementation.
+    /// @dev callable by anyone
+    function deploy() external returns (address) {
+        address newComet = CometFactory(factory).clone(configuratorParams);
+        emit CometDeployed(newComet);
+        return newComet;
+    }
+
+    /// @notice Transfers the admin rights to a new address
+    /// @dev only callable by admin
+    function transferAdmin(address newAdmin) external {
+        if (msg.sender != admin) revert Unauthorized();
+        address oldAdmin = admin;
+        admin = newAdmin;
+        emit AdminTransferred(oldAdmin, newAdmin);
+    }
+}

contracts/ConfiguratorStorage.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: XXX ADD VALID LICENSE
+pragma solidity ^0.8.11;
+
+import "./CometConfiguration.sol";
+
+/**
+ * @title Compound's Comet Configuration Storage Interface
+ * @dev Versions can enforce append-only storage slots via inheritance.
+ * @author Compound
+ */
+contract ConfiguratorStorage is CometConfiguration {
+    /// @notice The current version of Configurator. This version should be
+    /// checked in the initializer function.
+    uint public version;
+
+    /// @notice Configuration settings used to deploy new Comet instances
+    /// by the configurator
+    /// @dev This needs to be internal to avoid a `CompilerError: Stack too deep
+    /// when compiling inline assembly` error that is caused by the default
+    /// getters created for public variables.
+    Configuration internal configuratorParams; // XXX can create a public getter for this
+
+    /// @notice The admin of the protocol
+    address public admin; 
+
+    /// @notice Address for the Comet factory contract
+    address public factory;
+}

contracts/TransparentUpgradeableConfiguratorProxy.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: XXX ADD VALID LICENSE
+pragma solidity ^0.8.11;
+
+import "./vendor/proxy/transparent/TransparentUpgradeableProxy.sol";
+
+/**
+ * @dev A TransparentUpgradeableProxy that allows its admin to call its implementation.
+ */
+contract TransparentUpgradeableConfiguratorProxy is TransparentUpgradeableProxy {
+    /**
+     * @dev Initializes an upgradeable proxy managed by `_admin`, backed by the implementation at `_logic`, and
+     * optionally initialized with `_data` as explained in {UpgradeableProxy-constructor}.
+     */
+    constructor(address _logic, address _admin, bytes memory _data) payable TransparentUpgradeableProxy(_logic, _admin, _data) {}
+
+    // XXX triple check!
+    /**
+     * @dev Overrides the TransparentUpgradeableProxy's _beforeFallback so admin can call the implementation.
+     */
+    function _beforeFallback() internal virtual override {}
+}

contracts/test/Timelock.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: XXX ADD VALID LICENSE
+
+pragma solidity ^0.8.11;
+
+/**
+ * @dev Simple Timelock for more realistic deployments and scenarios.
+ */
+contract Timelock {
+
+    function execute(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata data) public {
+        for (uint i = 0; i < targets.length; i++) {
+            bytes memory callData;
+
+            if (bytes(signatures[i]).length == 0) {
+                callData = data[i];
+            } else {
+                callData = abi.encodePacked(bytes4(keccak256(bytes(signatures[i]))), data[i]);
+            }
+
+            // solhint-disable-next-line avoid-low-level-calls
+            (bool success, ) = targets[i].call{value: values[i]}(callData);
+            require(success, "failed to call");
+        }
+    }
+}

deployments/fuji/configuration.json

@@ -1,7 +1,7 @@
 {
   "symbol": "📈USDC",
-  "governor": "0xdd940fc821853799eaf27e9eb0a420ed3bcdc3ef",
-  "pauseGuardian": "0xdd940fc821853799eaf27e9eb0a420ed3bcdc3ef",
+  "governor": "0x1C2C3c2E3232080e0738187520372e30Ce2e34CB",
+  "pauseGuardian": "0x1C2C3c2E3232080e0738187520372e30Ce2e34CB",
   "baseToken": "USDC",
   "baseTokenPriceFeed": "0x7898AcCC83587C3C55116c5230C17a6Cd9C71bad",
   "reserveRate": 0.1,

deployments/fuji/migrations/1644432723_deploy_fuji.ts

@@ -53,20 +53,20 @@ migration('1644432723_deploy_fuji', {
       )
     );
     await wait(usdc.configureMinter(signerAddress, exp(10000, 6)));
+    await wait(usdc.mint(signerAddress, exp(10000, 6)));
+
+    let wbtc = await deploymentManager.clone(cloneAddr.wbtc, [], cloneNetwork);
+    // Give signer 1000 WBTC
     await wait(
-      usdc.mint(
+      wbtc.mint(
         signerAddress,
-        exp(10000, 6),
+        exp(10000, 8),
         '0x0000000000000000000000000000000000000000',
         0,
         '0x0000000000000000000000000000000000000000000000000000000000000000'
       )
     );
 
-    let wbtc = await deploymentManager.clone(cloneAddr.wbtc, [], cloneNetwork);
-    // Give signer 1000 WBTC
-    await wait(wbtc.mint(signerAddress, exp(1000, 8)));
-
     let wavax = await deploymentManager.clone(cloneAddr.wavax, [], cloneNetwork);
     // Give admin 0.01 WAVAX tokens [this is a precious resource here!]
     await wait(wavax.deposit({ value: exp(0.01, 18) }));
@@ -78,10 +78,11 @@ migration('1644432723_deploy_fuji', {
       ['WAVAX', wavax],
     ]);
 
-    let { comet, proxy } = await deployNetworkComet(deploymentManager, true, {}, contracts);
+    let { cometProxy, configuratorProxy } = await deployNetworkComet(deploymentManager, true, {}, contracts);
 
     return {
-      comet: proxy.address,
+      comet: cometProxy.address,
+      configurator: configuratorProxy.address,
       usdc: usdc.address,
       wbtc: wbtc.address,
       wavax: wavax.address,

deployments/fuji/roots.json

@@ -1,3 +1,7 @@
 {
-    "comet": "0xd0E4a32790B5875Df3b8360286dea88382662069"
+    "comet": "0x5Da5c1aDe062dbEad369a70876D12e554eF610a1",
+    "configurator": "0x4efA5fb9682F373823F025fCaC4e5CFD2a405B10",
+    "usdc": "0x56C25B0D28382764460636a642e985a674E03e89",
+    "wbtc": "0xc0C282615f322B2FBefe6f974CFc2e28d9b4bb86",
+    "wavax": "0xDFCF797509905E71B6258444Bf1657B300D7Ae8B"
 }

deployments/kovan/configuration.json

@@ -1,7 +1,7 @@
 {
   "symbol": "📈USDC",
-  "governor": "0xdd940fc821853799eaf27e9eb0a420ed3bcdc3ef",
-  "pauseGuardian": "0xdd940fc821853799eaf27e9eb0a420ed3bcdc3ef",
+  "governor": "0x1C2C3c2E3232080e0738187520372e30Ce2e34CB",
+  "pauseGuardian": "0x1C2C3c2E3232080e0738187520372e30Ce2e34CB",
   "baseToken": "USDC",
   "baseTokenPriceFeed": "0x9211c6b3BF41A10F78539810Cf5c64e1BB78Ec60",
   "reserveRate": 0.1,

deployments/kovan/migrations/1644388553_deploy_kovan.ts

@@ -102,10 +102,11 @@ migration('1644388553_deploy_kovan', {
       ['LINK', link],
     ]);
 
-    let { comet, proxy } = await deployNetworkComet(deploymentManager, true, {}, contracts);
+    let { cometProxy, configuratorProxy } = await deployNetworkComet(deploymentManager, true, {}, contracts);
 
     return {
-      comet: proxy.address,
+      comet: cometProxy.address,
+      configurator: configuratorProxy.address,
       usdc: usdc.address,
       wbtc: wbtc.address,
       weth: weth.address,

deployments/kovan/roots.json

@@ -1,9 +1,10 @@
 {
-  "comet": "0x93C747aa42548C12C58Da2cbC10C171342E2b3c2",
-  "usdc": "0xA2202bF3D1230E3F0cE46c7890e8b83A5110Ca2f",
-  "wbtc": "0xE16D6Bf3661403913A13D97D713803CcE4737B8B",
-  "weth": "0x2D3ee41eF0DcaFCa72C5C24D61437a09ca7cf460",
-  "comp": "0x1193A0C63d82701d4267980B4Ae7323955337Cc0",
-  "uni": "0xE1939AE051cc719E8bf20573CdB076319728B2c6",
-  "link": "0x3509DAfFBE157183af358f42a8Cd245A522A0398"
+  "comet": "0xb86D3bc4661DE67Fc92071b1FAE802C9b6Ae89F4",
+  "configurator": "0xcB6C34E704cb5c048e9D7B33E95aD0a5c993b78E",
+  "usdc": "0x38F2c0081f6Df09bC6c5040e711D6bf7AdC912aa",
+  "wbtc": "0xC821255246e454d66e0aD5De3A9eD7122AcFA48F",
+  "weth": "0xd766d103C14006cEa982AA45030B1eB984B693fc",
+  "comp": "0x773A57aA7C6dEd6C9d3B74079B79a16745748101",
+  "uni": "0xc2DC732Bb078cD48AB9791ebC4f68F4796b4C743",
+  "link": "0x6e9834EEbdF9bB62085Af3D035A6d7b03bB5eBf3"
 }

deployments/relations.ts

@@ -36,6 +36,29 @@ let relationConfigMap: RelationConfigMap = {
     },
     relations: {},
   },
+  configurator: {
+    proxy: {
+      field: {
+        slot: '0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc',
+      }
+    },
+    relations: {
+      configuratorAdmin: {
+        field: {
+          slot: '0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103',
+        }
+      }
+    }
+  },
+  cometAdmin: {
+    relations: {
+      timelock: {
+        field: async (cometAdmin) => {
+          return await cometAdmin.owner();
+        }
+      }
+    }
+  },
   FiatTokenProxy: {
     proxy: {
       field: {