Skip to main content

IStakedOverlayerWrap

Defines core staking functionality and rewards management

RewardsReceived​

event RewardsReceived(uint256 amount)

Event emitted when the rewards are received

Received​

event Received(address sender, uint256 amount)

Event emitted when the contract receives ETH

NativeRescued​

event NativeRescued(address to, uint256 amount)

Event emitted when native tokens are rescued from the contract

LockedAmountRedistributed​

event LockedAmountRedistributed(address from, address to, uint256 amount)

Event emitted when the balance from an WHOLE_RESTRICTED_ROLE user are redistributed

StakedOverlayerWrapWithdrawAaveDuringCompoundSet​

event StakedOverlayerWrapWithdrawAaveDuringCompoundSet(bool enabled)

Event emitted when a new value for aave withdraw during compound is set

BlacklistTimeSet​

event BlacklistTimeSet(uint256 time)

Event emitted when the blacklist timestamp is set

OverlayerWrapBackingSet​

event OverlayerWrapBackingSet(address backing)

Event emitted when the overlayerWrap backing contract is set

ProposedOverlayerWrapBacking​

event ProposedOverlayerWrapBacking(address backing, uint256 proposedAt)

Event emitted when a new overlayerWrap backing is proposed

OvaStakedOverlayerWrapBlackListTimeUpdated​

event OvaStakedOverlayerWrapBlackListTimeUpdated(uint256 previous, uint256 current)

Event emitted when the blacklist timestamp is updated

OvaStakedOverlayerWrapRedistributionTimeUpdated​

event OvaStakedOverlayerWrapRedistributionTimeUpdated(uint256 previous, uint256 current)

Event emitted when the redistribution timestamp is updated

TokenRescued​

event TokenRescued(address token, address to, uint256 amount)

Emitted when ERC20 tokens are rescued from the contract

StakedOverlayerWrapInvalidAmount​

error StakedOverlayerWrapInvalidAmount()

Error emitted shares or assets equal zero.

StakedOverlayerWrapInvalidToken​

error StakedOverlayerWrapInvalidToken()

Error emitted when owner attempts to rescue OverlayerWrap tokens.

StakedOverlayerWrapMinSharesViolation​

error StakedOverlayerWrapMinSharesViolation()

Error emitted when a small non-zero share amount remains, which risks donations attack

StakedOverlayerWrapOperationNotAllowed​

error StakedOverlayerWrapOperationNotAllowed()

Error emitted when owner is not allowed to perform an operation

StakedOverlayerWrapStillVesting​

error StakedOverlayerWrapStillVesting()

Error emitted when there is still unvested amount

StakedOverlayerWrapCantBlacklistOwner​

error StakedOverlayerWrapCantBlacklistOwner()

Error emitted when owner or blacklist manager attempts to blacklist owner

StakedOverlayerWrapInvalidZeroAddress​

error StakedOverlayerWrapInvalidZeroAddress()

Error emitted when the zero address is given

StakedOverlayerWrapCannotBlacklist​

error StakedOverlayerWrapCannotBlacklist()

Error emitted when blakclist time is not respected

StakedOverlayerWrapCannotRedistribute​

error StakedOverlayerWrapCannotRedistribute()

Error emitted when redistribute time is not respected

StakedOverlayerWrapInvalidTime​

error StakedOverlayerWrapInvalidTime()

Error emitted when blakclist time is not valid

StakedOverlayerWrapRescueFailed​

error StakedOverlayerWrapRescueFailed()

Error emitted when native asset rescue call fails

StakedOverlayerWrapBackingChangeDelayNotRespected​

error StakedOverlayerWrapBackingChangeDelayNotRespected()

Error emitted when backing change timelock delay has not elapsed

StakedOverlayerWrapCannotDirectlyAssignBlacklist​

error StakedOverlayerWrapCannotDirectlyAssignBlacklist()

Cannot directly grant or revoke blacklist roles via grantRole/revokeRole

transferInRewards​

function transferInRewards(uint256 amount) external

Transfers rewards to the staking contract

Parameters​

NameTypeDescription
amountuint256Amount of rewards to transfer

rescue​

function rescue(address token, uint256 amount, address to) external

Allows rescue of tokens accidentally sent to the contract

Parameters​

NameTypeDescription
tokenaddressAddress of the token to rescue
amountuint256Amount of tokens to rescue
toaddressAddress to receive the rescued tokens
Last updated on