@tokenfoundry/token-contracts - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

docs/ControllableToken.md

 # ControllableToken
 
 ### ControllableToken contract - an ownable, standard token, that queries a token controller to check whether a transfer is allowed 
-
+ 
+- ControllableToken contract is Ownable, StandardToken, ERC20, BasicToken and ERC20 which are OpenZeppelin contracts. More info about those contracts is available at [OpenZeppelin documentation page](https://openzeppelin.org/api/docs/open-zeppelin.html) and contracts' source code is [here](https://github.com/OpenZeppelin/zeppelin-solidity/tree/master/contracts/token/ERC20)
 - This contract does **not** have a fallback function.
@@ -34,1 +35,4 @@ - This contract does **not** have a constructor.
 Calls *StandardToken*'s `transferFrom` function to transfer tokens from one address to another. `_value` must be less than or equal to `from`'s balance of tokens. The `isAllowed` modifier again executes *controller*'s `transferAllowed` function to check if `_from` can transfer tokens to `_to`.
+
+## ControllableToken inheritance diagram
+![ControllableToken inheritance diagram](/diagrams/tokenController.png)

docs/Token.md

@@ -7,5 +7,10 @@ # Token
   * *uint256* `_supply`: the total supply of this instantiation of tokens.
+  * *string* `_name`:  is the long name by which the token contract should be known
+  * *string* `_symbol`: The set of capital letters used to represent the token e.g. DTH.
+  * *uint8* `_decimals`: The number of decimal places the tokens can be split up into. This should be between 0 and 18.
 
+- `_name`, `_symbol` and `_decimals` are parameters used in the DetailedERC20 constructor. DetailedERC20 is an OpenZeppelin contract. 
 - This contract does **not** have a fallback function.
 
+
 ## Token Events
@@ -15,5 +20,5 @@
   - logs the transferral of tokens between addresses
-  - inherited from ERC20Basic contract
+  - inherited from ERC20Basic contract (an OpenZeppelin contract)
 
 ## Token inheritance diagram
 ![Token inheritance diagram](/diagrams/token.png)

package.json

 {
   "name": "@tokenfoundry/token-contracts",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Code for token contracts to be used by token foundry projects",
@@ -5,0 +5,0 @@ "repository": "https://github.com/tokenfoundry/token-contracts.git",

No alert changes

Improved metrics

Total package byte prevSize

262676

increased by5.84%

Number of package files

43

increased by4.88%

No dependency changes