(feat) modify contracts based on requested changes

Author: yzhang1994

README.md

@@ -11,7 +11,7 @@ The Basket protocol establishes a decentralized ecosystem that trustlessly fulfi
 The Basket Protocol deconstructs the traditional asset management model into three functional roles, allowing for specialization, efficiency, and decentralization.  Market participants can act in any or all capacities.  Meanwhile, the protocol's registry capabilities facilitate the evaluation of and tracking of baskets as well as of the arrangers that created them.
 
 - **Arranger**: "fund manager" in the traditional sense, that selects tokens and weights for basket contracts
-- **Market Maker**: accumulates ERC20 tokens for compiling into baskets and "minting" of basket tokens
+- **Supplier**: accumulates ERC20 tokens for compiling into baskets and "minting" of basket tokens
 - **Buyer**: the ultimate holder of the basket token, who owns and controls the basket tokens and the underlying ERC20 tokens they represent
 
 ## Basket Protocol Contract Suite
@@ -99,4 +99,4 @@ We welcome code contributions (via [pull requests](https://github.com/CoinAlpha/
 The Basket Protocol was created by [CoinAlpha](https://www.coinalpha.com).  You can contact us at [[email protected]](mailto:[email protected]).
 
 ## License
-Code released under the [Apache-2.0 License](LICENSE).
+Code released under the [Apache-2.0 License](LICENSE).

config.js

@@ -5,9 +5,9 @@ module.exports = {
 
   // Fee amounts used for development and testing
   TRANSACTION_FEE: 0.005 * 1e18,        // Charge 0.5% transaction fee
-  PRODUCTION_FEE: 0.3 * 1e18,           // Charge 0.3 ETH of transaction per basket creation
-  SWAPPABLE_PRODUCTION_FEE: 0.3 * 1e18, // Charge 0.5 ETH of transaction per basket creation
-  ARRANGER_FEE: 0.01 * 1e18,            // Charge 0.01 ETH of transaction per basket minted
+  PRODUCTION_FEE: 0.3 * 1e18,           // Charge 0.3 ETH per basket creation
+  SWAPPABLE_PRODUCTION_FEE: 0.3 * 1e18, // Charge 0.5 ETH per basket creation
+  ARRANGER_FEE: 0.01 * 1e18,            // Charge 0.01 ETH per basket minted
   FEE_DECIMALS: 18,
 
   // Zero address

contracts/Basket.sol

@@ -77,7 +77,7 @@ contract Basket is StandardToken {
     address   _basketRegistryAddress,
     address   _arranger,
     address   _arrangerFeeRecipient,
-    uint      _arrangerFee                         // Amount of ETH charged per basket minted
+    uint      _arrangerFee                         // in wei, i.e. 1e18 = 1 ETH
   ) public {
     require(_tokens.length > 0 && _tokens.length == _weights.length, "Constructor: invalid number of tokens and weights");
 
@@ -102,13 +102,13 @@ contract Basket is StandardToken {
     for (uint i = 0; i < tokens.length; i++) {
       address t = tokens[i];
       uint w = weights[i];
-      assert(ERC20(t).transferFrom(msg.sender, this, w.mul(_quantity).div(10 ** 18)));
+      assert(ERC20(t).transferFrom(msg.sender, this, w.mul(_quantity).div(10 ** decimals)));
     }
 
-    // charging market makers a fee for every new basket minted
+    // charging suppliers a fee for every new basket minted
     // skip fees if tokens are minted through swaps
     if (arrangerFee > 0) {
-      require(msg.value >= arrangerFee.mul(_quantity).div(10 ** 18), "Insufficient ETH for arranger fee to bundle");
+      require(msg.value >= arrangerFee.mul(_quantity).div(10 ** decimals), "Insufficient ETH for arranger fee to bundle");
       arrangerFeeRecipient.transfer(msg.value);
     } else {
       // prevent transfers of unnecessary ether into the contract
@@ -132,7 +132,7 @@ contract Basket is StandardToken {
     return true;
   }
 
-  /// @dev Convert basketTokens back to original tokens and transfer to swap contract and initiate swap
+  /// @dev Convert basketTokens back to original tokens and transfer to specified recipient
   /// @param  _quantity                            Quantity of basket tokens to swap
   /// @param  _sender                              Address of transaction sender
   /// @param  _recipient                           Address of token recipient
@@ -147,19 +147,19 @@ contract Basket is StandardToken {
     balances[_sender] = balances[_sender].sub(_quantity);
     totalSupply_ = totalSupply_.sub(_quantity);
 
-    // transfer tokens back to holder
+    // transfer tokens back to _recipient
     for (uint i = 0; i < tokens.length; i++) {
       address t = tokens[i];
       uint w = weights[i];
-      ERC20(t).transfer(_recipient, w.mul(_quantity).div(10 ** 18));
+      ERC20(t).transfer(_recipient, w.mul(_quantity).div(10 ** decimals));
     }
 
     basketRegistry.incrementBasketsBurned(_quantity, _sender);
     return true;
   }
 
   /// @dev Allow holder to convert baskets to its underlying tokens and withdraw them individually
-  /// @param  _quantity                            quantity of tokens to withdraw
+  /// @param  _quantity                            quantity of tokens to burn
   /// @return success                              Operation successful
   function burn(uint _quantity) public returns (bool success) {
     balances[msg.sender] = balances[msg.sender].sub(_quantity);
@@ -169,7 +169,7 @@ contract Basket is StandardToken {
     for (uint i = 0; i < tokens.length; i++) {
       address t = tokens[i];
       uint w = weights[i];
-      outstandingBalance[msg.sender][t] = outstandingBalance[msg.sender][t].add(w.mul(_quantity).div(10 ** 18));
+      outstandingBalance[msg.sender][t] = outstandingBalance[msg.sender][t].add(w.mul(_quantity).div(10 ** decimals));
     }
 
     basketRegistry.incrementBasketsBurned(_quantity, msg.sender);
@@ -182,6 +182,7 @@ contract Basket is StandardToken {
   function withdraw(address _token) public returns (bool success) {
     uint bal = outstandingBalance[msg.sender][_token];
     require(bal > 0);
+    outstandingBalance[msg.sender][_token] = 0;
     assert(ERC20(_token).transfer(msg.sender, bal));
 
     emit LogWithdraw(msg.sender, _token, bal);
@@ -192,6 +193,10 @@ contract Basket is StandardToken {
   /// @param  _newRecipient                        New fee recipient
   /// @return success                              Operation successful
   function changeArrangerFeeRecipient(address _newRecipient) public onlyArranger returns (bool success) {
+    require(
+      _newRecipient != address(0) && _newRecipient != arrangerFeeRecipient,
+      "New receipient can not be 0x0 or the same as the current recipient"
+    );
     address oldRecipient = arrangerFeeRecipient;
     arrangerFeeRecipient = _newRecipient;
 

contracts/BasketFactory.sol

@@ -130,5 +130,5 @@ contract BasketFactory {
   }
 
   /// @dev Fallback to reject any ether sent to contract
-  function () public payable { revert("BasketFactory do not accept ETH transfers"); }
+  function () public payable { revert("BasketFactory does not accept ETH transfers"); }
 }

contracts/BasketRegistry.sol

@@ -67,7 +67,7 @@ contract BasketRegistry {
     _;
   }
   modifier onlyBasketFactory {
-    require(basketFactoryMap[msg.sender] == true, "Only the basket factory can call this function");
+    require(basketFactoryMap[msg.sender] == true, "Only a basket factory can call this function");
     _;
   }
 
@@ -188,5 +188,5 @@ contract BasketRegistry {
   }
 
   /// @dev Fallback to reject any ether sent to contract
-  function () public payable { revert("BasketRegistry do not accept ETH transfers"); }
+  function () public payable { revert("BasketRegistry does not accept ETH transfers"); }
 }

contracts/zeppelin/Pausable.sol

@@ -1,4 +1,4 @@
-pragma solidity ^0.4.21;
+pragma solidity ^0.4.22;
 
 
 import "./Ownable.sol";

test/2_basket_registry.js

@@ -69,7 +69,6 @@ contract('Basket Factory | Basket Registry', (accounts) => {
         // check addresses in both contracts have been set correctly
         const result = await basketRegistry.whitelistBasketFactory(INVALID_ADDRESS, { from: ADMINISTRATOR });
         const _basketFactoryExists = await basketRegistry.basketFactoryMap.call(INVALID_ADDRESS);
-        console.log(_basketFactoryExists);
         assert.strictEqual(_basketFactoryExists, true, 'basket factory address not whitelisted');
       } catch (err) { assert.throw(`Failed to set basket factory in registry: ${err.toString()}`); }
     });

test/3_exchange_baskets.js

@@ -498,7 +498,7 @@ contract('Basket Escrow', (accounts) => {
         const escrowBalance = await basketAB.balanceOf(basketEscrow.address);
         const sellerBalance = await basketAB.balanceOf(MARKET_MAKER);
         assert.strictEqual(Number(escrowBalance), (initialEscrowBasketBal + amountBasketsToSell), 'escrow balance did not increase');
-        assert.strictEqual(Number(sellerBalance), (initialMMBasketBal - amountBasketsToSell), 'market maker balance did not decrease');
+        assert.strictEqual(Number(sellerBalance), (initialMMBasketBal - amountBasketsToSell), 'supplier balance did not decrease');
       } catch (err) { assert.throw(`Error sending ETH to escrow contract: ${err.toString()}`); }
     });
 
@@ -547,12 +547,12 @@ contract('Basket Escrow', (accounts) => {
       } catch (err) { assert.throw(`Error creating buy order: ${err.toString()}`); }
     });
 
-    it('sends Baskets back to market maker', async () => {
+    it('sends Baskets back to supplier', async () => {
       try {
         const escrowBalance = await basketAB.balanceOf(basketEscrow.address);
         const sellerBalance = await basketAB.balanceOf(MARKET_MAKER);
         assert.strictEqual(Number(escrowBalance), (initialEscrowBasketBal - amountBasketsToSell), 'escrow balance did not decrease');
-        assert.strictEqual(Number(sellerBalance), (initialMMBasketBal + amountBasketsToSell), 'market maker balance did not increase');
+        assert.strictEqual(Number(sellerBalance), (initialMMBasketBal + amountBasketsToSell), 'supplier balance did not increase');
       } catch (err) { assert.throw(`Error sending ETH to escrow contract: ${err.toString()}`); }
     });