IRegeneratorPool
IRegeneratorPool
Interface for the RegeneratorPool contract, which handles token custody, distribution, and era-based logic for regenerators.
canWithdraw
function canWithdraw(uint256 era) external view returns (bool)
Checks if a regenerator is eligible to withdraw rewards for a given era.
Parameters
| Name | Type | Description |
|---|---|---|
| era | uint256 | The era number to check eligibility for. |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | bool | true if the regenerator can withdraw, false otherwise. |
withdraw
function withdraw(address user, uint256 era) external
Allows a user to withdraw their tokens for a specific era.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the regenerator withdrawing tokens. |
| era | uint256 | The era for which the withdrawal is being made. |
removePoolLevels
function removePoolLevels(address user, uint256 levelsToRemove, bool denied) external
Removes specified levels from a user's pool configuration.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the regenerator. |
| levelsToRemove | uint256 | Levels to be removed. |
| denied | bool | denied |
addLevel
function addLevel(address user, uint256 levels, uint64 eventId) external
Adds a new level to a user's pool configuration.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the regenerator. |
| levels | uint256 | The levels to be added. |
| eventId | uint64 |
currentContractEra
function currentContractEra() external view returns (uint256)
Returns the current era of the contract.
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | The current era number. |
nextEraIn
function nextEraIn(uint256 currentEra) external view returns (uint256)
Calculates the time or blocks remaining until the next era begins.
Parameters
| Name | Type | Description |
|---|---|---|
| currentEra | uint256 | The current era, passed as a parameter for calculation. |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | The number of seconds or blocks until the next era. |