CGT: all in one

packages/contracts-bedrock/interfaces/L1/IL1StandardBridge.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.0;
 import { IStandardBridge } from "interfaces/universal/IStandardBridge.sol";
 import { ICrossDomainMessenger } from "interfaces/universal/ICrossDomainMessenger.sol";
 import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol";
+import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol";
 
 interface IL1StandardBridge is IStandardBridge {
     event ERC20DepositInitiated(
@@ -63,7 +64,8 @@ interface IL1StandardBridge is IStandardBridge {
         payable;
     function initialize(
         ICrossDomainMessenger _messenger,
-        ISuperchainConfig _superchainConfig
+        ISuperchainConfig _superchainConfig,
+        ISystemConfig _systemConfig
     )
         external;
     function l2TokenBridge() external view returns (address);

packages/contracts-bedrock/interfaces/L1/IOptimismPortal2.sol

@@ -9,6 +9,7 @@ import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol";
 import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol";
 
 interface IOptimismPortal2 {
+    error CustomGasTokenNotSupported();
     error AlreadyFinalized();
     error BadTarget();
     error Blacklisted();
@@ -23,10 +24,13 @@ interface IOptimismPortal2 {
     error InvalidMerkleProof();
     error InvalidProof();
     error LargeCalldata();
+    error NoValue();
     error NonReentrant();
+    error OnlyCustomGasToken();
     error OutOfGas();
     error ProposalNotValidated();
     error SmallGasLimit();
+    error TransferFailed();
     error Unauthorized();
     error UnexpectedList();
     error UnexpectedString();
@@ -43,8 +47,18 @@ interface IOptimismPortal2 {
 
     receive() external payable;
 
+    function balance() external view returns (uint256);
     function blacklistDisputeGame(IDisputeGame _disputeGame) external;
     function checkWithdrawal(bytes32 _withdrawalHash, address _proofSubmitter) external view;
+    function depositERC20Transaction(
+        address _to,
+        uint256 _mint,
+        uint256 _value,
+        uint64 _gasLimit,
+        bool _isCreation,
+        bytes memory _data
+    )
+        external;
     function depositTransaction(
         address _to,
         uint256 _value,
@@ -96,6 +110,7 @@ interface IOptimismPortal2 {
         returns (IDisputeGame disputeGameProxy, uint64 timestamp); // nosemgrep
     function respectedGameType() external view returns (GameType);
     function respectedGameTypeUpdatedAt() external view returns (uint64);
+    function setGasPayingToken(address _token, uint8 _decimals, bytes32 _name, bytes32 _symbol) external;
     function setRespectedGameType(GameType _gameType) external;
     function superchainConfig() external view returns (ISuperchainConfig);
     function systemConfig() external view returns (ISystemConfig);

packages/contracts-bedrock/interfaces/L1/IOptimismPortalInterop.sol

@@ -10,6 +10,7 @@ import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol";
 import { ConfigType } from "interfaces/L2/IL1BlockInterop.sol";
 
 interface IOptimismPortalInterop {
+    error CustomGasTokenNotSupported();
     error AlreadyFinalized();
     error BadTarget();
     error Blacklisted();
@@ -24,10 +25,13 @@ interface IOptimismPortalInterop {
     error InvalidMerkleProof();
     error InvalidProof();
     error LargeCalldata();
+    error NoValue();
     error NonReentrant();
+    error OnlyCustomGasToken();
     error OutOfGas();
     error ProposalNotValidated();
     error SmallGasLimit();
+    error TransferFailed();
     error Unauthorized();
     error UnexpectedList();
     error UnexpectedString();
@@ -44,8 +48,18 @@ interface IOptimismPortalInterop {
 
     receive() external payable;
 
+    function balance() external view returns (uint256);
     function blacklistDisputeGame(IDisputeGame _disputeGame) external;
     function checkWithdrawal(bytes32 _withdrawalHash, address _proofSubmitter) external view;
+    function depositERC20Transaction(
+        address _to,
+        uint256 _mint,
+        uint256 _value,
+        uint64 _gasLimit,
+        bool _isCreation,
+        bytes memory _data
+    )
+        external;
     function depositTransaction(
         address _to,
         uint256 _value,
@@ -98,6 +112,7 @@ interface IOptimismPortalInterop {
     function respectedGameType() external view returns (GameType);
     function respectedGameTypeUpdatedAt() external view returns (uint64);
     function setConfig(ConfigType _type, bytes memory _value) external;
+    function setGasPayingToken(address _token, uint8 _decimals, bytes32 _name, bytes32 _symbol) external;
     function setRespectedGameType(GameType _gameType) external;
     function superchainConfig() external view returns (ISuperchainConfig);
     function systemConfig() external view returns (ISystemConfig);

packages/contracts-bedrock/interfaces/L1/ISystemConfig.sol

@@ -3,7 +3,10 @@ pragma solidity ^0.8.0;
 
 import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol";
 
+/// @notice This interface corresponds to the Custom Gas Token version of the SystemConfig contract.
 interface ISystemConfig {
+    error CustomGasTokenNotSupported();
+
     enum UpdateType {
         BATCHER,
         FEE_SCALARS,
@@ -19,6 +22,7 @@ interface ISystemConfig {
         address disputeGameFactory;
         address optimismPortal;
         address optimismMintableERC20Factory;
+        address gasPayingToken;
     }
 
     event ConfigUpdate(uint256 indexed version, UpdateType indexed updateType, bytes data);
@@ -44,6 +48,9 @@ interface ISystemConfig {
     function eip1559Denominator() external view returns (uint32);
     function eip1559Elasticity() external view returns (uint32);
     function getAddresses() external view returns (Addresses memory);
+    function gasPayingToken() external view returns (address addr_, uint8 decimals_);
+    function gasPayingTokenName() external view returns (string memory name_);
+    function gasPayingTokenSymbol() external view returns (string memory symbol_);
     function initialize(
         address _owner,
         uint32 _basefeeScalar,
@@ -56,6 +63,7 @@ interface ISystemConfig {
         Addresses memory _addresses
     )
         external;
+    function isCustomGasToken() external view returns (bool);
     function l1CrossDomainMessenger() external view returns (address addr_);
     function l1ERC721Bridge() external view returns (address addr_);
     function l1StandardBridge() external view returns (address addr_);

packages/contracts-bedrock/interfaces/L1/ISystemConfigInterop.sol

@@ -5,6 +5,8 @@ import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol";
 import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol";
 
 interface ISystemConfigInterop {
+    error CustomGasTokenNotSupported();
+
     event ConfigUpdate(uint256 indexed version, ISystemConfig.UpdateType indexed updateType, bytes data);
     event Initialized(uint8 version);
     event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
@@ -27,6 +29,10 @@ interface ISystemConfigInterop {
     function gasLimit() external view returns (uint64);
     function eip1559Denominator() external view returns (uint32);
     function eip1559Elasticity() external view returns (uint32);
+    function gasPayingToken() external view returns (address addr_, uint8 decimals_);
+    function gasPayingTokenName() external view returns (string memory name_);
+    function gasPayingTokenSymbol() external view returns (string memory symbol_);
+    function isCustomGasToken() external view returns (bool);
     function l1CrossDomainMessenger() external view returns (address addr_);
     function l1ERC721Bridge() external view returns (address addr_);
     function l1StandardBridge() external view returns (address addr_);

packages/contracts-bedrock/interfaces/L2/IETHLiquidity.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.0;
 
 interface IETHLiquidity {
+    error NotCustomGasToken();
     error Unauthorized();
 
     event LiquidityBurned(address indexed caller, uint256 value);

packages/contracts-bedrock/interfaces/L2/IL1Block.sol

@@ -2,21 +2,26 @@
 pragma solidity ^0.8.0;
 
 interface IL1Block {
+    error NotDepositor();
+
+    event GasPayingTokenSet(address indexed token, uint8 indexed decimals, bytes32 name, bytes32 symbol);
+
     function DEPOSITOR_ACCOUNT() external pure returns (address addr_);
     function baseFeeScalar() external view returns (uint32);
     function basefee() external view returns (uint256);
     function batcherHash() external view returns (bytes32);
     function blobBaseFee() external view returns (uint256);
     function blobBaseFeeScalar() external view returns (uint32);
-    function gasPayingToken() external pure returns (address addr_, uint8 decimals_);
-    function gasPayingTokenName() external pure returns (string memory name_);
-    function gasPayingTokenSymbol() external pure returns (string memory symbol_);
+    function gasPayingToken() external view returns (address addr_, uint8 decimals_);
+    function gasPayingTokenName() external view returns (string memory name_);
+    function gasPayingTokenSymbol() external view returns (string memory symbol_);
     function hash() external view returns (bytes32);
-    function isCustomGasToken() external pure returns (bool is_);
+    function isCustomGasToken() external view returns (bool);
     function l1FeeOverhead() external view returns (uint256);
     function l1FeeScalar() external view returns (uint256);
     function number() external view returns (uint64);
     function sequenceNumber() external view returns (uint64);
+    function setGasPayingToken(address _token, uint8 _decimals, bytes32 _name, bytes32 _symbol) external;
     function setL1BlockValues(
         uint64 _number,
         uint64 _timestamp,

packages/contracts-bedrock/interfaces/L2/IL1BlockInterop.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.0;
 
 enum ConfigType {
+    SET_GAS_PAYING_TOKEN,
     ADD_DEPENDENCY,
     REMOVE_DEPENDENCY
 }
@@ -16,6 +17,7 @@ interface IL1BlockInterop {
 
     event DependencyAdded(uint256 indexed chainId);
     event DependencyRemoved(uint256 indexed chainId);
+    event GasPayingTokenSet(address indexed token, uint8 indexed decimals, bytes32 name, bytes32 symbol);
 
     function DEPOSITOR_ACCOUNT() external pure returns (address addr_);
     function baseFeeScalar() external view returns (uint32);
@@ -25,18 +27,19 @@ interface IL1BlockInterop {
     function blobBaseFeeScalar() external view returns (uint32);
     function dependencySetSize() external view returns (uint8);
     function depositsComplete() external;
-    function gasPayingToken() external pure returns (address addr_, uint8 decimals_);
-    function gasPayingTokenName() external pure returns (string memory name_);
-    function gasPayingTokenSymbol() external pure returns (string memory symbol_);
+    function gasPayingToken() external view returns (address addr_, uint8 decimals_);
+    function gasPayingTokenName() external view returns (string memory name_);
+    function gasPayingTokenSymbol() external view returns (string memory symbol_);
     function hash() external view returns (bytes32);
-    function isCustomGasToken() external pure returns (bool is_);
+    function isCustomGasToken() external view returns (bool);
     function isDeposit() external view returns (bool isDeposit_);
     function isInDependencySet(uint256 _chainId) external view returns (bool);
     function l1FeeOverhead() external view returns (uint256);
     function l1FeeScalar() external view returns (uint256);
     function number() external view returns (uint64);
     function sequenceNumber() external view returns (uint64);
     function setConfig(ConfigType _type, bytes memory _value) external;
+    function setGasPayingToken(address _token, uint8 _decimals, bytes32 _name, bytes32 _symbol) external;
     function setL1BlockValues(
         uint64 _number,
         uint64 _timestamp,

packages/contracts-bedrock/interfaces/L2/ISuperchainWETH.sol

@@ -7,6 +7,7 @@ import { ISemver } from "interfaces/universal/ISemver.sol";
 
 interface ISuperchainWETH is IWETH98, IERC7802, ISemver {
     error Unauthorized();
+    error NotCustomGasToken();
     error InvalidCrossDomainSender();
     error ZeroAddress();
 
@@ -15,7 +16,7 @@ interface ISuperchainWETH is IWETH98, IERC7802, ISemver {
     event RelayETH(address indexed from, address indexed to, uint256 amount, uint256 source);
 
     function balanceOf(address src) external view returns (uint256);
-    function withdraw(uint256 wad) external;
+    function withdraw(uint256 _amount) external;
     function supportsInterface(bytes4 _interfaceId) external view returns (bool);
     function sendETH(address _to, uint256 _chainId) external payable returns (bytes32 msgHash_);
     function relayETH(address _from, address _to, uint256 _amount) external;

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

@@ -210,6 +210,12 @@ contract Deploy is Deployer {
         );
         vm.stopPrank();
 
+        if (cfg.useCustomGasToken()) {
+            // Reset the systemconfig then reinitialize it with the custom gas token
+            resetInitializedProxy("SystemConfig");
+            initializeSystemConfig();
+        }
+
         if (cfg.useAltDA()) {
             bytes32 typeHash = keccak256(bytes(cfg.daCommitmentType()));
             bytes32 keccakHash = keccak256(bytes("KeccakCommitment"));
@@ -305,6 +311,8 @@ contract Deploy is Deployer {
         artifacts.save("MipsSingleton", address(dio.mipsSingleton()));
         artifacts.save("OPContractsManager", address(dio.opcm()));
         artifacts.save("DelayedWETHImpl", address(dio.delayedWETHImpl()));
+        // added for CGT
+        artifacts.save("SystemConfigImpl", address(dio.systemConfigImpl()));
 
         // Get a contract set from the implementation addresses which were just deployed.
         Types.ContractSet memory impls = Types.ContractSet({
@@ -499,6 +507,11 @@ contract Deploy is Deployer {
 
         bytes32 batcherHash = bytes32(uint256(uint160(cfg.batchSenderAddress())));
 
+        address customGasTokenAddress = Constants.ETHER;
+        if (cfg.useCustomGasToken()) {
+            customGasTokenAddress = cfg.customGasTokenAddress();
+        }
+
         IProxyAdmin proxyAdmin = IProxyAdmin(payable(artifacts.mustGetAddress("ProxyAdmin")));
         proxyAdmin.upgradeAndCall({
             _proxy: payable(systemConfigProxy),
@@ -520,7 +533,8 @@ contract Deploy is Deployer {
                         l1StandardBridge: artifacts.mustGetAddress("L1StandardBridgeProxy"),
                         disputeGameFactory: artifacts.mustGetAddress("DisputeGameFactoryProxy"),
                         optimismPortal: artifacts.mustGetAddress("OptimismPortalProxy"),
-                        optimismMintableERC20Factory: artifacts.mustGetAddress("OptimismMintableERC20FactoryProxy")
+                        optimismMintableERC20Factory: artifacts.mustGetAddress("OptimismMintableERC20FactoryProxy"),
+                        gasPayingToken: customGasTokenAddress
                     })
                 )
             )

packages/contracts-bedrock/scripts/deploy/DeployConfig.s.sol

@@ -85,6 +85,9 @@ contract DeployConfig is Script {
     uint256 public daBondSize;
     uint256 public daResolverRefundPercentage;
 
+    bool public useCustomGasToken;
+    address public customGasTokenAddress;
+
     bool public useInterop;
     bool public useSoulGasToken;
     bool public isSoulBackedByNative;
@@ -170,6 +173,9 @@ contract DeployConfig is Script {
         daBondSize = _readOr(_json, "$.daBondSize", 1000000000);
         daResolverRefundPercentage = _readOr(_json, "$.daResolverRefundPercentage", 0);
 
+        useCustomGasToken = _readOr(_json, "$.useCustomGasToken", false);
+        customGasTokenAddress = _readOr(_json, "$.customGasTokenAddress", address(0));
+
         useInterop = _readOr(_json, "$.useInterop", false);
         useSoulGasToken = _readOr(_json, "$.useSoulGasToken", false);
         isSoulBackedByNative = _readOr(_json, "$.isSoulBackedByNative", false);
@@ -240,6 +246,12 @@ contract DeployConfig is Script {
         fundDevAccounts = _fundDevAccounts;
     }
 
+    /// @notice Allow the `useCustomGasToken` config to be overridden in testing environments
+    function setUseCustomGasToken(address _token) public {
+        useCustomGasToken = true;
+        customGasTokenAddress = _token;
+    }
+
     /// @notice Allow the `useUpgradedFork` config to be overridden in testing environments
     /// @dev When true, the forked system WILL be upgraded in setUp().
     ///      When false, the forked system WILL NOT be upgraded in setUp().

packages/contracts-bedrock/scripts/deploy/DeployOPChain.s.sol

@@ -540,6 +540,8 @@ contract DeployOPChain is Script {
             systemConfig.optimismMintableERC20Factory() == address(_doo.optimismMintableERC20FactoryProxy()),
             "SYSCON-210"
         );
+        (address gasPayingToken,) = systemConfig.gasPayingToken();
+        require(gasPayingToken == Constants.ETHER, "SYSCON-220");
     }
 
     function assertValidL1CrossDomainMessenger(DeployOPChainInput _doi, DeployOPChainOutput _doo) internal {

packages/contracts-bedrock/snapshots/abi/ETHLiquidity.json

@@ -70,6 +70,11 @@
     "name": "LiquidityMinted",
     "type": "event"
   },
+  {
+    "inputs": [],
+    "name": "NotCustomGasToken",
+    "type": "error"
+  },
   {
     "inputs": [],
     "name": "Unauthorized",