The AAVE token can also be staked in the Safety Module, a core part of Aavenomics. By staking AAVE in the Safety Module, users help protect the protocol from a short fall event and earn an incentive as a result.
The source code for the Safety Module, which includes the Staked AAVE token, can be found on Github here.
To perform AAVE staking in your integration, the following steps should be followed:
If they still have LEND, then the LEND tokens need to be migrated. See the LEND to AAVE migration guide of the V1 docs.
The user must first
approve() the amount for the
Staked AAVE contract to stake.
The user should call
stake(), passing in their address and the amount to stake.
After a period of time, the user will accrue rewards. To check the rewards accrued for a certain user, call
getTotalRewardsBalance() to fetch the pending rewards. To claim the rewards, call
To un-stake, a user must first activate the cool down timer, wait for the cool down time to elapse, then redeem their staked tokens.
To activate the cool down timer, call
When the cool down has finished, the user will have a maximum
UNSTAKE_WINDOW() of time to redeem their tokens. If they do not redeem before this time period has elapsed, then the cool down timer is reset and they will need to activate the cool down again.
The final step to un-stake it to call
When a user stakes AAVE in the Safety Module, the user receives an equivalent amount of stkAAVE in return, and starts accruing rewards in AAVE. The user is then able to claim the rewards at anytime. To withdraw their staked AAVE, the user needs to activate a
coolDown() period, as detailed below.
function stake(address onBehalfOf, uint256 amount) - code
Stakes a certain amount of AAVE tokens, with the option of sending the staked AAVE tokens (stkAAVE) to another address (i.e. the
msg.sender must already have a balance of AAVE token.
The address which will receive the stkAAVE tokens. Use
The amount of AAVE to be staked
function claimRewards(address to, uint256 amount) - code
amount of AAVE rewards that the
msg.sender has accrued, with the option of sending the rewards to a different account.
The address which will receive the AAVE tokens rewards. Use
The amount of AAVE to be claimed. Use
function redeem(address to, uint256 amount) - code
Redeems the staked tokens - receiving AAVE tokens and burning stkAAVE tokens.
The address which will receive the redeemed AAVE tokens. Use
The amount of AAVE to be redeemed. Use
function cooldown() - code
Activates the cool down timer to be able to unstake.
getNextCooldownTimestamp() for example cool down periods and scenarios.
function stakersCooldowns(address staker) view returns uint - code
Returns the unix timestamp in seconds for when the
staker activated the cool down by calling
A staker is able to successfully unstake when this value +
COOLDOWN_SECONDS in unix time has passed.
function COOLDOWN_SECONDS() view returns uint - code
Returns the current minimum cool down time needed to elapse before a staker is able to unstake their tokens.
As of October 2020, the current
COOLDOWN_SECONDS value is 864000 seconds (i.e. 10 days). This value should always be checked directly from the contracts.
function UNSTAKE_WINDOW() view returns uint - code
As of October 2020, the current
UNSTAKE_WINDOW value is 172800 seconds (i.e. 2 days). This value should always be checked directly from the contracts.
function getNextCooldownTimestamp(uint256 fromCooldownTimestamp, uint256 amountToReceive, address toAddress, uint256 toBalance) public returns (uint256) - code
Calculates the cool down timestamp based on the sender / receiver timestamps.
A user stakes AAVE for the first time. Their cool down time is set to the current block timestamp.
A user already has stkAAVE and decides to stake more AAVE (i.e. call
stake()), while they already have a cool down period active:
If the cool down is expired (e.g. beyond the
UNSTAKE_WINDOW), then the cool down period will remain expired.
If the cool down period is still valid, using the amount staked and and the current block timestamp, a weighted average is calculated with the current cool down timestamp of the user.
A user calls
redeem(). This will reset the cool down timestamp.
A user calls
claimRewards(). The cool down timestamp is not affected.
A user transfers (i.e. sends) stkAAVE to another address:
The cool down timestamp of the
msg.sender remains the same.
For the receiver of the stkAAVE:
If they have a valid cool down period finishing before the cool down period of the
msg.sender, a weighted average is calculated with the current cool down timestamp of the user.
If the receiver has an expired cool down timestamp, the cool down timestamp is reset.
If both the receiver and
msg.sender have valid cool down periods, and the
msg.sender cool down period ends before the receiver, then the receiver's cool down period remains the same.
The cool down timestamp of the sender
The amount of stkAAVE tokens to be sent
The receiver's address
The current stkAAVE balance of the receiver
function getTotalRewardsBalance(address staker) external view returns (uint256) - code
Returns the total rewards that are pending to be claimed by a staker.
The staker's address
To calculate the APR (as shown in the client UI), simply use:
seconds in a year /
To get the
emissionsPerSecond, go to the stkAAVE contract and under
assets() input the stkAave address.
current stakes, fetch the
balanceOf() the stkAAVE contract for the AAVE token.