PR679 + Audit Issue 8

chapters/asset.md

@@ -1,7 +1,5 @@
 # Assets
 
-Assets are the underlying constituent members of a water<b>melon</b> Fund. Assets are exclusively Tokens on the Ethereum blockchain implementing the ERC20 or ERC223 standard token interfaces.
-
 Token assets are the underlying constituent members of a water<b>melon</b> Fund. These token assets are exclusively Ethereum blockchain tokens implementing the ERC20 standard token interface.
 
 ## Asset Eligibility

chapters/exchanges.md

@@ -505,10 +505,12 @@ onlyManager notShutDown`
 
 Please see parameter descriptions above. In the context of the Kyber exchange contract's nomenclature (swapToken() function), the following parameters take the specified mappings:
 
-  `orderAddresses[2]` - The Src token address.
-  `orderAddresses[3]` - The Dest token address.
-  `orderValues[0]` - The Src token quantity.
-  `orderValues[0]` - The Dest token quantity.
+  `orderAddresses[2]` - The Src (maker asset) token address.
+  `orderAddresses[3]` - The Dest (taker asset) token address.
+  `orderValues[0]` - The Src (maker asset) token quantity.
+  `orderValues[0]` - The Dest (taker asset) token quantity.
+
+It should be noted that the Kyber adapter only publicly exposes the `takeOrder()` function. As an order `taker`, the maker/taker perspective is inverted.
 
 This public function must ensure that:
 

chapters/factory.md

@@ -14,7 +14,7 @@ The contract is a base contract which defines base elements below. It is inherit
 
 #### Inherits from
 
-None.
+None. 
  
 
 #### On Construction
@@ -241,51 +241,51 @@ This public function takes the following parameters and initiates the set up pro
  
 
 `function createAccounting()
-componentNotSet(managersToRoutes[msg.sender].accounting) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].accounting) amguPayable(0) payable`
 
-This public function creates the Accounting spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the Accounting spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function createFeeManager()
-componentNotSet(managersToRoutes[msg.sender].feeManager) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].feeManager) amguPayable(0) payable`
 
-This public function creates the FeeManager spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the FeeManager spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function createParticipation()
-componentNotSet(managersToRoutes[msg.sender].participation) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].participation) amguPayable(0) payable`
 
-This public function creates the Participation spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). TThe function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the Participation spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). TThe function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function createPolicyManager()
-componentNotSet(managersToRoutes[msg.sender].policyManager) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].policyManager) amguPayable(0) payable`
 
-This public function creates the PolicyManager spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the PolicyManager spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function createShares()
-componentNotSet(managersToRoutes[msg.sender].shares) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].shares) amguPayable(0) payable`
 
-This public function creates the Shares spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the Shares spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function createTrading()
-componentNotSet(managersToRoutes[msg.sender].trading) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].trading) amguPayable(0) payable`
 
-This public function creates the Trading spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the Trading spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function createVault()
-componentNotSet(managersToRoutes[msg.sender].vault) amguPayable payable`
+componentNotSet(managersToRoutes[msg.sender].vault) amguPayable(0) payable`
 
-This public function creates the Vault spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function creates the Vault spoke of a water<b>melon</b> fund and adds the resulting contract address to the `managersToRoutes` mapping, mapped to the `msg.sender` (manager). The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function completeSetup()
-amguPayable payable`
+amguPayable(0) payable`
 
-This public function completes the set up of a water<b>melon</b> fund. The function ensure the `childExists` mapping does not contain the `hub` address, then adds the `hub` address. The function then sets all of the `hub`'s spokes, routing, permissions and then adds the `hub` address to the `funds` state variable address array. The new water<b>melon</b> fund is then registered with the Version Registry. The function finally emits the `NewFund()` event, logging all parameter values as specified above. The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment.
+This public function completes the set up of a water<b>melon</b> fund. The function ensure the `childExists` mapping does not contain the `hub` address, then adds the `hub` address. The function then sets all of the `hub`'s spokes, routing, permissions and then adds the `hub` address to the `funds` state variable address array. The new water<b>melon</b> fund is then registered with the Version Registry. The function finally emits the `NewFund()` event, logging all parameter values as specified above. The function implements the `componentNotSet()` modifier ensuring its one-time execution in the water<b>melon</b> fund setup process. The function is `payable` and also implements the `amguPayable` modifier, requiring amgu payment. Here, the `deductFromRefund` parameter is set to `0`.
 &nbsp;
 
 `function getFundById(uint withId) public view returns (address)`