feat: cgt

.circleci/config.yml

@@ -420,7 +420,7 @@ jobs:
   contracts-bedrock-build:
     docker:
       - image: <<pipeline.parameters.default_docker_image>>
-    resource_class: xlarge
+    resource_class: 2xlarge
     parameters:
       build_args:
         description: Forge build arguments
@@ -720,7 +720,7 @@ jobs:
     circleci_ip_ranges: true
     docker:
       - image: <<pipeline.parameters.default_docker_image>>
-    resource_class: xlarge
+    resource_class: 2xlarge
     parameters:
       test_list:
         description: List of test files to run
@@ -1998,7 +1998,8 @@ workflows:
           dev_features: <<matrix.dev_features>>
           matrix:
             parameters:
-              dev_features: ["main", "OPTIMISM_PORTAL_INTEROP"]
+              dev_features:
+                ["main", "OPTIMISM_PORTAL_INTEROP", "CUSTOM_GAS_TOKEN"]
           # need this requires to ensure that all FFI JSONs exist
           requires:
             - contracts-bedrock-build

op-acceptance-tests/acceptance-tests.yaml

@@ -100,4 +100,9 @@ gates:
     description: "Jovian network tests."
     tests:
       - package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/jovian
+
+  - id: cgt
+    description: "Custom Gas Token (CGT) network tests."
+    tests:
+      - package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/custom_gas_token
         timeout: 10m

op-acceptance-tests/tests/custom_gas_token/cgt_introspection_test.go

@@ -0,0 +1,25 @@
+package custom_gas_token
+
+import (
+	"testing"
+
+	"github.com/ethereum-optimism/optimism/op-devstack/devtest"
+	"github.com/ethereum-optimism/optimism/op-devstack/presets"
+)
+
+// TestCGT_IntrospectionViaL1Block verifies that the L2 L1Block predeploy reports
+// that CGT mode is enabled and exposes non-empty token metadata (name, symbol).
+func TestCGT_IntrospectionViaL1Block(gt *testing.T) {
+	t := devtest.SerialT(gt)
+	sys := presets.NewMinimal(t)
+
+	name, symbol := ensureCGTOrSkip(t, sys)
+
+	// Metadata should be non-empty.
+	if name == "" {
+		t.Require().Fail("gasPayingTokenName() returned empty string")
+	}
+	if symbol == "" {
+		t.Require().Fail("gasPayingTokenSymbol() returned empty string")
+	}
+}

op-acceptance-tests/tests/custom_gas_token/cgt_l1_portal_introspection_test.go

@@ -0,0 +1,55 @@
+package custom_gas_token
+
+import (
+	"context"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/ethereum-optimism/optimism/op-devstack/devtest"
+	"github.com/ethereum-optimism/optimism/op-devstack/presets"
+
+	"github.com/ethereum/go-ethereum"
+	"github.com/ethereum/go-ethereum/accounts/abi"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/rpc"
+)
+
+// TestCGT_L1PortalIntrospection checks that the L1 OptimismPortal exposes
+// a valid SystemConfig address via its systemConfig() view.
+func TestCGT_L1PortalIntrospection(gt *testing.T) {
+	t := devtest.SerialT(gt)
+	sys := presets.NewMinimal(t)
+
+	// Skip if this devnet is not CGT-enabled (uses your existing gate).
+	ensureCGTOrSkip(t, sys)
+
+	l1c := sys.L1EL.EthClient()
+	portal := sys.L2Chain.DepositContractAddr()
+
+	ctx, cancel := context.WithTimeout(t.Ctx(), 20*time.Second)
+	defer cancel()
+
+	// Portal exposes systemConfig() -> address
+	const portalABI = `[
+	  {"inputs":[],"name":"systemConfig","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}
+	]`
+	pa, err := abi.JSON(strings.NewReader(portalABI))
+	if err != nil {
+		t.Require().Fail("parse portal ABI: %v", err)
+	}
+
+	data, _ := pa.Pack("systemConfig")
+	out, err := l1c.Call(ctx, ethereum.CallMsg{To: &portal, Data: data}, rpc.LatestBlockNumber)
+	if err != nil {
+		t.Require().Fail("portal.systemConfig() call failed: %v", err)
+	}
+	vals, err := pa.Unpack("systemConfig", out)
+	if err != nil {
+		t.Require().Fail("unpack portal.systemConfig() failed: %v", err)
+	}
+	sysCfg := vals[0].(common.Address)
+	if sysCfg == (common.Address{}) {
+		t.Require().Fail("portal.systemConfig() returned zero address")
+	}
+}

op-acceptance-tests/tests/custom_gas_token/cgt_native_payment_test.go

@@ -0,0 +1,48 @@
+package custom_gas_token
+
+import (
+	"testing"
+
+	"github.com/ethereum-optimism/optimism/op-devstack/devtest"
+	"github.com/ethereum-optimism/optimism/op-devstack/presets"
+	"github.com/ethereum-optimism/optimism/op-service/eth"
+)
+
+// TestCGT_ValueTransferPaysGasInToken verifies that on CGT chains a simple L2
+// value transfer charges gas in the native ERC-20, and balances reflect
+// recipient +amount and sender > amount decrease (amount + gas).
+func TestCGT_ValueTransferPaysGasInToken(gt *testing.T) {
+	t := devtest.SerialT(gt)
+	sys := presets.NewMinimal(t)
+
+	ensureCGTOrSkip(t, sys)
+
+	sender := sys.FunderL2.NewFundedEOA(eth.OneTenthEther)
+	recipient := sys.Wallet.NewEOA(sys.L2EL)
+
+	amount := eth.OneHundredthEther
+	beforeS := sender.GetBalance()
+	beforeR := recipient.GetBalance()
+
+	// This sends L2 native (CGT) value.
+	sender.Transfer(recipient.Address(), amount)
+
+	// Wait until recipient reflects the transfer.
+	// We don't wait on sender balance; it includes gas and is non-deterministic.
+	recipient.WaitForBalance(beforeR.Add(amount))
+
+	afterS := sender.GetBalance()
+	afterR := recipient.GetBalance()
+
+	// Recipient increased by amount
+	wantR := beforeR.Add(amount)
+	if afterR != wantR {
+		t.Require().Fail("recipient balance mismatch: got %s, want %s", afterR, wantR)
+	}
+
+	// Sender decreased by at least amount (amount + gas). Strict inequality:
+	if !(beforeS.Sub(afterS)).Gt(amount) {
+		t.Require().Fail("sender delta must exceed transferred amount (gas must be paid): before=%s after=%s amount=%s",
+			beforeS, afterS, amount)
+	}
+}

op-acceptance-tests/tests/custom_gas_token/cgt_portal_reverts_test.go

@@ -0,0 +1,34 @@
+package custom_gas_token
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/ethereum-optimism/optimism/op-devstack/devtest"
+	"github.com/ethereum-optimism/optimism/op-devstack/presets"
+	"github.com/ethereum/go-ethereum"
+	"github.com/ethereum/go-ethereum/common"
+)
+
+// TestCGT_PortalReceiveReverts asserts that sending ETH to the L1 OptimismPortal
+// (receive() -> depositTransaction) reverts under CGT, preventing ETH from getting stuck.
+func TestCGT_PortalReceiveReverts(gt *testing.T) {
+	t := devtest.SerialT(gt)
+	sys := presets.NewMinimal(t)
+	ensureCGTOrSkip(t, sys)
+
+	l1c := sys.L1EL.EthClient()
+	portal := sys.L2Chain.DepositContractAddr()
+
+	// Try to send 1 wei to the Portal (receive() -> depositTransaction); should revert in CGT mode.
+	ctx, cancel := context.WithTimeout(t.Ctx(), 20*time.Second)
+	defer cancel()
+	_, err := l1c.EstimateGas(ctx, ethereum.CallMsg{
+		To:    &portal,
+		Value: common.Big1,
+	})
+	if err == nil {
+		t.Require().Fail("expected L1 Portal to revert on direct ETH send in CGT mode, but estimator returned no error")
+	}
+}

op-acceptance-tests/tests/custom_gas_token/cgt_reverts_test.go

@@ -0,0 +1,80 @@
+package custom_gas_token
+
+import (
+	"context"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/ethereum-optimism/optimism/op-devstack/devtest"
+	"github.com/ethereum-optimism/optimism/op-devstack/presets"
+	"github.com/ethereum-optimism/optimism/op-service/eth"
+
+	"math/big"
+
+	"github.com/ethereum/go-ethereum"
+	"github.com/ethereum/go-ethereum/accounts/abi"
+)
+
+// TestCGT_MessengerRejectsValue ensures that sending native value to the
+// L2CrossDomainMessenger reverts under CGT (non-payable path).
+func TestCGT_MessengerRejectsValue(gt *testing.T) {
+	t := devtest.SerialT(gt)
+	sys := presets.NewMinimal(t)
+	ensureCGTOrSkip(t, sys)
+
+	ctx, cancel := context.WithTimeout(t.Ctx(), 30*time.Second)
+	defer cancel()
+
+	from := sys.FunderL2.NewFundedEOA(eth.OneHundredthEther).Address()
+	_, err := sys.L2EL.Escape().L2EthClient().EstimateGas(ctx, ethereum.CallMsg{
+		From:  from,
+		To:    &l2XDMAddr,
+		Value: big.NewInt(1), // 1 wei native
+		Data:  nil,
+	})
+	if err == nil {
+		t.Require().Fail("expected estimation error when sending value to L2CrossDomainMessenger in CGT mode")
+	}
+}
+
+// TestCGT_L2StandardBridge_LegacyWithdrawReverts verifies that the legacy
+// ETH-specific withdraw path on L2StandardBridge reverts under CGT.
+func TestCGT_L2StandardBridge_LegacyWithdrawReverts(gt *testing.T) {
+	t := devtest.SerialT(gt)
+	sys := presets.NewMinimal(t)
+	ensureCGTOrSkip(t, sys)
+
+	ctx, cancel := context.WithTimeout(t.Ctx(), 30*time.Second)
+	defer cancel()
+
+	bridgeABIJSON := `[
+		{"inputs":[
+			{"internalType":"address","name":"_l2Token","type":"address"},
+			{"internalType":"uint256","name":"_amount","type":"uint256"},
+			{"internalType":"uint32","name":"_minGasLimit","type":"uint32"},
+			{"internalType":"bytes","name":"_extraData","type":"bytes"}
+		],
+		"name":"withdraw","outputs":[],"stateMutability":"payable","type":"function"}
+	]`
+	bridgeABI, err := abi.JSON(strings.NewReader(bridgeABIJSON))
+	if err != nil {
+		t.Require().Fail("%v", err)
+	}
+	// Any address is fine; the ETH-specific legacy path should be disabled under CGT.
+	anyAddress := l2XDMAddr
+	data, err := bridgeABI.Pack("withdraw", anyAddress, big.NewInt(1), uint32(100_000), []byte{})
+	if err != nil {
+		t.Require().Fail("%v", err)
+	}
+
+	from := sys.FunderL2.NewFundedEOA(eth.OneHundredthEther).Address()
+	_, err = sys.L2EL.Escape().L2EthClient().EstimateGas(ctx, ethereum.CallMsg{
+		From: from,
+		To:   &l2BridgeAddr,
+		Data: data,
+	})
+	if err == nil {
+		t.Require().Fail("expected estimation error for L2StandardBridge.withdraw under CGT")
+	}
+}