Skip to main content

ValidationPool

ValidationPool​

This contract manages the distribution of Regeneration Credit tokens as rewards to validators.

Inherits core functionalities from Poolable (for pool management), Ownable (for deploy setup only), Blockable (for era/epoch tracking), and Callable (for whitelisted caller control).

regenerationCredit​

contract IRegenerationCredit regenerationCredit

Interface to the Regeneration Credit token contract, used to decrease total locked.

validationRulesAddress​

address validationRulesAddress

The address of the ValidationRules contract.

hasProcessedLevel​

mapping(address => bool) hasProcessedLevel

Tracks unique resource IDs to ensure levels for a resource are added only once.

constructor​

constructor(address regenerationCreditAddress, uint256 _halving, uint256 _blocksPerEra) public

Initializes the ValidationPool contract. Sets up the Regeneration Credit token interface and initializes inherited base contracts.

Parameters​

NameTypeDescription
regenerationCreditAddressaddressThe address of the RegenerationCredit token contract.
_halvinguint256The number of eras that constitute one halving cycle/epoch for reward adjustments. Passed to the Blockable base contract.
_blocksPerErauint256The number of blocks that constitute a single era. Passed to the Blockable base contract.

setContractCall​

function setContractCall(address _validationRulesAddress) external

onlyOwner function to set contract call addresses. This function must be called only once after the contract deploy and ownership must be renounced.

Parameters​

NameTypeDescription
_validationRulesAddressaddressAddress of ValidationRules.

withdraw​

function withdraw(address delegate, uint256 era) external

This function can only be called by the ValidationRules contract, whitelisted via the Callable contract's mechanisms. The user must also be eligible for withdrawal based on the Blockable contract's era tracking.

Allows an authorized caller, the Validation contract, to trigger a token withdrawal for a user. This function calculates the eligible tokens for the user's era and transfers them.

Parameters​

NameTypeDescription
delegateaddressThe address of the user (validation) for whom the withdrawal is being processed.
erauint256The last recorded era of the delegate user, used for reward calculation and eligibility.

addLevel​

function addLevel(address addr, address denied) external

Can only be called by the validationRules address.

Allows an authorized caller to increase the user pool level. This function updates the validation level within the system's pooling mechanism.

Parameters​

NameTypeDescription
addraddressThe wallet address of the validation.
deniedaddressThe address of the denied user.

addPointsLevel​

function addPointsLevel(address addr) external

Can only be called by the validationRules address.

Allows an authorized caller to increase the user pool level. This function updates the validation level within the system's pooling mechanism.

Parameters​

NameTypeDescription
addraddressThe wallet address of the validation.

haveTokensToWithdraw​

function haveTokensToWithdraw(address delegate, uint256 era) external view returns (bool)

View function to check if a user have tokens to withdraw at an era.

Parameters​

NameTypeDescription
delegateaddressUser address.
erauint256User current era.

Return Values​

NameTypeDescription
[0]boolbool True if have tokens to withdraw, false if will just update era.