feat: cgt by tynes · Pull Request #17412 · ethereum-optimism/optimism

tynes · 2025-09-10T04:01:52Z

Description

Based on top of #17320

Enables OP Stack chains to use an asset other than ETH as their native fee currency by introducing a minimal, flexible, and standardizable Custom Gas Token (CGT) architecture. To do so, it introduces new predeploys (NativeAssetLiquidity and LiquidityController) that decouple native asset management from core bridging operations while using a single isCustomGasToken() flag that disables ETH transfer flows in all bridging methods. The two new pre-deploys manage the native asset supply.

Tests

Core contracts:

OptimismPortal and L1Block: Tests for isCustomGasToken() flag blocking ETH deposits/withdrawals
NativeAssetLiquidity: Tests deposit/withdraw access control and functionality
LiquidityController: Tests minter authorization, mint/burn operations, and metadata functions

Metadata

Spec: feat: add custom gas token specs#749
Design Doc: feat: add custom gas token design-docs#305

Contributors

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

codecov · 2025-09-10T23:56:03Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.97%. Comparing base (e489612) to head (f033db8).
⚠️ Report is 235 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #17412      +/-   ##
===========================================
+ Coverage    73.33%   80.97%   +7.64%     
===========================================
  Files          172      121      -51     
  Lines        10954     6239    -4715     
===========================================
- Hits          8033     5052    -2981     
+ Misses        2777     1187    -1590     
+ Partials       144        0     -144

Flag	Coverage Δ
cannon-go-tests-64	`?`
contracts-bedrock-tests	`80.97% <100.00%> (+1.98%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...es/contracts-bedrock/src/L1/OPContractsManager.sol	`96.29% <100.00%> (+0.25%)`	⬆️
...kages/contracts-bedrock/src/L1/OptimismPortal2.sol	`98.50% <100.00%> (+81.04%)`	⬆️
packages/contracts-bedrock/src/L1/SystemConfig.sol	`94.92% <100.00%> (+0.80%)`	⬆️
packages/contracts-bedrock/src/L2/L1Block.sol	`97.56% <100.00%> (+4.87%)`	⬆️
packages/contracts-bedrock/src/L2/L1BlockCGT.sol	`100.00% <100.00%> (ø)`
...s/contracts-bedrock/src/L2/L2ToL1MessagePasser.sol	`86.66% <100.00%> (+2.05%)`	⬆️
...ontracts-bedrock/src/L2/L2ToL1MessagePasserCGT.sol	`100.00% <100.00%> (ø)`
...s/contracts-bedrock/src/L2/LiquidityController.sol	`100.00% <100.00%> (ø)`
.../contracts-bedrock/src/L2/NativeAssetLiquidity.sol	`100.00% <100.00%> (ø)`
...es/contracts-bedrock/src/libraries/DevFeatures.sol	`100.00% <ø> (ø)`
... and 1 more

... and 56 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

tynes · 2025-09-10T23:58:50Z

Looks like I am getting a bunch of failures due to version mismatches. It works when not running in a forked environment, so I am guessing it is something to do with u16a not being deployed and upgraded to yet?

Run tests:

FOUNDRY_PROFILE=lite forge test --mc OPContractsManagerStandardValidator_PermissionedDisputeGame_Test

Example failure:

[FAIL: assertion failed: PDDG-40 != PORTAL-10,PDDG-40] test_validate_permissionedDisputeGameInvalidAbsolutePrestate_succeeds() (gas: 715767)

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

tynes · 2025-09-11T14:39:41Z

op-deployer/pkg/deployer/state/intent_test.go

 }
+
+func setCustomGasToken(intent *Intent) {
+	intent.Chains[0].CustomGasToken = &CustomGasToken{


Should make sure the native asset liquidity amount is set properly everywhere it needs to be

Updated here: 9bb50bd

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

op-deployer/pkg/deployer/state/intent.go

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

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

op-deployer/pkg/deployer/state/deploy_config.go

op-deployer/pkg/deployer/state/chain_intent.go

Signed-off-by: Hex <165055168+hexshire@users.noreply.github.com> Co-authored-by: niha <205694301+0xniha@users.noreply.github.com> Co-authored-by: Ashitaka <96790496+ashitakah@users.noreply.github.com> Co-authored-by: AgusDuha <81362284+agusduha@users.noreply.github.com>

…files

* feat: add L1BlockCGT * feat: add L2ToL1MessagePasserCGT * chore: remove test exclution in test validation

* test(cgt): fix failing tests * test(cgt): fix portal version * test(cgt): skip tests on forked mode * fix: predeploys test cgt mismatch * test(cgt): minor fixes --------- Co-authored-by: niha <205694301+0xniha@users.noreply.github.com>

Updates the implementation to use the new feature flagging system

Use the legacy config name so that less needs to change for legacy CGT chains

Remove leftover merge conflict

Add a specific test for CGT in the intent

* chore: use w3 library * fix: msg error * refactor(cgt): rename amount & add geq 0 check (#600) * feat: add NativeAssetLiquidityAmount sign check * refactor: rename NativeAssetLiquidityAmount to InitialLiquidity * refactor(cgt): rename json nativeAssetLiquidityAmount to initialLiquidity (#601) * refactor: rename json nativeAssetLiquidityAmount to initialLiquidity * fix: only add initialLiquidity to cgt intent struct --------- Co-authored-by: Hex <165055168+hexshire@users.noreply.github.com> Co-authored-by: Ashitaka <96790496+ashitakah@users.noreply.github.com> Co-authored-by: niha <205694301+0xniha@users.noreply.github.com>

* refactor: replace enableCustomGasToken with cgt devfeature * feat: remove fund in NativeAssetLiquidity (#605) * fix(cgt): remove OptimismPortal2 test from exclusions (#606) * fix: remove OptimismPortal2 test from exclusions * fix: remove virtual and restore constructor in portal test * refactor: use low level call to receive test * refactor(cgt): migrate L1Block and L2ToL1MessagePasser cgt tests (#608) * refactor: migrate L1Block cgt tests * refactor: migrate L2ToL1MessagePasser cgt tests * fix: comments (#607) * fix: comments * fix: custom error * fix: errors and tests * fix: errors and tests * fix: cgt tests (#610) * fix: comments * fix: custom error * fix: errors and tests * fix: errors and tests * fix: tests * fix: tests * fix: weth * fix: cgt tests (#611) * fix: comments * fix: custom error * fix: errors and tests * fix: errors and tests * fix: tests * fix: tests * fix: weth * fix: remove types * fix: coverage tests (#612) * fix: separate setUp function tests (#613) --------- Co-authored-by: niha <205694301+0xniha@users.noreply.github.com> Co-authored-by: Ashitaka <96790496+ashitakah@users.noreply.github.com>

* test(inv): setup and total sup inv * test(inv): accounting invariants * chore: doc * fix: import in OptimismPortal2CGT test and pre-pr * fix(cgt): add missing native asset amount (#543) * fix: upgrade contract name * feat: add nativeAssetLiquidityAmount to config json files * fix: add correct nativeAssetLiquidityAmount in op-deployer * fix: add correct nativeAssetLiquidityAmount in op-e2e and fix withCustomGasToken argument on op-devstack * fix: restore OptimismPortal2CGT * fix: all comments * fix: comments * fix: governace * fix: remove aux * fix: remove aux * fix: deploy cgt * fix: revert cgt deploy config * fix: deploy config * chore: run linter * fix: remove unnecessary GetNativeAssetLiquidityAmount --------- Co-authored-by: Ashitaka <ashitaka@defi.sucks> Co-authored-by: agusduha <agusnduha@gmail.com> Co-authored-by: hexshire <hex@wonderland.xyz> * fix: l2 genesis pipeline (#554) * fix: add nativeAssetLiquidityAmount in e2e apply test (#555) * fix: failing test * chore: doc Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> * chore: remove unused imports * chore: fix semgrep * chore: change error name --------- Co-authored-by: drgorillamd <83670532+drgorillamd@users.noreply.github.com> Co-authored-by: niha <205694301+0xniha@users.noreply.github.com> Co-authored-by: Ashitaka <ashitaka@defi.sucks> Co-authored-by: agusduha <agusnduha@gmail.com> Co-authored-by: hexshire <hex@wonderland.xyz> Co-authored-by: AgusDuha <81362284+agusduha@users.noreply.github.com> Co-authored-by: Hex <165055168+hexshire@users.noreply.github.com> Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

…#17621) Co-authored-by: niha <205694301+0xniha@users.noreply.github.com>

…7642) * refactor: auth minter helper tests (#618) * fix: bound _mint correctly in depositTransaction test function (#619)

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

opgitgovernance · 2025-10-11T16:45:42Z

This pr has been automatically marked as stale and will be closed in 5 days if no updates

drinkcoffee · 2025-11-17T02:08:24Z

@tynes , should this PR be still open?

agusduha · 2025-11-19T12:52:27Z

This PR follows in #18076

tynes requested review from a team as code owners September 10, 2025 04:01

tynes requested review from blmalone and teddyknox September 10, 2025 04:01

almanax-ai bot reviewed Sep 10, 2025

View reviewed changes

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

tynes commented Sep 11, 2025

View reviewed changes

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

tynes commented Sep 11, 2025

View reviewed changes

almanax-ai bot reviewed Sep 12, 2025

View reviewed changes

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

bitwiseguy reviewed Sep 13, 2025

View reviewed changes

hexshire and others added 18 commits September 13, 2025 15:07

feat: add gasPayingTokenName and gasPayingTokenSymbol on json config …

5d807c7

…files

fix: contracts semver

2c9c7b9

fix: remove system config bool

4ddd49f

test: add OptimismPortal2CGT tests

1a9acec

chore(cgt): set cgt flag l1block & fixes

170cede

fix(linter): resolve goimports formatting issue

ef98d54

feat: add separate l2 contracts for cgt (#530)

1f223a4

* feat: add L1BlockCGT * feat: add L2ToL1MessagePasserCGT * chore: remove test exclution in test validation

test(cgt): fix failing tests (#529)

53a7501

* test(cgt): fix failing tests * test(cgt): fix portal version * test(cgt): skip tests on forked mode * fix: predeploys test cgt mismatch * test(cgt): minor fixes --------- Co-authored-by: niha <205694301+0xniha@users.noreply.github.com>

fix(cgt): revert weth

52d4840

cgt: feature flag integration

c64cbe5

Updates the implementation to use the new feature flagging system

config: make backwards compatible

01b018c

Use the legacy config name so that less needs to change for legacy CGT chains

fix: build issue

2b5fdf2

Remove leftover merge conflict

fix: better backwards compatibility

c1e9f38

build: fix

736e33d

lint: fix

e759aae

snapshots: update

38404d5

op-deployer: apply test with CGT

2175502

Add a specific test for CGT in the intent

This was referenced Sep 24, 2025

Revert OptimismPortal2.t.sol diff n2 #17592

Closed

Refactor test to make it simpler: OptimismPortal2.sol #17593

Closed

hexshire mentioned this pull request Sep 24, 2025

Remove unnecessary virtual tags #17595

Closed

agusduha mentioned this pull request Sep 24, 2025

Review Custom Gas Token #17586

Closed

agusduha mentioned this pull request Sep 25, 2025

fix: cgt review #17612

Merged

agusduha mentioned this pull request Sep 25, 2025

refactor: use skipIfDevFeatureDisabled for cgt predeploys test (#614) #17621

Merged

simon-something and others added 4 commits September 25, 2025 19:02

refactor: use skipIfDevFeatureDisabled for cgt predeploys test (#614) (…

882ca7a

…#17621) Co-authored-by: niha <205694301+0xniha@users.noreply.github.com>

Merge branch 'develop' into sc-feat/custom-gas-token-rebase

2da84c8

fix: tests

bf72a8c

0xniha mentioned this pull request Sep 26, 2025

fix: auth minter helper & bound _mint in depositTransaction tests #17642

Merged

fix: auth minter helper & bound _mint in depositTransaction tests (#1…

f033db8

…7642) * refactor: auth minter helper tests (#618) * fix: bound _mint correctly in depositTransaction test function (#619)

almanax-ai bot reviewed Sep 26, 2025

View reviewed changes

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

opgitgovernance added the S-stale Status: Will be closed unless there is activity label Oct 11, 2025

zjg555543 mentioned this pull request Oct 13, 2025

Pre release okx/optimism#51

Closed

hexshire mentioned this pull request Oct 29, 2025

feat: cgt #18076

Merged

opgitgovernance closed this Oct 31, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: cgt#17412

feat: cgt#17412
tynes wants to merge 62 commits intodevelopfrom
sc-feat/custom-gas-token-rebase

tynes commented Sep 10, 2025

Uh oh!

Uh oh!

codecov bot commented Sep 10, 2025 •

edited

Loading

Uh oh!

tynes commented Sep 10, 2025

Uh oh!

Uh oh!

tynes Sep 11, 2025

Uh oh!

0xniha Sep 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

opgitgovernance commented Oct 11, 2025

Uh oh!

drinkcoffee commented Nov 17, 2025

Uh oh!

agusduha commented Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

Conversation

tynes commented Sep 10, 2025

Contributors

Uh oh!

Uh oh!

codecov bot commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tynes commented Sep 10, 2025

Uh oh!

Uh oh!

tynes Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

0xniha Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

opgitgovernance commented Oct 11, 2025

Uh oh!

drinkcoffee commented Nov 17, 2025

Uh oh!

agusduha commented Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

codecov bot commented Sep 10, 2025 •

edited

Loading