fix outboundTransferCustomRefund comment; sender, not _to, is callVal…

…ueRefundAddress
OffchainLabs · Feb 5, 2024 · 32f7a70 · 32f7a70
1 parent cb9bca7
commit 32f7a70
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/contracts/tokenbridge/ethereum/gateway/L1ArbitrumGateway.sol b/contracts/tokenbridge/ethereum/gateway/L1ArbitrumGateway.sol
@@ -224,10 +224,12 @@ abstract contract L1ArbitrumGateway is
      *      - a contract in construction
      *      - an address where a contract will be created
      *      - an address where a contract lived, but was destroyed
+     *    The msg.sender that calls this methid, or its L2 alias if it has code in L1, will be set to the callValueRefundAddress;
+     *    this means it can cancel the retryable ticket if its auto-redeem fails, and also that it receives the l2 callvalue refund 
+     *    (although note that for this method there is no l2 callvalue).
      * @param _l1Token L1 address of ERC20
      * @param _refundTo Account, or its L2 alias if it have code in L1, to be credited with excess gas refund in L2
-     * @param _to Account to be credited with the tokens in the L2 (can be the user's L2 account or a contract), not subject to L2 aliasing
-                  This account, or its L2 alias if it have code in L1, will also be able to cancel the retryable ticket and receive callvalue refund
+     * @param _to Account to be credited with the tokens in the L2 (can be an EOA or a contract), not subject to L2 aliasing
      * @param _amount Token Amount
      * @param _maxGas Max gas deducted from user's L2 balance to cover L2 execution
      * @param _gasPriceBid Gas price for L2 execution

diff --git a/contracts/tokenbridge/ethereum/gateway/L1GatewayRouter.sol b/contracts/tokenbridge/ethereum/gateway/L1GatewayRouter.sol
@@ -294,10 +294,12 @@ contract L1GatewayRouter is
      *      - a contract in construction
      *      - an address where a contract will be created
      *      - an address where a contract lived, but was destroyed
+     *    The msg.sender that calls this methid, or its L2 alias if it has code in L1, will be set to the callValueRefundAddress;
+     *    this means it can cancel the retryable ticket if its auto-redeem fails, and also that it receives the l2 callvalue refund 
+     *    (although note that for this method there is no l2 callvalue).
      * @param _token L1 address of ERC20
      * @param _refundTo Account, or its L2 alias if it have code in L1, to be credited with excess gas refund in L2
-     * @param _to Account to be credited with the tokens in the L2 (can be the user's L2 account or a contract), not subject to L2 aliasing
-                  This account, or its L2 alias if it have code in L1, will also be able to cancel the retryable ticket and receive callvalue refund
+     * @param _to Account to be credited with the tokens in the L2 (can be an EOA or a contract), not subject to L2 aliasing.
      * @param _amount Token Amount
      * @param _maxGas Max gas deducted from user's L2 balance to cover L2 execution
      * @param _gasPriceBid Gas price for L2 execution