🥞 Publish minimum-deposit-controller package (#486)

Author: truefibot

.compiler.json

@@ -0,0 +1,9 @@
+{
+    "version": "0.8.16",
+    "settings": {
+        "optimizer": {
+            "enabled": true,
+            "runs": 200
+        }
+    }
+}

.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  root: true,
+  // This tells ESLint to load the config from the package `eslint-config-archblock`
+  extends: ['archblock/contracts'],
+}

.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "require": ["ts-node/register/transpile-only", "tsconfig-paths/register"],
+  "extension": ["ts"],
+  "target": "esnext",
+  "timeout": 40000,
+  "watch-files": ["test"],
+  "exit": true
+}

.solhint.json

@@ -0,0 +1,27 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "avoid-suicide": "error",
+    "compiler-version": [
+      "error",
+      ">=0.8.16"
+    ],
+    "state-visibility": "off",
+    "func-name-mixedcase": "off",
+    "var-name-mixedcase": "off",
+    "no-empty-blocks": "off",
+    "no-inline-assembly": "off",
+    "not-rely-on-time": "off",
+    "max-states-count": "off",
+    "reason-string": "off",
+    "const-name-snakecase": "off",
+    "avoid-tx-origin": "off",
+    "func-visibility": [
+      "warn",
+      {
+        "ignoreConstructors": true,
+        "reentrancy": true
+      }
+    ]
+  }
+}

README.md

@@ -1 +1 @@
-## 🥞 Minimum deposit controller
+# 🦐 Minimum deposit controller

abi-exporter.js

@@ -0,0 +1,70 @@
+const fs = require('fs')
+const path = require('path')
+const { extendConfig } = require('hardhat/config')
+
+const { HardhatPluginError } = require('hardhat/plugins')
+
+const {
+  TASK_COMPILE,
+} = require('hardhat/builtin-tasks/task-names')
+
+extendConfig(function (config, userConfig) {
+  config.abiExporter = Object.assign(
+    {
+      path: './abi',
+      clear: false,
+      flat: false,
+      only: [],
+      except: [],
+      spacing: 2,
+    },
+    userConfig.abiExporter,
+  )
+})
+
+task(TASK_COMPILE, async function (args, hre, runSuper) {
+  const config = hre.config.abiExporter
+
+  await runSuper()
+
+  const outputDirectory = path.resolve(hre.config.paths.root, config.path)
+
+  if (!outputDirectory.startsWith(hre.config.paths.root)) {
+    throw new HardhatPluginError('resolved path must be inside of project directory')
+  }
+
+  if (outputDirectory === hre.config.paths.root) {
+    throw new HardhatPluginError('resolved path must not be root directory')
+  }
+
+  if (config.clear) {
+    if (fs.existsSync(outputDirectory)) {
+      fs.rmdirSync(outputDirectory, { recursive: true })
+    }
+  }
+
+  if (!fs.existsSync(outputDirectory)) {
+    fs.mkdirSync(outputDirectory, { recursive: true })
+  }
+
+  for (const fullName of await hre.artifacts.getAllFullyQualifiedNames()) {
+    if (config.only.length && !config.only.some(m => fullName.match(m))) continue
+    if (config.except.length && config.except.some(m => fullName.match(m))) continue
+
+    const { abi, sourceName, contractName, bytecode, deployedBytecode } = await hre.artifacts.readArtifact(fullName)
+
+    if (!abi.length) continue
+
+    const destination = path.resolve(
+      outputDirectory,
+      config.flat ? '' : sourceName,
+      contractName,
+    ) + '.json'
+
+    if (!fs.existsSync(path.dirname(destination))) {
+      fs.mkdirSync(path.dirname(destination), { recursive: true })
+    }
+
+    fs.writeFileSync(destination, `${JSON.stringify({ abi, bytecode, deployedBytecode }, null, config.spacing)}\n`, { flag: 'w' })
+  }
+})

contracts/MinimumDepositController/IDepositController.sol

@@ -0,0 +1,172 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.16;
+
+import {ILenderVerifier} from "../carbon/interfaces/ILenderVerifier.sol";
+import {Status} from "../carbon/interfaces/IStructuredPortfolio.sol";
+import {DepositAllowed} from "../carbon/interfaces/IDepositController.sol";
+
+/**
+ * @title Contract for managing deposit related settings
+ * @dev Used by TrancheVault contract
+ */
+interface IDepositController {
+    /**
+     * @notice Event emitted when new ceiling is set
+     * @param newCeiling New ceiling value
+     */
+    event CeilingChanged(uint256 newCeiling);
+
+    /**
+     * @notice Event emitted when deposits are disabled or enabled for a specific StructuredPortfolio status
+     * @param newDepositAllowed Value indicating whether deposits should be enabled or disabled
+     * @param portfolioStatus StructuredPortfolio status for which changes are applied
+     */
+    event DepositAllowedChanged(bool newDepositAllowed, Status portfolioStatus);
+
+    /**
+     * @notice Event emitted when deposit fee rate is switched
+     * @param newFeeRate New deposit fee rate value (in BPS)
+     */
+    event DepositFeeRateChanged(uint256 newFeeRate);
+
+    /**
+     * @notice Event emitted when minimum deposit is changed
+     * @param newMinimumDeposit New minimum deposit value (in assets)
+     */
+    event MinimumDepositChanged(uint256 newMinimumDeposit);
+
+    /**
+     * @notice Event emitted when lender verifier is switched
+     * @param newLenderVerifier New lender verifier contract address
+     */
+    event LenderVerifierChanged(ILenderVerifier indexed newLenderVerifier);
+
+    /// @return DepositController manager role used for access control
+    function MANAGER_ROLE() external view returns (bytes32);
+
+    /// @return Address of contract used for checking whether given address is allowed to put funds into an instrument according to implemented strategy
+    function lenderVerifier() external view returns (ILenderVerifier);
+
+    /// @return Max asset capacity defined for TrancheVaults interacting with DepositController
+    function ceiling() external view returns (uint256);
+
+    /// @return Rate (in BPS) of the fee applied to the deposit amount
+    function depositFeeRate() external view returns (uint256);
+
+    /// @return Value indicating whether deposits are allowed when related StructuredPortfolio is in given status
+    /// @param status StructuredPortfolio status
+    function depositAllowed(Status status) external view returns (bool);
+
+    /**
+     * @notice Setup contract with given params
+     * @dev Used by Initializable contract (can be called only once)
+     * @param manager Address to which MANAGER_ROLE should be granted
+     * @param _lenderVerifier Address of LenderVerifier contract
+     * @param _depositFeeRate Deposit fee rate (in BPS)
+     * @param _minimumDeposit Minimum deposit value (in assets)
+     * @param _ceiling Ceiling value
+     */
+    function initialize(
+        address manager,
+        address _lenderVerifier,
+        uint256 _depositFeeRate,
+        uint256 _minimumDeposit,
+        uint256 _ceiling
+    ) external;
+
+    /**
+     * @return assets Max assets amount that can be deposited with TrancheVault shares minted to given receiver
+     * @param receiver Shares receiver address
+     */
+    function maxDeposit(address receiver) external view returns (uint256 assets);
+
+    /**
+     * @return shares Max TrancheVault shares amount given address can receive
+     * @param receiver Shares receiver address
+     */
+    function maxMint(address receiver) external view returns (uint256 shares);
+
+    /**
+     * @notice Simulates deposit assets conversion including fees
+     * @return shares Shares amount that can be obtained from the given assets amount
+     * @param assets Tested assets amount
+     */
+    function previewDeposit(uint256 assets) external view returns (uint256 shares);
+
+    /**
+     * @notice Simulates mint shares conversion including fees
+     * @return assets Assets amount that needs to be deposited to obtain given shares amount
+     * @param shares Tested shares amount
+     */
+    function previewMint(uint256 shares) external view returns (uint256 assets);
+
+    /**
+     * @notice Simulates deposit result
+     * @return shares Shares amount that can be obtained from the deposit with given params
+     * @return depositFee Fee for a deposit with given params
+     * @param sender Supposed deposit transaction sender address
+     * @param assets Supposed assets amount
+     * @param receiver Supposed shares receiver address
+     */
+    function onDeposit(
+        address sender,
+        uint256 assets,
+        address receiver
+    ) external returns (uint256 shares, uint256 depositFee);
+
+    /**
+     * @notice Simulates mint result
+     * @return assets Assets amount that needs to be provided to execute mint with given params
+     * @return mintFee Fee for a mint with given params
+     * @param sender Supposed mint transaction sender address
+     * @param shares Supposed shares amount
+     * @param receiver Supposed shares receiver address
+     */
+    function onMint(
+        address sender,
+        uint256 shares,
+        address receiver
+    ) external returns (uint256 assets, uint256 mintFee);
+
+    /**
+     * @notice Ceiling setter
+     * @param newCeiling New ceiling value
+     */
+    function setCeiling(uint256 newCeiling) external;
+
+    /**
+     * @notice Deposit allowed setter
+     * @param newDepositAllowed Value indicating whether deposits should be allowed when related StructuredPortfolio is in given status
+     * @param portfolioStatus StructuredPortfolio status for which changes are applied
+     */
+    function setDepositAllowed(bool newDepositAllowed, Status portfolioStatus) external;
+
+    /**
+     * @notice Deposit fee rate setter
+     * @param newFeeRate New deposit fee rate (in BPS)
+     */
+    function setDepositFeeRate(uint256 newFeeRate) external;
+
+    /**
+     * @notice Lender verifier setter
+     * @param newLenderVerifier New LenderVerifier contract address
+     */
+    function setLenderVerifier(ILenderVerifier newLenderVerifier) external;
+
+    /**
+     * @notice Allows to change ceiling, deposit fee rate, minimum deposit, lender verifier and enable or disable deposits at once
+     * @param newCeiling New ceiling value
+     * @param newFeeRate New deposit fee rate (in BPS)
+     * @param newMinimumDeposit New minimum deposit value (in assets)
+     * @param newLenderVerifier New LenderVerifier contract address
+     * @param newDepositAllowed New deposit allowed settings
+     */
+    function configure(
+        uint256 newCeiling,
+        uint256 newFeeRate,
+        uint256 newMinimumDeposit,
+        ILenderVerifier newLenderVerifier,
+        DepositAllowed memory newDepositAllowed
+    ) external;
+}