diff --git a/README.md b/README.md index 28a80a1..b1c7e71 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Optimism-Compatible Token -ERC-20 token with extra features, capable of being bridged to an +EVM-compatible ERC-20 token with extra features, capable of being bridged to an Optimism-compatible L2. Built for Base blockchain and the 10Grans token, -specifically but general. +but general enough to be reused. ```shell npx hardhat compile diff --git a/contracts/L2Token.sol b/contracts/L2Token.sol index 2d5d44c..3632bda 100644 --- a/contracts/L2Token.sol +++ b/contracts/L2Token.sol @@ -43,6 +43,7 @@ contract L2Token is AbstractToken, IOptimismMintableERC20 { /// @notice Allows the StandardBridge on this network to mint tokens. /// @param _to Address to mint tokens to. /// @param _amount Amount of tokens to mint. + // ONLY bridge is allowed to mint, for security reasons. function mint( address _to, uint256 _amount @@ -59,6 +60,7 @@ contract L2Token is AbstractToken, IOptimismMintableERC20 { /// @notice Allows the StandardBridge on this network to burn tokens. /// @param _from Address to burn tokens from. /// @param _amount Amount of tokens to burn. + // ONLY bridge is allowed to burn, for security reasons. function burn( address _from, uint256 _amount @@ -100,12 +102,14 @@ contract L2Token is AbstractToken, IOptimismMintableERC20 { /// @custom:legacy /// @notice Legacy getter for the remote token. Use REMOTE_TOKEN going forward. + // Turns out Base blockchain needed this. function l1Token() public virtual view returns (address) { return REMOTE_TOKEN; } /// @custom:legacy /// @notice Legacy getter for the bridge. Use BRIDGE going forward. + // Turns out Base blockchain needed this. function l2Bridge() public virtual view returns (address) { return BRIDGE; }