Merge pull request #15 from OpenSTFoundation/final-tokensale

Final token sale specifications

Author: jasonklein

contracts/ERC20Token.sol

@@ -24,7 +24,7 @@ contract ERC20Token is ERC20Interface, Owned {
     string  private tokenName;
     string  private tokenSymbol;
     uint8   private tokenDecimals;
-    uint256 private tokenTotalSupply;
+    uint256 internal tokenTotalSupply;
 
     mapping(address => uint256) balances;
     mapping(address => mapping (address => uint256)) allowed;
@@ -107,4 +107,5 @@ contract ERC20Token is ERC20Interface, Owned {
 
         return true;
     }
+
 }

contracts/SimpleToken.sol

@@ -39,6 +39,7 @@ contract SimpleToken is ERC20Token, OpsManaged, SimpleTokenConfig {
 
 
     // Events
+    event Burnt(address indexed _from, uint256 _amount);
     event Finalized();
 
 
@@ -79,6 +80,19 @@ contract SimpleToken is ERC20Token, OpsManaged, SimpleTokenConfig {
         require(isOwnerOrOps(_sender) || _to == owner);
     }
 
+    // Implement a burn function to permit msg.sender to reduce its balance
+    // which also reduces tokenTotalSupply
+    function burn(uint256 _value) public returns (bool success) {
+        require(_value <= balances[msg.sender]);
+
+        balances[msg.sender] = balances[msg.sender].sub(_value);
+        tokenTotalSupply = tokenTotalSupply.sub(_value);
+
+        Burnt(msg.sender, _value);
+
+        return true;
+    }
+
 
     // Finalize method marks the point where token transfers are finally allowed for everybody.
     function finalize() external onlyAdmin returns (bool success) {

contracts/TokenSale.sol

@@ -63,6 +63,7 @@ import "./SafeMath.sol";
 // addPresale                                x
 // pause / unpause                           x
 // reclaimTokens                             x
+// burnUnsoldTokens                          x
 // finalize                                  x
 //
 
@@ -118,11 +119,12 @@ contract TokenSale is OpsManaged, Pausable, TokenSaleConfig { // Pausable is als
     event Initialized();
     event PresaleAdded(address indexed _account, uint256 _baseTokens, uint256 _bonusTokens);
     event WhitelistUpdated(address indexed _account, uint8 _phase);
-    event TokensPurchased(address indexed _beneficiary, uint256 _cost, uint256 _tokens);
+    event TokensPurchased(address indexed _beneficiary, uint256 _cost, uint256 _tokens, uint256 _totalSold);
     event TokensPerKEtherUpdated(uint256 _amount);
     event Phase1AccountTokensMaxUpdated(uint256 _tokens);
     event WalletChanged(address _newWallet);
     event TokensReclaimed(uint256 _amount);
+    event UnsoldTokensBurnt(uint256 _amount);
     event Finalized();
 
 
@@ -212,6 +214,12 @@ contract TokenSale is OpsManaged, Pausable, TokenSaleConfig { // Pausable is als
         _;
     }
 
+    modifier onlyAfterSale() {
+        // require finalized is stronger than hasSaleEnded
+        require(finalized);
+        _;
+    }
+
 
     function hasSaleEnded() private view returns (bool) {
         // if sold out or finalized, sale has ended
@@ -345,7 +353,7 @@ contract TokenSale is OpsManaged, Pausable, TokenSaleConfig { // Pausable is als
         // Transfer the contribution to the wallet
         wallet.transfer(msg.value.sub(refund));
 
-        TokensPurchased(msg.sender, cost, tokensBought);
+        TokensPurchased(msg.sender, cost, tokensBought, totalTokensSold);
 
         // If all tokens available for sale have been sold out, finalize the sale automatically.
         if (totalTokensSold == TOKENS_SALE) {
@@ -437,17 +445,32 @@ contract TokenSale is OpsManaged, Pausable, TokenSaleConfig { // Pausable is als
     }
 
 
-    // Allows the admin to reclaim all tokens assigned to the sale contract.
-    // This should only be used in case of emergency.
-    function reclaimTokens() external onlyAdmin returns (bool) {
+    // Allows the admin to move bonus tokens still available in the sale contract
+    // out before burning all remaining unsold tokens in burnUnsoldTokens().
+    // Used to distribute bonuses to token sale participants when the sale has ended
+    // and all bonuses are known.
+    function reclaimTokens(uint256 _amount) external onlyAfterSale onlyAdmin returns (bool) {
         uint256 ownBalance = tokenContract.balanceOf(address(this));
-
+        require(_amount <= ownBalance);
+        
         address tokenOwner = tokenContract.owner();
         require(tokenOwner != address(0));
 
-        require(tokenContract.transfer(tokenOwner, ownBalance));
+        require(tokenContract.transfer(tokenOwner, _amount));
+
+        TokensReclaimed(_amount);
+
+        return true;
+    }
+
+
+    // Allows the admin to burn all unsold tokens in the sale contract.
+    function burnUnsoldTokens() external onlyAfterSale onlyAdmin returns (bool) {
+        uint256 ownBalance = tokenContract.balanceOf(address(this));
+
+        require(tokenContract.burn(ownBalance));
 
-        TokensReclaimed(ownBalance);
+        UnsoldTokensBurnt(ownBalance);
 
         return true;
     }

contracts/TokenSaleConfig.sol

@@ -17,7 +17,7 @@ contract TokenSaleConfig is SimpleTokenConfig {
 
     uint256 public constant PHASE1_START_TIME         = 1510664400; // 2017-11-14, 13:00:00 UTC
     uint256 public constant PHASE2_START_TIME         = 1510750800; // 2017-11-15, 13:00:00 UTC
-    uint256 public constant END_TIME                  = 1511269199; // 2017-11-21, 12:59:59 UTC
+    uint256 public constant END_TIME                  = 1512133199; // 2017-12-01, 12:59:59 UTC
     uint256 public constant CONTRIBUTION_MIN          = 0.1 ether;
     uint256 public constant CONTRIBUTION_MAX          = 10000.0 ether;