Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updated comments errors #50

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/L1/gateways/L1ERC1155Gateway.sol
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ contract L1ERC1155Gateway is ERC1155HolderUpgradeable, ScrollGatewayBase, IL1ERC
* Restricted Functions *
************************/

/// @notice Update layer 2 to layer 2 token mapping.
/// @notice Update layer 1 to layer 2 token mapping.
/// @param _l1Token The address of ERC1155 token on layer 1.
/// @param _l2Token The address of corresponding ERC1155 token on layer 2.
function updateTokenMapping(address _l1Token, address _l2Token) external onlyOwner {
Expand Down
2 changes: 1 addition & 1 deletion src/L1/gateways/L1ERC721Gateway.sol
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ contract L1ERC721Gateway is ERC721HolderUpgradeable, ScrollGatewayBase, IL1ERC72
* Restricted Functions *
************************/

/// @notice Update layer 2 to layer 2 token mapping.
/// @notice Update layer 1 to layer 2 token mapping.
/// @param _l1Token The address of ERC721 token on layer 1.
/// @param _l2Token The address of corresponding ERC721 token on layer 2.
function updateTokenMapping(address _l1Token, address _l2Token) external onlyOwner {
Expand Down
2 changes: 1 addition & 1 deletion src/L1/gateways/L1GatewayRouter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ contract L1GatewayRouter is OwnableUpgradeable, IL1GatewayRouter {
/// @notice The address of L1ETHGateway.
address public ethGateway;

/// @notice The addess of default ERC20 gateway, normally the L1StandardERC20Gateway contract.
/// @notice The address of default ERC20 gateway, normally the L1StandardERC20Gateway contract.
address public defaultERC20Gateway;

/// @notice Mapping from ERC20 token address to corresponding L1ERC20Gateway.
Expand Down
2 changes: 1 addition & 1 deletion src/L1/gateways/L1StandardERC20Gateway.sol
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ contract L1StandardERC20Gateway is L1ERC20Gateway {

/// @inheritdoc IL1ERC20Gateway
function getL2ERC20Address(address _l1Token) public view override returns (address) {
// In StandardERC20Gateway, all corresponding l2 tokens are depoyed by Create2 with salt,
// In StandardERC20Gateway, all corresponding l2 tokens are deployed by Create2 with salt,
// we can calculate the l2 address directly.
bytes32 _salt = keccak256(abi.encodePacked(counterpart, keccak256(abi.encodePacked(_l1Token))));

Expand Down
2 changes: 1 addition & 1 deletion src/L1/gateways/L1WETHGateway.sol
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ contract L1WETHGateway is L1ERC20Gateway {
///
/// @dev The parameters `_counterpart`, `_router` and `_messenger` are no longer used.
///
/// @param _counterpart The address of L2ETHGateway in L2.
/// @param _counterpart The address of L2WETHGateway in L2.
/// @param _router The address of L1GatewayRouter in L1.
/// @param _messenger The address of L1ScrollMessenger in L1.
function initialize(
Expand Down
2 changes: 1 addition & 1 deletion src/L2/L2ScrollMessenger.sol
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {ScrollMessengerBase} from "../libraries/ScrollMessengerBase.sol";
/// @notice The `L2ScrollMessenger` contract can:
///
/// 1. send messages from layer 2 to layer 1;
/// 2. relay messages from layer 1 layer 2;
/// 2. relay messages from layer 1 to layer 2;
/// 3. drop expired message due to sequencer problems.
///
/// @dev It should be a predeployed contract on layer 2 and should hold infinite amount
Expand Down
2 changes: 1 addition & 1 deletion src/L2/gateways/L2GatewayRouter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ contract L2GatewayRouter is OwnableUpgradeable, IL2GatewayRouter {
/// @notice The address of L2ETHGateway.
address public ethGateway;

/// @notice The addess of default L2 ERC20 gateway, normally the L2StandardERC20Gateway contract.
/// @notice The address of default L2 ERC20 gateway, normally the L2StandardERC20Gateway contract.
address public defaultERC20Gateway;

/// @notice Mapping from L2 ERC20 token address to corresponding L2ERC20Gateway.
Expand Down
2 changes: 1 addition & 1 deletion src/L2/gateways/L2ReverseCustomERC20Gateway.sol
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {L2CustomERC20Gateway} from "./L2CustomERC20Gateway.sol";
/// @title L2ReverseCustomERC20Gateway
/// @notice The `L2ReverseCustomERC20Gateway` is used to withdraw native ERC20 tokens on layer 2 and
/// finalize deposit the tokens from layer 1.
/// @dev The withdrawn ERC20 tokens are holed in this contract. On finalizing deposit, the corresponding
/// @dev The withdrawn ERC20 tokens are held in this contract. On finalizing deposit, the corresponding
/// token will be transferred to the recipient.
contract L2ReverseCustomERC20Gateway is L2CustomERC20Gateway {
using SafeERC20Upgradeable for IERC20Upgradeable;
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/gateway/CCTPGatewayBase.sol
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ abstract contract CCTPGatewayBase is ScrollGatewayBase {
* Constants *
*************/

/// @notice The address of L1 USDC address.
/// @notice The address of L1 USDC.
address public immutable l1USDC;

/// @notice The address of L2 USDC address.
/// @notice The address of L2 USDC.
address public immutable l2USDC;

/// @notice The destination domain for layer2.
Expand Down