upgrade script etrog -> sovereign #533

laisolizq · 2025-09-18T15:28:39Z

Add script upgrade etrog -> sovereign

ignasirv · 2025-09-19T15:28:01Z

contracts/sovereignChains/AgglayerBridgeL2FromEtrog.sol

+        address _emergencyBridgePauser,
+        address _emergencyBridgeUnpauser,
+        address _proxiedTokensManager
+    ) public virtual reinitializer(3) {


I think it's a good idea to add the getInitializedVersion as it is done in the AgglayerBridge initialize; check initializer version is 1 (or not zero) and also check that current values to update are zero.

krlosMata · 2025-09-22T10:47:45Z

Add localBalanceTree initialization

ignasirv · 2025-09-29T15:08:38Z

contracts/sovereignChains/AgglayerBridgeL2FromEtrog.sol

+     * @dev The key is generated as keccak256(abi.encodePacked(originNetwork, originTokenAddress))
+     * @param amount The amount to set for the local balance tree leaf
+     */
+    function _setLocalBalanceTreeInitialize(


Instead of replicating the function setLocalBalanceTree I would move setLocalBalanceTree code to an internal function _setLocalBalanceTree and call it from initialize, this way you will be saving a lot of bytecode

I thought the idea was not to change the AgglayerBridgeL2 contract, so I implemented this function here.
Is it okay to change it? Should I modify it, or leave it as it is?
@krlosMata

Well, since it’s an internal change that doesn’t affect functionality, I’ll go ahead and make the change. If anyone thinks otherwise, please let me know ^^

invocamanman · 2025-10-09T09:34:09Z

contracts/sovereignChains/AgglayerBridgeL2FromEtrog.sol

+     * @param _emergencyBridgeUnpauser emergency bridge unpauser address, allowed to be zero if the chain wants to disable the feature to unpause the bridge
+     * @param _proxiedTokensManager address of the proxied tokens manager
+     */
+    function initializeBridgeZkEVM(


funciton name seems uncoherent with contract name
maybe InitializeFromEtrog?

invocamanman · 2025-10-09T09:37:02Z

JUst to double check, are we sure that the PolygonZkEVMBridgeV2Pessimistic is the contract deployed on those networks?¿

laisolizq · 2025-10-10T08:34:13Z

JUst to double check, are we sure that the PolygonZkEVMBridgeV2Pessimistic is the contract deployed on those networks?¿

I compared the two bytecodes with a script (comparing only strings), and it says everything is the same except for the last few bytes (which, according to what I’ve found, is a metadata hash that shouldn’t matter). Is that right? @invocamanman

krlosMata · 2025-10-10T09:24:45Z

@codex review

Copilot

Pull Request Overview

Adds a script for upgrading L2 bridge and global exit root contracts from Etrog to Sovereign versions, facilitating the migration from PolygonZkEVMBridgeV2 to AgglayerBridgeL2 and PolygonZkEVMGlobalExitRootL2 to AgglayerGERL2.

Key changes:

Upgrade script with timelock operation generation for both bridge and GER contracts
Test suite for validation via shallow fork testing
Contract implementation supporting upgrade from Etrog with initialization of new parameters

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
upgrade/upgradeEtrogSovereign/upgradeEtrogToSovereign.ts	Main upgrade script deploying implementations and generating timelock operations
upgrade/upgradeEtrogSovereign/test/shallowForkUpgrade.test.ts	Shallow fork test validating contract upgrades and parameter initialization
upgrade/upgradeEtrogSovereign/getLBT.ts	Utility script for retrieving Local Balance Tree data from NewWrappedToken events
upgrade/upgradeEtrogSovereign/README.md	Documentation for upgrade process and configuration
upgrade/upgradeEtrogSovereign/upgrade_parameters.json.example	Example configuration file with required parameters
contracts/sovereignChains/AgglayerBridgeL2FromEtrog.sol	Bridge contract implementation supporting upgrade from Etrog version
contracts/sovereignChains/AgglayerBridgeL2.sol	Internal method extraction for Local Balance Tree initialization
test/contractsv2/AgglayerBridgeL2FromEtrogUpgrade.test.ts	Unit test for upgrade functionality
hardhat.config.ts	Compilation configuration for new contract
upgrade/upgradeEtrogSovereign/.gitignore	Ignore file for generated LBT data

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-10T09:25:35Z

upgrade/upgradeEtrogSovereign/test/shallowForkUpgrade.test.ts

+
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });


Duplicate dotenv.config() call - this line is identical to line 22 and should be removed.

Suggested change

dotenv.config({ path: path.resolve(__dirname, '../../.env') });

Copilot · 2025-10-10T09:25:36Z

upgrade/upgradeEtrogSovereign/test/shallowForkUpgrade.test.ts

+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+
+async function main() {
+    // Asser upgrade version


Corrected spelling of 'Asser' to 'Assert'.

Suggested change

// Asser upgrade version

// Assert upgrade version

Copilot · 2025-10-10T09:25:36Z

upgrade/upgradeEtrogSovereign/upgradeEtrogToSovereign.ts

+    // load timelock
+    const timelockContractFactory = await ethers.getContractFactory('PolygonZkEVMTimelock', deployer);
+    const timelockContract = (await timelockContractFactory.attach(timelockAddress)) as TimelockController;
+    // take params delay, or minimum timelock dela


Corrected spelling of 'dela' to 'delay'.

Suggested change

// take params delay, or minimum timelock dela

// take params delay, or minimum timelock delay

Copilot · 2025-10-10T09:25:36Z

upgrade/upgradeEtrogSovereign/getLBT.ts

+import upgradeParams from './upgrade_parameters.json';
+import { logger } from '../../src/logger';
+
+export async function getLBT(contractAddress) {


Missing type annotation for contractAddress parameter. Should be 'contractAddress: string'.

Suggested change

export async function getLBT(contractAddress) {

export async function getLBT(contractAddress: string) {

chatgpt-codex-connector · 2025-10-10T09:28:18Z

Codex Review: Didn't find any major issues. Swish!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting

@codex fix this CI failure
@codex address that feedback

krlosMata · 2025-10-10T09:35:57Z

upgrade/upgradeEtrogSovereign/upgrade_parameters.json.example

@@ -0,0 +1,14 @@
+{
+    "bridgeL2": "0x..",


can we create a separate object with: initiaizationParameters ?
Just to be more explicit

krlosMata · 2025-10-10T09:38:00Z

upgrade/upgradeEtrogSovereign/upgradeEtrogToSovereign.ts

+import { addInfoOutput } from '../../tools/utils';
+
+// You can replace this import with the actual values obtained from getLBT
+import { originNetwork, originTokenAddress, totalSupply } from './initializeLBT.json';


There is no example of this file.
Reminder that this file could be generated from getLBT.ts tool or from the agglayer-node or any other tool

krlosMata · 2025-10-10T09:38:58Z

upgrade/upgradeEtrogSovereign/upgradeEtrogToSovereign.ts

+    logger.info('Create schedule and execute operation');
+    logger.info('Operation Bridge');
+    // Get LBT initialization parameters (if not imported, import getLBT and use it)
+    // const { originNetwork, originTokenAddress, totalSupply } = await getLBT(bridgeL2, creationBridgeL2Block);


Several comments in the files. It should be cleaned

krlosMata · 2025-10-10T09:40:26Z

upgrade/upgradeEtrogSovereign/getLBT.ts

@@ -0,0 +1,79 @@
+import { ethers } from 'hardhat';


This is another tool. The upgrade can take the LBT from any source.
I'd create a separate tool to synch the LBT.

krlosMata · 2025-10-10T09:42:28Z

upgrade/upgradeEtrogSovereign/upgradeEtrogToSovereign.ts

+
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+
+const pathOutputJson = path.join(__dirname, './upgrade_output.json');


I'd add timestamp here

I’d rather not add a timestamp, since from the test I retrieve this upgrade_output in order to use that data within the test.
I think I’ve seen all the upgrade tests done this way.

krlosMata · 2025-10-10T09:43:00Z

upgrade/upgradeEtrogSovereign/.gitignore

@@ -0,0 +1 @@
+initializeLBT.json


missing upgrade_output_*.json

This file is added to the .gitignore in the root of the project. Even so, if I add a timestamp to it, I’ll also add it to the .gitignore of this tool.

invocamanman · 2025-10-13T10:17:18Z

contracts/sovereignChains/AgglayerBridgeL2FromEtrog.sol

+        uint32[] memory originNetwork,
+        address[] memory originTokenAddress,
+        uint256[] memory amount


rename this and also the internal function, to array i think might be better
e.g originNetworkArray

invocamanman · 2025-10-13T10:36:02Z

contracts/sovereignChains/AgglayerBridgeL2FromEtrog.sol

+     * @param _proxiedTokensManager address of the proxied tokens manager
+     */


invocamanman · 2025-10-13T10:36:29Z

upgrade/upgradeEtrogSovereign/test/shadowForkUpgrade.test.ts

+/* eslint-disable no-await-in-loop, no-use-before-define, no-lonely-if */
+/* eslint-disable no-console, no-inner-declarations, no-undef, import/no-unresolved */
+import { expect } from 'chai';
+import path = require('path');
+
+import * as dotenv from 'dotenv';
+import { ethers, upgrades } from 'hardhat';
+import { time, reset, setBalance, mine } from '@nomicfoundation/hardhat-network-helpers';
+import {
+    PolygonZkEVMTimelock,
+    AgglayerGERL2,
+    AgglayerBridgeL2,
+    PolygonZkEVMBridgeV2Pessimistic,
+    LegacyAgglayerGERL2,
+} from '../../../typechain-types';
+import upgradeParams from '../upgrade_parameters.json';
+import upgradeOutput from '../upgrade_output.json';
+import { logger } from '../../../src/logger';
+import { checkParams } from '../../../src/utils';
+import { ProxyAdmin } from '../../../typechain-types/@openzeppelin/contracts4/proxy/transparent';
+
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+


shadow fork ahhaha

laisolizq requested review from ignasirv, invocamanman and krlosMata as code owners September 18, 2025 15:28

laisolizq marked this pull request as draft September 18, 2025 15:28

ignasirv requested changes Sep 19, 2025

View reviewed changes

laisolizq force-pushed the feature/reorg-v2 branch from d7080a6 to c44ff1c Compare September 22, 2025 08:03

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from 6277218 to 1207da1 Compare September 22, 2025 09:28

laisolizq requested a review from ignasirv September 22, 2025 09:28

ignasirv requested changes Sep 29, 2025

View reviewed changes

laisolizq changed the base branch from feature/reorg-v2 to feature/v12 October 3, 2025 15:16

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from 7d700a2 to 3c1c8e2 Compare October 3, 2025 16:04

laisolizq marked this pull request as ready for review October 8, 2025 15:54

invocamanman reviewed Oct 9, 2025

View reviewed changes

laisolizq added 7 commits October 10, 2025 09:52

upgrade script etrog -> sovereign

2a454c8

Add README & comments upgradeEtrogToSovereign

b294498

add unsafeMode and more checks

ed7b07d

add check initialized version

3f67f8b

update with initialize setLBT

129dd96

add initialize LBT script

68665e1

update getLBT

f278464

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from 7326371 to 2862a36 Compare October 10, 2025 08:23

review changes

15dafbb

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from 2862a36 to 15dafbb Compare October 10, 2025 08:50

laisolizq requested review from ignasirv and invocamanman October 10, 2025 08:50

krlosMata requested a review from Copilot October 10, 2025 09:24

Copilot AI reviewed Oct 10, 2025

View reviewed changes

codex review

ad60e6e

krlosMata requested changes Oct 10, 2025

View reviewed changes

reviews

e49d164

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from a0a3ab9 to e49d164 Compare October 10, 2025 13:04

laisolizq requested a review from krlosMata October 10, 2025 13:04

invocamanman reviewed Oct 13, 2025

View reviewed changes

laisolizq marked this pull request as draft October 15, 2025 08:48

updates script upgradeEtrogToSovereign

26d5f01

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from 919cc16 to 26d5f01 Compare October 16, 2025 09:54

laisolizq marked this pull request as ready for review October 16, 2025 16:22

update upgrade etrog with prepare manifest

ff874a1

laisolizq force-pushed the feature/upgrade-etrog-sovereign branch from 2d285ae to ff874a1 Compare October 16, 2025 16:24


		dotenv.config({ path: path.resolve(__dirname, '../../.env') });

		dotenv.config({ path: path.resolve(__dirname, '../../.env') });

	// take params delay, or minimum timelock dela
	// take params delay, or minimum timelock delay

	export async function getLBT(contractAddress) {
	export async function getLBT(contractAddress: string) {


		dotenv.config({ path: path.resolve(__dirname, '../../.env') });

		const pathOutputJson = path.join(__dirname, './upgrade_output.json');

		* @param _proxiedTokensManager address of the proxied tokens manager
		*/

		@@ -0,0 +1 @@
		initializeLBT.json No newline at end of file

upgrade script etrog -> sovereign #533

Are you sure you want to change the base?

upgrade script etrog -> sovereign #533

Uh oh!

Conversation

laisolizq commented Sep 18, 2025

Uh oh!

ignasirv Sep 19, 2025 • 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!

krlosMata commented Sep 22, 2025

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!

invocamanman commented Oct 9, 2025

Uh oh!

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

Uh oh!

Uh oh!

krlosMata commented Oct 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot commented Oct 10, 2025

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ignasirv Sep 19, 2025 •

edited

Loading

laisolizq commented Oct 10, 2025 •

edited

Loading