feat: cgt

op-chain-ops/genesis/config.go

@@ -275,18 +275,27 @@ func (d *GasPriceOracleDeployConfig) OperatorFeeParams() [32]byte {
 type GasTokenDeployConfig struct {
 	// 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"`
+	// GasPayingTokenName represents the custom gas token name.
+	GasPayingTokenName string `json:"gasPayingTokenName"`
+	// GasPayingTokenSymbol represents the custom gas token symbol.
+	GasPayingTokenSymbol string `json:"gasPayingTokenSymbol"`
+	// NativeAssetLiquidityAmount represents the amount of liquidity to pre-fund the NativeAssetLiquidity contract with
+	NativeAssetLiquidityAmount *hexutil.Big `json:"nativeAssetLiquidityAmount"`
 }
 
 var _ ConfigChecker = (*GasTokenDeployConfig)(nil)
 
 func (d *GasTokenDeployConfig) Check(log log.Logger) error {
 	if d.UseCustomGasToken {
-		if d.CustomGasTokenAddress == (common.Address{}) {
-			return fmt.Errorf("%w: CustomGasTokenAddress cannot be address(0)", ErrInvalidDeployConfig)
+		if d.GasPayingTokenName == "" {
+			return fmt.Errorf("%w: GasPayingTokenName cannot be empty", ErrInvalidDeployConfig)
+		}
+		if d.GasPayingTokenSymbol == "" {
+			return fmt.Errorf("%w: GasPayingTokenSymbol cannot be empty", ErrInvalidDeployConfig)
+		}
+		if d.NativeAssetLiquidityAmount == nil {
+			return fmt.Errorf("%w: NativeAssetLiquidityAmount cannot be nil", ErrInvalidDeployConfig)
 		}
-		log.Info("Using custom gas token", "address", d.CustomGasTokenAddress)
 	}
 	return nil
 }

op-chain-ops/genesis/testdata/test-deploy-config-full.json

@@ -6,7 +6,6 @@
   "maxSequencerDrift": 20,
   "sequencerWindowSize": 100,
   "channelTimeout": 30,
-  "customGasTokenAddress": "0x0000000000000000000000000000000000000000",
   "p2pSequencerAddress": "0x9965507d1a55bcc2695c58ba16fb37d819b0a4dc",
   "batchInboxAddress": "0x42000000000000000000000000000000000000ff",
   "batchSenderAddress": "0x3c44cdddb6a900fa2b585dd299e03d12fa4293bc",
@@ -85,6 +84,9 @@
   "disputeGameFinalityDelaySeconds": 6,
   "respectedGameType": 0,
   "useCustomGasToken": false,
+  "gasPayingTokenName": "",
+  "gasPayingTokenSymbol": "",
+  "nativeAssetLiquidityAmount": null,
   "useFaultProofs": false,
   "useAltDA": false,
   "daBondSize": 0,

op-chain-ops/interopgen/deploy.go

@@ -247,6 +247,7 @@ func DeployL2ToL1(l1Host *script.Host, superCfg *SuperchainConfig, superDeployme
 		AllowCustomDisputeParameters: true,
 		OperatorFeeScalar:            cfg.GasPriceOracleOperatorFeeScalar,
 		OperatorFeeConstant:          cfg.GasPriceOracleOperatorFeeConstant,
+		UseCustomGasToken:            cfg.UseCustomGasToken,
 	})
 	if err != nil {
 		return nil, fmt.Errorf("failed to deploy L2 OP chain: %w", err)
@@ -329,6 +330,10 @@ func GenesisL2(l2Host *script.Host, cfg *L2Config, deployment *L2Deployment, mul
 		DeployCrossL2Inbox:                       multichainDepSet,
 		EnableGovernance:                         cfg.EnableGovernance,
 		FundDevAccounts:                          cfg.FundDevAccounts,
+		UseCustomGasToken:                        cfg.UseCustomGasToken,
+		GasPayingTokenName:                       cfg.GasPayingTokenName,
+		GasPayingTokenSymbol:                     cfg.GasPayingTokenSymbol,
+		NativeAssetLiquidityAmount:               cfg.NativeAssetLiquidityAmount.ToInt(),
 	}); err != nil {
 		return fmt.Errorf("failed L2 genesis: %w", err)
 	}

op-chain-ops/interopgen/recipe.go

@@ -243,7 +243,10 @@ func (r *InteropDevL2Recipe) build(l1ChainID uint64, addrs devkeys.Addresses) (*
 				GasPriceOracleBlobBaseFeeScalar: 810949,
 			},
 			GasTokenDeployConfig: genesis.GasTokenDeployConfig{
-				UseCustomGasToken: false,
+				UseCustomGasToken:          false,
+				GasPayingTokenName:         "",
+				GasPayingTokenSymbol:       "",
+				NativeAssetLiquidityAmount: (*hexutil.Big)(big.NewInt(0)),
 			},
 			OperatorDeployConfig: genesis.OperatorDeployConfig{
 				P2PSequencerAddress: sequencerP2P,

op-deployer/pkg/deployer/integration_test/apply_test.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/bootstrap"
 	"github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/inspect"
+	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/params"
 
 	"github.com/ethereum-optimism/optimism/op-service/testutils"
@@ -34,6 +35,7 @@ import (
 	op_e2e "github.com/ethereum-optimism/optimism/op-e2e"
 
 	"github.com/holiman/uint256"
+	"github.com/lmittmann/w3"
 
 	"github.com/ethereum-optimism/optimism/op-chain-ops/addresses"
 	"github.com/ethereum-optimism/optimism/op-chain-ops/devkeys"
@@ -238,6 +240,43 @@ func TestEndToEndApply(t *testing.T) {
 			require.NoError(t, err)
 		}
 	})
+
+	t.Run("with custom gas token", func(t *testing.T) {
+		intent, st := newIntent(t, l1ChainID, dk, l2ChainID1, loc, loc)
+		intent.Chains[0].CustomGasToken = &state.CustomGasToken{
+			Enabled: true,
+			Name:    "Custom Gas Token",
+			Symbol:  "CGT",
+		}
+
+		require.NoError(t, deployer.ApplyPipeline(ctx, deployer.ApplyPipelineOpts{
+			DeploymentTarget:   deployer.DeploymentTargetLive,
+			L1RPCUrl:           l1RPC,
+			DeployerPrivateKey: pk,
+			Intent:             intent,
+			State:              st,
+			Logger:             lgr,
+			StateWriter:        pipeline.NoopStateWriter(),
+			CacheDir:           testCacheDir,
+		}))
+
+		systemConfig := st.Chains[0].SystemConfigProxy
+		fn := w3.MustNewFunc("isFeatureEnabled(bytes32)", "bool")
+		// bytes32("CUSTOM_GAS_TOKEN")
+		data, err := fn.EncodeArgs(w3.H("0x435553544f4d5f4741535f544f4b454e00000000000000000000000000000000"))
+		require.NoError(t, err)
+
+		res, err := l1Client.CallContract(ctx, ethereum.CallMsg{
+			To:   &systemConfig,
+			Data: data,
+		}, nil)
+		require.NoError(t, err)
+
+		var response bool
+		err = fn.DecodeReturns(res, &response)
+		require.NoError(t, err)
+		require.Equal(t, true, response)
+	})
 }
 
 func TestGlobalOverrides(t *testing.T) {
@@ -711,6 +750,11 @@ func newChainIntent(t *testing.T, dk *devkeys.MnemonicDevKeys, l1ChainID *big.In
 			Proposer:          addrFor(t, dk, devkeys.ProposerRole.Key(l1ChainID)),
 			Challenger:        addrFor(t, dk, devkeys.ChallengerRole.Key(l1ChainID)),
 		},
+		CustomGasToken: &state.CustomGasToken{
+			Enabled: false,
+			Name:    "",
+			Symbol:  "",
+		},
 	}
 }
 

op-deployer/pkg/deployer/opcm/l2genesis.go

@@ -28,6 +28,10 @@ type L2GenesisInput struct {
 	DeployCrossL2Inbox                       bool
 	EnableGovernance                         bool
 	FundDevAccounts                          bool
+	UseCustomGasToken                        bool
+	GasPayingTokenName                       string
+	GasPayingTokenSymbol                     string
+	NativeAssetLiquidityAmount               *big.Int
 }
 
 type L2GenesisScript script.DeployScriptWithoutOutput[L2GenesisInput]

op-deployer/pkg/deployer/opcm/opchain.go

@@ -40,6 +40,7 @@ type DeployOPChainInput struct {
 	DisputeClockExtension        uint64
 	DisputeMaxClockDuration      uint64
 	AllowCustomDisputeParameters bool
+	UseCustomGasToken            bool
 
 	OperatorFeeScalar   uint32
 	OperatorFeeConstant uint64

op-deployer/pkg/deployer/pipeline/l2genesis.go

@@ -22,6 +22,9 @@ import (
 )
 
 type l2GenesisOverrides struct {
+	UseCustomGasToken                        bool                      `json:"useCustomGasToken"`
+	GasPayingTokenName                       string                    `json:"gasPayingTokenName"`
+	GasPayingTokenSymbol                     string                    `json:"gasPayingTokenSymbol"`
 	FundDevAccounts                          bool                      `json:"fundDevAccounts"`
 	BaseFeeVaultMinimumWithdrawalAmount      *hexutil.Big              `json:"baseFeeVaultMinimumWithdrawalAmount"`
 	L1FeeVaultMinimumWithdrawalAmount        *hexutil.Big              `json:"l1FeeVaultMinimumWithdrawalAmount"`
@@ -31,6 +34,7 @@ type l2GenesisOverrides struct {
 	SequencerFeeVaultWithdrawalNetwork       genesis.WithdrawalNetwork `json:"sequencerFeeVaultWithdrawalNetwork"`
 	EnableGovernance                         bool                      `json:"enableGovernance"`
 	GovernanceTokenOwner                     common.Address            `json:"governanceTokenOwner"`
+	NativeAssetLiquidityAmount               *hexutil.Big              `json:"nativeAssetLiquidityAmount"`
 }
 
 func GenerateL2Genesis(pEnv *Env, intent *state.Intent, bundle ArtifactsBundle, st *state.State, chainID common.Hash) error {
@@ -94,6 +98,10 @@ func GenerateL2Genesis(pEnv *Env, intent *state.Intent, bundle ArtifactsBundle,
 		DeployCrossL2Inbox:                       len(intent.Chains) > 1,
 		EnableGovernance:                         overrides.EnableGovernance,
 		FundDevAccounts:                          overrides.FundDevAccounts,
+		UseCustomGasToken:                        thisIntent.CustomGasToken.Enabled,
+		GasPayingTokenName:                       thisIntent.CustomGasToken.Name,
+		GasPayingTokenSymbol:                     thisIntent.CustomGasToken.Symbol,
+		NativeAssetLiquidityAmount:               thisIntent.GetNativeAssetLiquidityAmount(),
 	}); err != nil {
 		return fmt.Errorf("failed to call L2Genesis script: %w", err)
 	}
@@ -142,6 +150,15 @@ func calculateL2GenesisOverrides(intent *state.Intent, thisIntent *state.ChainIn
 		}
 	}
 
+	if thisIntent.CustomGasToken == nil {
+		thisIntent.CustomGasToken = &state.CustomGasToken{
+			Enabled:                    overrides.UseCustomGasToken,
+			Name:                       overrides.GasPayingTokenName,
+			Symbol:                     overrides.GasPayingTokenSymbol,
+			NativeAssetLiquidityAmount: overrides.NativeAssetLiquidityAmount,
+		}
+	}
+
 	return overrides, schedule, nil
 }
 
@@ -155,7 +172,13 @@ func wdNetworkToBig(wd genesis.WithdrawalNetwork) *big.Int {
 }
 
 func defaultOverrides() l2GenesisOverrides {
+	// Default to type(uint248).max = 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
+	maxUint248, _ := new(big.Int).SetString("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", 16)
+
 	return l2GenesisOverrides{
+		UseCustomGasToken:                        false,
+		GasPayingTokenName:                       "",
+		GasPayingTokenSymbol:                     "",
 		FundDevAccounts:                          false,
 		BaseFeeVaultMinimumWithdrawalAmount:      standard.VaultMinWithdrawalAmount,
 		L1FeeVaultMinimumWithdrawalAmount:        standard.VaultMinWithdrawalAmount,
@@ -165,5 +188,6 @@ func defaultOverrides() l2GenesisOverrides {
 		SequencerFeeVaultWithdrawalNetwork:       "local",
 		EnableGovernance:                         false,
 		GovernanceTokenOwner:                     standard.GovernanceTokenOwner,
+		NativeAssetLiquidityAmount:               (*hexutil.Big)(maxUint248),
 	}
 }

op-deployer/pkg/deployer/pipeline/l2genesis_test.go

@@ -43,17 +43,11 @@ func TestCalculateL2GenesisOverrides(t *testing.T) {
 			},
 			chainIntent: &state.ChainIntent{},
 			expectError: false,
-			expectedOverrides: l2GenesisOverrides{
-				FundDevAccounts:                          true,
-				BaseFeeVaultMinimumWithdrawalAmount:      standard.VaultMinWithdrawalAmount,
-				L1FeeVaultMinimumWithdrawalAmount:        standard.VaultMinWithdrawalAmount,
-				SequencerFeeVaultMinimumWithdrawalAmount: standard.VaultMinWithdrawalAmount,
-				BaseFeeVaultWithdrawalNetwork:            "local",
-				L1FeeVaultWithdrawalNetwork:              "local",
-				SequencerFeeVaultWithdrawalNetwork:       "local",
-				EnableGovernance:                         false,
-				GovernanceTokenOwner:                     standard.GovernanceTokenOwner,
-			},
+			expectedOverrides: func() l2GenesisOverrides {
+				defaults := defaultOverrides()
+				defaults.FundDevAccounts = true
+				return defaults
+			}(),
 			expectedSchedule: func() *genesis.UpgradeScheduleDeployConfig {
 				return standard.DefaultHardforkScheduleForTag("")
 			},
@@ -73,21 +67,26 @@ func TestCalculateL2GenesisOverrides(t *testing.T) {
 					"enableGovernance":                         true,
 					"governanceTokenOwner":                     "0x1111111111111111111111111111111111111111",
 					"l2GenesisInteropTimeOffset":               "0x1234",
+					"useCustomGasToken":                        false,
+					"gasPayingTokenName":                       "",
+					"gasPayingTokenSymbol":                     "",
 				},
 			},
 			chainIntent: &state.ChainIntent{},
 			expectError: false,
-			expectedOverrides: l2GenesisOverrides{
-				FundDevAccounts:                          true,
-				BaseFeeVaultMinimumWithdrawalAmount:      (*hexutil.Big)(hexutil.MustDecodeBig("0x1234")),
-				L1FeeVaultMinimumWithdrawalAmount:        (*hexutil.Big)(hexutil.MustDecodeBig("0x2345")),
-				SequencerFeeVaultMinimumWithdrawalAmount: (*hexutil.Big)(hexutil.MustDecodeBig("0x3456")),
-				BaseFeeVaultWithdrawalNetwork:            "remote",
-				L1FeeVaultWithdrawalNetwork:              "remote",
-				SequencerFeeVaultWithdrawalNetwork:       "remote",
-				EnableGovernance:                         true,
-				GovernanceTokenOwner:                     common.HexToAddress("0x1111111111111111111111111111111111111111"),
-			},
+			expectedOverrides: func() l2GenesisOverrides {
+				defaults := defaultOverrides()
+				defaults.FundDevAccounts = true
+				defaults.BaseFeeVaultMinimumWithdrawalAmount = (*hexutil.Big)(hexutil.MustDecodeBig("0x1234"))
+				defaults.L1FeeVaultMinimumWithdrawalAmount = (*hexutil.Big)(hexutil.MustDecodeBig("0x2345"))
+				defaults.SequencerFeeVaultMinimumWithdrawalAmount = (*hexutil.Big)(hexutil.MustDecodeBig("0x3456"))
+				defaults.BaseFeeVaultWithdrawalNetwork = "remote"
+				defaults.L1FeeVaultWithdrawalNetwork = "remote"
+				defaults.SequencerFeeVaultWithdrawalNetwork = "remote"
+				defaults.EnableGovernance = true
+				defaults.GovernanceTokenOwner = common.HexToAddress("0x1111111111111111111111111111111111111111")
+				return defaults
+			}(),
 			expectedSchedule: func() *genesis.UpgradeScheduleDeployConfig {
 				sched := standard.DefaultHardforkScheduleForTag("")
 				sched.L2GenesisInteropTimeOffset = op_service.U64UtilPtr(0x1234)
@@ -114,20 +113,25 @@ func TestCalculateL2GenesisOverrides(t *testing.T) {
 					"enableGovernance":                         true,
 					"governanceTokenOwner":                     "0x1111111111111111111111111111111111111111",
 					"l2GenesisInteropTimeOffset":               "0x1234",
+					"useCustomGasToken":                        false,
+					"gasPayingTokenName":                       "",
+					"gasPayingTokenSymbol":                     "",
 				},
 			},
 			expectError: false,
-			expectedOverrides: l2GenesisOverrides{
-				FundDevAccounts:                          true,
-				BaseFeeVaultMinimumWithdrawalAmount:      (*hexutil.Big)(hexutil.MustDecodeBig("0x1234")),
-				L1FeeVaultMinimumWithdrawalAmount:        (*hexutil.Big)(hexutil.MustDecodeBig("0x2345")),
-				SequencerFeeVaultMinimumWithdrawalAmount: (*hexutil.Big)(hexutil.MustDecodeBig("0x3456")),
-				BaseFeeVaultWithdrawalNetwork:            "remote",
-				L1FeeVaultWithdrawalNetwork:              "remote",
-				SequencerFeeVaultWithdrawalNetwork:       "remote",
-				EnableGovernance:                         true,
-				GovernanceTokenOwner:                     common.HexToAddress("0x1111111111111111111111111111111111111111"),
-			},
+			expectedOverrides: func() l2GenesisOverrides {
+				defaults := defaultOverrides()
+				defaults.FundDevAccounts = true
+				defaults.BaseFeeVaultMinimumWithdrawalAmount = (*hexutil.Big)(hexutil.MustDecodeBig("0x1234"))
+				defaults.L1FeeVaultMinimumWithdrawalAmount = (*hexutil.Big)(hexutil.MustDecodeBig("0x2345"))
+				defaults.SequencerFeeVaultMinimumWithdrawalAmount = (*hexutil.Big)(hexutil.MustDecodeBig("0x3456"))
+				defaults.BaseFeeVaultWithdrawalNetwork = "remote"
+				defaults.L1FeeVaultWithdrawalNetwork = "remote"
+				defaults.SequencerFeeVaultWithdrawalNetwork = "remote"
+				defaults.EnableGovernance = true
+				defaults.GovernanceTokenOwner = common.HexToAddress("0x1111111111111111111111111111111111111111")
+				return defaults
+			}(),
 			expectedSchedule: func() *genesis.UpgradeScheduleDeployConfig {
 				sched := standard.DefaultHardforkScheduleForTag("")
 				sched.L2GenesisInteropTimeOffset = op_service.U64UtilPtr(0x1234)

op-deployer/pkg/deployer/pipeline/opchain.go

@@ -110,6 +110,7 @@ func makeDCI(intent *state.Intent, thisIntent *state.ChainIntent, chainID common
 		DisputeClockExtension:        proofParams.DisputeClockExtension,   // 3 hours (input in seconds)
 		DisputeMaxClockDuration:      proofParams.DisputeMaxClockDuration, // 3.5 days (input in seconds)
 		AllowCustomDisputeParameters: proofParams.DangerouslyAllowCustomDisputeParameters,
+		UseCustomGasToken:            thisIntent.CustomGasToken != nil && thisIntent.CustomGasToken.Enabled,
 		OperatorFeeScalar:            thisIntent.OperatorFeeScalar,
 		OperatorFeeConstant:          thisIntent.OperatorFeeConstant,
 	}, nil