feat: Add decimals to tokenFactory

packages/contracts-bedrock/.gas-snapshot

@@ -17,7 +17,7 @@ AttestationStationTest:test_attest_bulk_succeeds() (gas: 703749)
 AttestationStationTest:test_attest_individual_succeeds() (gas: 632087)
 AttestationStationTest:test_attest_single_succeeds() (gas: 651325)
 BlockOracle_Test:test_checkpointAndLoad_succeeds() (gas: 58341)
-BlockOracle_Test:test_load_noBlockHash_reverts() (gas: 12805)
+BlockOracle_Test:test_load_noBlockHash_reverts() (gas: 13659)
 Bytes_slice_Test:test_slice_acrossMultipleWords_works() (gas: 9413)
 Bytes_slice_Test:test_slice_acrossWords_works() (gas: 1430)
 Bytes_slice_Test:test_slice_fromNonZeroIdx_works() (gas: 17240)
@@ -174,7 +174,7 @@ L1CrossDomainMessenger_Test:test_relayMessage_v2_reverts() (gas: 12343)
 L1CrossDomainMessenger_Test:test_replayMessage_withValue_reverts() (gas: 33133)
 L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 392933)
 L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1669172)
-L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 86992)
+L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 87853)
 L1CrossDomainMessenger_Test:test_xDomainSender_notSet_reverts() (gas: 24253)
 L1ERC721Bridge_Test:test_bridgeERC721To_localTokenZeroAddress_reverts() (gas: 62677)
 L1ERC721Bridge_Test:test_bridgeERC721To_remoteTokenZeroAddress_reverts() (gas: 37273)
@@ -218,7 +218,7 @@ L2CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 3
 L2CrossDomainMessenger_Test:test_relayMessage_v2_reverts() (gas: 11689)
 L2CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 123957)
 L2CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 135812)
-L2CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 48371)
+L2CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 49230)
 L2CrossDomainMessenger_Test:test_xDomainSender_senderNotSet_reverts() (gas: 10590)
 L2ERC721Bridge_Test:test_bridgeERC721To_localTokenZeroAddress_reverts() (gas: 31428)
 L2ERC721Bridge_Test:test_bridgeERC721To_remoteTokenZeroAddress_reverts() (gas: 26826)
@@ -251,12 +251,12 @@ L2OutputOracle_deleteOutputs_Test:test_deleteL2Outputs_ifNotChallenger_reverts()
 L2OutputOracle_deleteOutputs_Test:test_deleteL2Outputs_nonExistent_reverts() (gas: 111651)
 L2OutputOracle_deleteOutputs_Test:test_deleteOutputs_multipleOutputs_succeeds() (gas: 307411)
 L2OutputOracle_deleteOutputs_Test:test_deleteOutputs_singleOutput_succeeds() (gas: 185564)
-L2OutputOracle_getter_Test:test_computeL2Timestamp_succeeds() (gas: 37341)
+L2OutputOracle_getter_Test:test_computeL2Timestamp_succeeds() (gas: 38198)
 L2OutputOracle_getter_Test:test_getL2OutputIndexAfter_multipleOutputsExist_succeeds() (gas: 269700)
 L2OutputOracle_getter_Test:test_getL2OutputIndexAfter_noOutputsExis_reverts() (gas: 17892)
 L2OutputOracle_getter_Test:test_getL2OutputIndexAfter_previousBlock_succeeds() (gas: 98188)
 L2OutputOracle_getter_Test:test_getL2OutputIndexAfter_sameBlock_succeeds() (gas: 98096)
-L2OutputOracle_getter_Test:test_getL2Output_succeeds() (gas: 103735)
+L2OutputOracle_getter_Test:test_getL2Output_succeeds() (gas: 104600)
 L2OutputOracle_getter_Test:test_latestBlockNumber_succeeds() (gas: 99129)
 L2OutputOracle_getter_Test:test_nextBlockNumber_succeeds() (gas: 17447)
 L2OutputOracle_proposeL2Output_Test:test_proposeL2Output_emptyOutput_reverts() (gas: 28812)
@@ -292,7 +292,7 @@ LegacyERC20ETH_Test:test_burn_doesNotExist_reverts() (gas: 10637)
 LegacyERC20ETH_Test:test_crossDomain_succeeds() (gas: 6341)
 LegacyERC20ETH_Test:test_decreaseAllowance_doesNotExist_reverts() (gas: 10724)
 LegacyERC20ETH_Test:test_increaseAllowance_doesNotExist_reverts() (gas: 10690)
-LegacyERC20ETH_Test:test_metadata_succeeds() (gas: 15470)
+LegacyERC20ETH_Test:test_metadata_succeeds() (gas: 15476)
 LegacyERC20ETH_Test:test_mint_doesNotExist_reverts() (gas: 10627)
 LegacyERC20ETH_Test:test_transferFrom_doesNotExist_reverts() (gas: 12957)
 LegacyERC20ETH_Test:test_transfer_doesNotExist_reverts() (gas: 10755)
@@ -426,9 +426,10 @@ OptimismMintableERC721_Test:test_safeMint_succeeds() (gas: 140547)
 OptimismMintableERC721_Test:test_supportsInterfaces_succeeds() (gas: 9005)
 OptimismMintableERC721_Test:test_tokenURI_succeeds() (gas: 163441)
 OptimismMintableTokenFactory_Test:test_bridge_succeeds() (gas: 9760)
-OptimismMintableTokenFactory_Test:test_createStandardL2Token_remoteIsZero_reverts() (gas: 9471)
-OptimismMintableTokenFactory_Test:test_createStandardL2Token_sameTwice_reverts() (gas: 8937393460516769105)
-OptimismMintableTokenFactory_Test:test_createStandardL2Token_succeeds() (gas: 1295838)
+OptimismMintableTokenFactory_Test:test_createStandardL2TokenWithDecimals_succeeds() (gas: 1304000)
+OptimismMintableTokenFactory_Test:test_createStandardL2Token_remoteIsZero_reverts() (gas: 9570)
+OptimismMintableTokenFactory_Test:test_createStandardL2Token_sameTwice_reverts() (gas: 8937393460516769330)
+OptimismMintableTokenFactory_Test:test_createStandardL2Token_succeeds() (gas: 1303990)
 OptimismPortalUpgradeable_Test:test_initialize_cannotInitImpl_reverts() (gas: 11178)
 OptimismPortalUpgradeable_Test:test_initialize_cannotInitProxy_reverts() (gas: 16111)
 OptimismPortalUpgradeable_Test:test_params_initValuesOnProxy_succeeds() (gas: 26781)
@@ -465,7 +466,7 @@ OptimismPortal_Test:test_depositTransaction_withEthValueAndContractContractCreat
 OptimismPortal_Test:test_depositTransaction_withEthValueAndEOAContractCreation_succeeds() (gas: 75929)
 OptimismPortal_Test:test_depositTransaction_withEthValueFromContract_succeeds() (gas: 83476)
 OptimismPortal_Test:test_depositTransaction_withEthValueFromEOA_succeeds() (gas: 84069)
-OptimismPortal_Test:test_isOutputFinalized_succeeds() (gas: 126749)
+OptimismPortal_Test:test_isOutputFinalized_succeeds() (gas: 127617)
 OptimismPortal_Test:test_minimumGasLimit_succeeds() (gas: 17430)
 OptimismPortal_Test:test_pause_onlyGuardian_reverts() (gas: 24487)
 OptimismPortal_Test:test_pause_succeeds() (gas: 27344)
@@ -525,7 +526,7 @@ PreimageOracle_Test:test_loadKeccak256PreimagePart_outOfBoundsOffset_reverts() (
 PreimageOracle_Test:test_loadKeccak256PreimagePart_succeeds() (gas: 76098)
 PreimageOracle_Test:test_loadLocalData_onePart_succeeds() (gas: 75840)
 PreimageOracle_Test:test_loadLocalData_outOfBoundsOffset_reverts() (gas: 8803)
-ProxyAdmin_Test:test_chugsplashChangeProxyAdmin_succeeds() (gas: 35586)
+ProxyAdmin_Test:test_chugsplashChangeProxyAdmin_succeeds() (gas: 36440)
 ProxyAdmin_Test:test_chugsplashGetProxyAdmin_succeeds() (gas: 15675)
 ProxyAdmin_Test:test_chugsplashGetProxyImplementation_succeeds() (gas: 51084)
 ProxyAdmin_Test:test_chugsplashUpgradeAndCall_succeeds() (gas: 82311)
@@ -535,7 +536,7 @@ ProxyAdmin_Test:test_delegateResolvedGetProxyAdmin_succeeds() (gas: 17691)
 ProxyAdmin_Test:test_delegateResolvedGetProxyImplementation_succeeds() (gas: 62028)
 ProxyAdmin_Test:test_delegateResolvedUpgradeAndCall_succeeds() (gas: 98039)
 ProxyAdmin_Test:test_delegateResolvedUpgrade_succeeds() (gas: 58482)
-ProxyAdmin_Test:test_erc1967ChangeProxyAdmin_succeeds() (gas: 33820)
+ProxyAdmin_Test:test_erc1967ChangeProxyAdmin_succeeds() (gas: 34674)
 ProxyAdmin_Test:test_erc1967GetProxyAdmin_succeeds() (gas: 15616)
 ProxyAdmin_Test:test_erc1967GetProxyImplementation_succeeds() (gas: 52073)
 ProxyAdmin_Test:test_erc1967UpgradeAndCall_succeeds() (gas: 78971)
@@ -553,9 +554,9 @@ Proxy_Test:test_implementationKey_succeeds() (gas: 20911)
 Proxy_Test:test_implementation_isZeroAddress_reverts() (gas: 47628)
 Proxy_Test:test_implementation_zeroAddressCaller_succeeds() (gas: 14752)
 Proxy_Test:test_ownerKey_succeeds() (gas: 19067)
-Proxy_Test:test_ownerProxyCall_notAdmin_succeeds() (gas: 34623)
+Proxy_Test:test_ownerProxyCall_notAdmin_succeeds() (gas: 35477)
 Proxy_Test:test_proxyCallToImp_notAdmin_succeeds() (gas: 30010)
-Proxy_Test:test_upgradeToAndCall_functionDoesNotExist_reverts() (gas: 104567)
+Proxy_Test:test_upgradeToAndCall_functionDoesNotExist_reverts() (gas: 107980)
 Proxy_Test:test_upgradeToAndCall_isPayable_succeeds() (gas: 53744)
 Proxy_Test:test_upgradeToAndCall_succeeds() (gas: 125192)
 Proxy_Test:test_upgradeTo_clashingFunctionSignatures_succeeds() (gas: 101363)
@@ -648,8 +649,8 @@ StandardBridge_Stateless_Test:test_isOptimismMintableERC20_succeeds() (gas: 3307
 SystemConfig_Initialize_Test:test_initialize_events_succeeds() (gas: 71945)
 SystemConfig_Initialize_Test:test_initialize_startBlockOverride_succeeds() (gas: 65127)
 SystemConfig_Initialize_Test:test_initialize_values_succeeds() (gas: 64946)
-SystemConfig_Initialize_TestFail:test_initialize_lowGasLimit_reverts() (gas: 55589)
-SystemConfig_Initialize_TestFail:test_initialize_startBlock_reverts() (gas: 78208)
+SystemConfig_Initialize_TestFail:test_initialize_lowGasLimit_reverts() (gas: 57177)
+SystemConfig_Initialize_TestFail:test_initialize_startBlock_reverts() (gas: 79794)
 SystemConfig_Setters_TestFail:test_setBatcherHash_notOwner_reverts() (gas: 15607)
 SystemConfig_Setters_TestFail:test_setGasConfig_notOwner_reverts() (gas: 15577)
 SystemConfig_Setters_TestFail:test_setGasLimit_notOwner_reverts() (gas: 15676)
@@ -660,9 +661,9 @@ SystemConfig_Setters_TestFail:test_setResourceConfig_notOwner_reverts() (gas: 16
 SystemConfig_Setters_TestFail:test_setResourceConfig_zeroDenominator_reverts() (gas: 18578)
 SystemConfig_Setters_TestFail:test_setUnsafeBlockSigner_notOwner_reverts() (gas: 15590)
 TransactorTest:test_call_succeeds() (gas: 26709)
-TransactorTest:test_call_unauthorized_reverts() (gas: 16543)
+TransactorTest:test_call_unauthorized_reverts() (gas: 18117)
 TransactorTest:test_constructor_succeeds() (gas: 9739)
 TransactorTest:test_delegateCall_succeeds() (gas: 20909)
-TransactorTest:test_delegateCall_unauthorized_reverts() (gas: 16550)
+TransactorTest:test_delegateCall_unauthorized_reverts() (gas: 18124)
 TransferOnionTest:test_constructor_succeeds() (gas: 564855)
 TransferOnionTest:test_unwrap_succeeds() (gas: 724955)
\ No newline at end of file

packages/contracts-bedrock/semver-lock.json

@@ -24,8 +24,8 @@
   "src/periphery/op-nft/Optimist.sol": "0x38407f766aa9d394403e9da388dd0265b48901789f3e8a28af50014f9f5251d9",
   "src/periphery/op-nft/OptimistAllowlist.sol": "0x53e9a9dfecbae036fd468e8f34c80c7d9c35bd8908c8a6483db44dbc5128ad69",
   "src/periphery/op-nft/OptimistInviter.sol": "0xfdd5b9d45205ef9372ba37f7a6394724695e676d27a47cb154ee6e4148490013",
-  "src/universal/OptimismMintableERC20.sol": "0xa0b4f168802d0f9eca9ddc54347ca66c34ad7aa0fd84b01e0d7e99a9f86f46d6",
-  "src/universal/OptimismMintableERC20Factory.sol": "0xf4beb7fed4defc3e70b2298831bf0024cceaa8f1cf55fd98c00f5998b8ab5589",
+  "src/universal/OptimismMintableERC20.sol": "0x17fe6e955dc7e9e480e57bc62c227206838b204dcb660b8cb8f6f217319a22ba",
+  "src/universal/OptimismMintableERC20Factory.sol": "0xa8b1781116fd296a2630b94e4e18724b64094a70e2e716cb4c5bf5a8dbe32889",
   "src/universal/OptimismMintableERC721.sol": "0x49dc863caf3e002bf0c90b3af3873990fb282771f4c63735fd61a885b7873983",
   "src/universal/OptimismMintableERC721Factory.sol": "0x502438b009bfaf0ab187914662468261f10446fd85d44a79b29cdaef7b4982ba"
 }
\ No newline at end of file

packages/contracts-bedrock/src/legacy/LegacyERC20ETH.sol

@@ -14,7 +14,7 @@ import { OptimismMintableERC20 } from "../universal/OptimismMintableERC20.sol";
 ///         disabled as part of the EVM equivalence upgrade.
 contract LegacyERC20ETH is OptimismMintableERC20 {
     /// @notice Initializes the contract as an Optimism Mintable ERC20.
-    constructor() OptimismMintableERC20(Predeploys.L2_STANDARD_BRIDGE, address(0), "Ether", "ETH") { }
+    constructor() OptimismMintableERC20(Predeploys.L2_STANDARD_BRIDGE, address(0), "Ether", "ETH", 18) { }
 
     /// @notice Returns the ETH balance of the target account. Overrides the base behavior of the
     ///         contract to preserve the invariant that the balance within this contract always

packages/contracts-bedrock/src/universal/OptimismMintableERC20.sol

@@ -19,6 +19,9 @@ contract OptimismMintableERC20 is IOptimismMintableERC20, ILegacyMintableERC20,
     /// @notice Address of the StandardBridge on this network.
     address public immutable BRIDGE;
 
+    /// @notice Decimals of the token
+    uint8 private immutable DECIMALS;
+
     /// @notice Emitted whenever tokens are minted for an account.
     /// @param account Address of the account tokens are being minted for.
     /// @param amount  Amount of tokens minted.
@@ -35,7 +38,7 @@ contract OptimismMintableERC20 is IOptimismMintableERC20, ILegacyMintableERC20,
         _;
     }
 
-    /// @custom:semver 1.1.0
+    /// @custom:semver 1.2.0
     /// @param _bridge      Address of the L2 standard bridge.
     /// @param _remoteToken Address of the corresponding L1 token.
     /// @param _name        ERC20 name.
@@ -44,13 +47,15 @@ contract OptimismMintableERC20 is IOptimismMintableERC20, ILegacyMintableERC20,
         address _bridge,
         address _remoteToken,
         string memory _name,
-        string memory _symbol
+        string memory _symbol,
+        uint8 _decimals
     )
         ERC20(_name, _symbol)
-        Semver(1, 1, 0)
+        Semver(1, 2, 0)
     {
         REMOTE_TOKEN = _remoteToken;
         BRIDGE = _bridge;
+        DECIMALS = _decimals;
     }
 
     /// @notice Allows the StandardBridge on this network to mint tokens.
@@ -120,4 +125,14 @@ contract OptimismMintableERC20 is IOptimismMintableERC20, ILegacyMintableERC20,
     function bridge() public view returns (address) {
         return BRIDGE;
     }
+
+    /// @dev Returns the number of decimals used to get its user representation.
+    /// For example, if `decimals` equals `2`, a balance of `505` tokens should
+    /// be displayed to a user as `5.05` (`505 / 10 ** 2`).
+    /// NOTE: This information is only used for _display_ purposes: it in
+    /// no way affects any of the arithmetic of the contract, including
+    /// {IERC20-balanceOf} and {IERC20-transfer}.
+    function decimals() public view override returns (uint8) {
+        return DECIMALS;
+    }
 }

packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol

@@ -30,11 +30,11 @@ contract OptimismMintableERC20Factory is Semver, Initializable {
     /// @param deployer    Address of the account that deployed the token.
     event OptimismMintableERC20Created(address indexed localToken, address indexed remoteToken, address deployer);
 
-    /// @custom:semver 1.3.0
+    /// @custom:semver 1.4.0
     /// @notice The semver MUST be bumped any time that there is a change in
     ///         the OptimismMintableERC20 token contract since this contract
     ///         is responsible for deploying OptimismMintableERC20 contracts.
-    constructor() Semver(1, 3, 0) {
+    constructor() Semver(1, 4, 0) {
         initialize({ _bridge: address(0) });
     }
 
@@ -81,11 +81,30 @@ contract OptimismMintableERC20Factory is Semver, Initializable {
     )
         public
         returns (address)
+    {
+        return createOptimismMintableERC20WithDecimals(_remoteToken, _name, _symbol, 18);
+    }
+
+    /// @notice Creates an instance of the OptimismMintableERC20 contract, with specified decimals.
+    /// @param _remoteToken Address of the token on the remote chain.
+    /// @param _name        ERC20 name.
+    /// @param _symbol      ERC20 symbol.
+    /// @param _decimals    ERC20 decimals
+    /// @return Address of the newly created token.
+    function createOptimismMintableERC20WithDecimals(
+        address _remoteToken,
+        string memory _name,
+        string memory _symbol,
+        uint8 _decimals
+    )
+        public
+        returns (address)
     {
         require(_remoteToken != address(0), "OptimismMintableERC20Factory: must provide remote token address");
 
         bytes32 salt = keccak256(abi.encode(_remoteToken, _name, _symbol));
-        address localToken = address(new OptimismMintableERC20{salt: salt}(bridge, _remoteToken, _name, _symbol));
+        address localToken =
+            address(new OptimismMintableERC20{salt: salt}(bridge, _remoteToken, _name, _symbol, _decimals));
 
         // Emit the old event too for legacy support.
         emit StandardL2TokenCreated(_remoteToken, localToken);

packages/contracts-bedrock/test/OptimismMintableERC20Factory.t.sol

@@ -18,7 +18,9 @@ contract OptimismMintableTokenFactory_Test is Bridge_Initializer {
 
     function test_createStandardL2Token_succeeds() external {
         address remote = address(4);
-        address local = calculateTokenAddress(remote, "Beep", "BOOP");
+
+        // Defaults to 18 decimals
+        address local = calculateTokenAddress(remote, "Beep", "BOOP", 18);
 
         vm.expectEmit(true, true, true, true);
         emit StandardL2TokenCreated(remote, local);
@@ -27,7 +29,26 @@ contract OptimismMintableTokenFactory_Test is Bridge_Initializer {
         emit OptimismMintableERC20Created(local, remote, alice);
 
         vm.prank(alice);
-        L2TokenFactory.createStandardL2Token(remote, "Beep", "BOOP");
+        address addr = L2TokenFactory.createStandardL2Token(remote, "Beep", "BOOP");
+        assertTrue(addr == local);
+        assertTrue(OptimismMintableERC20(local).decimals() == 18);
+    }
+
+    function test_createStandardL2TokenWithDecimals_succeeds() external {
+        address remote = address(4);
+        address local = calculateTokenAddress(remote, "Beep", "BOOP", 6);
+
+        vm.expectEmit(true, true, true, true);
+        emit StandardL2TokenCreated(remote, local);
+
+        vm.expectEmit(true, true, true, true);
+        emit OptimismMintableERC20Created(local, remote, alice);
+
+        vm.prank(alice);
+        address addr = L2TokenFactory.createOptimismMintableERC20WithDecimals(remote, "Beep", "BOOP", 6);
+        assertTrue(addr == local);
+
+        assertTrue(OptimismMintableERC20(local).decimals() == 6);
     }
 
     function test_createStandardL2Token_sameTwice_reverts() external {
@@ -51,13 +72,14 @@ contract OptimismMintableTokenFactory_Test is Bridge_Initializer {
     function calculateTokenAddress(
         address _remote,
         string memory _name,
-        string memory _symbol
+        string memory _symbol,
+        uint8 _decimals
     )
         internal
         view
         returns (address)
     {
-        bytes memory constructorArgs = abi.encode(address(L2Bridge), _remote, _name, _symbol);
+        bytes memory constructorArgs = abi.encode(address(L2Bridge), _remote, _name, _symbol, _decimals);
         bytes memory bytecode = abi.encodePacked(type(OptimismMintableERC20).creationCode, constructorArgs);
         bytes32 salt = keccak256(abi.encode(_remote, _name, _symbol));
         bytes32 hash = keccak256(abi.encodePacked(bytes1(0xff), address(L2TokenFactory), salt, keccak256(bytecode)));

packages/contracts-bedrock/test/StandardBridge.t.sol

@@ -74,7 +74,8 @@ contract StandardBridge_Stateless_Test is CommonTest {
             _bridge: address(0),
             _remoteToken: address(0),
             _name: "Stonks",
-            _symbol: "STONK"
+            _symbol: "STONK",
+            _decimals: 18
         });
 
         erc20 = new ERC20("Altcoin", "ALT");