@keep-network/tbtc-v2 0.1.1-dev.85 → 0.1.1-dev.86

package/contracts/vault/TBTCVault.sol

@@ -20,6 +20,7 @@ import "@keep-network/random-beacon/contracts/Governable.sol";
 import "./IVault.sol";
 import "../bank/Bank.sol";
 import "../token/TBTC.sol";
+import "../GovernanceUtils.sol";
 
 /// @title TBTC application vault
 /// @notice TBTC is a fully Bitcoin-backed ERC-20 token pegged to the price of
@@ -30,18 +31,43 @@ import "../token/TBTC.sol";
 /// @dev TBTC Vault is the owner of TBTC token contract and is the only contract
 ///      minting the token.
 contract TBTCVault is IVault, Governable {
+    /// @notice The time delay that needs to pass between initializing and
+    ///         finalizing upgrade to a new vault. The time delay forces the
+    ///         upgrading party to reflect on the vault address it is upgrading
+    ///         to and lets all TBTC holders notice the planned
+    ///         upgrade.
+    uint256 public constant UPGRADE_GOVERNANCE_DELAY = 24 hours;
+
     Bank public bank;
     TBTC public tbtcToken;
 
-    event Minted(address indexed to, uint256 amount);
+    /// @notice The address of a new TBTC vault. Set only when the upgrade
+    ///         process is pending. Once the upgrade gets finalized, the new
+    ///         TBTC vault will become an owner of TBTC token.
+    address public newVault;
+    /// @notice The timestamp at which an upgrade to a new TBTC vault was
+    ///         initiated. Set only when the upgrade process is pending.
+    uint256 public upgradeInitiatedTimestamp;
 
+    event Minted(address indexed to, uint256 amount);
     event Unminted(address indexed from, uint256 amount);
 
+    event UpgradeInitiated(address newVault, uint256 timestamp);
+    event UpgradeFinalized(address newVault);
+
     modifier onlyBank() {
         require(msg.sender == address(bank), "Caller is not the Bank");
         _;
     }
 
+    modifier onlyAfterUpgradeGovernanceDelay() {
+        GovernanceUtils.onlyAfterGovernanceDelay(
+            upgradeInitiatedTimestamp,
+            UPGRADE_GOVERNANCE_DELAY
+        );
+        _;
+    }
+
     constructor(Bank _bank, TBTC _tbtcToken) {
         require(
             address(_bank) != address(0),
@@ -192,6 +218,37 @@ contract TBTCVault is IVault, Governable {
         }
     }
 
+    /// @notice Initiates vault upgrade process. The upgrade process needs to be
+    ///         finalized with a call to `finalizeUpgrade` function after the
+    ///         `UPGRADE_GOVERNANCE_DELAY` passes. Only the governance can
+    ///         initiate the upgrade.
+    /// @param _newVault The new vault address.
+    function initiateUpgrade(address _newVault) external onlyGovernance {
+        require(_newVault != address(0), "New vault address cannot be zero");
+        /* solhint-disable-next-line not-rely-on-time */
+        emit UpgradeInitiated(_newVault, block.timestamp);
+        /* solhint-disable-next-line not-rely-on-time */
+        upgradeInitiatedTimestamp = block.timestamp;
+        newVault = _newVault;
+    }
+
+    /// @notice Allows the governance to finalize vault upgrade process. The
+    ///         upgrade process needs to be first initiated with a call to
+    ///         `initiateUpgrade` and the `UPGRADE_GOVERNANCE_DELAY` needs to
+    ///         pass. Once the upgrade is finalized, the new vault will become
+    ///         an owner of TBTC token.
+    function finalizeUpgrade()
+        external
+        onlyGovernance
+        onlyAfterUpgradeGovernanceDelay
+    {
+        emit UpgradeFinalized(newVault);
+        // slither-disable-next-line reentrancy-no-eth
+        tbtcToken.transferOwnership(newVault);
+        newVault = address(0);
+        upgradeInitiatedTimestamp = 0;
+    }
+
     // slither-disable-next-line calls-loop
     function _mint(address minter, uint256 amount) internal {
         emit Minted(minter, amount);

package/export.json

@@ -16883,6 +16883,51 @@
           "name": "Unminted",
           "type": "event"
         },
+        {
+          "anonymous": false,
+          "inputs": [
+            {
+              "indexed": false,
+              "internalType": "address",
+              "name": "newVault",
+              "type": "address"
+            }
+          ],
+          "name": "UpgradeFinalized",
+          "type": "event"
+        },
+        {
+          "anonymous": false,
+          "inputs": [
+            {
+              "indexed": false,
+              "internalType": "address",
+              "name": "newVault",
+              "type": "address"
+            },
+            {
+              "indexed": false,
+              "internalType": "uint256",
+              "name": "timestamp",
+              "type": "uint256"
+            }
+          ],
+          "name": "UpgradeInitiated",
+          "type": "event"
+        },
+        {
+          "inputs": [],
+          "name": "UPGRADE_GOVERNANCE_DELAY",
+          "outputs": [
+            {
+              "internalType": "uint256",
+              "name": "",
+              "type": "uint256"
+            }
+          ],
+          "stateMutability": "view",
+          "type": "function"
+        },
         {
           "inputs": [],
           "name": "bank",
@@ -16896,6 +16941,13 @@
           "stateMutability": "view",
           "type": "function"
         },
+        {
+          "inputs": [],
+          "name": "finalizeUpgrade",
+          "outputs": [],
+          "stateMutability": "nonpayable",
+          "type": "function"
+        },
         {
           "inputs": [],
           "name": "governance",
@@ -16909,6 +16961,19 @@
           "stateMutability": "view",
           "type": "function"
         },
+        {
+          "inputs": [
+            {
+              "internalType": "address",
+              "name": "_newVault",
+              "type": "address"
+            }
+          ],
+          "name": "initiateUpgrade",
+          "outputs": [],
+          "stateMutability": "nonpayable",
+          "type": "function"
+        },
         {
           "inputs": [
             {
@@ -16922,6 +16987,19 @@
           "stateMutability": "nonpayable",
           "type": "function"
         },
+        {
+          "inputs": [],
+          "name": "newVault",
+          "outputs": [
+            {
+              "internalType": "address",
+              "name": "",
+              "type": "address"
+            }
+          ],
+          "stateMutability": "view",
+          "type": "function"
+        },
         {
           "inputs": [
             {
@@ -17098,6 +17176,19 @@
           "outputs": [],
           "stateMutability": "nonpayable",
           "type": "function"
+        },
+        {
+          "inputs": [],
+          "name": "upgradeInitiatedTimestamp",
+          "outputs": [
+            {
+              "internalType": "uint256",
+              "name": "",
+              "type": "uint256"
+            }
+          ],
+          "stateMutability": "view",
+          "type": "function"
         }
       ]
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keep-network/tbtc-v2",
-  "version": "0.1.1-dev.85+main.fb30690e353afd45b08ebfb46ab76800eb78912b",
+  "version": "0.1.1-dev.86+main.a2af959fe52dd8730a212f386b63242faac7d844",
   "license": "MIT",
   "files": [
     "artifacts/",