Merge branch 'develop' into ci/linting-in-makefile

indexer/README.md

@@ -2,6 +2,15 @@
 
 ## Getting started
 
+
+### Setup env
+The `indexer.toml` stores a set of preset environmental variables that can be used to run the indexer with the exception of the network specific `l1-rpc` and `l2-rpc` variables. The `indexer.toml` file can be ran as a default config, otherwise a custom `.toml` config can provided via the `--config` flag when running the application. Additionally, L1 system contract addresses must provided for the specific OP Stack network actively being indexed. Currently the indexer has no way to infer L1 system config addresses provided a L2 chain ID or network enum.
+
+### Testing
+All tests can be ran by running `make test` from the `/indexer` directory.  This will run all unit and e2e tests.
+
+**NOTE:** Successfully running the E2E tests requires spinning up a local L1 geth node and pre-populating it with necessary bedrock genesis state.  This can be done by calling `make devnet-allocs` from the root of the optimism monorepo before running the indexer tests. More information on this can be found in the [op-e2e README](../op-e2e/README.md).
+
 ### Run indexer vs goerli
 
 - install docker

indexer/config/config.go

@@ -24,11 +24,11 @@ type Config struct {
 
 // fetch this via onchain config from RPCsConfig and remove from config in future
 type L1Contracts struct {
-	OptimismPortal         common.Address
-	L2OutputOracle         common.Address
-	L1CrossDomainMessenger common.Address
-	L1StandardBridge       common.Address
-	L1ERC721Bridge         common.Address
+	OptimismPortal         common.Address `toml:"optimism-portal"`
+	L2OutputOracle         common.Address `toml:"l2-output-oracle"`
+	L1CrossDomainMessenger common.Address `toml:"l1-cross-domain-messenger"`
+	L1StandardBridge       common.Address `toml:"l1-standard-bridge"`
+	L1ERC721Bridge         common.Address `toml:"l1-erc721-bridge"`
 
 	// Some more contracts -- ProxyAdmin, SystemConfig, etcc
 	// Ignore the auxiliary contracts?
@@ -52,9 +52,12 @@ func (c L1Contracts) ToSlice() []common.Address {
 // ChainConfig configures of the chain being indexed
 type ChainConfig struct {
 	// Configure known chains with the l2 chain id
-	Preset int
-	// Configure custom chains via providing the L1Contract addresses
-	L1Contracts L1Contracts
+	// NOTE - This currently performs no lookups to extract known L1 contracts by l2 chain id
+	Preset      int
+	L1Contracts L1Contracts `toml:"l1-contracts"`
+	// L1StartingHeight is the block height to start indexing from
+	// NOTE - This is currently unimplemented
+	L1StartingHeight int
 }
 
 // RPCsConfig configures the RPC urls

indexer/config/config_test.go

@@ -80,7 +80,12 @@ func TestLoadConfig_WithoutPreset(t *testing.T) {
 
 	testData := `
         [chain]
-        l1contracts = { OptimismPortal = "0x4205Fc579115071764c7423A4f12eDde41f106Ed", L2OutputOracle = "0x42097868233d1aa22e815a266982f2cf17685a27", L1CrossDomainMessenger = "0x420ce71c97B33Cc4729CF772ae268934F7ab5fA1", L1StandardBridge = "0x4209fc46f92E8a1c0deC1b1747d010903E884bE1", L1ERC721Bridge ="0x420749f83b81B301cAb5f48EB8516B986DAef23D" }
+		[chain.l1-contracts]
+		optimism-portal = "0x4205Fc579115071764c7423A4f12eDde41f106Ed"
+		l2-output-oracle = "0x42097868233d1aa22e815a266982f2cf17685a27"
+		l1-cross-domain-messenger = "0x420ce71c97B33Cc4729CF772ae268934F7ab5fA1"
+		l1-standard-bridge = "0x4209fc46f92E8a1c0deC1b1747d010903E884bE1"
+		l1-erc721-bridge = "0x420749f83b81B301cAb5f48EB8516B986DAef23D"
 
         [rpcs]
         l1-rpc = "https://l1.example.com"

indexer/indexer.toml

@@ -3,6 +3,7 @@
 [chain]
 # OP Goerli
 preset = 420
+
 [rpcs]
 l1-rpc = "${INDEXER_RPC_URL_L1}"
 l2-rpc = "${INDEXER_RPC_URL_L2}"

op-chain-ops/cmd/check-l2/main.go

@@ -543,15 +543,36 @@ func checkOptimismMintableERC20Factory(addr common.Address, client *ethclient.Cl
 		return err
 	}
 
-	bridge, err := contract.BRIDGE(&bind.CallOpts{})
+	bridgeLegacy, err := contract.BRIDGE(&bind.CallOpts{})
 	if err != nil {
 		return err
 	}
-	log.Info("OptimismMintableERC20Factory", "BRIDGE", bridge.Hex())
-	if bridge == (common.Address{}) {
+	log.Info("OptimismMintableERC20Factory", "BRIDGE", bridgeLegacy.Hex())
+	if bridgeLegacy == (common.Address{}) {
 		return errors.New("OptimismMintableERC20Factory.BRIDGE is zero address")
 	}
 
+	bridge, err := contract.Bridge(&bind.CallOpts{})
+	if err != nil {
+		return err
+	}
+	if bridge == (common.Address{}) {
+		return errors.New("OptimismMintableERC20Factory.bridge is zero address")
+	}
+	log.Info("OptimismMintableERC20Factory", "bridge", bridge.Hex())
+
+	initialized, err := getInitialized("OptimismMintableERC20Factory", addr, client)
+	if err != nil {
+		return err
+	}
+	log.Info("OptimismMintableERC20Factory", "_initialized", initialized)
+
+	initializing, err := getInitializing("OptimismMintableERC20Factory", addr, client)
+	if err != nil {
+		return err
+	}
+	log.Info("OptimismMintableERC20Factory", "_initializing", initializing)
+
 	version, err := contract.Version(&bind.CallOpts{})
 	if err != nil {
 		return err

op-chain-ops/genesis/config.go

@@ -695,6 +695,11 @@ func NewL2StorageConfig(config *DeployConfig, block *types.Block) (state.Storage
 		"_initialized":  2,
 		"_initializing": false,
 	}
+	storage["OptimismMintableERC20Factory"] = state.StorageValues{
+		"bridge":        predeploys.L2StandardBridgeAddr,
+		"_initialized":  2,
+		"_initializing": false,
+	}
 	return storage, nil
 }
 

op-chain-ops/immutables/immutables.go

@@ -216,7 +216,7 @@ func l2Deployer(backend *backends.SimulatedBackend, opts *bind.TransactOpts, dep
 		}
 		_, tx, _, err = bindings.DeployL1FeeVault(opts, backend, recipient, minimumWithdrawalAmount, withdrawalNetwork)
 	case "OptimismMintableERC20Factory":
-		_, tx, _, err = bindings.DeployOptimismMintableERC20Factory(opts, backend, predeploys.L2StandardBridgeAddr)
+		_, tx, _, err = bindings.DeployOptimismMintableERC20Factory(opts, backend)
 	case "DeployerWhitelist":
 		_, tx, _, err = bindings.DeployDeployerWhitelist(opts, backend)
 	case "LegacyMessagePasser":

op-e2e/e2eutils/wait/waits.go

@@ -38,7 +38,8 @@ func ForReceipt(ctx context.Context, client *ethclient.Client, hash common.Hash,
 			return nil, fmt.Errorf("failed to get receipt: %w", err)
 		}
 		if receipt.Status != status {
-			return receipt, addDebugTrace(ctx, client, hash, fmt.Errorf("expected status %d, but got %d", status, receipt.Status))
+			printDebugTrace(ctx, client, hash)
+			return receipt, fmt.Errorf("expected status %d, but got %d", status, receipt.Status)
 		}
 		return receipt, nil
 	}
@@ -52,15 +53,16 @@ func (s *jsonRawString) UnmarshalJSON(input []byte) error {
 	return nil
 }
 
-// addDebugTrace adds debug_traceTransaction output to the original error to make debugging
-func addDebugTrace(ctx context.Context, client *ethclient.Client, txHash common.Hash, origErr error) error {
-	var result jsonRawString
+// printDebugTrace logs debug_traceTransaction output to aid in debugging unexpected receipt statuses
+func printDebugTrace(ctx context.Context, client *ethclient.Client, txHash common.Hash) {
+	var trace jsonRawString
 	options := map[string]string{}
-	err := client.Client().CallContext(ctx, &result, "debug_traceTransaction", hexutil.Bytes(txHash.Bytes()), options)
+	err := client.Client().CallContext(ctx, &trace, "debug_traceTransaction", hexutil.Bytes(txHash.Bytes()), options)
 	if err != nil {
-		return errors.Join(origErr, fmt.Errorf("tx trace unavailable: %w", err))
+		fmt.Printf("TxTrace unavailable: %v\n", err)
+		return
 	}
-	return fmt.Errorf("%w\nTxTrace: %v", origErr, result)
+	fmt.Printf("TxTrace: %v\n", trace)
 }
 
 func ForBlock(ctx context.Context, client *ethclient.Client, n uint64) error {

packages/contracts-bedrock/.gas-snapshot

@@ -423,10 +423,10 @@ OptimismMintableERC721_Test:test_safeMint_notBridge_reverts() (gas: 11121)
 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: 7646)
-OptimismMintableTokenFactory_Test:test_createStandardL2Token_remoteIsZero_reverts() (gas: 9401)
-OptimismMintableTokenFactory_Test:test_createStandardL2Token_sameTwice_reverts() (gas: 8937393460516769032)
-OptimismMintableTokenFactory_Test:test_createStandardL2Token_succeeds() (gas: 1293594)
+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)
 OptimismPortalUpgradeable_Test:test_initialize_cannotInitImpl_reverts() (gas: 11178)
 OptimismPortalUpgradeable_Test:test_initialize_cannotInitProxy_reverts() (gas: 16111)
 OptimismPortalUpgradeable_Test:test_params_initValuesOnProxy_succeeds() (gas: 26781)

packages/contracts-bedrock/.storage-layout

@@ -259,8 +259,11 @@
 ➡ src/universal/OptimismMintableERC20Factory.sol:OptimismMintableERC20Factory
 =======================
 
-| Name | Type | Slot | Offset | Bytes | Contract |
-|------|------|------|--------|-------|----------|
+| Name          | Type    | Slot | Offset | Bytes | Contract                                                                    |
+|---------------|---------|------|--------|-------|-----------------------------------------------------------------------------|
+| _initialized  | uint8   | 0    | 0      | 1     | src/universal/OptimismMintableERC20Factory.sol:OptimismMintableERC20Factory |
+| _initializing | bool    | 0    | 1      | 1     | src/universal/OptimismMintableERC20Factory.sol:OptimismMintableERC20Factory |
+| bridge        | address | 0    | 2      | 20    | src/universal/OptimismMintableERC20Factory.sol:OptimismMintableERC20Factory |
 
 =======================
 ➡ src/dispute/DisputeGameFactory.sol:DisputeGameFactory

packages/contracts-bedrock/scripts/Deploy.s.sol

@@ -345,10 +345,10 @@ contract Deploy is Deployer {
 
     /// @notice Deploy the OptimismMintableERC20Factory
     function deployOptimismMintableERC20Factory() public broadcast returns (address addr_) {
-        address l1StandardBridgeProxy = mustGetAddress("L1StandardBridgeProxy");
-        OptimismMintableERC20Factory factory = new OptimismMintableERC20Factory(l1StandardBridgeProxy);
+        OptimismMintableERC20Factory factory = new OptimismMintableERC20Factory();
 
-        require(factory.BRIDGE() == l1StandardBridgeProxy);
+        require(factory.BRIDGE() == address(0));
+        require(factory.bridge() == address(0));
 
         save("OptimismMintableERC20Factory", address(factory));
         console.log("OptimismMintableERC20Factory deployed at %s", address(factory));
@@ -613,9 +613,10 @@ contract Deploy is Deployer {
         address optimismMintableERC20Factory = mustGetAddress("OptimismMintableERC20Factory");
         address l1StandardBridgeProxy = mustGetAddress("L1StandardBridgeProxy");
 
-        proxyAdmin.upgrade({
+        proxyAdmin.upgradeAndCall({
             _proxy: payable(optimismMintableERC20FactoryProxy),
-            _implementation: optimismMintableERC20Factory
+            _implementation: optimismMintableERC20Factory,
+            _data: abi.encodeCall(OptimismMintableERC20Factory.initialize, (l1StandardBridgeProxy))
         });
 
         OptimismMintableERC20Factory factory = OptimismMintableERC20Factory(optimismMintableERC20FactoryProxy);
@@ -623,6 +624,7 @@ contract Deploy is Deployer {
         console.log("OptimismMintableERC20Factory version: %s", version);
 
         require(factory.BRIDGE() == l1StandardBridgeProxy);
+        require(factory.bridge() == l1StandardBridgeProxy);
     }
 
     /// @notice initializeL1CrossDomainMessenger

packages/contracts-bedrock/semver-lock.json

@@ -25,7 +25,7 @@
   "src/periphery/op-nft/OptimistAllowlist.sol": "0x53e9a9dfecbae036fd468e8f34c80c7d9c35bd8908c8a6483db44dbc5128ad69",
   "src/periphery/op-nft/OptimistInviter.sol": "0xfdd5b9d45205ef9372ba37f7a6394724695e676d27a47cb154ee6e4148490013",
   "src/universal/OptimismMintableERC20.sol": "0xa0b4f168802d0f9eca9ddc54347ca66c34ad7aa0fd84b01e0d7e99a9f86f46d6",
-  "src/universal/OptimismMintableERC20Factory.sol": "0x8afb6b634f40e8ac8c60ec7e2ca3bcd610b020d09b3cae70a3d4995722cab3ce",
+  "src/universal/OptimismMintableERC20Factory.sol": "0xf4beb7fed4defc3e70b2298831bf0024cceaa8f1cf55fd98c00f5998b8ab5589",
   "src/universal/OptimismMintableERC721.sol": "0x49dc863caf3e002bf0c90b3af3873990fb282771f4c63735fd61a885b7873983",
   "src/universal/OptimismMintableERC721Factory.sol": "0x502438b009bfaf0ab187914662468261f10446fd85d44a79b29cdaef7b4982ba"
 }
\ No newline at end of file

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

@@ -2,6 +2,7 @@
 pragma solidity 0.8.15;
 
 import { OptimismMintableERC20 } from "../universal/OptimismMintableERC20.sol";
+import { Initializable } from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import { Semver } from "./Semver.sol";
 
 /// @custom:proxied
@@ -11,9 +12,10 @@ import { Semver } from "./Semver.sol";
 ///         contracts on the network it's deployed to. Simplifies the deployment process for users
 ///         who may be less familiar with deploying smart contracts. Designed to be backwards
 ///         compatible with the older StandardL2ERC20Factory contract.
-contract OptimismMintableERC20Factory is Semver {
+contract OptimismMintableERC20Factory is Semver, Initializable {
     /// @notice Address of the StandardBridge on this chain.
-    address public immutable BRIDGE;
+    /// @custom:network-specific
+    address public bridge;
 
     /// @custom:legacy
     /// @notice Emitted whenever a new OptimismMintableERC20 is created. Legacy version of the newer
@@ -28,13 +30,25 @@ contract OptimismMintableERC20Factory is Semver {
     /// @param deployer    Address of the account that deployed the token.
     event OptimismMintableERC20Created(address indexed localToken, address indexed remoteToken, address deployer);
 
-    /// @custom:semver 1.2.0
+    /// @custom:semver 1.3.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) {
+        initialize({ _bridge: address(0) });
+    }
+
+    /// @notice Initializer.
     /// @param _bridge Address of the StandardBridge on this chain.
-    constructor(address _bridge) Semver(1, 2, 0) {
-        BRIDGE = _bridge;
+    function initialize(address _bridge) public reinitializer(2) {
+        bridge = _bridge;
+    }
+
+    /// @notice Returns the address of the StandardBridge on this chain.
+    ///         This is a legacy getter, use `bridge` instead.
+    /// @custom:legacy
+    function BRIDGE() external view returns (address) {
+        return bridge;
     }
 
     /// @custom:legacy
@@ -71,7 +85,7 @@ contract OptimismMintableERC20Factory is Semver {
         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));
 
         // Emit the old event too for legacy support.
         emit StandardL2TokenCreated(_remoteToken, localToken);

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

@@ -377,17 +377,17 @@ contract Bridge_Initializer is Messenger_Initializer {
         vm.label(address(L1Bridge_Impl), "L1StandardBridge_Impl");
 
         // Deploy the L2StandardBridge, move it to the correct predeploy
-        // address and then initialize it
+        // address and then initialize it. It is safe to call initialize directly
+        // on the proxy because the bytecode was set in state with `etch`.
         vm.etch(Predeploys.L2_STANDARD_BRIDGE, address(new L2StandardBridge(StandardBridge(payable(proxy)))).code);
         L2Bridge = L2StandardBridge(payable(Predeploys.L2_STANDARD_BRIDGE));
         L2Bridge.initialize();
 
         // Set up the L2 mintable token factory
-        OptimismMintableERC20Factory factory = new OptimismMintableERC20Factory(
-            Predeploys.L2_STANDARD_BRIDGE
-        );
+        OptimismMintableERC20Factory factory = new OptimismMintableERC20Factory();
         vm.etch(Predeploys.OPTIMISM_MINTABLE_ERC20_FACTORY, address(factory).code);
         L2TokenFactory = OptimismMintableERC20Factory(Predeploys.OPTIMISM_MINTABLE_ERC20_FACTORY);
+        L2TokenFactory.initialize(Predeploys.L2_STANDARD_BRIDGE);
 
         vm.etch(Predeploys.LEGACY_ERC20_ETH, address(new LegacyERC20ETH()).code);
 
@@ -419,7 +419,15 @@ contract Bridge_Initializer is Messenger_Initializer {
         );
 
         NativeL2Token = new ERC20("Native L2 Token", "L2T");
-        L1TokenFactory = new OptimismMintableERC20Factory(address(L1Bridge));
+        Proxy factoryProxy = new Proxy(multisig);
+        OptimismMintableERC20Factory L1TokenFactoryImpl = new OptimismMintableERC20Factory();
+
+        vm.prank(multisig);
+        factoryProxy.upgradeToAndCall(
+            address(L1TokenFactoryImpl), abi.encodeCall(OptimismMintableERC20Factory.initialize, address(L1Bridge))
+        );
+
+        L1TokenFactory = OptimismMintableERC20Factory(address(factoryProxy));
 
         RemoteL1Token = OptimismMintableERC20(
             L1TokenFactory.createStandardL2Token(

pnpm-lock.yaml

@@ -591,7 +591,7 @@ packages:
     engines: {node: '>=6.0.0'}
     dependencies:
       '@jridgewell/gen-mapping': 0.3.3
-      '@jridgewell/trace-mapping': 0.3.18
+      '@jridgewell/trace-mapping': 0.3.19
     dev: true
 
   /@babel/code-frame@7.22.10:
@@ -689,7 +689,7 @@ packages:
     dependencies:
       '@babel/types': 7.22.5
       '@jridgewell/gen-mapping': 0.3.3
-      '@jridgewell/trace-mapping': 0.3.18
+      '@jridgewell/trace-mapping': 0.3.19
       jsesc: 2.5.2
     dev: true
 
@@ -699,7 +699,7 @@ packages:
     dependencies:
       '@babel/types': 7.22.5
       '@jridgewell/gen-mapping': 0.3.3
-      '@jridgewell/trace-mapping': 0.3.18
+      '@jridgewell/trace-mapping': 0.3.19
       jsesc: 2.5.2
     dev: true
 
@@ -2565,12 +2565,7 @@ packages:
     dependencies:
       '@jridgewell/set-array': 1.1.2
       '@jridgewell/sourcemap-codec': 1.4.15
-      '@jridgewell/trace-mapping': 0.3.18
-    dev: true
-
-  /@jridgewell/resolve-uri@3.1.0:
-    resolution: {integrity: sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==}
-    engines: {node: '>=6.0.0'}
+      '@jridgewell/trace-mapping': 0.3.19
     dev: true
 
   /@jridgewell/resolve-uri@3.1.1:
@@ -2583,21 +2578,10 @@ packages:
     engines: {node: '>=6.0.0'}
     dev: true
 
-  /@jridgewell/sourcemap-codec@1.4.14:
-    resolution: {integrity: sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==}
-    dev: true
-
   /@jridgewell/sourcemap-codec@1.4.15:
     resolution: {integrity: sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==}
     dev: true
 
-  /@jridgewell/trace-mapping@0.3.18:
-    resolution: {integrity: sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA==}
-    dependencies:
-      '@jridgewell/resolve-uri': 3.1.0
-      '@jridgewell/sourcemap-codec': 1.4.14
-    dev: true
-
   /@jridgewell/trace-mapping@0.3.19:
     resolution: {integrity: sha512-kf37QtfW+Hwx/buWGMPcR60iF9ziHa6r/CZJIHbmcm4+0qrXiVdxegAH0F6yddEVQ7zdkjcGCgCzUu+BcbhQxw==}
     dependencies:
@@ -2608,7 +2592,7 @@ packages:
   /@jridgewell/trace-mapping@0.3.9:
     resolution: {integrity: sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==}
     dependencies:
-      '@jridgewell/resolve-uri': 3.1.0
+      '@jridgewell/resolve-uri': 3.1.1
       '@jridgewell/sourcemap-codec': 1.4.15
     dev: true
 
@@ -9302,9 +9286,9 @@ packages:
     engines: {node: '>=10'}
     dependencies:
       cross-spawn: 7.0.3
-      get-stream: 6.0.0
+      get-stream: 6.0.1
       human-signals: 2.1.0
-      is-stream: 2.0.0
+      is-stream: 2.0.1
       merge-stream: 2.0.0
       npm-run-path: 4.0.1
       onetime: 5.1.2
@@ -17570,7 +17554,7 @@ packages:
       '@types/node': 20.5.0
       esbuild: 0.18.15
       postcss: 8.4.27
-      rollup: 3.26.3
+      rollup: 3.28.0
     optionalDependencies:
       fsevents: 2.3.2
     dev: true