Skip to content

Commit

Permalink
Merge pull request #1 from dean65/bep-131
Browse files Browse the repository at this point in the history 
[R4R] Implement bep 131
  • Loading branch information
@dean65
dean65 authored Mar 2, 2022
2 parents 1dd4ce1 + c98f24c commit 381c1f9
Show file tree
Hide file tree
Showing 4 changed files with 307 additions and 41 deletions.
80 changes: 73 additions & 7 deletions contracts/BSCValidatorSet.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
uint32 public constant ERROR_LEN_OF_VAL_MISMATCH = 103;
uint32 public constant ERROR_RELAYFEE_TOO_LARGE = 104;

uint256 public constant INIT_NUM_OF_CABINETS = 21;
uint256 public constant EPOCH = 200;

/*********************** state of the contract **************************/
Validator[] public currentValidatorSet;
Expand Down Expand Up @@ -67,6 +69,10 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
// Corresponds strictly to currentValidatorSet
// validatorExtraSet[index] = the `ValidatorExtra` info of currentValidatorSet[index]
ValidatorExtra[] public validatorExtraSet;
// BEP-131 candidate validator
uint256 public numOfCabinets;
uint256 public maxNumOfCandidates;
uint256 public maxNumOfWorkingCandidates;

struct Validator{
address consensusAddress;
Expand Down Expand Up @@ -354,7 +360,46 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
return CODE_OK;
}

function getValidators() public view returns (address[] memory) {
function shuffle(address[] memory validators, uint256 epochNumber, uint startIdx, uint offset, uint limit, uint modNumber) internal pure {
for (uint i = 0; i<limit; i++) {
uint random = uint(keccak256(abi.encodePacked(epochNumber, startIdx+i))) % modNumber;
if ( (startIdx+i) != (offset+random) ) {
address tmp = validators[startIdx+i];
validators[startIdx+i] = validators[offset+random];
validators[offset+random] = tmp;
}
}
}

function getMiningValidators() public view returns(address[] memory) {
uint256 _maxNumOfWorkingCandidates = maxNumOfWorkingCandidates;
uint256 _numOfCabinets = numOfCabinets;
if (_numOfCabinets == 0 ){
_numOfCabinets = INIT_NUM_OF_CABINETS;
}

address[] memory validators = getValidators();
if (validators.length <= _numOfCabinets) {
return validators;
}

if ((validators.length - _numOfCabinets) < _maxNumOfWorkingCandidates){
_maxNumOfWorkingCandidates = validators.length - _numOfCabinets;
}
if (_maxNumOfWorkingCandidates > 0) {
uint256 epochNumber = block.number / EPOCH;
shuffle(validators, epochNumber, _numOfCabinets-_maxNumOfWorkingCandidates, 0, _maxNumOfWorkingCandidates, _numOfCabinets);
shuffle(validators, epochNumber, _numOfCabinets-_maxNumOfWorkingCandidates, _numOfCabinets-_maxNumOfWorkingCandidates,
_maxNumOfWorkingCandidates, validators.length-_numOfCabinets+_maxNumOfWorkingCandidates);
}
address[] memory miningValidators = new address[](_numOfCabinets);
for (uint i=0;i<_numOfCabinets;i++) {
miningValidators[i] = validators[i];
}
return miningValidators;
}

function getValidators() public view returns(address[] memory) {
uint n = currentValidatorSet.length;
uint valid = 0;
for (uint i = 0;i<n;i++) {
Expand Down Expand Up @@ -500,6 +545,24 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
uint256 newMaintainSlashScale = BytesToTypes.bytesToUint256(32, value);
require(newMaintainSlashScale > 0, "the maintainSlashScale must be greater than 0");
maintainSlashScale = newMaintainSlashScale;
} else if (Memory.compareStrings(key, "maxNumOfWorkingCandidates")) {
require(value.length == 32, "length of maxNumOfWorkingCandidates mismatch");
uint256 newMaxNumOfWorkingCandidates = BytesToTypes.bytesToUint256(32, value);
require(newMaxNumOfWorkingCandidates <= maxNumOfCandidates, "the maxNumOfWorkingCandidates must be not greater than maxNumOfCandidates");
maxNumOfWorkingCandidates = newMaxNumOfWorkingCandidates;
} else if (Memory.compareStrings(key, "maxNumOfCandidates")) {
require(value.length == 32, "length of maxNumOfCandidates mismatch");
uint256 newMaxNumOfCandidates = BytesToTypes.bytesToUint256(32, value);
maxNumOfCandidates = newMaxNumOfCandidates;
if (maxNumOfWorkingCandidates > maxNumOfCandidates) {
maxNumOfWorkingCandidates = maxNumOfCandidates;
}
} else if (Memory.compareStrings(key, "numOfCabinets")) {
require(value.length == 32, "length of numOfCabinets mismatch");
uint256 newNumOfCabinets = BytesToTypes.bytesToUint256(32, value);
require(newNumOfCabinets > 0, "the numOfCabinets must be greater than 0");
require(newNumOfCabinets <= MAX_NUM_OF_VALIDATORS, "the numOfCabinets must be less than MAX_NUM_OF_VALIDATORS");
numOfCabinets = newNumOfCabinets;
} else {
require(false, "unknown param");
}
Expand Down Expand Up @@ -620,13 +683,13 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica

// remove the validator from currentValidatorSet
delete currentValidatorSetMap[validator];
// It is ok that the validatorSet is not in order.
if (index != currentValidatorSet.length - 1) {
currentValidatorSet[index] = currentValidatorSet[currentValidatorSet.length - 1];
validatorExtraSet[index] = validatorExtraSet[currentValidatorSet.length - 1];

currentValidatorSetMap[currentValidatorSet[index].consensusAddress] = index + 1;
// remove felony validator
for (uint i = index;i < (currentValidatorSet.length-1);i++) {
currentValidatorSet[i] = currentValidatorSet[i+1];
validatorExtraSet[i] = validatorExtraSet[i+1];
currentValidatorSetMap[currentValidatorSet[i].consensusAddress] = i+1;
}

currentValidatorSet.pop();
validatorExtraSet.pop();

Expand Down Expand Up @@ -693,6 +756,9 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica

function _exitMaintenance(address validator, uint index) private returns (bool isFelony){
uint256 workingValidatorCount = getValidators().length;
if (workingValidatorCount>numOfCabinets) {
workingValidatorCount = numOfCabinets;
}
if (maintainSlashScale == 0 || workingValidatorCount == 0 || numOfMaintaining == 0) {
// should not happen, still protect
return false;
Expand Down
79 changes: 72 additions & 7 deletions contracts/BSCValidatorSet.template
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
uint32 public constant ERROR_LEN_OF_VAL_MISMATCH = 103;
uint32 public constant ERROR_RELAYFEE_TOO_LARGE = 104;

uint256 public constant INIT_NUM_OF_CABINETS = 21;
uint256 public constant EPOCH = 200;

/*********************** state of the contract **************************/
Validator[] public currentValidatorSet;
Expand Down Expand Up @@ -67,6 +69,10 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
// Corresponds strictly to currentValidatorSet
// validatorExtraSet[index] = the `ValidatorExtra` info of currentValidatorSet[index]
ValidatorExtra[] public validatorExtraSet;
// BEP-131 candidate validator
uint256 public numOfCabinets;
uint256 public maxNumOfCandidates;
uint256 public maxNumOfWorkingCandidates;

struct Validator{
address consensusAddress;
Expand Down Expand Up @@ -354,7 +360,46 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
return CODE_OK;
}

function getValidators() public view returns (address[] memory) {
function shuffle(address[] memory validators, uint256 epochNumber, uint startIdx, uint offset, uint limit, uint modNumber) internal pure {
for (uint i = 0; i<limit; i++) {
uint random = uint(keccak256(abi.encodePacked(epochNumber, startIdx+i))) % modNumber;
if ( (startIdx+i) != (offset+random) ) {
address tmp = validators[startIdx+i];
validators[startIdx+i] = validators[offset+random];
validators[offset+random] = tmp;
}
}
}

function getMiningValidators() public view returns(address[] memory) {
uint256 _maxNumOfWorkingCandidates = maxNumOfWorkingCandidates;
uint256 _numOfCabinets = numOfCabinets;
if (_numOfCabinets == 0 ){
_numOfCabinets = INIT_NUM_OF_CABINETS;
}

address[] memory validators = getValidators();
if (validators.length <= _numOfCabinets) {
return validators;
}

if ((validators.length - _numOfCabinets) < _maxNumOfWorkingCandidates){
_maxNumOfWorkingCandidates = validators.length - _numOfCabinets;
}
if (_maxNumOfWorkingCandidates > 0) {
uint256 epochNumber = block.number / EPOCH;
shuffle(validators, epochNumber, _numOfCabinets-_maxNumOfWorkingCandidates, 0, _maxNumOfWorkingCandidates, _numOfCabinets);
shuffle(validators, epochNumber, _numOfCabinets-_maxNumOfWorkingCandidates, _numOfCabinets-_maxNumOfWorkingCandidates,
_maxNumOfWorkingCandidates, validators.length-_numOfCabinets+_maxNumOfWorkingCandidates);
}
address[] memory miningValidators = new address[](_numOfCabinets);
for (uint i=0;i<_numOfCabinets;i++) {
miningValidators[i] = validators[i];
}
return miningValidators;
}

function getValidators() public view returns(address[] memory) {
uint n = currentValidatorSet.length;
uint valid = 0;
for (uint i = 0;i<n;i++) {
Expand Down Expand Up @@ -500,6 +545,24 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica
uint256 newMaintainSlashScale = BytesToTypes.bytesToUint256(32, value);
require(newMaintainSlashScale > 0, "the maintainSlashScale must be greater than 0");
maintainSlashScale = newMaintainSlashScale;
} else if (Memory.compareStrings(key, "maxNumOfWorkingCandidates")) {
require(value.length == 32, "length of maxNumOfWorkingCandidates mismatch");
uint256 newMaxNumOfWorkingCandidates = BytesToTypes.bytesToUint256(32, value);
require(newMaxNumOfWorkingCandidates <= maxNumOfCandidates, "the maxNumOfWorkingCandidates must be not greater than maxNumOfCandidates");
maxNumOfWorkingCandidates = newMaxNumOfWorkingCandidates;
} else if (Memory.compareStrings(key, "maxNumOfCandidates")) {
require(value.length == 32, "length of maxNumOfCandidates mismatch");
uint256 newMaxNumOfCandidates = BytesToTypes.bytesToUint256(32, value);
maxNumOfCandidates = newMaxNumOfCandidates;
if (maxNumOfWorkingCandidates > maxNumOfCandidates) {
maxNumOfWorkingCandidates = maxNumOfCandidates;
}
} else if (Memory.compareStrings(key, "numOfCabinets")) {
require(value.length == 32, "length of numOfCabinets mismatch");
uint256 newNumOfCabinets = BytesToTypes.bytesToUint256(32, value);
require(newNumOfCabinets > 0, "the numOfCabinets must be greater than 0");
require(newNumOfCabinets <= MAX_NUM_OF_VALIDATORS, "the numOfCabinets must be less than MAX_NUM_OF_VALIDATORS");
numOfCabinets = newNumOfCabinets;
} else {
require(false, "unknown param");
}
Expand Down Expand Up @@ -620,12 +683,11 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica

// remove the validator from currentValidatorSet
delete currentValidatorSetMap[validator];
// It is ok that the validatorSet is not in order.
if (index != currentValidatorSet.length - 1) {
currentValidatorSet[index] = currentValidatorSet[currentValidatorSet.length - 1];
validatorExtraSet[index] = validatorExtraSet[currentValidatorSet.length - 1];

currentValidatorSetMap[currentValidatorSet[index].consensusAddress] = index + 1;
// remove felony validator
for (uint i = index;i < (currentValidatorSet.length-1);i++) {
currentValidatorSet[i] = currentValidatorSet[i+1];
validatorExtraSet[i] = validatorExtraSet[i+1];
currentValidatorSetMap[currentValidatorSet[i].consensusAddress] = i+1;
}
currentValidatorSet.pop();
validatorExtraSet.pop();
Expand Down Expand Up @@ -693,6 +755,9 @@ contract BSCValidatorSet is IBSCValidatorSet, System, IParamSubscriber, IApplica

function _exitMaintenance(address validator, uint index) private returns (bool isFelony){
uint256 workingValidatorCount = getValidators().length;
if (workingValidatorCount > numOfCabinets) {
workingValidatorCount = numOfCabinets;
}
if (maintainSlashScale == 0 || workingValidatorCount == 0 || numOfMaintaining == 0) {
// should not happen, still protect
return false;
Expand Down
Loading

0 comments on commit 381c1f9

Please sign in to comment.