CCIP-9118: Add BurnMintERC20Transparent and TransparentUpgradeableProxy (including ProxyAdmin) from OpenZeppelin by athegaul · Pull Request #20999 · smartcontractkit/chainlink

athegaul · 2026-02-02T21:46:58Z

Jira: CCIP-9118

This PR implements the full deployment for the BurnMintERC20Transparent token using the standard OpenZeppelin Transparent Upgradeable Proxy (TUP) pattern.

Contracts

Transparent Proxy Pattern: Adopted OpenZeppelin v5 TransparentUpgradeableProxy:

Logic: BurnMintERC20Transparent (Implementation)
Admin: ProxyAdmin (automatically deployed to manage upgrades).

PR: smartcontractkit/ccip-contract-examples#10

CLD

The following changes will be added to durable pipeline, when calling changesets:

environment: <environment>
domain: ccip
changesets:
  - deploy_burn_mint_erc20_transparent_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              maxSupply: 0
              preMint: 0
  - deploy_transparent_upgradeable_proxy_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              burnMintERC20Transparent: "0xD3FA300206659889240EB21a62a9C1c95bB80959" # First we need to deploy BurnMintERC20Trasnaprent before we can run any of the operations
              symbol: TEST01302026
              decimals: 18
              maxSupply: 0
              preMint: 0
              initialize: true
  - save_proxy_admin_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              symbol: TEST01302026
  - transfer_proxy_admin_ownership_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              symbol: TEST01302026
              newOwner: "0xb14F1fEd84a0Cc0302B10ea6bFFBD87a970a5D32"
  - transparent_upgradeable_proxy_grant_role_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              - symbol: TEST01302026
                role: BURNER_ROLE
                account: "0xb14F1fEd84a0Cc0302B10ea6bFFBD87a970a5D32"
              - symbol: TEST01302026
                role: MINTER_ROLE
                account: "0xb14F1fEd84a0Cc0302B10ea6bFFBD87a970a5D32"
  - transparent_upgradeable_proxy_begin_default_admin_transfer_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              symbol: TEST01302026
              newAdmin: "0xb14F1fEd84a0Cc0302B10ea6bFFBD87a970a5D32"
  - transparent_upgradeable_proxy_accept_default_admin_transfer_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              symbol: TEST01302026
  - transparent_upgradeable_proxy_set_ccip_admin_evm:
      chainOverrides:
        - 10344971235874465080
      payload:
        tokens:
          10344971235874465080:
            TEST01302026:
              symbol: TEST01302026
              newAdmin: "0xb14F1fEd84a0Cc0302B10ea6bFFBD87a970a5D32"

…xy (including ProxyAdmin) from OpenZeppelin

… into CCIP-9118/add-transparent-upgradable-proxy

github-actions · 2026-02-03T15:19:31Z

CORA - Pending Reviewers

All codeowners have approved! ✅

For more details, see the full review summary.

github-actions · 2026-02-03T15:20:10Z

I see you updated files related to core. Please run pnpm changeset in the root directory to add a changeset as well as in the text include at least one of the following tags:

#added For any new functionality added.
#breaking_change For any functionality that requires manual action for the node to boot.
#bugfix For bug fixes.
#changed For any change to the existing functionality.
#db_update For any feature that introduces updates to database schema.
#deprecation_notice For any upcoming deprecation functionality.
#internal For changesets that need to be excluded from the final changelog.
#nops For any feature that is NOP facing and needs to be in the official Release Notes for the release.
#removed For any functionality/config that is removed.
#updated For any functionality that is updated.
#wip For any change that is not ready yet and external communication about it should be held off till it is feature complete.

…github.com/smartcontractkit/chainlink into CCIP-9118/add-transparent-upgradable-proxy

trunk-io · 2026-02-03T16:54:26Z

_{View Full Report ↗︎ ⋅ Docs}

deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_transparent.go

deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy_test.go

simsonraj · 2026-02-04T08:51:07Z

deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_transparent.go

+
+	cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm"
+	cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
+	"github.com/smartcontractkit/chainlink-evm/gethwrappers/shared/generated/1_5_0/burn_mint_erc20_transparent"


does this have to be in 1.5? or was it already present in 1.5?
Just because the previous version gethwrappers are hard to generate :( would be great if we can move it to the latest versions

simsonraj · 2026-02-04T08:52:59Z

deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_transparent.go

+	"github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview"
+)
+
+var _ cldf.ChangeSet[BurnMintERC20TransparentChangesetConfig] = DeployBurnMintERC20Transparent


Can we move this to the changeset v2 version instead of legacy, separate apply & validate methods, would be easier to work with orchestrator changesets ( i think)

simsonraj · 2026-02-04T08:55:52Z

deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_transparent.go

+		for token, config := range tokens {
+			if config.PreMint == nil {
+				config.PreMint = big.NewInt(0)
+				tokens[token] = config


it would be ideal if we dont instantiate config in the validate method, we have had trouble before with similar patterns in the Token Pool deployments

We intentionally left PreMint as optional. Although we don't plan to use it ourselves (ever), we want to support the feature for potential clients. Keeping it optional allows us to satisfy those edge cases without complicating the default deployment.

simsonraj · 2026-02-04T09:00:35Z

deployment/ccip/changeset/v1_6/cs_token_governor.go

 	"github.com/smartcontractkit/chainlink/deployment/common/proposalutils"

-	"github.com/smartcontractkit/ccip-contract-examples/chains/evm/gobindings/generated/latest/token_governor"
+	"github.com/smartcontractkit/ccip-contract-examples/chains/evm/gobindings/generated/1_6_1/token_governor"


nice catch, did not know when the latest one was added

simsonraj · 2026-02-04T09:09:31Z

deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy.go

+		return r, nil
+	}
+
+	return [32]byte{}, nil


better to return error for default case instead of empty?

I agree, I will add error and remove check if it returns [32]byte32{}.

simsonraj · 2026-02-04T09:15:02Z

deployment/ccip/shared/stateview/state.go

 			state.SignerRegistry = signerRegistry
 			state.ABIByAddress[address] = signer_registry.SignerRegistryABI
+		case cldf.NewTypeAndVersion(ccipshared.TransparentUpgradeableProxy, deployment.Version1_6_1).String():
+			token, err := burn_mint_erc20_transparent.NewBurnMintERC20Transparent(common.HexToAddress(address), chain.Client)


is it mandatory to have a NewBurnMintERC20Transparent associated with TransparentUpgradeableProxy?
it seems the deploy function of TransparentUpgradeableProxy could have deployment independent of NewBurnMintERC20Transparent with !initialize?
we may have to solidify this assumption

Hey @simsonraj, let me try to explain the reasoning behind it and if we need to make loading state differently.

The Implementation (BurnMintERC20Transparent): This contract serves purely as a logic library. Its own storage is never initialized, so if we query it directly, symbol() returns an empty string.

The ProxyAdmin: This contract is strictly for administrative tasks (upgrades) and does not store any token metadata (like the symbol).

Because neither of these contracts holds the state (only the TUP Proxy does), we cannot fetch the symbol from them directly during state loading. I am using EIP-1967 storage slot lookups on the Proxy to deterministically link these addresses together, as that is the only reliable on-chain method to associate them without relying on event logs."

… into CCIP-9118/add-transparent-upgradable-proxy

…UpgradeableProxy

cl-sonarqube-production · 2026-02-04T15:27:41Z

Quality Gate passed

Issues
12 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
9.5% Duplication on New Code

See analysis details on SonarQube

CCIP-9118: Add BurnMintERC20Transparent and TransparentUpgradeablePro…

3bc9431

…xy (including ProxyAdmin) from OpenZeppelin

athegaul requested review from a team as code owners February 2, 2026 21:46

athegaul requested review from AmrMohamedRezk, agusaldasoro, asoliman92, chris-de-leon-cll, makramkd, matYang and winder February 2, 2026 21:47

product-security-plaid-production bot requested review from gustavogama-cll and jmank88 and removed request for jmank88 February 2, 2026 21:47

athegaul marked this pull request as draft February 2, 2026 21:47

athegaul marked this pull request as ready for review February 2, 2026 22:00

athegaul and others added 3 commits February 2, 2026 14:40

CCIP-9118: Add TestTransparentUpgradeableProxyDeploy

ba5bb58

Merge branch 'develop' of https://github.com/smartcontractkit/chainlink…

3f18c34

… into CCIP-9118/add-transparent-upgradable-proxy

fix go mod

7ef7f8e

b-gopalswami requested a review from a team as a code owner February 3, 2026 15:19

athegaul added 2 commits February 3, 2026 07:52

Merge branch 'CCIP-9118/add-transparent-upgradable-proxy' of https://…

4843c4d

…github.com/smartcontractkit/chainlink into CCIP-9118/add-transparent-upgradable-proxy

CCIP-9118: Update state imports (linter)

d09e34f

athegaul added 3 commits February 3, 2026 10:12

CCIP-9118: Update tessts to pass

a5439cc

CCIP-9118: Remove pre-mint as required for BurnMintERC20Trasparent

5c8a33b

CCIP-9118: Add PreMint as optional

fb6c0e3

CCIP-9118: Reassign config back to struct since it doesn't use pointers

70869ae

b-gopalswami reviewed Feb 3, 2026

View reviewed changes

deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_transparent.go Outdated Show resolved Hide resolved

deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy_test.go Show resolved Hide resolved

CCIP-9118: Add proposed unit tests

e7f0ad9

b-gopalswami previously approved these changes Feb 3, 2026

View reviewed changes

CCIP-9118: Lint errors and require logic

77c31a7

athegaul dismissed b-gopalswami’s stale review via 77c31a7 February 3, 2026 23:56

simsonraj reviewed Feb 4, 2026

View reviewed changes

athegaul added 2 commits February 4, 2026 06:27

Merge branch 'develop' of https://github.com/smartcontractkit/chainlink…

43d8fcf

… into CCIP-9118/add-transparent-upgradable-proxy

CCIP-9118: Add error when role is not found in GetRoleFromTransparent…

23fb609

…UpgradeableProxy

kylesmartin approved these changes Feb 4, 2026

View reviewed changes

simsonraj approved these changes Feb 4, 2026

View reviewed changes

athegaul added this pull request to the merge queue Feb 4, 2026

Merged via the queue into develop with commit 43e1e86 Feb 4, 2026
262 of 267 checks passed

athegaul deleted the CCIP-9118/add-transparent-upgradable-proxy branch February 4, 2026 16:15

Conversation

athegaul commented Feb 2, 2026 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contracts

CLD

Uh oh!

github-actions bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CORA - Pending Reviewers

Uh oh!

github-actions bot commented Feb 3, 2026

Uh oh!

trunk-io bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

simsonraj Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

simsonraj Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simsonraj Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

athegaul Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

simsonraj Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

simsonraj Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

athegaul Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

simsonraj Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

athegaul Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

cl-sonarqube-production bot commented Feb 4, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

athegaul commented Feb 2, 2026 •

edited by atlassian bot

Loading

github-actions bot commented Feb 3, 2026 •

edited

Loading

trunk-io bot commented Feb 3, 2026 •

edited

Loading

simsonraj Feb 4, 2026 •

edited

Loading

simsonraj Feb 4, 2026 •

edited

Loading