edit comments

README.md

@@ -64,7 +64,7 @@ For more information on how to use Foundry, check out the [Foundry Github Reposi
   - [ ] Approve once on contract deployment instead of every liquidation
 - Replace `jumpi` with other operations
   - [x] Use `mload(type(uint256).max)` for `jumpi` if-else-revert pattern (`GrimReaperHuff`)
-- [x] Abuse `returndatasize`, `calldatasize`, `chainid` and `msize` for `push` operations
+- [x] Abuse `returndatasize`, `calldatasize`, `chainid` and `msize` for `push` operations (`GrimReaperHuff`)
 
 ## Acknowledgements
 

src/GrimReaper.huff

@@ -145,6 +145,7 @@
 
 
 /// @dev Read memory at 0x00 will trigger a memory expansion if the memory location is not already allocated.
+/// @dev Consumes all gas if the condition `success` is false.
 #define macro IF_FALSE_REVERT_BY_BURNING_GAS() = takes (1) returns (1) {
                     // [success]
     0x01 swap1 sub  // [0 (if true), type(uint256).max (if false)]

src/OptimizedGrimReaper.sol

@@ -35,6 +35,7 @@ contract OptimizedGrimReaper {
     /// @dev function liquidationCall(address collateralAsset,address debtAsset,address user,uint256 debtToCover,bool receiveAToken)
     bytes4 internal constant LIQUIDATION_CALL_ID = 0x00a718a9;
 
+    /// @dev Dispatching function calls manually saves tiny gas. It's not much worth it.
     fallback() external payable virtual {
         assembly {
             // only the owner of this contract is allowed to call this function