Browse Source

Merge pull request #454 from economicnetwork/master

comments on vesting
Francisco Giordano 8 years ago
parent
commit
bd99b207c9
1 changed files with 8 additions and 8 deletions
  1. 8 8
      contracts/token/VestedToken.sol

+ 8 - 8
contracts/token/VestedToken.sol

@@ -128,13 +128,13 @@ contract VestedToken is StandardToken, LimitedTransferToken {
   }
 
   /**
-   * @dev Calculate amount of vested tokens at a specifc time.
-   * @param tokens uint256 The amount of tokens grantted.
+   * @dev Calculate amount of vested tokens at a specific time
+   * @param tokens uint256 The amount of tokens granted
    * @param time uint64 The time to be checked
-   * @param start uint64 A time representing the begining of the grant
-   * @param cliff uint64 The cliff period.
-   * @param vesting uint64 The vesting period.
-   * @return An uint256 representing the amount of vested tokensof a specif grant.
+   * @param start uint64 The time representing the beginning of the grant
+   * @param cliff uint64  The cliff period, the period before nothing can be paid out
+   * @param vesting uint64 The vesting period
+   * @return An uint256 representing the amount of vested tokens of a specific grant
    *  transferableTokens
    *   |                         _/--------   vestedTokens rect
    *   |                       _/
@@ -149,7 +149,7 @@ contract VestedToken is StandardToken, LimitedTransferToken {
    *   |      .        |
    *   |    .          |
    *   +===+===========+---------+----------> time
-   *      Start       Clift    Vesting
+   *      Start       Cliff    Vesting
    */
   function calculateVestedTokens(
     uint256 tokens,
@@ -166,7 +166,7 @@ contract VestedToken is StandardToken, LimitedTransferToken {
       // As before cliff the shortcut returns 0, we can use just calculate a value
       // in the vesting rect (as shown in above's figure)
 
-      // vestedTokens = tokens * (time - start) / (vesting - start)
+      // vestedTokens = (tokens * (time - start)) / (vesting - start)
       uint256 vestedTokens = SafeMath.div(
                                     SafeMath.mul(
                                       tokens,