resolve comments and add readme

contracts/README.md

@@ -0,0 +1,4 @@
+The smart contract files in this folder contains protocol-level smart contracts that are critical to the overall operation of Harmony protocol:
+
+* Faucet.sol is the smart contract to dispense free test tokens in our testnet.
+* StakeLockContract.sol is the staking smart contract that receives and locks stakes. The stakes are used for the POS and sharding protocol.

contracts/StakeLockContract.sol

@@ -8,9 +8,9 @@ contract StakeLockContract {
     string internal constant NOT_LOCKED = 'No tokens locked';
     string internal constant AMOUNT_ZERO = 'Amount can not be 0';
 
-    uint256 internal constant LOCK_PERIOD_IN_EPOCHS = 3;
+    uint256 internal constant LOCK_PERIOD_IN_EPOCHS = 3;  // Final locking period TBD.
 
-    uint256 internal numBlocksPerEpoch = 5;
+    uint256 internal numBlocksPerEpoch = 5;  // This value is for testing only
 
     /**
      * @dev locked token structure
@@ -33,7 +33,7 @@ contract StakeLockContract {
     event Locked(address indexed _of, uint _amount, uint256 _epoch);
     event Unlocked(address indexed account, uint index);
 
-	/**
+    /**
      * @dev Returns total tokens held by an address (locked + transferable)
      * @param _of The address to query the total balance of
      */