feat(cgt): custom gas token #478

hexshire · 2025-08-07T20:56:55Z

Closes: OPT-969

* feat: custom gas token l1 * fix: comments * fix: comments * fix: error * fix: comments * fix: natspec and tests --------- Co-authored-by: Ashitaka <[email protected]>

* feat: add NativeAssetLiquidity and LiquidityController predeploys initial version * fix: set fixed contract version and update interfaces * test: add NA & LC predeploys to L2Genesis script and test * test: add predeploys to setup * feat: add semver to NA & LC predeploys * test: add enableCustomGasToken setup * test: add native asset liquidity unit tests * test: add liquidity controller unit tests * fix: unused imports on test * refactor: custom gas token setup in L2Genesis * refactor: replace onlyMinter modifier in LiquidityController * refactor: add liquidity controller events and remove gasTokenDecimals * fix: remove unused stdStorage * refactor: make liquidity controller initializable * refactor: fix setLiquidityController safety invariant and remove unnecessary payable casts * docs: add natspec to liquidity controller event arguments * chore: fix predeploys version * feat: add burn function on NativeAssetLiquidity * test: assert burner balance is 0 * fix: replaced ownable with proxy admin owner * refactor: removed isCustomGasToken unnecessary check * fix: predeploys addresses * feat(cgt): poc custom gas token l2 l1block upgrade * feat: update l1block and weth for cgt * feat: add cgt check on initiateWithdrawal * test: add l1block unit tests * test: add l2ToL1MessagePasser unit tests * docs: add comments on L1Block test * refactor: leave cgt tests with uncategorized tag * refactor: rename error and fix unused import * test: move cgt related tests to separate files --------- Co-authored-by: niha <[email protected]>

packages/contracts-bedrock/src/L2/L1Block.sol

packages/contracts-bedrock/src/L2/LiquidityController.sol

packages/contracts-bedrock/test/L2/L1Block_CGT.t.sol

packages/contracts-bedrock/test/L2/L2ToL1MessagePasser_CGT.t.sol

tynes · 2025-08-11T22:11:09Z

I do not think you need to do anything based on my comments around the network upgrade transactions, looks like we will need to implement them for the upgrade. I can handle that outside of this PR

packages/contracts-bedrock/src/L1/SystemConfig.sol

packages/contracts-bedrock/src/L2/NativeAssetLiquidity.sol

linear · 2025-08-13T17:58:04Z

OPT-969 PoC: CGT Bridge

This is WIP so far but meant to show how it can work. The big todo is to rename the feature flag with the name of the hardfork that the CGT upgrade is included in. This does leak knowledge of CGT into the client software so that it can optionally deploy the CGT predeploys. It is expected that the CGT predeploys will be in the genesis if the hardfork is active at genesis only on CGT chains. Relevant links: - ethereum-optimism/design-docs#305 - ethereum-optimism/design-docs#313 - defi-wonderland#478

* fix: var naming * fix: var naming

* fix: stack too deep * fix: scripts * fix: scripts

* fix(cgt): remove gasPayingToken function in L1Block

* refactor: move cgt flag to portal * test(cgt): add custom gas token enabled * chore(cgt): nit remove unused param * test(cgt): update initialize test * refactor(cgt): use stdstore

packages/contracts-bedrock/src/L2/L1Block.sol

…imism into poc/custom-gas-token

* feat(cgt): add cgt flag check in finalizeWithdrawal

* feat: add withdrawal network type check on fee vaults deploy * test: add l2genesis revert test cases for invalid withdrawal network types

…#505)

* feat: add deauthorizeMinter to liquidity controller * refactor: replace set minter to false for delete

* feat: add cgt config in op-deployer * feat: add cgt config in op-chain-ops * feat: add enable cgt in op-up & sysgo deployer * test: add isCustomGasToken tests for DeployOPChain * feat: add cgt integration script * chore(cgt): make l1 rpc ip static * feat: add cgt config to chain intent and fix deployer * test: add cgt tests in op deployer * test: add cgt test in intent builder * refactor: intent test * feat: add cgt standard values * fix: l2genesis override * refactor: remove config log and change builder test * feat: add cgt check in checkSystemConfig * fix: deploy opchain tests * chore: remove cgt demo config --------- Co-authored-by: hexshire <[email protected]>

agusduha · 2025-09-02T18:26:04Z

packages/contracts-bedrock/scripts/checks/test-validation/main.go

 	"test/L2/CrossDomainOwnable3.t.sol",                 // Contains contracts not matching CrossDomainOwnable3 base name
 	"test/L2/GasPriceOracle.t.sol",                      // Contains contracts not matching GasPriceOracle base name
 	"test/universal/StandardBridge.t.sol",               // Contains contracts not matching StandardBridge base name
+	"test/L1/OptimismPortal2.t.sol",                     // Contains contracts not matching OptimismPortal2 base name


Add a different test file for CGT

packages/contracts-bedrock/scripts/L2Genesis.s.sol

agusduha · 2025-09-02T18:31:32Z

packages/contracts-bedrock/scripts/L2Genesis.s.sol

        _setImplementationCode(Predeploys.SUPERCHAIN_TOKEN_BRIDGE);
    }

+    /// @notice This predeploy is following the safety invariant #1.


Check invariant number

The safety invariant # 1 is ok for this case. Ref.

agusduha · 2025-09-02T18:42:28Z

packages/contracts-bedrock/src/L1/OptimismPortal2.sol

+    /// @custom:semver 4.6.1
    function version() public pure virtual returns (string memory) {
-        return "4.6.0";
+        return "4.6.1";


Change to 4.7.0

OPT-1061 - We should revisit other contracts too.

agusduha · 2025-09-02T18:45:08Z

packages/contracts-bedrock/src/L1/SystemConfig.sol

+
+    /// @notice Returns whether the gas token is custom by reading from the OptimismPortal.
+    /// @return bool True if the gas token is custom, false otherwise.
+    function isCustomGasToken() public view returns (bool) {


Co-authored-by: AgusDuha <[email protected]> Signed-off-by: Hex <[email protected]>

cursor

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, please have a team admin upgrade your team to Bugbot Pro by visiting the Cursor dashboard. Your first 14 days will be free!

cursor · 2025-09-02T19:19:52Z

packages/contracts-bedrock/src/L2/L1Block.sol

-        is_ = false;
+    function gasPayingTokenSymbol() public view returns (string memory symbol_) {
+        symbol_ =
+            isCustomGasToken() ? ILiquidityController(Predeploys.LIQUIDITY_CONTROLLER).gasPayingTokenSymbol() : "ETH";


Bug: Custom Gas Token Functions Fail Prematurely

The gasPayingTokenName() and gasPayingTokenSymbol() functions can revert if setCustomGasToken() enables custom gas token mode when the LIQUIDITY_CONTROLLER predeploy isn't fully ready. These view functions then attempt to call an uninitialized or non-existent contract, leading to unexpected failures.

hexshire · 2025-09-02T19:20:37Z

packages/contracts-bedrock/deploy-config/hardhat.json

  "daBondSize": 1000,
-  "daResolverRefundPercentage": 50
+  "daResolverRefundPercentage": 50,
+  "isCustomGasToken": false


hexshire and others added 2 commits August 7, 2025 17:55

poc(cgt): custom gas token l1

f8799a4

* feat: custom gas token l1 * fix: comments * fix: comments * fix: error * fix: comments * fix: natspec and tests --------- Co-authored-by: Ashitaka <[email protected]>

hexshire requested review from 0xniha, agusduha and ashitakah August 7, 2025 20:56

hexshire self-assigned this Aug 7, 2025

hexshire changed the title ~~poc: custom gas token~~ poc(cgt): custom gas token Aug 7, 2025

hexshire added the proof-of-concept label Aug 7, 2025

agusduha marked this pull request as draft August 11, 2025 13:51

tynes mentioned this pull request Aug 11, 2025

feat: add custom gas token ethereum-optimism/design-docs#305

Merged

tynes reviewed Aug 11, 2025

View reviewed changes

packages/contracts-bedrock/src/L2/L1Block.sol Outdated Show resolved Hide resolved

tynes reviewed Aug 11, 2025

View reviewed changes

packages/contracts-bedrock/src/L2/LiquidityController.sol Show resolved Hide resolved

tynes reviewed Aug 11, 2025

View reviewed changes

packages/contracts-bedrock/test/L2/L1Block_CGT.t.sol Outdated Show resolved Hide resolved

tynes reviewed Aug 11, 2025

View reviewed changes

packages/contracts-bedrock/test/L2/L2ToL1MessagePasser_CGT.t.sol Show resolved Hide resolved

tynes reviewed Aug 13, 2025

View reviewed changes

packages/contracts-bedrock/src/L1/SystemConfig.sol Outdated Show resolved Hide resolved

tynes reviewed Aug 13, 2025

View reviewed changes

packages/contracts-bedrock/src/L2/NativeAssetLiquidity.sol Outdated Show resolved Hide resolved

tynes reviewed Aug 13, 2025

View reviewed changes

packages/contracts-bedrock/src/L2/NativeAssetLiquidity.sol Outdated Show resolved Hide resolved

tynes mentioned this pull request Aug 13, 2025

feat: network upgrade transactions for cgt ethereum-optimism/optimism#17062

Closed

ashitakah and others added 9 commits August 14, 2025 11:37

fix: var naming

c8fd3ff

* fix: var naming * fix: var naming

test: refactor to reuse L1Block repeated tests

9da1cef

fix(cgt): stack too deep (#485)

078832f

* fix: stack too deep * fix: scripts * fix: scripts

fix: remove gasPayingToken function in L1Block

0353ecb

feat: add fund method to NativeAssetLiquidity

b23bce5

fix(cgt): remove gasPayingToken function from L1Block (#486)

0365015

* fix(cgt): remove gasPayingToken function in L1Block

refactor: remove burn method from NativeAssetLiquidity

cec8a1f

refactor(cgt): move cgt flag to portal

af5f254

* refactor: move cgt flag to portal * test(cgt): add custom gas token enabled * chore(cgt): nit remove unused param * test(cgt): update initialize test * refactor(cgt): use stdstore

fix: test validation for portal

20b8820

chore(cgt): consolidate duplicated flags

a2c9b3a

tynes reviewed Aug 19, 2025

View reviewed changes

packages/contracts-bedrock/src/L2/L1Block.sol Outdated Show resolved Hide resolved

hexshire and others added 12 commits August 19, 2025 13:27

chore(cgt): remove underscore

2bc0430

Merge branch 'poc/custom-gas-token' of github.com:defi-wonderland/opt…

e94f687

…imism into poc/custom-gas-token

fix: cgt flag on depositTransaction test

7dec744

feat: add cgt flag check in finalizeWithdrawal

0cfdc41

refactor: add setIsCustomGasToken internal function

8ab97c7

fix: remove unused using-for directives

f2ed1ec

feat: add cgt flag check in finalizeWithdrawal (#493)

63c7c4c

* feat(cgt): add cgt flag check in finalizeWithdrawal

refactor(cgt): add flag setter

fdd80de

chore(cgt): add withdrawal network type check on fee vaults deploy

37a849d

* feat: add withdrawal network type check on fee vaults deploy * test: add l2genesis revert test cases for invalid withdrawal network types

fix: set withdrawal network as L2 for feevaults when cgt enabled

9d382ea

fix(cgt): set withdrawal network as L2 for feevaults when cgt enabled (…

bf8fb20

…#505)

feat(cgt): add deauthorizeMinter to liquidity controller (#506)

7501512

* feat: add deauthorizeMinter to liquidity controller * refactor: replace set minter to false for delete

hexshire changed the base branch from develop to sc-feat/custom-gas-token September 2, 2025 17:05

agusduha reviewed Sep 2, 2025

View reviewed changes

packages/contracts-bedrock/scripts/L2Genesis.s.sol Outdated Show resolved Hide resolved

agusduha reviewed Sep 2, 2025

View reviewed changes

agusduha marked this pull request as ready for review September 2, 2025 19:00

agusduha changed the title ~~poc(cgt): custom gas token~~ feat(cgt): custom gas token Sep 2, 2025

chore: update comment

53e3747

Co-authored-by: AgusDuha <[email protected]> Signed-off-by: Hex <[email protected]>

cursor bot reviewed Sep 2, 2025

View reviewed changes

hexshire commented Sep 2, 2025

View reviewed changes

0xniha approved these changes Sep 2, 2025

View reviewed changes

hexshire merged commit 98be88f into sc-feat/custom-gas-token Sep 2, 2025
2 checks passed

0xniha mentioned this pull request Sep 18, 2025

feat: cgt ethereum-optimism/optimism#17412

Closed

hexshire deleted the poc/custom-gas-token branch October 13, 2025 14:23

feat(cgt): custom gas token #478

feat(cgt): custom gas token #478

Uh oh!

Conversation

hexshire commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tynes commented Aug 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linear bot commented Aug 13, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

This PR is being reviewed by Cursor Bugbot

Uh oh!

cursor bot Sep 2, 2025

Choose a reason for hiding this comment

Bug: Custom Gas Token Functions Fail Prematurely

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hexshire commented Aug 7, 2025 •

edited

Loading