Skip to main content

StakedOverlayerWrap

Public interface for staking OverlayerWrap tokens following the ERC4626 standard

withdrawAaveDuringCompound​

bool withdrawAaveDuringCompound

Flag to control Aave withdrawal during compound operations

constructor​

constructor(contract IERC20 asset_, address initialRewarder_, address admin_) public

Constructor for StakedOverlayerWrap

Parameters​

NameTypeDescription
asset_contract IERC20The OverlayerWrap token contract address
initialRewarder_addressAddress authorized to distribute rewards
admin_addressContract administrator address

mint​

function mint(uint256 shares_, address receiver_) public virtual returns (uint256)

See {IERC4626-mint}.

deposit​

function deposit(uint256 assets_, address receiver_) public virtual returns (uint256)

See {IERC4626-deposit}.

withdraw​

function withdraw(uint256 assets_, address receiver_, address owner_) public virtual returns (uint256)

See {IERC4626-withdraw}.

redeem​

function redeem(uint256 shares_, address receiver_, address owner_) public virtual returns (uint256)

See {IERC4626-redeem}.

_compound​

function _compound() internal

Compounds yield from the overlayerWrap backing contract, reverting on failures

setWithdrawAaveDuringCompound​

function setWithdrawAaveDuringCompound(bool doWithdraw_) external

Controls whether Aave tokens should be withdrawn during compound operations

Can only be called by contract admin

Parameters​

NameTypeDescription
doWithdraw_boolTrue to enable Aave withdrawals, false to disable