From 1c80060753fd669a0debaea5e8be83cd9009d191 Mon Sep 17 00:00:00 2001 From: zimpha Date: Tue, 30 Jul 2024 16:55:03 +0800 Subject: [PATCH] feat: add comments about replayMessage and dropMessage --- src/L1/L1ScrollMessenger.sol | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/L1/L1ScrollMessenger.sol b/src/L1/L1ScrollMessenger.sol index 544beb2..c70719f 100644 --- a/src/L1/L1ScrollMessenger.sol +++ b/src/L1/L1ScrollMessenger.sol @@ -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 *