Merge pull request #24 from webb-tools/drew-token-updates

Update tokens, contract names, tests

Author: drewstone

contracts/anchors/bridged/LinkableCompTokenAnchorPoseidon2.sol renamed to contracts/anchors/bridged/2/Anchor2.sol

@@ -5,12 +5,13 @@
 
 pragma solidity ^0.8.0;
 
-import "../../tokens/TokenWrapper.sol";
-import "./LinkableAnchorPoseidon2.sol";
+import "../../../tokens/TokenWrapper.sol";
+import "../../../interfaces/IMintableERC20.sol";
+import "./LinkableAnchor2.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
-contract LinkableCompTokenAnchorPoseidon2 is LinkableAnchorPoseidon2 {
+contract Anchor2 is LinkableAnchor2 {
   using SafeERC20 for IERC20;
   address public immutable token;
 
@@ -20,22 +21,25 @@ contract LinkableCompTokenAnchorPoseidon2 is LinkableAnchorPoseidon2 {
     uint256 _denomination,
     uint32 _merkleTreeHeight,
     uint32 _chainID,
-    TokenWrapper _token
-  ) LinkableAnchorPoseidon2(_verifier, _hasher, _denomination, _merkleTreeHeight, _chainID) {
+    TokenWrapper _token,
+    address _bridge,
+    address _admin,
+    address _handler
+  ) LinkableAnchor2(_verifier, _hasher, _denomination, _merkleTreeHeight, _chainID, _bridge, _admin, _handler) {
     token = address(_token);
   }
 
   function wrap(address tokenAddress, uint256 amount) public {
-    TokenWrapper(token).wrap(msg.sender, tokenAddress, amount);
+    TokenWrapper(token).wrapFor(msg.sender, tokenAddress, amount);
   }
 
   function unwrap(address tokenAddress, uint256 amount) public {
-    TokenWrapper(token).unwrap(msg.sender, tokenAddress, amount);
+    TokenWrapper(token).unwrapFor(msg.sender, tokenAddress, amount);
   }
 
   function _processDeposit() internal override {
     require(msg.value == 0, "ETH value is supposed to be 0 for ERC20 instance");
-    IMintableCompToken(token).transferFrom(msg.sender, address(this), denomination);
+    IMintableERC20(token).transferFrom(msg.sender, address(this), denomination);
   }
 
   function _processWithdraw(
@@ -46,15 +50,19 @@ contract LinkableCompTokenAnchorPoseidon2 is LinkableAnchorPoseidon2 {
   ) internal override {
     require(msg.value == _refund, "Incorrect refund amount received by the contract");
 
-    if (IERC20(token).balanceOf(address(this)) == 0) {
-      IMintableCompToken(token).mint(_recipient, denomination - _fee);
+    uint balance = IERC20(token).balanceOf(address(this));
+    
+    if (balance >= denomination) {
+      // transfer tokens when balance exists
+      IERC20(token).safeTransfer(_recipient, denomination - _fee);
       if (_fee > 0) {
-        IMintableCompToken(token).mint(_relayer, _fee);
+        IERC20(token).safeTransfer(_relayer, _fee);
       }
     } else {
-      IERC20(token).safeTransfer(_recipient, denomination - _fee);
+      // mint tokens when not enough balance exists
+      IMintableERC20(token).mint(_recipient, denomination - _fee);
       if (_fee > 0) {
-        IERC20(token).safeTransfer(_relayer, _fee);
+        IMintableERC20(token).mint(_relayer, _fee);
       }
     }
 

contracts/anchors/bridged/AnchorPoseidon2.sol renamed to contracts/anchors/bridged/2/AnchorBase2.sol

@@ -5,7 +5,7 @@
 
 pragma solidity ^0.8.0;
 
-import "../../trees/MerkleTreePoseidon.sol";
+import "../../../trees/MerkleTreePoseidon.sol";
 import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
 
 interface IVerifier {
@@ -17,7 +17,7 @@ interface IVerifier {
   ) external view returns (bool r);
 }
 
-abstract contract AnchorPoseidon2 is MerkleTreePoseidon, ReentrancyGuard {
+abstract contract AnchorBase2 is MerkleTreePoseidon, ReentrancyGuard {
   address public bridge;
   address public admin;
   address public handler;

contracts/anchors/bridged/LinkableAnchorPoseidon2.sol renamed to contracts/anchors/bridged/2/LinkableAnchor2.sol

@@ -5,22 +5,23 @@
 
 pragma solidity ^0.8.0;
 
-import "./AnchorPoseidon2.sol";
-import "../../interfaces/ILinkableAnchor.sol";
+import "./AnchorBase2.sol";
+import "../../../interfaces/ILinkableAnchor.sol";
 
-abstract contract LinkableAnchorPoseidon2 is AnchorPoseidon2, ILinkableAnchor {
+abstract contract LinkableAnchor2 is AnchorBase2, ILinkableAnchor {
   constructor(
     IVerifier _verifier,
     IPoseidonT3 _hasher,
     uint256 _denomination,
     uint32 _merkleTreeHeight,
-    uint256 _chainID
-  ) AnchorPoseidon2(_verifier, _hasher, _denomination, _merkleTreeHeight, _chainID) {
-    // set the sender as admin & bridge & handler address
-    // TODO: Properly set addresses and permissions
-    bridge = msg.sender;
-    admin = msg.sender;
-    handler = msg.sender;
+    uint256 _chainID,
+    address _bridge,
+    address _admin,
+    address _handler
+  ) AnchorBase2(_verifier, _hasher, _denomination, _merkleTreeHeight, _chainID) {
+    bridge = _bridge;
+    admin = _admin;
+    handler = _handler;
   }
 
   function setHandler(address _handler) onlyBridge override external {

contracts/anchors/bridged/AnchorFactoryPoseidon.sol

@@ -5,7 +5,7 @@
 
 pragma solidity ^0.8.0;
 
-import "./LinkableERC20AnchorPoseidon2.sol";
+import "./2/Anchor2.sol";
 
 contract AnchorFactoryPoseidon {
   function createAnchor2(
@@ -14,15 +14,21 @@ contract AnchorFactoryPoseidon {
     uint256 _denomination,
     uint32 _merkleTreeHeight,
     uint32 _chainID,
-    IERC20 _token
+    TokenWrapper _token,
+    address _bridge,
+    address _admin,
+    address _handler
   ) external {
-    new LinkableERC20AnchorPoseidon2(
+    new Anchor2(
       _verifier,
       _hasher,
       _denomination,
       _merkleTreeHeight,
       _chainID,
-      _token
+      _token,
+      _bridge,
+      _admin,
+      _handler
     );
   }
 
@@ -33,15 +39,21 @@ contract AnchorFactoryPoseidon {
     uint256 _denomination,
     uint32 _merkleTreeHeight,
     uint32 _chainID,
-    IERC20 _token
+    TokenWrapper _token,
+    address _bridge,
+    address _admin,
+    address _handler
   ) external {
-    new LinkableERC20AnchorPoseidon2{salt: _salt}(
+    new Anchor2{salt: _salt}(
       _verifier,
       _hasher,
       _denomination,
       _merkleTreeHeight,
       _chainID,
-      _token
+      _token,
+      _bridge,
+      _admin,
+      _handler
     );
   }
 }

contracts/anchors/bridged/LinkableERC20AnchorPoseidon2.sol

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2021 Webb Technologies
+ * SPDX-License-Identifier: GPL-3.0-or-later-only
+ */
+
+pragma solidity ^0.8.0;
+
+/**
+ * @dev Interface of the ERC20 standard as defined in the EIP.
+ */
+interface IMintableERC20 {
+    /**
+     * @dev Mints `amount` tokens to account `to`.
+     *
+     * Emits a {Transfer} event.
+     */
+    function mint(address to, uint256 amount) external;
+
+    /**
+     * @dev Moves `amount` tokens from the caller's account to `recipient`.
+     *
+     * Returns a boolean value indicating whether the operation succeeded.
+     *
+     * Emits a {Transfer} event.
+     */
+    function transfer(address recipient, uint256 amount) external returns (bool);
+
+    /**
+     * @dev Moves `amount` tokens from `sender` to `recipient` using the
+     * allowance mechanism. `amount` is then deducted from the caller's
+     * allowance.
+     *
+     * Returns a boolean value indicating whether the operation succeeded.
+     *
+     * Emits a {Transfer} event.
+     */
+    function transferFrom(
+        address sender,
+        address recipient,
+        uint256 amount
+    ) external returns (bool);
+}

contracts/interfaces/IMintableCompToken.sol

@@ -6,10 +6,10 @@
 pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
-import "../interfaces/IMintableCompToken.sol";
+import "../interfaces/IMintableERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/presets/ERC20PresetMinterPauser.sol";
 
-contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
+contract CompToken is ERC20PresetMinterPauser, IMintableERC20 {
     /// @notice A record of each accounts delegate
     mapping (address => address) public delegates;
 
@@ -51,7 +51,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      * @param rawAmount The number of tokens to transfer
      * @return Whether or not the transfer succeeded
      */
-    function transfer(address dst, uint rawAmount) override(ERC20, IMintableCompToken) public virtual returns (bool) {
+    function transfer(address dst, uint rawAmount) override(ERC20, IMintableERC20) public virtual returns (bool) {
         _transfer(_msgSender(), dst, rawAmount);
         _transferDelegates(_msgSender(), dst, rawAmount);
         return true;
@@ -64,7 +64,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      * @param rawAmount The number of tokens to transfer
      * @return Whether or not the transfer succeeded
      */
-    function transferFrom(address src, address dst, uint rawAmount) override(ERC20, IMintableCompToken) public virtual returns (bool) {
+    function transferFrom(address src, address dst, uint rawAmount) override(ERC20, IMintableERC20) public virtual returns (bool) {
         _transfer(src, dst, rawAmount);
         _transferDelegates(src, dst, rawAmount);
 
@@ -86,7 +86,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      *
      * - the caller must have the `MINTER_ROLE`.
      */
-    function mint(address to, uint256 amount) override(ERC20PresetMinterPauser, IMintableCompToken) public virtual {
+    function mint(address to, uint256 amount) override(ERC20PresetMinterPauser, IMintableERC20) public virtual {
         require(hasRole(MINTER_ROLE, _msgSender()), "ERC20PresetMinterPauser: must have minter role to mint");
         _mint(to, amount);
     }
@@ -95,7 +95,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      * @notice Delegate votes from `msg.sender` to `delegatee`
      * @param delegatee The address to delegate votes to
      */
-    function delegate(address delegatee) override public {
+    function delegate(address delegatee) public {
         return _delegate(msg.sender, delegatee);
     }
 
@@ -108,7 +108,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      * @param r Half of the ECDSA signature pair
      * @param s Half of the ECDSA signature pair
      */
-    function delegateBySig(address delegatee, uint nonce, uint expiry, uint8 v, bytes32 r, bytes32 s) override public {
+    function delegateBySig(address delegatee, uint nonce, uint expiry, uint8 v, bytes32 r, bytes32 s) public {
         bytes32 domainSeparator = keccak256(abi.encode(DOMAIN_TYPEHASH, keccak256(bytes(name())), getChainId(), address(this)));
         bytes32 structHash = keccak256(abi.encode(DELEGATION_TYPEHASH, delegatee, nonce, expiry));
         bytes32 digest = keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash));
@@ -124,7 +124,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      * @param account The address to get votes balance
      * @return The number of current votes for `account`
      */
-    function getCurrentVotes(address account) override external view returns (uint256) {
+    function getCurrentVotes(address account) external view returns (uint256) {
         uint32 nCheckpoints = numCheckpoints[account];
         return nCheckpoints > 0 ? checkpoints[account][nCheckpoints - 1].votes : 0;
     }
@@ -136,7 +136,7 @@ contract CompToken is ERC20PresetMinterPauser, IMintableCompToken {
      * @param blockNumber The block number to get the vote balance at
      * @return The number of votes the account had as of the given block
      */
-    function getPriorVotes(address account, uint blockNumber) override public view returns (uint256) {
+    function getPriorVotes(address account, uint blockNumber) public view returns (uint256) {
         require(blockNumber < block.number, "Comp::getPriorVotes: not yet determined");
 
         uint32 nCheckpoints = numCheckpoints[account];