Skip to content

feat(paymaster): add separate whitelistAdmin param to BondTreasuryPaymaster #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aliXsed merged 1 commit into from
Apr 8, 2026
Merged

feat(paymaster): add separate whitelistAdmin param to BondTreasuryPaymaster #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion script/DeploySwarmUpgradeableZkSync.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ contract DeploySwarmUpgradeableZkSync is Script {
whitelistedUsers[0] = fleetOperator;
bondTreasuryPaymaster = address(
new BondTreasuryPaymaster(
owner, withdrawer, whitelistedContracts, whitelistedUsers, bondToken, bondQuota, bondPeriod
owner, fleetOperator, withdrawer, whitelistedContracts, whitelistedUsers, bondToken, bondQuota, bondPeriod
)
);
console.log(" Address:", bondTreasuryPaymaster);
Expand Down
20 changes: 13 additions & 7 deletions src/paymasters/BondTreasuryPaymaster.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,35 +23,41 @@ contract BondTreasuryPaymaster is WhitelistPaymaster, QuotaControl {

constructor(
address admin,
address whitelistAdmin,
address withdrawer,
address[] memory initialWhitelistedContracts,
address[] memory initialWhitelistedUsers,
address bondToken_,
uint256 initialQuota,
uint256 initialPeriod
) WhitelistPaymaster(admin, withdrawer) QuotaControl(initialQuota, initialPeriod, admin) {
if (whitelistAdmin != admin) {
_grantRole(WHITELIST_ADMIN_ROLE, whitelistAdmin);
}
bondToken = IERC20(bondToken_);

uint256 n = initialWhitelistedContracts.length;
for (uint256 i = 0; i < n; ++i) {
isWhitelistedContract[initialWhitelistedContracts[i]] = true;
}
if (n > 0) {
emit WhitelistedContractsAdded(initialWhitelistedContracts);
}
uint256 m = initialWhitelistedUsers.length;
for (uint256 j = 0; j < m; ++j) {
isWhitelistedUser[initialWhitelistedUsers[j]] = true;
}
if (m > 0) {
emit WhitelistedUsersAdded(initialWhitelistedUsers);
}

if (!isWhitelistedContract[address(this)]) {
isWhitelistedContract[address(this)] = true;
address[] memory selfDest = new address[](1);
selfDest[0] = address(this);
emit WhitelistedContractsAdded(selfDest);
}

uint256 m = initialWhitelistedUsers.length;
for (uint256 j = 0; j < m; ++j) {
isWhitelistedUser[initialWhitelistedUsers[j]] = true;
}
if (m > 0) {
emit WhitelistedUsersAdded(initialWhitelistedUsers);
}
}

/// @notice Validate whitelist + consume quota for a sponsored bond.
Expand Down
1 change: 1 addition & 0 deletions src/swarms/doc/spec/swarm-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,7 @@ address[] memory initialUsers = new address[](1);
initialUsers[0] = nodleSwarmOperator;
new BondTreasuryPaymaster(
admin,
whitelistAdmin,
withdrawer,
initialContracts,
initialUsers,
Expand Down
31 changes: 29 additions & 2 deletions test/paymasters/BondTreasuryPaymaster.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ contract SponsoredBondPuller {
contract MockBondTreasuryPaymaster is BondTreasuryPaymaster {
constructor(
address admin,
address whitelistAdmin,
address withdrawer,
address[] memory initialWhitelistedContracts,
address[] memory initialWhitelistedUsers,
Expand All @@ -51,6 +52,7 @@ contract MockBondTreasuryPaymaster is BondTreasuryPaymaster {
)
BondTreasuryPaymaster(
admin,
whitelistAdmin,
withdrawer,
initialWhitelistedContracts,
initialWhitelistedUsers,
Expand Down Expand Up @@ -130,6 +132,7 @@ contract BondTreasuryPaymasterTest is Test {
initialUsers[1] = admin;

paymaster = new MockBondTreasuryPaymaster(
admin,
admin,
withdrawer,
_initialContractWhitelist(address(fleet)),
Expand All @@ -154,6 +157,25 @@ contract BondTreasuryPaymasterTest is Test {
assertTrue(paymaster.hasRole(paymaster.WITHDRAWER_ROLE(), withdrawer));
}

function test_separateWhitelistAdmin() public {
address whitelistAdmin = address(0x3333);
MockBondTreasuryPaymaster pm = new MockBondTreasuryPaymaster(
admin,
whitelistAdmin,
withdrawer,
_initialContractWhitelist(address(fleet)),
_emptyAddresses(),
address(bondToken),
QUOTA,
PERIOD
);
assertTrue(pm.hasRole(pm.DEFAULT_ADMIN_ROLE(), admin));
assertTrue(pm.hasRole(pm.WHITELIST_ADMIN_ROLE(), admin));
assertTrue(pm.hasRole(pm.WHITELIST_ADMIN_ROLE(), whitelistAdmin));
assertTrue(pm.hasRole(pm.WITHDRAWER_ROLE(), withdrawer));
assertFalse(pm.hasRole(pm.DEFAULT_ADMIN_ROLE(), whitelistAdmin));
}

function test_immutables() public view {
assertEq(address(paymaster.bondToken()), address(bondToken));
}
Expand All @@ -173,6 +195,7 @@ contract BondTreasuryPaymasterTest is Test {

function test_constructorWithEmptyWhitelistedUsers() public {
MockBondTreasuryPaymaster pm = new MockBondTreasuryPaymaster(
admin,
admin,
withdrawer,
_initialContractWhitelist(address(fleet)),
Expand All @@ -193,7 +216,7 @@ contract BondTreasuryPaymasterTest is Test {
users[2] = charlie;

MockBondTreasuryPaymaster pm = new MockBondTreasuryPaymaster(
admin, withdrawer, _initialContractWhitelist(address(fleet)), users, address(bondToken), QUOTA, PERIOD
admin, admin, withdrawer, _initialContractWhitelist(address(fleet)), users, address(bondToken), QUOTA, PERIOD
);
assertTrue(pm.isWhitelistedUser(alice));
assertTrue(pm.isWhitelistedUser(bob));
Expand All @@ -208,13 +231,14 @@ contract BondTreasuryPaymasterTest is Test {
vm.expectEmit();
emit WhitelistPaymaster.WhitelistedUsersAdded(users);
new MockBondTreasuryPaymaster(
admin, withdrawer, _initialContractWhitelist(address(fleet)), users, address(bondToken), QUOTA, PERIOD
admin, admin, withdrawer, _initialContractWhitelist(address(fleet)), users, address(bondToken), QUOTA, PERIOD
);
}

function test_constructorEmptyUsersDoesNotEmitEvent() public {
vm.recordLogs();
new MockBondTreasuryPaymaster(
admin,
admin,
withdrawer,
_initialContractWhitelist(address(fleet)),
Expand Down Expand Up @@ -501,6 +525,7 @@ contract BondTreasuryPaymasterTest is Test {

function test_quotaTracksBaseBondNotClaimCount() public {
MockBondTreasuryPaymaster tightPaymaster = new MockBondTreasuryPaymaster(
admin,
admin,
withdrawer,
_initialContractWhitelist(address(fleet)),
Expand Down Expand Up @@ -581,6 +606,7 @@ contract BondTreasuryPaymasterTest is Test {
function test_RevertIf_constructorZeroPeriod() public {
vm.expectRevert(QuotaControl.ZeroPeriod.selector);
new MockBondTreasuryPaymaster(
admin,
admin,
withdrawer,
_initialContractWhitelist(address(fleet)),
Expand All @@ -594,6 +620,7 @@ contract BondTreasuryPaymasterTest is Test {
function test_RevertIf_constructorTooLongPeriod() public {
vm.expectRevert(QuotaControl.TooLongPeriod.selector);
new MockBondTreasuryPaymaster(
admin,
admin,
withdrawer,
_initialContractWhitelist(address(fleet)),
Expand Down
Loading