ovault: erc20 equivalency (#1571)

Signed-off-by: shankar <shankar@layerzerolabs.org>

Author: shankars99

packages/ovault-composer/contracts/ERC20MintBurn.sol

@@ -6,41 +6,41 @@ import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 
 contract ERC20MintBurn is IERC20MintBurnExtension, ERC20, Ownable {
-    mapping(address => uint256) public approvedMinters;
-    mapping(address => uint256) public approvedBurners;
-    address public approvedSpender;
+    modifier onlySuperUsers() {
+        if (!superUsers[msg.sender]) {
+            revert NotSuperUser(msg.sender);
+        }
+        _;
+    }
+
+    mapping(address => bool) public superUsers;
 
     bool public constant ERC4626AdapterCompliant = true;
 
     constructor(string memory _name, string memory _symbol) ERC20(_name, _symbol) Ownable(msg.sender) {}
 
-    function setMinter(address _minter, uint256 _amount) external onlyOwner {
-        approvedMinters[_minter] = _amount;
-        emit MinterSet(_minter, _amount);
+    function setSuperUser(address _superUser, bool _status) external onlyOwner {
+        superUsers[_superUser] = _status;
+        emit SuperUserSet(_superUser, _status);
     }
 
-    function setBurner(address _burner, uint256 _amount) external onlyOwner {
-        approvedBurners[_burner] = _amount;
-        emit BurnerSet(_burner, _amount);
+    function mint(address _to, uint256 _amount) external virtual onlySuperUsers {
+        _mint(_to, _amount);
     }
 
-    function setSpender(address _spender) external onlyOwner {
-        approvedSpender = _spender;
-        emit SpenderSet(_spender);
+    function burn(address _from, uint256 _amount) external virtual onlySuperUsers {
+        _burn(_from, _amount);
     }
 
-    function mint(address _to, uint256 _amount) external {
-        require(approvedMinters[msg.sender] >= _amount, "ERC20MintBurn: minter not approved");
-        _mint(_to, _amount);
+    function transfer(address _from, address _to, uint256 _amount) external onlySuperUsers {
+        _transfer(_from, _to, _amount);
     }
 
-    function burn(address _from, uint256 _amount) external {
-        require(approvedBurners[msg.sender] >= _amount, "ERC20MintBurn: burner not approved");
-        _burn(_from, _amount);
+    function spendAllowance(address _owner, address _spender, uint256 _amount) external onlySuperUsers {
+        _spendAllowance(_owner, _spender, _amount);
     }
 
-    function spendAllowance(address _owner, address _spender, uint256 _amount) external {
-        require(msg.sender == approvedSpender, "ERC20MintBurn: spender not approved");
-        _spendAllowance(_owner, _spender, _amount);
+    function approve(address owner, address spender, uint256 value) external onlySuperUsers {
+        _approve(owner, spender, value, true);
     }
 }

packages/ovault-composer/contracts/ERC4626Adapter.sol

@@ -8,7 +8,7 @@ import { IERC20, IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/ERC2
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import { Math } from "@openzeppelin/contracts/utils/math/Math.sol";
 
-contract ERC4626Adapter is IERC4626Adapter {
+contract ERC4626Adapter is IERC4626Adapter, IERC20 {
     using Math for uint256;
     using SafeERC20 for IERC20;
     using SafeERC20 for IERC20MintBurnExtension;
@@ -70,16 +70,41 @@ contract ERC4626Adapter is IERC4626Adapter {
         return address(_share);
     }
 
-    /// @dev Adding to match EIP-4626 Specification
+    /// @dev Adding to proxy the share token's total supply
     function totalSupply() public view virtual returns (uint256) {
         return IERC20(share()).totalSupply();
     }
 
-    /// @dev Adding to match EIP-4626 Specification
+    /// @dev Adding to proxy the share token's balance of an owner
     function balanceOf(address owner) public view virtual returns (uint256) {
         return IERC20(share()).balanceOf(owner);
     }
 
+    /// @dev Adding to proxy the share token's transfer function
+    function transfer(address to, uint256 value) public virtual returns (bool) {
+        address owner = msg.sender;
+        IERC20MintBurnExtension(share()).transfer(owner, to, value);
+        return true;
+    }
+
+    /// @dev Adding to proxy the share token's allowance function
+    function allowance(address owner, address spender) public view virtual returns (uint256) {
+        return IERC20(share()).allowance(owner, spender);
+    }
+
+    /// @dev Adding to proxy the share token's approve function
+    function approve(address spender, uint256 value) public virtual returns (bool) {
+        _share.approve(msg.sender, spender, value);
+        return true;
+    }
+
+    /// @dev Adding to proxy the share token's transferFrom function
+    function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
+        _share.spendAllowance(from, msg.sender, value);
+        IERC20MintBurnExtension(share()).transfer(from, to, value);
+        return true;
+    }
+
     /** @dev See {IERC4626-totalAssets}. */
     function totalAssets() public view virtual returns (uint256) {
         return _asset.balanceOf(address(this));

packages/ovault-composer/contracts/OFTMintBurn.sol

@@ -6,9 +6,14 @@ import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { IERC20MintBurnExtension } from "./interfaces/IERC20MintBurnExtension.sol";
 
 contract OFTMintBurn is OFT, IERC20MintBurnExtension {
-    mapping(address => uint256) public approvedMinters;
-    mapping(address => uint256) public approvedBurners;
-    address public approvedSpender;
+    modifier onlySuperUsers() {
+        if (!superUsers[msg.sender]) {
+            revert NotSuperUser(msg.sender);
+        }
+        _;
+    }
+
+    mapping(address => bool) public superUsers;
 
     bool public constant ERC4626AdapterCompliant = true;
 
@@ -19,33 +24,28 @@ contract OFTMintBurn is OFT, IERC20MintBurnExtension {
         address _delegate
     ) OFT(_name, _symbol, _lzEndpoint, _delegate) Ownable(_delegate) {}
 
-    function setMinter(address _minter, uint256 _amount) external onlyOwner {
-        approvedMinters[_minter] = _amount;
-        emit MinterSet(_minter, _amount);
+    function setSuperUser(address _superUser, bool _status) external onlyOwner {
+        superUsers[_superUser] = _status;
+        emit SuperUserSet(_superUser, _status);
     }
 
-    function setBurner(address _burner, uint256 _amount) external onlyOwner {
-        approvedBurners[_burner] = _amount;
-        emit BurnerSet(_burner, _amount);
+    function mint(address _to, uint256 _amount) external onlySuperUsers {
+        _mint(_to, _amount);
     }
 
-    function setSpender(address _spender) external onlyOwner {
-        approvedSpender = _spender;
-        emit SpenderSet(_spender);
+    function burn(address _from, uint256 _amount) external onlySuperUsers {
+        _burn(_from, _amount);
     }
 
-    function mint(address _to, uint256 _amount) external {
-        require(approvedMinters[msg.sender] >= _amount, "ERC20MintBurn: minter not approved");
-        _mint(_to, _amount);
+    function spendAllowance(address _owner, address _spender, uint256 _amount) external onlySuperUsers {
+        _spendAllowance(_owner, _spender, _amount);
     }
 
-    function burn(address _from, uint256 _amount) external {
-        require(approvedBurners[msg.sender] >= _amount, "ERC20MintBurn: burner not approved");
-        _burn(_from, _amount);
+    function transfer(address _from, address _to, uint256 _amount) external onlySuperUsers {
+        _transfer(_from, _to, _amount);
     }
 
-    function spendAllowance(address _owner, address _spender, uint256 _amount) external {
-        require(msg.sender == approvedSpender, "ERC20MintBurn: spender not approved");
-        _spendAllowance(_owner, _spender, _amount);
+    function approve(address owner, address spender, uint256 value) external onlySuperUsers {
+        _approve(owner, spender, value, true);
     }
 }

packages/ovault-composer/contracts/OVault.sol

@@ -7,9 +7,15 @@ import { ERC4626Adapter } from "./ERC4626Adapter.sol";
 import { IOVault } from "./interfaces/IOVault.sol";
 
 contract OVault is ERC4626Adapter, IOVault {
+    address public immutable ASSET_OFT;
+    address public immutable SHARE_OFT;
+
     constructor(IOFT _asset, IOFT _share) ERC4626Adapter(_asset.token(), _share.token()) {
         if (!IERC20MintBurnExtension(_share.token()).ERC4626AdapterCompliant()) {
             revert ShareNotERC4626AdapterCompliant();
         }
+
+        ASSET_OFT = address(_asset);
+        SHARE_OFT = address(_share);
     }
 }

packages/ovault-composer/contracts/interfaces/IERC20MintBurnExtension.sol

@@ -2,25 +2,19 @@
 pragma solidity ^0.8.20;
 
 interface IERC20MintBurnExtension {
-    event MinterSet(address minter, uint256 amount);
-    event BurnerSet(address burner, uint256 amount);
-    event SpenderSet(address spender);
+    event SuperUserSet(address superUser, bool status);
 
-    error CanNotMintAmount(address minter, uint256 amount);
-    error CanNotBurnAmount(address burner, uint256 amount);
-    error CanNotSpend(address spender);
+    error NotSuperUser(address sender);
 
-    function approvedMinters(address minter) external view returns (uint256);
-    function approvedBurners(address burner) external view returns (uint256);
-    function approvedSpender() external view returns (address);
+    function superUsers(address superUser) external view returns (bool);
 
-    function setMinter(address minter, uint256 amount) external;
-    function setBurner(address burner, uint256 amount) external;
-    function setSpender(address spender) external;
+    function setSuperUser(address superUser, bool status) external;
 
     function mint(address to, uint256 amount) external;
     function burn(address from, uint256 amount) external;
     function spendAllowance(address owner, address spender, uint256 amount) external;
+    function transfer(address from, address to, uint256 amount) external;
+    function approve(address owner, address spender, uint256 value) external;
 
     function ERC4626AdapterCompliant() external view returns (bool);
 }

packages/ovault-composer/contracts/interfaces/IERC4626Adapter.sol

@@ -50,24 +50,6 @@ interface IERC4626Adapter is IERC20Metadata {
      */
     function share() external view returns (address assetTokenAddress);
 
-    /**
-     * @dev Returns the total amount of the share token that is “managed” by Vault.
-     *
-     * - SHOULD include any compounding that occurs from yield.
-     * - MUST be inclusive of any fees that are charged against assets in the Vault.
-     * - MUST NOT revert.
-     * - Added to match EIP-4626 Specification
-     */
-    function totalSupply() external view returns (uint256 totalManagedShares);
-
-    /**
-     * @dev Returns the amount of shares that the Vault holds for an address.
-     *
-     * - MUST NOT revert.
-     * - Added to match EIP-4626 Specification
-     */
-    function balanceOf(address owner) external view returns (uint256 shares);
-
     /**
      * @dev Returns the total amount of the underlying asset that is “managed” by Vault.
      *

packages/ovault-composer/contracts/interfaces/IOVault.sol

@@ -3,4 +3,7 @@ pragma solidity ^0.8.20;
 
 interface IOVault {
     error ShareNotERC4626AdapterCompliant();
+
+    function ASSET_OFT() external view returns (address);
+    function SHARE_OFT() external view returns (address);
 }