Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
c221857
feat: Add transfer admin role workflow and scripts for multi-chain su…
gfournierPro Aug 4, 2025
2379869
refactor: Clean up TransferAdminRole and AcceptAdminRole scripts for …
gfournierPro Aug 4, 2025
07c4d7b
refactor: Remove dependency on build-and-test from transfer admin rol…
gfournierPro Aug 4, 2025
484c6be
refactor: Update admin retrieval methods to use defaultAdmin for cons…
gfournierPro Aug 7, 2025
266e94c
feat: Add NEW_ADMIN configuration to .env.template for admin setup
gfournierPro Aug 7, 2025
f83d5d7
feat: Implement admin transfer validation in TransferAdminRole script
gfournierPro Aug 7, 2025
2bbfac6
refactor: Rename parameter for clarity in validateAdminTransfer function
gfournierPro Aug 7, 2025
7328144
feat: Add workflow for transferring default admin role
gfournierPro Aug 7, 2025
1707f23
feat: Update Makefile and workflow to use new admin transfer command
gfournierPro Aug 7, 2025
d2c4479
feat: Rename TransferAdminRole script to BeginTransferAdminRole for c…
gfournierPro Aug 7, 2025
ea6801f
feat: Refactor admin transfer functions for improved clarity and logging
gfournierPro Aug 7, 2025
fcc0607
feat: Update transfer-admin-role workflow to use input for new admin …
gfournierPro Aug 7, 2025
34eb919
feat: Update admin transfer workflow to use NEW_DEFAULT_ADMIN variable
gfournierPro Aug 7, 2025
749a8bf
fix: forge fmt
gfournierPro Aug 7, 2025
40ab8c3
Merge branch 'main' into feature/transfer-admin-script
gfournierPro Aug 7, 2025
9835548
feat: Enhance admin role transfer scripts with conditional logic for …
gfournierPro Aug 7, 2025
6c65563
feat: Update admin role transfer scripts to use IAccessControlDefault…
gfournierPro Aug 7, 2025
632d8ff
refactor: Simplify admin contract instance variable naming in transfe…
gfournierPro Aug 7, 2025
6853fef
fix: Add zero address check for new admin in validateAdminTransfer fu…
gfournierPro Aug 7, 2025
2fb7dfb
refactor: Replace transferContractAdmin calls with beginTransfer for …
gfournierPro Aug 7, 2025
122c285
fix: forge fmt
gfournierPro Aug 7, 2025
5552f3e
fix: Remove zero address check for new admin in BeginTransferAdminRol…
gfournierPro Aug 7, 2025
8ad0628
feat: Add TransferAdminRoleScript test suite with validation and tran…
gfournierPro Aug 8, 2025
dcced88
Merge branch 'main' into feature/transfer-admin-script
gfournierPro Aug 8, 2025
0fc947e
fix: forge fmt
gfournierPro Aug 8, 2025
982a700
fix: Update test/units/TransferAdminRoleScript.t.sol
gfournierPro Aug 8, 2025
75528a0
refactor: Rename test wrapper contracts for clarity and consistency
gfournierPro Aug 8, 2025
8514c7e
refactor: Reorganize revert scenario tests in TransferAdminRoleScript…
gfournierPro Aug 8, 2025
9d1c452
refactor: Remove unused RLCCrosschainToken variable and related test
gfournierPro Aug 8, 2025
42251ee
test: Add revert scenario for wrong address in AcceptAdminRole
gfournierPro Aug 8, 2025
dfda2cd
refactor: Rename public functions in test harnesses for clarity
gfournierPro Aug 11, 2025
2743dd4
test: Add integration tests for TransferAdminRole script with mocked …
gfournierPro Aug 11, 2025
a3c8e88
refactor: Simplify test harnesses by removing unnecessary functions a…
gfournierPro Aug 11, 2025
7931ece
refactor: Make functions virtual in TransferAdminRole scripts for ext…
gfournierPro Aug 11, 2025
b38d231
test: Enhance BeginTransfer and AcceptAdminRole tests with approval s…
gfournierPro Aug 11, 2025
cef039a
refactor: Remove TransferAdminRoleScriptIntegration test file to stre…
gfournierPro Aug 11, 2025
e353cc0
fix: forge fmt
gfournierPro Aug 11, 2025
b5229b9
refactor: Introduce helper functions for admin transfer process and s…
gfournierPro Aug 11, 2025
a7254a8
refactor: Remove unnecessary console logging from AcceptAdminRoleHarness
gfournierPro Aug 11, 2025
2c3d917
refactor: Remove unused import from TransferAdminRoleScript test file
gfournierPro Aug 11, 2025
4e62e76
refactor: Simplify admin role transfer process by introducing helper …
gfournierPro Aug 11, 2025
66cf967
feat: Add emptyConfigParams function to initialize common configurati…
gfournierPro Aug 11, 2025
bb43519
refactor: Simplify admin role transfer tests by removing harness cont…
gfournierPro Aug 11, 2025
5451587
refactor: Remove unused console import and improve test function stru…
gfournierPro Aug 11, 2025
59be92d
feat: Remove intermediate external call function & clean
zguesmi Aug 11, 2025
bf0f0c0
refactor: Add TODO comment to check if setup-matrix is needed
gfournierPro Aug 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 44 additions & 49 deletions script/TransferAdminRole.s.sol
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it could be nice to move run() function as the first function of each contracts

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ pragma solidity ^0.8.22;

import {Script} from "forge-std/Script.sol";
import {console} from "forge-std/console.sol";
import {AccessControlDefaultAdminRulesUpgradeable} from
"@openzeppelin/contracts-upgradeable/access/extensions/AccessControlDefaultAdminRulesUpgradeable.sol";
import {IAccessControlDefaultAdminRules} from
"@openzeppelin/contracts/access/extensions/IAccessControlDefaultAdminRules.sol";
import {ConfigLib} from "./lib/ConfigLib.sol";
import {RLCLiquidityUnifier} from "../src/RLCLiquidityUnifier.sol";
import {RLCCrosschainToken} from "../src/RLCCrosschainToken.sol";
Expand All @@ -18,60 +18,56 @@ import {IexecLayerZeroBridge} from "../src/bridges/layerZero/IexecLayerZeroBridg
* for all deployed smart contracts on the current chain.
*/
contract BeginTransferAdminRole is Script {
/**
* @notice Transfers the default admin role to a new admin for all contracts on the current chain
* @dev This function automatically detects which contracts are deployed on the current chain
* based on the configuration and transfers admin roles accordingly
*/
function run() external {
address newAdmin = vm.envAddress("NEW_DEFAULT_ADMIN");
string memory chain = vm.envString("CHAIN");
console.log("Starting admin role transfer on chain:", chain);
console.log("New admin address:", newAdmin);

ConfigLib.CommonConfigParams memory params = ConfigLib.readCommonConfig(chain);

vm.startBroadcast();
if (params.approvalRequired) {
beginTransfer(params.rlcLiquidityUnifierAddress, newAdmin, "RLCLiquidityUnifier");
} else {
beginTransfer(params.rlcCrosschainTokenAddress, newAdmin, "RLCCrosschainToken");
}
beginTransfer(params.iexecLayerZeroBridgeAddress, newAdmin, "IexecLayerZeroBridge");
vm.stopBroadcast();
}

/**
* @notice Validates that the new admin is different from the current admin
* @param currentDefaultAdmin The current admin address
* @param newAdmin The new admin address
*/
function validateAdminTransfer(address currentDefaultAdmin, address newAdmin) internal pure {
require(newAdmin != address(0), "BeginTransferAdminRole: new admin cannot be zero address");
require(
currentDefaultAdmin != newAdmin, "BeginTransferAdminRole: New admin must be different from current admin"
newAdmin != currentDefaultAdmin, "BeginTransferAdminRole: New admin must be different from current admin"
);
}

/**
* @notice Transfers the default admin role for any contract implementing AccessControlDefaultAdminRulesUpgradeable
* @notice Transfers the default admin role for any contract implementing IAccessControlDefaultAdminRules
* @param contractAddress The address of the contract
* @param newAdmin The new admin address
* @param contractName The name of the contract for logging purposes
*/
function transferContractAdmin(address contractAddress, address newAdmin, string memory contractName) internal {
AccessControlDefaultAdminRulesUpgradeable adminContract =
AccessControlDefaultAdminRulesUpgradeable(contractAddress);
function beginTransfer(address contractAddress, address newAdmin, string memory contractName) internal {
IAccessControlDefaultAdminRules contractInstance = IAccessControlDefaultAdminRules(contractAddress);

address currentAdmin = adminContract.defaultAdmin();
address currentAdmin = contractInstance.defaultAdmin();
console.log("Current admin for", contractName, ":", currentAdmin);
validateAdminTransfer(currentAdmin, newAdmin);

adminContract.beginDefaultAdminTransfer(newAdmin);

contractInstance.beginDefaultAdminTransfer(newAdmin);
console.log("Admin transfer initiated for", contractName, "at:", contractAddress);
}

/**
* @notice Transfers the default admin role to a new admin for all contracts on the current chain
* @dev This function automatically detects which contracts are deployed on the current chain
* based on the configuration and transfers admin roles accordingly
*/
function run() external {
address newAdmin = vm.envAddress("NEW_DEFAULT_ADMIN");
require(newAdmin != address(0), "BeginTransferAdminRole: New admin cannot be zero address");

string memory chain = vm.envString("CHAIN");
console.log("Starting admin role transfer on chain:", chain);
console.log("New admin address:", newAdmin);

ConfigLib.CommonConfigParams memory params = ConfigLib.readCommonConfig(chain);

vm.startBroadcast();
if (params.approvalRequired) {
transferContractAdmin(params.rlcLiquidityUnifierAddress, newAdmin, "RLCLiquidityUnifier");
} else {
transferContractAdmin(params.rlcCrosschainTokenAddress, newAdmin, "RLCCrosschainToken");
}
transferContractAdmin(params.iexecLayerZeroBridgeAddress, newAdmin, "IexecLayerZeroBridge");
vm.stopBroadcast();
}
}

/**
Expand All @@ -80,19 +76,6 @@ contract BeginTransferAdminRole is Script {
* This script should be run by the new admin after the BeginTransferAdminRole script has been executed.
*/
contract AcceptAdminRole is Script {
/**
* @notice Accepts the default admin role transfer for any contract implementing AccessControlDefaultAdminRulesUpgradeable
* @param contractAddress The address of the contract
* @param contractName The name of the contract for logging purposes
*/
function acceptContractAdmin(address contractAddress, string memory contractName) internal {
console.log("Accepting admin role for", contractName, "at:", contractAddress);
AccessControlDefaultAdminRulesUpgradeable adminContract =
AccessControlDefaultAdminRulesUpgradeable(contractAddress);
adminContract.acceptDefaultAdminTransfer();
console.log("New admin for", contractName, ":", adminContract.defaultAdmin());
}

/**
* @notice Accepts the default admin role transfer for all contracts on the current chain
* @dev This function should be called by the new admin to complete the transfer process
Expand All @@ -111,4 +94,16 @@ contract AcceptAdminRole is Script {
acceptContractAdmin(params.iexecLayerZeroBridgeAddress, "IexecLayerZeroBridge");
vm.stopBroadcast();
}

/**
* @notice Accepts the default admin role transfer for any contract implementing IAccessControlDefaultAdminRules
* @param contractAddress The address of the contract
* @param contractName The name of the contract for logging purposes
*/
function acceptContractAdmin(address contractAddress, string memory contractName) internal {
console.log("Accepting admin role for", contractName, "at:", contractAddress);
IAccessControlDefaultAdminRules contractInstance = IAccessControlDefaultAdminRules(contractAddress);
contractInstance.acceptDefaultAdminTransfer();
console.log("New admin for", contractName, ":", contractInstance.defaultAdmin());
}
}
204 changes: 204 additions & 0 deletions test/units/TransferAdminRoleScript.t.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
// SPDX-FileCopyrightText: 2025 IEXEC BLOCKCHAIN TECH <[email protected]>
// SPDX-License-Identifier: Apache-2.0

pragma solidity ^0.8.22;

import {BeginTransferAdminRole, AcceptAdminRole} from "../../script/TransferAdminRole.s.sol";
import {TestHelperOz5} from "@layerzerolabs/test-devtools-evm-foundry/contracts/TestHelperOz5.sol";

import {IAccessControlDefaultAdminRules} from
"@openzeppelin/contracts/access/extensions/IAccessControlDefaultAdminRules.sol";
import {TestUtils} from "./utils/TestUtils.sol";
import {RLCLiquidityUnifier} from "../../src/RLCLiquidityUnifier.sol";
import {RLCCrosschainToken} from "../../src/RLCCrosschainToken.sol";
import {IexecLayerZeroBridge} from "../../src/bridges/layerZero/IexecLayerZeroBridge.sol";
import {Deploy as RLCLiquidityUnifierDeployScript} from "../../script/RLCLiquidityUnifier.s.sol";
import {Deploy as RLCCrosschainTokenDeployScript} from "../../script/RLCCrosschainToken.s.sol";
import {CreateX} from "@createx/contracts/CreateX.sol";

// Test wrapper contract to expose internal functions
contract TestableBeginTransferAdminRole is BeginTransferAdminRole {
function publicBeginTransfer(address contractAddress, address newAdmin, string memory contractName) public {
beginTransfer(contractAddress, newAdmin, contractName);
}

function publicBeginTransferAsAdmin(
address contractAddress,
address newAdmin,
string memory contractName,
address admin
) public {
vm.startPrank(admin);
beginTransfer(contractAddress, newAdmin, contractName);
vm.stopPrank();
}

function publicValidateAdminTransfer(address currentDefaultAdmin, address newAdmin) public pure {
validateAdminTransfer(currentDefaultAdmin, newAdmin);
}
}

// Test wrapper contract to expose internal functions
contract TestableAcceptAdminRole is AcceptAdminRole {
function publicAcceptContractAdmin(address contractAddress, string memory contractName) public {
acceptContractAdmin(contractAddress, contractName);
}

function publicAcceptContractAdminAsUser(address contractAddress, string memory contractName, address user)
public
{
vm.startPrank(user);
acceptContractAdmin(contractAddress, contractName);
vm.stopPrank();
}
}

contract TransferAdminRoleScriptTest is TestHelperOz5 {
using TestUtils for *;

TestableBeginTransferAdminRole private beginTransferScript;
TestableAcceptAdminRole private acceptAdminScript;

// Test addresses
address private newAdmin = makeAddr("newAdmin");
address private admin = makeAddr("admin");
address private upgrader = makeAddr("upgrader");
address private pauser = makeAddr("pauser");
uint16 private sourceEndpointId = 1;
uint16 private targetEndpointId = 2;
RLCLiquidityUnifier rlcLiquidityUnifier;
RLCCrosschainToken rlcCrosschainToken;

TestUtils.DeploymentResult deployment;

RLCLiquidityUnifierDeployScript private liquidityUnifierDeployer;
RLCCrosschainTokenDeployScript private crosschainTokenDeployer;

function setUp() public virtual override {
super.setUp();
setUpEndpoints(2, LibraryType.UltraLightNode);
deployment = TestUtils.setupDeployment(
TestUtils.DeploymentParams({
iexecLayerZeroBridgeContractName: "IexecLayerZeroBridge",
lzEndpointSource: endpoints[sourceEndpointId],
lzEndpointDestination: endpoints[targetEndpointId],
initialAdmin: admin,
initialUpgrader: upgrader,
initialPauser: pauser
})
);
rlcLiquidityUnifier = deployment.rlcLiquidityUnifier;
rlcCrosschainToken = deployment.rlcCrosschainToken;

beginTransferScript = new TestableBeginTransferAdminRole();
acceptAdminScript = new TestableAcceptAdminRole();

// Label contracts for better debugging
vm.label(address(rlcLiquidityUnifier), "RLCLiquidityUnifier");
vm.label(address(rlcCrosschainToken), "RLCCrosschainToken");
vm.label(admin, "admin");
vm.label(newAdmin, "newAdmin");
}

// ====== revert scenarios checks ======
function test_RevertWhen_NewAdminIsZeroAddress() public {
vm.startPrank(admin);
vm.expectRevert("BeginTransferAdminRole: new admin cannot be zero address");
beginTransferScript.publicBeginTransfer(address(rlcLiquidityUnifier), address(0), "RLCLiquidityUnifier");
vm.stopPrank();
}

function test_RevertWhen_NewAdminIsSameAsCurrentAdmin() public {
vm.startPrank(admin);
vm.expectRevert("BeginTransferAdminRole: New admin must be different from current admin");
beginTransferScript.publicBeginTransfer(address(rlcLiquidityUnifier), admin, "RLCLiquidityUnifier");
vm.stopPrank();
}

function test_RevertWhen_NotAuthorizedToTransferAdmin() public {
address unauthorizedUser = makeAddr("unauthorizedUser");
vm.startPrank(unauthorizedUser);
vm.expectRevert(); // Should revert with access control error
beginTransferScript.publicBeginTransfer(address(rlcLiquidityUnifier), newAdmin, "RLCLiquidityUnifier");
vm.stopPrank();
}

function test_RevertWhen_WrongAddressTriesToAcceptAdmin() public {
beginTransferScript.publicBeginTransferAsAdmin(
address(rlcLiquidityUnifier), newAdmin, "RLCLiquidityUnifier", admin
);

// Try to accept with wrong address using the script wrapper
address wrongAddress = makeAddr("wrongAddress");

vm.expectRevert(); // Should revert because only pending admin can accept
acceptAdminScript.publicAcceptContractAdminAsUser(
address(rlcLiquidityUnifier), "RLCLiquidityUnifier", wrongAddress
);
}

// ====== BeginTransferAdminRole.validateAdminTransfer ======
function test_ValidateAdminTransfer() public {
// Test the validation function directly
vm.startPrank(admin);

// Should not revert with valid inputs
beginTransferScript.publicValidateAdminTransfer(admin, newAdmin);

// Should revert with zero address
vm.expectRevert("BeginTransferAdminRole: new admin cannot be zero address");
beginTransferScript.publicValidateAdminTransfer(admin, address(0));

// Should revert when new admin is same as current
vm.expectRevert("BeginTransferAdminRole: New admin must be different from current admin");
beginTransferScript.publicValidateAdminTransfer(admin, admin);

vm.stopPrank();
}

// ====== BeginTransferAdminRole.beginTransfer ======
function test_BeginTransferAdminRole_LiquidityUnifier() public {
assertEq(IAccessControlDefaultAdminRules(address(rlcLiquidityUnifier)).defaultAdmin(), admin);
beginTransferScript.publicBeginTransferAsAdmin(
address(rlcLiquidityUnifier), newAdmin, "RLCLiquidityUnifier", admin
);
// Verify that the admin transfer has been initiated
(address pendingAdmin,) = IAccessControlDefaultAdminRules(address(rlcLiquidityUnifier)).pendingDefaultAdmin();
assertEq(pendingAdmin, newAdmin);

// Current admin should still be the initial admin until acceptance
assertEq(IAccessControlDefaultAdminRules(address(rlcLiquidityUnifier)).defaultAdmin(), admin);
}

function test_BeginTransferAdminRole_CrosschainToken() public {
assertEq(IAccessControlDefaultAdminRules(address(rlcCrosschainToken)).defaultAdmin(), admin);
beginTransferScript.publicBeginTransferAsAdmin(
address(rlcCrosschainToken), newAdmin, "RLCCrosschainToken", admin
);

// Verify that the admin transfer has been initiated
(address pendingAdmin,) = IAccessControlDefaultAdminRules(address(rlcCrosschainToken)).pendingDefaultAdmin();
assertEq(pendingAdmin, newAdmin);
}

// ====== AcceptAdminRole.acceptContractAdmin ======
function test_AcceptAdminRole_LiquidityUnifier() public {
beginTransferScript.publicBeginTransferAsAdmin(
address(rlcLiquidityUnifier), newAdmin, "RLCLiquidityUnifier", admin
);

// Get the delay schedule and wait for it to pass
(, uint48 acceptSchedule) = IAccessControlDefaultAdminRules(address(rlcLiquidityUnifier)).pendingDefaultAdmin();
vm.warp(acceptSchedule + 1); // Wait until after the scheduled time

// Now accept as the new admin using the script wrapper
acceptAdminScript.publicAcceptContractAdminAsUser(address(rlcLiquidityUnifier), "RLCLiquidityUnifier", newAdmin);

// Verify that the admin transfer has been completed
assertEq(IAccessControlDefaultAdminRules(address(rlcLiquidityUnifier)).defaultAdmin(), newAdmin);

// Pending admin should be reset to zero
(address pendingAdmin,) = IAccessControlDefaultAdminRules(address(rlcLiquidityUnifier)).pendingDefaultAdmin();
assertEq(pendingAdmin, address(0));
}
}