ResearcherPool
ResearcherPool
This contract manages the distribution of Regeneration Credit tokens as rewards to researchers for their research and methodology improvement service provided. The reward is distributed related to the number of valid published researches.
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.
researcherRulesAddress
address researcherRulesAddress
The address of the ResearcherRules contract.
hasProcessedLevel
mapping(uint64 => 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 ResearcherPool contract. Sets up the Regeneration Credit token interface and initializes inherited base contracts.
Parameters
| Name | Type | Description |
|---|---|---|
| regenerationCreditAddress | address | The address of the RegenerationCredit token contract. |
| _halving | uint256 | The number of eras that constitute one halving cycle/epoch for reward adjustments. Passed to the Blockable base contract. |
| _blocksPerEra | uint256 | The number of blocks that constitute a single era. Passed to the Blockable base contract. |
setContractCall
function setContractCall(address _researcherRulesAddress) 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
| Name | Type | Description |
|---|---|---|
| _researcherRulesAddress | address | Address of DeveloperRules. |
withdraw
function withdraw(address delegate, uint256 era) external
This function can only be called by the ResearcherRules 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 Researcher contract, to trigger a token withdrawal for a user. This function calculates the eligible tokens for the user's era and transfers them.
Parameters
| Name | Type | Description |
|---|---|---|
| delegate | address | The address of the user (researcher) for whom the withdrawal is being processed. |
| era | uint256 | The last recorded era of the delegate user, used for reward calculation and eligibility. |
addLevel
function addLevel(address addr, uint256 levels, uint64 eventId) external
Can only be called by the researcherRules address.
Allows an authorized caller to increase the user pool level. This function updates the researcher level within the system's pooling mechanism.
Parameters
| Name | Type | Description |
|---|---|---|
| addr | address | The wallet address of the researcher. |
| levels | uint256 | The number of levels to increase the researcher's pool level by. |
| eventId | uint64 | The ID of the research being processed. |
removePoolLevels
function removePoolLevels(address addr, bool denied) external
Can only be called by researcherRules address.
Allows an authorized caller to decrease an researcher's pool level. This function adjusts the researcher's level downwards within the system's pooling mechanism.
Parameters
| Name | Type | Description |
|---|---|---|
| addr | address | The wallet address of the researcher. |
| denied | bool | Remove level user status. If true, user is being denied. |
haveTokensToWithdraw
function haveTokensToWithdraw(address delegate, uint256 era) public view returns (bool)
View function to check if a user have tokens to withdraw at an era.
Parameters
| Name | Type | Description |
|---|---|---|
| delegate | address | User address. |
| era | uint256 | User current era. |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | bool | bool True if have tokens to withdraw, false if will just update era. |