Skip to content

Commit

Permalink
feat: add comments about replayMessage and dropMessage
Browse files Browse the repository at this point in the history
  • Loading branch information
zimpha committed Jul 30, 2024
1 parent da5a1df commit 1c80060
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/L1/L1ScrollMessenger.sol
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ import {IMessageDropCallback} from "../libraries/callbacks/IMessageDropCallback.
///
/// @dev All deposited Ether (including `WETH` deposited throng `L1WETHGateway`) will locked in
/// this contract.
///
/// The messages sent through this contract may failed due to out of gas or some contract errors layer 2. In such case,
/// users can initiate `replayMessage` to retry this message in layer 2. If it is because out of gas, users can provide
/// a larger `gasLimit`. Users need also to pay the cross domain relay fee again.
///
/// The messages sent through this contract may possibly be skipped in layer 2 due to circuit capacity overflow.
/// In such case, users can initiate `dropMessage` to claim refunds. But the cross domain relay fee won't be refunded.
contract L1ScrollMessenger is ScrollMessengerBase, IL1ScrollMessenger {
/*************
* Constants *
Expand Down

0 comments on commit 1c80060

Please sign in to comment.