feat: custom gas token (#10143)

* contracts-bedrock: custom gas token L1 contracts

Implement the L1 contract diff of the custom gas token spec

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* contracts-bedrock: custom gas token L2 contracts

Implement the L2 contract diff of the custom gas token spec

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* contracts-bedrock: custom gas token contracts

Libraries and universal contracts in the custom gas token spec

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* contracts-bedrock: custom gas token scripts

Implement the scripts for the custom gas token spec

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* contracts-bedrock: custom gas token tests

Implement tests for the custom gas token spec

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* op-bindings: update with custom gas token

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* op-chain-ops: fixup tests

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* contracts-bedrock: snapshots

Update snapshots

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* cleanup: get tests passing

* contracts-bedrock: cleanup tests

* contracts-bedrock: cleanup custom gas token

* op-bindings: regenerate

* codesize: fix

* contracts-bedrock: custom gas token cleanup

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

* build: fix

* custom-gas-token: fix build

* custom-gas-token: cleanup, final spec nits

* gas-snapshot: fix

* contracts-bedrock: cleanup

* contracts-bedrock: semver lock

* invariant-docs: fixup

* storage-layout: address

* bindings: remove preview

* bindings: add back bindingspreview

* weth: remove weth9

Migrate to WETH based on weth98

* contracts-bedrock: cleanup

* custom-gas-token: more cleanup

Fix abi

* contracts-bedrock: test case

* custom-gas-token: cleanup, tests

* lint: fix

* custom-gas-token: address review comments

* snapshots: regenerate

* lint: fix

* contracts-bedrock: clean up semantics of cgt

Custom gas token semantics are strengthened and
cleaned up to ensure invariants in spec are held
true.

* snapshots: regenerate

* snapshots: gas snapshot

* semver-lock: regenerate

* comments: address

* semver: calculate

* ctb: revert in test

* tests: fix flake

* portal: better comment

* test: fixup

* lint: fix

* snapshot: gas

---------

Co-authored-by: Diego <105765223+0xfuturistic@users.noreply.github.com>

Author: tynes

op-bindings/bindings/l1block.go

@@ -8,7 +8,7 @@ import "github.com/ethereum/go-ethereum/common"
 const (
 	L2ToL1MessagePasser           = "0x4200000000000000000000000000000000000016"
 	DeployerWhitelist             = "0x4200000000000000000000000000000000000002"
-	WETH9                         = "0x4200000000000000000000000000000000000006"
+	WETH                          = "0x4200000000000000000000000000000000000006"
 	L2CrossDomainMessenger        = "0x4200000000000000000000000000000000000007"
 	L2StandardBridge              = "0x4200000000000000000000000000000000000010"
 	SequencerFeeVault             = "0x4200000000000000000000000000000000000011"
@@ -41,7 +41,7 @@ const (
 var (
 	L2ToL1MessagePasserAddr           = common.HexToAddress(L2ToL1MessagePasser)
 	DeployerWhitelistAddr             = common.HexToAddress(DeployerWhitelist)
-	WETH9Addr                         = common.HexToAddress(WETH9)
+	WETHAddr                          = common.HexToAddress(WETH)
 	L2CrossDomainMessengerAddr        = common.HexToAddress(L2CrossDomainMessenger)
 	L2StandardBridgeAddr              = common.HexToAddress(L2StandardBridge)
 	SequencerFeeVaultAddr             = common.HexToAddress(SequencerFeeVault)
@@ -77,7 +77,7 @@ var (
 func init() {
 	Predeploys["L2ToL1MessagePasser"] = &Predeploy{Address: L2ToL1MessagePasserAddr}
 	Predeploys["DeployerWhitelist"] = &Predeploy{Address: DeployerWhitelistAddr}
-	Predeploys["WETH9"] = &Predeploy{Address: WETH9Addr, ProxyDisabled: true}
+	Predeploys["WETH"] = &Predeploy{Address: WETHAddr, ProxyDisabled: true}
 	Predeploys["L2CrossDomainMessenger"] = &Predeploy{Address: L2CrossDomainMessengerAddr}
 	Predeploys["L2StandardBridge"] = &Predeploy{Address: L2StandardBridgeAddr}
 	Predeploys["SequencerFeeVault"] = &Predeploy{Address: SequencerFeeVaultAddr}

op-bindings/bindings/l1crossdomainmessenger.go

@@ -248,7 +248,10 @@ type DeployConfig struct {
 	// UseFaultProofs is a flag that indicates if the system is using fault
 	// proofs instead of the older output oracle mechanism.
 	UseFaultProofs bool `json:"useFaultProofs"`
-
+	// UseCustomGasToken is a flag to indicate that a custom gas token should be used
+	UseCustomGasToken bool `json:"useCustomGasToken"`
+	// CustomGasTokenAddress is the address of the ERC20 token to be used to pay for gas on L2.
+	CustomGasTokenAddress common.Address `json:"customGasTokenAddress"`
 	// UsePlasma is a flag that indicates if the system is using op-plasma
 	UsePlasma bool `json:"usePlasma"`
 	// DAChallengeWindow represents the block interval during which the availability of a data commitment can be challenged.
@@ -427,6 +430,12 @@ func (d *DeployConfig) Check() error {
 			return fmt.Errorf("%w: DAResolveWindow cannot be 0 when using plasma mode", ErrInvalidDeployConfig)
 		}
 	}
+	if d.UseCustomGasToken {
+		if d.CustomGasTokenAddress == (common.Address{}) {
+			return fmt.Errorf("%w: CustomGasTokenAddress cannot be address(0)", ErrInvalidDeployConfig)
+		}
+		log.Info("Using custom gas token", "address", d.CustomGasTokenAddress)
+	}
 	// checkFork checks that fork A is before or at the same time as fork B
 	checkFork := func(a, b *hexutil.Uint64, aName, bName string) error {
 		if a == nil && b == nil {