Merge pull request #3135 from ethereum-optimism/fix/contracts-event-extension

contracts-bedrock: L2ToL1MessagePasser event extension

.changeset/hip-shrimps-cheat.md

+---
+'@eth-optimism/contracts-bedrock': patch
+---
+
+Emit an extra event when withdrawals are initiated to make chainops easier

op-bindings/bindings/l2tol1messagepasser_deployed.go

@@ -2,4 +2,4 @@
 // This file is a generated binding and any manual changes will be lost.
 package bindings
 
-var L2ToL1MessagePasserDeployedBin = "0x60806040526004361061005e5760003560e01c806382e3702d1161004357806382e3702d146100c7578063affed0e014610107578063c2b3e5ac1461012b57600080fd5b806344df8e701461008757806354fd4d501461009c57600080fd5b366100825761008033620186a060405180602001604052806000815250610139565b005b600080fd5b34801561009357600080fd5b50610080610242565b3480156100a857600080fd5b506100b161027a565b6040516100be919061055c565b60405180910390f35b3480156100d357600080fd5b506100f76100e2366004610576565b60006020819052908152604090205460ff1681565b60405190151581526020016100be565b34801561011357600080fd5b5061011d60015481565b6040519081526020016100be565b6100806101393660046105be565b600061019e6040518060c0016040528060015481526020013373ffffffffffffffffffffffffffffffffffffffff1681526020018673ffffffffffffffffffffffffffffffffffffffff1681526020013481526020018581526020018481525061031d565b6000818152602081905260409081902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600190811790915554905191925073ffffffffffffffffffffffffffffffffffffffff8616913391907f87bf7b546c8de873abb0db5b579ec131f8d0cf5b14f39933551cf9ced23a61369061022c903490899089906106c2565b60405180910390a4505060018054810190555050565b4761024c8161036a565b60405181907f7967de617a5ac1cc7eba2d6f37570a0135afa950d8bb77cdd35f0d0b4e85a16f90600090a250565b60606102a57f0000000000000000000000000000000000000000000000000000000000000000610399565b6102ce7f0000000000000000000000000000000000000000000000000000000000000000610399565b6102f77f0000000000000000000000000000000000000000000000000000000000000000610399565b604051602001610309939291906106ea565b604051602081830303815290604052905090565b80516020808301516040808501516060860151608087015160a0880151935160009761034d979096959101610760565b604051602081830303815290604052805190602001209050919050565b80604051610377906104d6565b6040518091039082f0905080158015610394573d6000803e3d6000fd5b505050565b6060816000036103dc57505060408051808201909152600181527f3000000000000000000000000000000000000000000000000000000000000000602082015290565b8160005b811561040657806103f0816107e6565b91506103ff9050600a8361084d565b91506103e0565b60008167ffffffffffffffff8111156104215761042161058f565b6040519080825280601f01601f19166020018201604052801561044b576020820181803683370190505b5090505b84156104ce57610460600183610861565b915061046d600a86610878565b61047890603061088c565b60f81b81838151811061048d5761048d6108a4565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a9053506104c7600a8661084d565b945061044f565b949350505050565b6008806108d483390190565b60005b838110156104fd5781810151838201526020016104e5565b8381111561050c576000848401525b50505050565b6000815180845261052a8160208601602086016104e2565b601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b60208152600061056f6020830184610512565b9392505050565b60006020828403121561058857600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b6000806000606084860312156105d357600080fd5b833573ffffffffffffffffffffffffffffffffffffffff811681146105f757600080fd5b925060208401359150604084013567ffffffffffffffff8082111561061b57600080fd5b818601915086601f83011261062f57600080fd5b8135818111156106415761064161058f565b604051601f82017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0908116603f011681019083821181831017156106875761068761058f565b816040528281528960208487010111156106a057600080fd5b8260208601602083013760006020848301015280955050505050509250925092565b8381528260208201526060604082015260006106e16060830184610512565b95945050505050565b600084516106fc8184602089016104e2565b80830190507f2e000000000000000000000000000000000000000000000000000000000000008082528551610738816001850160208a016104e2565b600192019182015283516107538160028401602088016104e2565b0160020195945050505050565b868152600073ffffffffffffffffffffffffffffffffffffffff808816602084015280871660408401525084606083015283608083015260c060a08301526107ab60c0830184610512565b98975050505050505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b60007fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8203610817576108176107b7565b5060010190565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601260045260246000fd5b60008261085c5761085c61081e565b500490565b600082821015610873576108736107b7565b500390565b6000826108875761088761081e565b500690565b6000821982111561089f5761089f6107b7565b500190565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fdfe608060405230fffea164736f6c634300080f000a"
+var L2ToL1MessagePasserDeployedBin = "0x60806040526004361061005e5760003560e01c806382e3702d1161004357806382e3702d146100c7578063affed0e014610107578063c2b3e5ac1461012b57600080fd5b806344df8e701461008757806354fd4d501461009c57600080fd5b366100825761008033620186a060405180602001604052806000815250610139565b005b600080fd5b34801561009357600080fd5b5061008061026d565b3480156100a857600080fd5b506100b16102a5565b6040516100be9190610587565b60405180910390f35b3480156100d357600080fd5b506100f76100e23660046105a1565b60006020819052908152604090205460ff1681565b60405190151581526020016100be565b34801561011357600080fd5b5061011d60015481565b6040519081526020016100be565b6100806101393660046105e9565b600061019e6040518060c0016040528060015481526020013373ffffffffffffffffffffffffffffffffffffffff1681526020018673ffffffffffffffffffffffffffffffffffffffff16815260200134815260200185815260200184815250610348565b6000818152602081905260409081902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600190811790915554905191925073ffffffffffffffffffffffffffffffffffffffff8616913391907f87bf7b546c8de873abb0db5b579ec131f8d0cf5b14f39933551cf9ced23a61369061022c903490899089906106ed565b60405180910390a460405181907f2ef6ceb1668fdd882b1f89ddd53a666b0c1113d14cf90c0fbf97c7b1ad880fbb90600090a2505060018054810190555050565b4761027781610395565b60405181907f7967de617a5ac1cc7eba2d6f37570a0135afa950d8bb77cdd35f0d0b4e85a16f90600090a250565b60606102d07f00000000000000000000000000000000000000000000000000000000000000006103c4565b6102f97f00000000000000000000000000000000000000000000000000000000000000006103c4565b6103227f00000000000000000000000000000000000000000000000000000000000000006103c4565b60405160200161033493929190610715565b604051602081830303815290604052905090565b80516020808301516040808501516060860151608087015160a0880151935160009761037897909695910161078b565b604051602081830303815290604052805190602001209050919050565b806040516103a290610501565b6040518091039082f09050801580156103bf573d6000803e3d6000fd5b505050565b60608160000361040757505060408051808201909152600181527f3000000000000000000000000000000000000000000000000000000000000000602082015290565b8160005b8115610431578061041b81610811565b915061042a9050600a83610878565b915061040b565b60008167ffffffffffffffff81111561044c5761044c6105ba565b6040519080825280601f01601f191660200182016040528015610476576020820181803683370190505b5090505b84156104f95761048b60018361088c565b9150610498600a866108a3565b6104a39060306108b7565b60f81b8183815181106104b8576104b86108cf565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a9053506104f2600a86610878565b945061047a565b949350505050565b6008806108ff83390190565b60005b83811015610528578181015183820152602001610510565b83811115610537576000848401525b50505050565b6000815180845261055581602086016020860161050d565b601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b60208152600061059a602083018461053d565b9392505050565b6000602082840312156105b357600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b6000806000606084860312156105fe57600080fd5b833573ffffffffffffffffffffffffffffffffffffffff8116811461062257600080fd5b925060208401359150604084013567ffffffffffffffff8082111561064657600080fd5b818601915086601f83011261065a57600080fd5b81358181111561066c5761066c6105ba565b604051601f82017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0908116603f011681019083821181831017156106b2576106b26105ba565b816040528281528960208487010111156106cb57600080fd5b8260208601602083013760006020848301015280955050505050509250925092565b83815282602082015260606040820152600061070c606083018461053d565b95945050505050565b6000845161072781846020890161050d565b80830190507f2e000000000000000000000000000000000000000000000000000000000000008082528551610763816001850160208a0161050d565b6001920191820152835161077e81600284016020880161050d565b0160020195945050505050565b868152600073ffffffffffffffffffffffffffffffffffffffff808816602084015280871660408401525084606083015283608083015260c060a08301526107d660c083018461053d565b98975050505050505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b60007fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8203610842576108426107e2565b5060010190565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601260045260246000fd5b60008261088757610887610849565b500490565b60008282101561089e5761089e6107e2565b500390565b6000826108b2576108b2610849565b500690565b600082198211156108ca576108ca6107e2565b500190565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fdfe608060405230fffea164736f6c634300080f000a"

op-node/withdrawals/utils.go

 package withdrawals
 
 import (
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
@@ -172,8 +173,15 @@ func FinalizeWithdrawalParameters(ctx context.Context, l2client ProofClient, txH
 	if err != nil {
 		return FinalizedWithdrawalParameters{}, err
 	}
+	ev1, err := ParseWithdrawalInitiatedExtension1(receipt)
+	if err != nil {
+		return FinalizedWithdrawalParameters{}, err
+	}
 	// Generate then verify the withdrawal proof
 	withdrawalHash, err := WithdrawalHash(ev)
+	if !bytes.Equal(withdrawalHash[:], ev1.Hash[:]) {
+		return FinalizedWithdrawalParameters{}, errors.New("Computed withdrawal hash incorrectly")
+	}
 	if err != nil {
 		return FinalizedWithdrawalParameters{}, err
 	}
@@ -255,14 +263,52 @@ func ParseWithdrawalInitiated(receipt *types.Receipt) (*bindings.L2ToL1MessagePa
 	if err != nil {
 		return nil, err
 	}
-	if len(receipt.Logs) != 1 {
-		return nil, errors.New("invalid length of logs")
+	abi, err := bindings.L2ToL1MessagePasserMetaData.GetAbi()
+	if err != nil {
+		return nil, err
 	}
-	ev, err := contract.ParseWithdrawalInitiated(*receipt.Logs[0])
+
+	for _, log := range receipt.Logs {
+		event, err := abi.EventByID(log.Topics[0])
+		if err != nil {
+			return nil, err
+		}
+		if event.Name == "WithdrawalInitiated" {
+			ev, err := contract.ParseWithdrawalInitiated(*log)
+			if err != nil {
+				return nil, fmt.Errorf("failed to parse log: %w", err)
+			}
+			return ev, nil
+		}
+	}
+	return nil, errors.New("Unable to find WithdrawalInitiated event")
+}
+
+// ParseWithdrawalInitiatedExtension1 parses
+func ParseWithdrawalInitiatedExtension1(receipt *types.Receipt) (*bindings.L2ToL1MessagePasserWithdrawalInitiatedExtension1, error) {
+	contract, err := bindings.NewL2ToL1MessagePasser(common.Address{}, nil)
+	if err != nil {
+		return nil, err
+	}
+	abi, err := bindings.L2ToL1MessagePasserMetaData.GetAbi()
 	if err != nil {
-		return nil, fmt.Errorf("failed to parse log: %w", err)
+		return nil, err
+	}
+
+	for _, log := range receipt.Logs {
+		event, err := abi.EventByID(log.Topics[0])
+		if err != nil {
+			return nil, err
+		}
+		if event.Name == "WithdrawalInitiatedExtension1" {
+			ev, err := contract.ParseWithdrawalInitiatedExtension1(*log)
+			if err != nil {
+				return nil, fmt.Errorf("failed to parse log: %w", err)
+			}
+			return ev, nil
+		}
 	}
-	return ev, nil
+	return nil, errors.New("Unable to find WithdrawalInitiatedExtension1 event")
 }
 
 // StorageSlotOfWithdrawalHash determines the storage slot of the Withdrawer contract to look at

packages/contracts-bedrock/.gas-snapshot

@@ -69,8 +69,8 @@ L2CrossDomainMessenger_Test:test_L2MessengerRelayMessageFirstStuckSecondSucceeds
 L2CrossDomainMessenger_Test:test_L2MessengerRelayMessageSucceeds() (gas: 57396)
 L2CrossDomainMessenger_Test:test_L2MessengerRelayMessageToSystemContract() (gas: 36217)
 L2CrossDomainMessenger_Test:test_L2MessengerRelayShouldRevertIfPaused() (gas: 41682)
-L2CrossDomainMessenger_Test:test_L2MessengerSendMessage() (gas: 121684)
-L2CrossDomainMessenger_Test:test_L2MessengerTwiceSendMessage() (gas: 136258)
+L2CrossDomainMessenger_Test:test_L2MessengerSendMessage() (gas: 122833)
+L2CrossDomainMessenger_Test:test_L2MessengerTwiceSendMessage() (gas: 138556)
 L2CrossDomainMessenger_Test:test_L2MessengerXDomainSenderReverts() (gas: 10598)
 L2CrossDomainMessenger_Test:test_L2MessengerxDomainMessageSenderResets() (gas: 54889)
 L2OutputOracleTest:testCannot_ProposeWithUnmatchedBlockhash() (gas: 26829)
@@ -96,19 +96,19 @@ L2OutputOracleUpgradeable_Test:test_cannotInitImpl() (gas: 19555)
 L2OutputOracleUpgradeable_Test:test_cannotInitProxy() (gas: 24554)
 L2OutputOracleUpgradeable_Test:test_initValuesOnProxy() (gas: 39086)
 L2OutputOracleUpgradeable_Test:test_upgrading() (gas: 180632)
-L2StandardBridge_Test:test_ERC20BridgeFailed_whenLocalTokenIsBridge() (gas: 134358)
+L2StandardBridge_Test:test_ERC20BridgeFailed_whenLocalTokenIsBridge() (gas: 135507)
 L2StandardBridge_Test:test_cannotWithdrawEthWithoutSendingIt() (gas: 21619)
-L2StandardBridge_Test:test_finalizeBridgeERC20FailSendBack() (gas: 499449)
+L2StandardBridge_Test:test_finalizeBridgeERC20FailSendBack() (gas: 500368)
 L2StandardBridge_Test:test_finalizeDeposit() (gas: 93125)
-L2StandardBridge_Test:test_finalizeDeposit_failsToCompleteOutboundTransfer() (gas: 141373)
+L2StandardBridge_Test:test_finalizeDeposit_failsToCompleteOutboundTransfer() (gas: 142522)
 L2StandardBridge_Test:test_initialize() (gas: 14823)
-L2StandardBridge_Test:test_receive() (gas: 137921)
-L2StandardBridge_Test:test_withdraw() (gas: 353438)
-L2StandardBridge_Test:test_withdrawTo() (gas: 354193)
+L2StandardBridge_Test:test_receive() (gas: 139070)
+L2StandardBridge_Test:test_withdraw() (gas: 354357)
+L2StandardBridge_Test:test_withdrawTo() (gas: 355112)
 L2StandardBridge_Test:test_withdraw_onlyEOA() (gas: 251674)
-L2ToL1MessagePasserTest:test_burn() (gas: 112246)
-L2ToL1MessagePasserTest:test_initiateWithdrawal_fromContract() (gas: 68198)
-L2ToL1MessagePasserTest:test_initiateWithdrawal_fromEOA() (gas: 75284)
+L2ToL1MessagePasserTest:test_burn() (gas: 113395)
+L2ToL1MessagePasserTest:test_initiateWithdrawal_fromContract() (gas: 72486)
+L2ToL1MessagePasserTest:test_initiateWithdrawal_fromEOA() (gas: 76433)
 LegacyERC20ETH_Test:test_approve() (gas: 10796)
 LegacyERC20ETH_Test:test_burn() (gas: 10681)
 LegacyERC20ETH_Test:test_crossDomain() (gas: 10577)
@@ -279,4 +279,4 @@ SequencerFeeVault_Test:test_constructor() (gas: 7678)
 SequencerFeeVault_Test:test_minWithdrawalAmount() (gas: 5440)
 SequencerFeeVault_Test:test_receive() (gas: 17338)
 SequencerFeeVault_Test:test_revertWithdraw() (gas: 9342)
-SequencerFeeVault_Test:test_withdraw() (gas: 148784)
+SequencerFeeVault_Test:test_withdraw() (gas: 149933)

packages/contracts-bedrock/contracts/L2/L2ToL1MessagePasser.sol

@@ -49,6 +49,14 @@ contract L2ToL1MessagePasser is Semver {
         bytes data
     );
 
+    /**
+     * @notice Emitted any time a withdrawal is initiated. An extension to
+     *         WithdrawalInitiated so that the interface is maintained.
+     *
+     * @param hash The hash of the withdrawal
+     */
+    event WithdrawalInitiatedExtension1(bytes32 indexed hash);
+
     /**
      * @notice Emitted when the balance of this contract is burned.
      *
@@ -106,6 +114,8 @@ contract L2ToL1MessagePasser is Semver {
         sentMessages[withdrawalHash] = true;
 
         emit WithdrawalInitiated(nonce, msg.sender, _target, msg.value, _gasLimit, _data);
+        emit WithdrawalInitiatedExtension1(withdrawalHash);
+
         unchecked {
             ++nonce;
         }

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

@@ -18,6 +18,8 @@ contract L2ToL1MessagePasserTest is CommonTest {
         bytes data
     );
 
+    event WithdrawalInitiatedExtension1(bytes32 indexed hash);
+
     event WithdrawerBalanceBurnt(uint256 indexed amount);
 
     function setUp() virtual public {
@@ -36,6 +38,20 @@ contract L2ToL1MessagePasserTest is CommonTest {
             hex""
         );
 
+        bytes32 withdrawalHash = Hashing.hashWithdrawal(
+            Types.WithdrawalTransaction(
+                messagePasser.nonce(),
+                address(this),
+                address(4),
+                100,
+                64000,
+                hex""
+            )
+        );
+
+        vm.expectEmit(true, true, true, true);
+        emit WithdrawalInitiatedExtension1(withdrawalHash);
+
         vm.deal(address(this), 2**64);
         messagePasser.initiateWithdrawal{ value: 100 }(
             address(4),

specs/withdrawals.md

@@ -87,6 +87,8 @@ interface L2ToL1MessagePasser {
         bytes data
     );
 
+    event WithdrawalInitiatedExtension1(bytes32 indexed hash);
+
     event WithdrawerBalanceBurnt(uint256 indexed amount);
 
     function burn() external;
@@ -100,6 +102,14 @@ interface L2ToL1MessagePasser {
 
 ```
 
+The `WithdrawalInitiated` event includes all of the data that is hashed and
+stored in the `sentMessages` mapping. The `WithdrawalInitiatedExtension1` emits
+the hash that was computed and used as part of the storage proof used to
+finalize the withdrawal on L1.
+
+The events are separate as to preserve backwards compatibility. The hashing
+scheme could be upgraded in the future through a contract upgrade.
+
 ### Addresses are not Aliased on Withdrawals
 
 [address-aliasing]: #no-address-aliasing