Instadapp/aave-protocol-v2
1
0
Fork 0
mirror of https://github.com/Instadapp/aave-protocol-v2.git synced 2024-07-29 21:47:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Clean comments in StaticAtokenLM

Browse Source
This commit is contained in:
Lasse Herskind 2021-06-01 12:29:20 +02:00
parent 70e49ba127
commit 9010a5e0d3
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
contracts/protocol/tokenization/StaticATokenLM.sol
View File

@ -13,6 +13,14 @@ import {WadRayMath} from '../../protocol/libraries/math/WadRayMath.sol';
import {RayMathNoRounding} from '../../protocol/libraries/math/RayMathNoRounding.sol'; import {RayMathNoRounding} from '../../protocol/libraries/math/RayMathNoRounding.sol';
import {SafeMath} from '../../dependencies/openzeppelin/contracts/SafeMath.sol'; import {SafeMath} from '../../dependencies/openzeppelin/contracts/SafeMath.sol';
/**
* @title StaticATokenLM
* @dev Wrapper token that allows to deposit tokens on the Aave protocol and receive
* a token which balance doesn't increase automatically, but uses an ever-increasing exchange rate.
* The token support claiming liquidity mining rewards from the Aave system.
* @author Aave
**/
contract StaticATokenLM is ERC20 { contract StaticATokenLM is ERC20 {
using SafeERC20 for IERC20; using SafeERC20 for IERC20;
using SafeMath for uint256; using SafeMath for uint256;
@ -45,14 +53,12 @@ contract StaticATokenLM is ERC20 {
mapping(address => uint256) public _nonces; mapping(address => uint256) public _nonces;
// Handling Liquidity Mining incentives. Unclear how we can handle multiple reward assets
uint256 public accRewardstokenPerShare; uint256 public accRewardstokenPerShare;
uint256 public lastRewardBlock; uint256 public lastRewardBlock;
mapping(address => uint256) public rewardDebts; //Rays mapping(address => uint256) public rewardDebts; // Measured in Rays
mapping(address => uint256) public unclaimedRewards; //Rays mapping(address => uint256) public unclaimedRewards; // Measured in Rays
IAaveIncentivesController internal _incentivesController; IAaveIncentivesController internal _incentivesController;
// TODO: Implement the ability to change this. Should probably be a list of the reward tokens, [first, second, third...], where we can loop backwards to see if a user gas been there since before a change.
address public immutable currentRewardToken; address public immutable currentRewardToken;
constructor( constructor(
@ -66,7 +72,7 @@ contract StaticATokenLM is ERC20 {
IERC20 underlyingAsset = IERC20(IAToken(aToken).UNDERLYING_ASSET_ADDRESS()); IERC20 underlyingAsset = IERC20(IAToken(aToken).UNDERLYING_ASSET_ADDRESS());
ASSET = underlyingAsset; ASSET = underlyingAsset;
underlyingAsset.approve(address(lendingPool), type(uint256).max); // Could an attacker max this out with flashminting or so? underlyingAsset.approve(address(lendingPool), type(uint256).max);
_incentivesController = IAToken(aToken).getIncentivesController(); _incentivesController = IAToken(aToken).getIncentivesController();
currentRewardToken = _incentivesController.REWARD_TOKEN(); currentRewardToken = _incentivesController.REWARD_TOKEN();
@ -460,7 +466,7 @@ contract StaticATokenLM is ERC20 {
} }
/** /**
* @dev Update the rewards and claim rewards * @dev Update the rewards and claim rewards for the user
* @param user The address of the user to claim rewards for * @param user The address of the user to claim rewards for
*/ */
function updateAndClaimRewards(address user) public { function updateAndClaimRewards(address user) public {
@ -531,7 +537,7 @@ contract StaticATokenLM is ERC20 {
} }
/** /**
* @dev Get the total claimable rewards for a user in WAD * @dev Get the total claimable rewards for a user in WAD cliam
* @param user The address of the user * @param user The address of the user
* @return The claimable amount of rewards in WAD * @return The claimable amount of rewards in WAD
*/ */