[VEN-1474]: Harvest BNB Income

contracts/Admin/VBNBAdmin.sol

@@ -0,0 +1,119 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+pragma solidity 0.8.13;
+
+import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
+import "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
+import "./VBNBAdminStorage.sol";
+
+/**
+ * @title VBNBAdmin
+ * @author Venus
+ * @notice This contract is the "admin" of the vBNB market, reducing the reserves of the market, sending them to the `ProtocolShareReserve` contract,
+ * and allowing the executions of the rest of the privileged functions in the vBNB contract (after checking if the sender has the required permissions).
+ */
+contract VBNBAdmin is ReentrancyGuardUpgradeable, AccessControlledV8, VBNBAdminStorage {
+    using SafeERC20Upgradeable for IWBNB;
+
+    /// @notice address of vBNB
+    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
+    VTokenInterface public immutable vBNB;
+
+    /// @notice address of WBNB contract
+    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
+    IWBNB public immutable WBNB;
+
+    /// @notice Emitted when PSR is updated
+    event ProtocolShareReserveUpdated(
+        IProtocolShareReserve indexed oldProtocolShareReserve,
+        IProtocolShareReserve indexed newProtocolShareReserve
+    );
+
+    /// @notice Emitted reserves are reduced
+    event ReservesReduced(uint256 reduceAmount);
+
+    /// @param _vBNB Address of the vBNB contract
+    /// @param _WBNB Address of the WBNB token
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor(VTokenInterface _vBNB, IWBNB _WBNB) {
+        require(address(_WBNB) != address(0), "WBNB address invalid");
+        require(address(_vBNB) != address(0), "vBNB address invalid");
+
+        vBNB = _vBNB;
+        WBNB = _WBNB;
+
+        // Note that the contract is upgradeable. Use initialize() or reinitializers
+        // to set the state variables.
+        _disableInitializers();
+    }
+
+    /// @notice Used to initialize non-immutable variables
+    function initialize(
+        IProtocolShareReserve _protocolShareReserve,
+        address accessControlManager
+    ) external initializer {
+        require(address(_protocolShareReserve) != address(0), "PSR address invalid");
+        protocolShareReserve = _protocolShareReserve;
+
+        __ReentrancyGuard_init();
+        __AccessControlled_init(accessControlManager);
+    }
+
+    /**
+     * @notice PSR setter.
+     * @param protocolShareReserve_ Address of the PSR contract
+     * @custom:access Only owner (Governance)
+     * @custom:event Emits ProtocolShareReserveUpdated event.
+     */
+    function setProtocolShareReserve(IProtocolShareReserve protocolShareReserve_) external onlyOwner {
+        require(address(protocolShareReserve_) != address(0), "PSR address invalid");
+        emit ProtocolShareReserveUpdated(protocolShareReserve, protocolShareReserve_);
+        protocolShareReserve = protocolShareReserve_;
+    }
+
+    /**
+     * @notice Reduce reserves of vBNB, wrap them and send them to the PSR contract
+     * @param reduceAmount amount of reserves to reduce
+     * @custom:event Emits ReservesReduced event.
+     */
+    function reduceReserves(uint reduceAmount) external nonReentrant {
+        require(vBNB._reduceReserves(reduceAmount) == 0, "reduceReserves failed");
+        _wrapBNB();
+
+        uint256 balance = WBNB.balanceOf(address(this));
+        WBNB.safeTransfer(address(protocolShareReserve), balance);
+        protocolShareReserve.updateAssetsState(
+            vBNB.comptroller(),
+            address(WBNB),
+            IProtocolShareReserve.IncomeType.SPREAD
+        );
+
+        emit ReservesReduced(reduceAmount);
+    }
+
+    /**
+     * @notice Wraps BNB into WBNB
+     */
+    function _wrapBNB() internal {
+        uint256 bnbBalance = address(this).balance;
+        WBNB.deposit{ value: bnbBalance }();
+    }
+
+    /**
+     * @notice Invoked when BNB is sent to this contract
+     * @custom:access Only vBNB is considered a valid sender
+     */
+    receive() external payable {
+        require(msg.sender == address(vBNB), "only vBNB can send BNB to this contract");
+    }
+
+    /**
+     * @notice Invoked when called function does not exist in the contract. The function will be executed in the vBNB contract.
+     * @custom:access Only owner (Governance)
+     */
+    fallback(bytes calldata data) external payable onlyOwner returns (bytes memory) {
+        (bool ok, bytes memory res) = address(vBNB).call{ value: msg.value }(data);
+        require(ok, "call failed");
+        return res;
+    }
+}

contracts/Admin/VBNBAdminStorage.sol

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: BSD-3-Clause
+pragma solidity 0.8.13;
+
+import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
+
+interface VTokenInterface {
+    function _reduceReserves(uint reduceAmount) external returns (uint);
+
+    function _acceptAdmin() external returns (uint);
+
+    function comptroller() external returns (address);
+}
+
+interface IWBNB is IERC20Upgradeable {
+    function deposit() external payable;
+}
+
+interface IProtocolShareReserve {
+    enum IncomeType {
+        SPREAD,
+        LIQUIDATION
+    }
+
+    function updateAssetsState(address comptroller, address asset, IncomeType incomeType) external;
+}
+
+contract VBNBAdminStorage {
+    /// @notice address of protocol share reserve contract
+    IProtocolShareReserve public protocolShareReserve;
+
+    /// @dev gap to prevent collision in inheritence
+    uint256[49] private __gap;
+}

contracts/test/MockVBNB.sol

@@ -127,6 +127,10 @@ contract MockVBNB is VToken {
         requireNoError(err, "liquidateBorrow failed");
     }
 
+    function setTotalReserves(uint totalReserves_) external payable {
+        totalReserves = totalReserves_;
+    }
+
     /*** Safe Token ***/
 
     /**

deploy/007-deploy-VBNBAdmin.ts

@@ -0,0 +1,67 @@
+import { ethers } from "hardhat";
+import { Address, DeployFunction } from "hardhat-deploy/types";
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+
+import { Contracts as Mainnet } from "../networks/mainnet.json";
+import { Contracts as Testnet } from "../networks/testnet.json";
+
+interface AddressConfig {
+  [key: string]: {
+    [key: string]: Address;
+  };
+}
+
+const ADDRESSES: AddressConfig = {
+  bsctestnet: Testnet,
+  bscmainnet: Mainnet,
+};
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { deployments, network, getNamedAccounts } = hre;
+  const { deploy } = deployments;
+  const { deployer } = await getNamedAccounts();
+
+  const networkName = network.name === "bscmainnet" ? "bscmainnet" : "bsctestnet";
+  const vBNB = ADDRESSES[networkName].vBNB;
+  const WBNB = ADDRESSES[networkName].WBNB;
+
+  const acmAddresses: { [network: string]: string } = {
+    bsctestnet: "0x45f8a08F534f34A97187626E05d4b6648Eeaa9AA",
+    bscmainnet: "0x4788629ABc6cFCA10F9f969efdEAa1cF70c23555",
+  };
+
+  const protocolShareReserve: { [network: string]: string } = {
+    bsctestnet: "0x25c7c7D6Bf710949fD7f03364E9BA19a1b3c10E3",
+    bscmainnet: "0xCa01D5A9A248a830E9D93231e791B1afFed7c446",
+  };
+
+  await deploy("VBNBAdmin", {
+    contract: "VBNBAdmin",
+    from: deployer,
+    args: [vBNB, WBNB],
+    log: true,
+    autoMine: true,
+    proxy: {
+      owner: ADDRESSES[networkName].Timelock,
+      proxyContract: "OpenZeppelinTransparentProxy",
+      execute: {
+        methodName: "initialize",
+        args: [protocolShareReserve[networkName], acmAddresses[networkName]],
+      },
+    },
+  });
+
+  const vBNBAdmin = await ethers.getContract("VBNBAdmin");
+
+  if (network.name !== "hardhat") {
+    const timelockAddress = ADDRESSES[networkName].Timelock;
+    await vBNBAdmin.transferOwnership(timelockAddress);
+    console.log(`VBNBAdmin Contract (${vBNBAdmin.address}) owner changed from ${deployer} to ${timelockAddress}`);
+  }
+  return hre.network.live; // when live network, record the script as executed to prevent rexecution
+};
+
+func.id = "vbnbadmin_deploy"; // id required to prevent re-execution
+func.tags = ["VBNBAdmin"];
+
+export default func;

deployments/bscmainnet/.migrations.json

@@ -1,3 +1,4 @@
 {
-  "psm_initial_deploy": 1690981284
+  "psm_initial_deploy": 1690981284,
+  "vbnbadmin_deploy": 1697477430
 }

deployments/bscmainnet/DefaultProxyAdmin.json

@@ -1,5 +1,5 @@
 {
-  "address": "0x3f918bA9446552AB184C6Ffd2e2fcB1FA5ee1e59",
+  "address": "0x6beb6D2695B67FEb73ad4f172E8E2975497187e4",
   "abi": [
     {
       "inputs": [
@@ -162,34 +162,34 @@
       "type": "function"
     }
   ],
-  "transactionHash": "0xad7e189b2375d6cd981880ad905006abb531d2935b9ea5ce1cb3bab65146ba37",
+  "transactionHash": "0xad6ac5a87976826e994ec930ab979ae330345d828e1ee6926635ce11eb645e95",
   "receipt": {
     "to": null,
-    "from": "0xa05f990d647287e4E84715b813BC000aEA970467",
-    "contractAddress": "0x3f918bA9446552AB184C6Ffd2e2fcB1FA5ee1e59",
-    "transactionIndex": 45,
+    "from": "0x55A9f5374Af30E3045FB491f1da3C2E8a74d168D",
+    "contractAddress": "0x6beb6D2695B67FEb73ad4f172E8E2975497187e4",
+    "transactionIndex": 51,
     "gasUsed": "642683",
-    "logsBloom": "0x00000000000000000000000000000000000001000000000000800000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000220000000000000000000800000002000000000000000000000000400000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000002000000000000000000000000000000000000000000000000000000",
-    "blockHash": "0xbf164b826398a95757702f2951b8422f1023875f8f7e46d2aaf1bcd2fe26cb01",
-    "transactionHash": "0xad7e189b2375d6cd981880ad905006abb531d2935b9ea5ce1cb3bab65146ba37",
+    "logsBloom": "0x00000000000000000000000000000000000001000000000000800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000020000000000000000000800000002000008000000000000000000400000000000000000000000000000000000000000080000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000010000000000000000000000000000",
+    "blockHash": "0xf8f6cb1dd8c033affe5227c67647ff04ec6524b3d512cdff2c571504d79b4a6b",
+    "transactionHash": "0xad6ac5a87976826e994ec930ab979ae330345d828e1ee6926635ce11eb645e95",
     "logs": [
       {
-        "transactionIndex": 45,
-        "blockNumber": 29298107,
-        "transactionHash": "0xad7e189b2375d6cd981880ad905006abb531d2935b9ea5ce1cb3bab65146ba37",
-        "address": "0x3f918bA9446552AB184C6Ffd2e2fcB1FA5ee1e59",
+        "transactionIndex": 51,
+        "blockNumber": 29334996,
+        "transactionHash": "0xad6ac5a87976826e994ec930ab979ae330345d828e1ee6926635ce11eb645e95",
+        "address": "0x6beb6D2695B67FEb73ad4f172E8E2975497187e4",
         "topics": [
           "0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0",
           "0x0000000000000000000000000000000000000000000000000000000000000000",
           "0x000000000000000000000000939bd8d64c0a9583a7dcea9933f7b21697ab6396"
         ],
         "data": "0x",
-        "logIndex": 84,
-        "blockHash": "0xbf164b826398a95757702f2951b8422f1023875f8f7e46d2aaf1bcd2fe26cb01"
+        "logIndex": 92,
+        "blockHash": "0xf8f6cb1dd8c033affe5227c67647ff04ec6524b3d512cdff2c571504d79b4a6b"
       }
     ],
-    "blockNumber": 29298107,
-    "cumulativeGasUsed": "4279153",
+    "blockNumber": 29334996,
+    "cumulativeGasUsed": "4717348",
     "status": 1,
     "byzantium": true
   },