Controller, FeeTreasury, polygon deployment

.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: unit-test
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Hardhat unit test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+      - run: npm ci
+      - run: npm run test
+        env:
+          FORCE_COLOR: 1
+          ENABLE_GAS_REPORT: true
+      - name: Print gas report
+        run: cat gas-report.txt

.gitignore

@@ -0,0 +1,19 @@
+.idea
+
+node_modules
+.env
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+# Hardhat Ignition default folder for deployments against a local node
+ignition/deployments/chain-31337

.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+    skipFiles: ['test']
+};

LICENSE

@@ -0,0 +1,97 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Vsevolod Grigorovich
+
+Licensed Work:        Tetu
+
+Additional Use Grant: None
+
+Change Date:          2034-01-01
+
+Change License:       GNU General Public License v2.0 or later
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

README.md

@@ -1,2 +1,25 @@
-# tetu-contracts-v3
-Index funds of yield-bearing vaults
+# Tetu V3
+
+Index funds of yield-bearing vaults.
+
+*Under development*
+
+## Deployments
+
+### Polygon
+
+* Controller [0x7658d472996d90C0e0Ab8488af148184512DEE2c](https://polygonscan.com/address/0x7658d472996d90C0e0Ab8488af148184512DEE2c)
+* FeeTreasury [0x4f6f91929A3C56982A324102a69733383195E181](https://polygonscan.com/address/0x4f6f91929A3C56982A324102a69733383195E181)
+
+## How to
+
+```shell
+yarn
+npx hardhat help
+npx hardhat test
+npx hardhat coverage
+npx hardhat vars setup
+npx hardhat ignition deploy ./ignition/modules/FeeTreasury.ts --parameters ./ignition/parameters.json --network polygon
+npx hardhat ignition verify chain-137 --include-unrelated-contracts
+```
+

contracts/Controller.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.24;
+
+import "@openzeppelin/contracts/access/manager/AccessManager.sol";
+import "@openzeppelin/contracts-upgradeable/access/manager/AccessManagerUpgradeable.sol";
+
+/// @title Tetu V3 controller
+/// @author Alien Deployer (https://github.com/a17)
+contract Controller is AccessManagerUpgradeable {
+    /// @dev Version of Controller contract implementation
+    string public constant VERSION = "1.0.0";
+
+    function initialize(address initialAdmin) public initializer {
+        __AccessManager_init(initialAdmin);
+    }
+}

contracts/FeeTreasury.sol

@@ -0,0 +1,123 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.24;
+
+import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import "@openzeppelin/contracts/utils/structs/EnumerableMap.sol";
+import "hardhat/console.sol";
+
+/// @title Performance fee treasury that distribute fees to claimers
+/// @author Alien Deployer (https://github.com/a17)
+contract FeeTreasury is AccessManagedUpgradeable {
+    using SafeERC20 for IERC20;
+    using EnumerableSet for EnumerableSet.AddressSet;
+    using EnumerableMap for EnumerableMap.AddressToUintMap;
+
+    /// @dev Version of Treasury contract implementation
+    string public constant VERSION = "1.0.0";
+
+    uint internal THRESHOLD = 10;
+
+    // keccak256(abi.encode(uint256(keccak256("tetu.storage.FeeTreasury")) - 1)) & ~bytes32(uint256(0xff))
+    bytes32 private constant FeeTreasuryStorageLocation = 0x09d69abd7689fd56666fe6869d931c23d02c3338dae383978413185cacb0a400;
+
+    struct AssetData {
+        uint distributed;
+        uint claimed;
+    }
+
+    /// @custom:storage-location erc7201:tetu.storage.FeeTreasury
+    struct FeeTreasuryStorage {
+        EnumerableMap.AddressToUintMap claimers;
+        mapping (address asset => AssetData) assetData;
+        mapping (address asset => mapping (address claimer => uint amount)) toClaim;
+    }
+
+    event Claimers(address[] claimers, uint[] shares);
+    event Claim(address indexed claimer, address indexed asset, uint amount);
+
+    error IncorrectArgument();
+    error AccessDenied();
+    error SetupFeeTreasuryFirst();
+
+    function initialize(address controller) public initializer {
+        __AccessManaged_init(controller);
+    }
+
+    function setClaimers(address[] memory claimers_, uint[] memory shares) external restricted {
+        FeeTreasuryStorage storage $ = _getTreasuryStorage();
+        _cleanClaimers($);
+        uint len = claimers_.length;
+        if (len == 0 || len != shares.length) {
+            revert IncorrectArgument();
+        }
+        for (uint i; i < len; ++i) {
+            $.claimers.set(claimers_[i], shares[i]);
+        }
+        emit Claimers(claimers_, shares);
+    }
+
+    function claim(address[] memory assets) external {
+        FeeTreasuryStorage storage $ = _getTreasuryStorage();
+        (bool exists,) = $.claimers.tryGet(msg.sender);
+        if (!exists) {
+            revert AccessDenied();
+        }
+        uint len = assets.length;
+        for (uint i; i < len; ++i) {
+            uint toClaim = $.toClaim[assets[i]][msg.sender];
+            $.toClaim[assets[i]][msg.sender] = 0;
+            IERC20(assets[i]).safeTransfer(msg.sender, toClaim);
+            AssetData memory assetData = $.assetData[assets[i]];
+            $.assetData[assets[i]].claimed = assetData.claimed + toClaim;
+        }
+    }
+
+    function distribute(address[] memory assets) external {
+        FeeTreasuryStorage storage $ = _getTreasuryStorage();
+        uint len = assets.length;
+        for (uint i; i < len; ++i) {
+            AssetData memory assetData = $.assetData[assets[i]];
+            uint bal = IERC20(assets[i]).balanceOf(address(this));
+            uint distributedOnBalance = assetData.distributed - assetData.claimed;
+            if (bal > distributedOnBalance) {
+                uint amountToDistribute = bal - distributedOnBalance;
+                if (amountToDistribute > THRESHOLD) {
+                    _distributeAssetAmount($, assets[i], amountToDistribute);
+                    $.assetData[assets[i]].distributed = assetData.distributed + amountToDistribute;
+                }
+            }
+        }
+    }
+
+    function _distributeAssetAmount(FeeTreasuryStorage storage $, address asset, uint amount) internal {
+        address[] memory claimerAddress = $.claimers.keys();
+        uint len = claimerAddress.length;
+        if (len == 0) {
+            revert SetupFeeTreasuryFirst();
+        }
+        for (uint i; i < len; ++i) {
+            uint share = $.claimers.get(claimerAddress[i]);
+            uint amountForClaimer = amount * share / 1e18;
+            uint oldAmountToClaim = $.toClaim[asset][claimerAddress[i]];
+            $.toClaim[asset][claimerAddress[i]] = oldAmountToClaim + amountForClaimer;
+        }
+    }
+
+    function _cleanClaimers(FeeTreasuryStorage storage $) internal {
+        uint len = $.claimers.length();
+        if (len > 0) {
+            address[] memory claimerAddress = $.claimers.keys();
+            for (uint i; i < len; ++i) {
+                $.claimers.remove(claimerAddress[i]);
+            }
+        }
+    }
+
+    function _getTreasuryStorage() private pure returns (FeeTreasuryStorage storage $) {
+        assembly {
+            $.slot := FeeTreasuryStorageLocation
+        }
+    }
+}

contracts/Proxy.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.24;
+
+import "@openzeppelin/contracts/access/manager/IAccessManager.sol";
+import {UpgradeableProxy} from "./base/UpgradeableProxy.sol";
+
+/// @title Proxy for Tetu V3 core contracts
+/// @author Alien Deployer (https://github.com/a17)
+contract Proxy is UpgradeableProxy {
+    error ProxyUpgradeDenied();
+
+    function initProxy(address logic_) external {
+        _init(logic_);
+    }
+
+    //slither-disable-next-line naming-convention
+    function upgrade(address newImplementation_) external {
+        (bool callAllowed,) = IAccessManager(address(this)).canCall(msg.sender, address(this), this.upgrade.selector);
+        if (!callAllowed) {
+            revert ProxyUpgradeDenied();
+        }
+        _upgradeTo(newImplementation_);
+    }
+
+    function implementation() external view returns (address) {
+        return _implementation();
+    }
+}