Redeem with Underlying
The redeem underlying function converts qTokens into a specified quantity of the underlying asset, and returns them to the user. The amount of qTokens redeemed is equal to the quantity of underlying tokens received, divided by the current Exchange Rate. The amount redeemed must be less than the user's Account Liquidity and the market's available liquidity.
function redeemUnderlying(address qToken, uint underlyingAmount) external returns (uint redeemed);
- msg.sender: The account to which redeemed funds shall be transferred.
- qToken: The address of the qToken market to redeem.
- underlyingAmount: The amount of underlying to be redeemed.
- RETURN: The amount of underlying redeemed.
Qore qore = Qore(<qoreAddress>);
uint redeemed = qore.redeemUnderlying(<qTokenAddress>, <underlyingAmount>);
const qore = await ethers.getContractAt(<qoreABI>, <qoreAddress>);
const redeemed = await qore.redeemUnderlying(<qTokenAddress>, <underlyingAmount>);