Skip to content
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.

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

fix(evm-contracts): sort validators by voteBalance DESC, address ASC #812

Merged
merged 5 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 contracts/src/consensus/ConsensusV1.sol
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,7 @@ contract ConsensusV1 is UUPSUpgradeable, OwnableUpgradeable {

function _isGreater(Validator memory validatorA, Validator memory validatorB) internal pure returns (bool) {
if (validatorA.data.voteBalance == validatorB.data.voteBalance) {
return validatorA.addr > validatorB.addr;
return validatorA.addr < validatorB.addr;
}

return validatorA.data.voteBalance > validatorB.data.voteBalance;
Expand Down
4 changes: 2 additions & 2 deletions contracts/test/consensus/Base.sol
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ contract Base is Test {
for (uint256 i = 0; i < length; i++) {
for (uint256 j = i + 1; j < length; j++) {
// Sort in descending order by votersCount
if (_isGreater(validators[i], validators[j])) {
if (!_isGreater(validators[i], validators[j])) {
ConsensusV1.Validator memory temp = validators[i];
validators[i] = validators[j];
validators[j] = temp;
Expand All @@ -52,7 +52,7 @@ contract Base is Test {
returns (bool)
{
if (validatorA.data.voteBalance == validatorB.data.voteBalance) {
return validatorA.addr > validatorB.addr;
return validatorA.addr < validatorB.addr;
}

return validatorA.data.voteBalance > validatorB.data.voteBalance;
Expand Down
60 changes: 54 additions & 6 deletions contracts/test/consensus/Consensus-CalculateTop.sol
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,52 @@ contract ConsensusTest is Base {
assertEq(validators[1].addr, addr); // Second validator is duplicated
}

function test_consensus_sortedValidators_sameVoteCounts() public {
vm.pauseGasMetering();
assertEq(consensus.registeredValidatorsCount(), 0);

uint256 n = 55;
uint256 balance = 50;
for (uint256 i = 0; i < n; i++) {
address addr = address(uint160(i + 1));
vm.deal(addr, balance);
vm.startPrank(addr);

if (balance > 0) {
balance -= 1; // the last spots share same number of votes
}

consensus.registerValidator(prepareBLSKey(addr));
consensus.vote(addr);
vm.stopPrank();
}

vm.resumeGasMetering();

uint160 activeValidators = 53;

consensus.calculateActiveValidators(uint8(activeValidators));
ConsensusV1.Validator[] memory validators = consensus.getActiveValidators();

for (uint256 i = 0; i < activeValidators; i++) {
ConsensusV1.Validator memory validator = validators[i];

// all addresses are below 0x35 (53) since they are sorted ascending if vote balance is equal.
assertEq(validator.addr <= address(0x35), true);
}

validators = sortValidators(validators);
assertEq(validators.length, activeValidators);

// highest voter balance at top (lowest address)
assertEq(validators[0].addr, address(0x01));
assertEq(validators[0].data.voteBalance, uint256(50));

// lowest voter balance at bottom (lowest address)
assertEq(validators[activeValidators - 1].addr, address(0x35));
assertEq(validators[activeValidators - 1].data.voteBalance, uint256(0));
}

function test_consensus_200_topValidators() public {
vm.pauseGasMetering();
assertEq(consensus.registeredValidatorsCount(), 0);
Expand All @@ -106,7 +152,7 @@ contract ConsensusTest is Base {
vm.deal(addr, balance);

if (balance == highestBalance) {
if (addr > highest) {
if (addr < highest || highest == address(0)) {
highest = addr;
}
}
Expand All @@ -131,17 +177,19 @@ contract ConsensusTest is Base {
ConsensusV1.Validator[] memory validators = consensus.getActiveValidators();
assertEq(validators.length, activeValidators);

assertEq(validators[activeValidators - 1].addr, address(0xAE)); // Shuffled address
assertEq(validators[activeValidators - 1].addr, address(0x1B)); // Shuffled address
validators = sortValidators(validators);
assertEq(validators[activeValidators - 1].addr, highest);
assertEq(validators[0].addr, highest);
assertEq(validators[activeValidators - 1].addr, address(53));

// Seccond attempt shoudl return the same result
// Second attempt should return the same result
consensus.calculateActiveValidators(uint8(activeValidators));

validators = consensus.getActiveValidators();
assertEq(validators[activeValidators - 1].addr, address(0xAE)); // Shuffled address
assertEq(validators[activeValidators - 1].addr, address(0x1B)); // Shuffled address
validators = sortValidators(validators);
assertEq(validators.length, activeValidators);
assertEq(validators[activeValidators - 1].addr, highest);
assertEq(validators[0].addr, highest);
assertEq(validators[activeValidators - 1].addr, address(53));
}
}
Loading
Loading