Idle Finance
WebsiteGithubTwitterDiscord
Search…
📥
Introduction
👇
Get in touch
🌀
Products
Introduction
Best Yield
Perpetual Yield Tranches
Fee structure
Integration Partners programs
💻
Developers
Introduction
Networks and codebase
Best Yield
Architecture
Deployed contracts
Interface
Methods
mintIdleToken
redeemIdleToken
redeemInterestBearingTokens
rebalance
tokenPrice
tokenPriceWithFee
getAPRs
getAvgApr
userAvgPrices
getGovTokensAmounts
getAllocations
getGovTokens
getAllAvailableTokens
getProtocolTokenToGov
Edge cases
Security management policy
Get integrated as yield source
Get user earnings
Perpetual Yield Tranches
Gauges
Security
🏛
Governance
Introduction
Idle DAO
$IDLE token
$IDLE staking
Idle Grants Program
🗂
Other
Guides
FAQs
Glossary
Resources
Archive
Powered By GitBook
redeemIdleToken
Developers > Best Yield strategy > redeemIdleToken
With this method, users can redeem their underlying balance by burning $IDLE tokens. We calculate the pool share one can withdraw given the amount of $IDLE tokens they want to burn and redeem the corresponding underlying amount from each lending protocol currently used (if the unlent pool is not sufficient). We then send the underlying to the msg.sender .
With this call also governance tokens accrued by a user will be redeemed and sent to the user. This method can be called with _amount equal to 0 in order to redeem governance tokens only and maintain the position in Idle.

Function

1
function redeemIdleToken(
2
uint256 _amount
3
) external returns (uint256 redeemedTokens);
Copied!

Parameters

Parameter
Description
_amount
The amount of $IDLE tokens to be burned

Return values

Value
Description
redeemedTokens
The amount of underlying tokens redeemed
Previous
mintIdleToken
Next
redeemInterestBearingTokens
Last modified 3mo ago
Copy link
Contents
Function
Parameters
Return values