Renamed contracts and variables.

Author: bweick

contracts/core/SetToken.sol

@@ -18,7 +18,6 @@ pragma solidity 0.4.24;
 
 
 import { DetailedERC20 } from "zeppelin-solidity/contracts/token/ERC20/DetailedERC20.sol";
-import { ERC20 } from "zeppelin-solidity/contracts/token/ERC20/ERC20.sol";
 import { StandardToken } from "zeppelin-solidity/contracts/token/ERC20/StandardToken.sol";
 import { SafeMath } from "zeppelin-solidity/contracts/math/SafeMath.sol";
 import { ISetFactory } from "./interfaces/ISetFactory.sol";

contracts/core/TransferProxy.sol

@@ -19,7 +19,7 @@ pragma solidity 0.4.24;
 
 import { Authorizable } from "../lib/Authorizable.sol";
 import { SafeMath } from "zeppelin-solidity/contracts/math/SafeMath.sol";
-import { TokenInteract } from "./lib/TokenInteract.sol";
+import { ERC20Wrapper } from "./lib/ERC20Wrapper.sol";
 
 
 /**
@@ -80,22 +80,22 @@ contract TransferProxy is
         onlyAuthorized
     {
         // Retrieve current balance of token for the vault
-        uint existingVaultBalance = TokenInteract.balanceOf(
+        uint existingVaultBalance = ERC20Wrapper.balanceOf(
             _tokenAddress,
             vaultAddress
         );
 
         // Call specified ERC20 contract to transfer tokens from user to Vault (via proxy).
 
-        TokenInteract.transferFrom(
+        ERC20Wrapper.transferFrom(
             _tokenAddress,
             _from,
             vaultAddress,
             _quantity
         );
 
         // Verify transfer quantity is reflected in balance
-        uint newVaultBalance = TokenInteract.balanceOf(
+        uint newVaultBalance = ERC20Wrapper.balanceOf(
             _tokenAddress,
             vaultAddress
         );

contracts/core/Vault.sol

@@ -18,9 +18,8 @@ pragma solidity 0.4.24;
 
 
 import { Authorizable } from "../lib/Authorizable.sol";
-import { ERC20 } from "zeppelin-solidity/contracts/token/ERC20/ERC20.sol";
 import { SafeMath } from "zeppelin-solidity/contracts/math/SafeMath.sol";
-import { TokenInteract } from "./lib/TokenInteract.sol";
+import { ERC20Wrapper } from "./lib/ERC20Wrapper.sol";
 
 
 /**
@@ -93,20 +92,20 @@ contract Vault is
         isValidDestination(_to)
     {
         // Retrieve current balance of token for the vault
-        uint existingVaultBalance = TokenInteract.balanceOf(
+        uint existingVaultBalance = ERC20Wrapper.balanceOf(
             _tokenAddress,
             this
         );
 
         // Call specified ERC20 token contract to transfer tokens from Vault to user
-        TokenInteract.transfer(
+        ERC20Wrapper.transfer(
             _tokenAddress,
             _to,
             _quantity
         );
 
         // Verify transfer quantity is reflected in balance
-        uint newVaultBalance = TokenInteract.balanceOf(
+        uint newVaultBalance = ERC20Wrapper.balanceOf(
             _tokenAddress,
             this
         );

contracts/core/lib/TokenInteract.sol renamed to contracts/core/lib/ERC20Wrapper.sol

@@ -1,9 +1,12 @@
 /*
     Copyright 2018 Set Labs Inc.
+
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at
+
     http://www.apache.org/licenses/LICENSE-2.0
+
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -13,7 +16,7 @@
 
 pragma solidity 0.4.24;
 
-import { GeneralERC20 } from "../../lib/GeneralERC20.sol";
+import { IERC20 } from "../../lib/IERC20.sol";
 
 
 /**
@@ -23,12 +26,11 @@ import { GeneralERC20 } from "../../lib/GeneralERC20.sol";
  * This library contains functions for interacting wtih ERC20 tokens, even those not fully compliant.
  * For all functions we will only accept tokens that return a null or true value, any other values will
  * cause the operation to revert.
- *
- * Inspired by dYdX Trading Inc's TokenInteract contract.
  */
-library TokenInteract {
+library ERC20Wrapper {
 
     // ============ Constants ============
+
     string constant INVALID_RETURN_VALUE_TRANSFER = "Transferred token does not return null or true on successful trasnfer.";
     string constant INVALID_RETURN_VALUE_TRANSFERFROM = "Transferred token does not return null or true on successful transferFrom.";
 
@@ -42,7 +44,7 @@ library TokenInteract {
         view
         returns (uint256)
     {
-        return GeneralERC20(_tokenAddress).balanceOf(_ownerAddress);
+        return IERC20(_tokenAddress).balanceOf(_ownerAddress);
     }
 
     function transfer(
@@ -52,8 +54,7 @@ library TokenInteract {
     )
         internal
     {
-
-        GeneralERC20(_tokenAddress).transfer(_to, _quantity);
+        IERC20(_tokenAddress).transfer(_to, _quantity);
 
         require(
             checkSuccess(),
@@ -69,8 +70,7 @@ library TokenInteract {
     )
         internal
     {
-
-        GeneralERC20(_tokenAddress).transferFrom(_from, _to, _quantity);
+        IERC20(_tokenAddress).transferFrom(_from, _to, _quantity);
 
         require(
             checkSuccess(),
@@ -90,7 +90,7 @@ library TokenInteract {
         pure
         returns (bool)
     {
-        //default to failure
+        // default to failure
         uint256 returnValue = 0;
 
         assembly {
@@ -118,4 +118,4 @@ library TokenInteract {
         // check if returned value is one or nothing
         return returnValue == 1;
     }
-}
+}

contracts/lib/Authorizable.sol

@@ -26,7 +26,6 @@ import { Ownable } from "zeppelin-solidity/contracts/ownership/Ownable.sol";
  * The Authorizable contract is an inherited contract that sets permissions on certain function calls
  * through the onlyAuthorized modifier. Permissions can be managed only by the Owner of the contract.
  */
-
 contract Authorizable is
     Ownable
 {

contracts/lib/GeneralERC20.sol renamed to contracts/lib/IERC20.sol

@@ -1,9 +1,12 @@
 /*
     Copyright 2018 Set Labs Inc.
+
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at
+
     http://www.apache.org/licenses/LICENSE-2.0
+
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -20,11 +23,8 @@ pragma solidity 0.4.24;
  *
  * Interface for using ERC20 Tokens. This interface is needed to interact with tokens that are not
  * fully ERC20 compliant and return something other than true on successful transfers.
- *
- * Inspired by dYdX Trading Inc's TokenInteract contract.
  */
-interface GeneralERC20 {
-
+interface IERC20 {
     function balanceOf(
         address _owner
     )
@@ -38,11 +38,10 @@ interface GeneralERC20 {
     )
         external;
 
-
     function transferFrom(
         address _from,
         address _to,
         uint256 _quantity
     )
         external;
-}
+}

contracts/test/MockTokenInvalidReturn.sol

@@ -188,4 +188,4 @@ contract MockTokenInvalidReturn {
     emit Approval(msg.sender, _spender, allowed[msg.sender][_spender]);
     return 4;
   }
-}
+}