style: add func docu

omgnetwork · Jan 15, 2021 · a284ea6 · a284ea6
1 parent 0a50243
commit a284ea6
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/plasma_framework/contracts/poc/fast_exits/Quasar.sol b/plasma_framework/contracts/poc/fast_exits/Quasar.sol
@@ -128,10 +128,16 @@ contract Quasar is QuasarPool {
         unclaimedBonds = unclaimedBonds.add(ticketData[utxoPos].bondValue); 
     }
 
+    /**
+     * @dev Pause contract in a byzantine state
+    */
     function pauseQuasar() public onlyQuasarMaintainer() {
         isPaused = true;
     }
 
+    /**
+     * @dev Unpause contract and allow tickets
+    */
     function resumeQuasar() public onlyQuasarMaintainer() {
         isPaused = false;
     }
@@ -218,6 +224,11 @@ contract Quasar is QuasarPool {
         claimData[utxoPos] = Claim(rlpTxToQuasarOwner, block.timestamp.add(waitingPeriod), true);
     }
 
+    /**
+     * @dev Submit and IFEclaim for claims without inclusion proof
+     * @param utxoPos pos of the output, which is the ticket identifier
+     * @param inFlightClaimTx in-flight tx that spends the output to quasar owner
+    */
     function ifeClaim(uint256 utxoPos, bytes memory inFlightClaimTx) public {
         verifyTicketValidityForClaim(utxoPos);