portal: better comment

ethereum-optimism · May 2, 2024 · e532b85 · e532b85
1 parent 4f05c00
commit e532b85
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/packages/contracts-bedrock/semver-lock.json b/packages/contracts-bedrock/semver-lock.json
@@ -33,7 +33,7 @@
   },
   "src/L1/OptimismPortal.sol": {
     "initCodeHash": "0x8ca0ac98c37ad221d679c744b295b1b38742bfebac050f789197d658951709f5",
-    "sourceCodeHash": "0xecaabf75adc0351dfc79139664ac54731a4ec6cfda9c1c50e58105ee1d4d157e"
+    "sourceCodeHash": "0x8e9221539290a9b3cfb933d30ab77b137e2a76a1481671e41469ed1014ffbdc4"
   },
   "src/L1/OptimismPortal2.sol": {
     "initCodeHash": "0xea32d79e8297956d4f9a4c7985bb53ff8bb3735e5b307d4e118fea71f503a38e",

diff --git a/packages/contracts-bedrock/src/L1/OptimismPortal.sol b/packages/contracts-bedrock/src/L1/OptimismPortal.sol
@@ -428,6 +428,9 @@ contract OptimismPortal is Initializable, ResourceMetering, ISemver {
     }
 
     /// @notice Entrypoint to depositing an ERC20 token as a custom gas token.
+    ///         This function depends on a well formed ERC20 token. There are only
+    ///         so many checks that can be done on chain for this so it is assumed
+    ///         that chain operators will deploy chains with well formed ERC20 tokens.
     /// @param _to         Target address on L2.
     /// @param _mint       Units of ERC20 token to deposit into L2.
     /// @param _value      Units of ERC20 token to send on L2 to the recipient.