| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623 |
18×
18×
18×
18×
18×
18×
18×
18×
18×
18×
18×
127×
38×
1×
4×
3×
2×
2×
2×
1×
1×
4×
3×
2×
2×
2×
1×
1×
5×
4×
3×
3×
3×
2×
2×
98×
1×
1×
377×
10×
10×
10×
129×
138×
128×
127×
127×
100×
100×
27×
127×
127×
127×
41×
40×
39×
39×
39×
39×
39×
39×
38×
38×
1×
1×
1×
39×
39×
36×
36×
3×
39×
181×
181×
54×
181×
142×
166×
166×
165×
165×
165×
77×
88×
88×
88×
88×
88×
88×
88×
54×
54×
54×
54×
54×
54×
54×
54×
54×
13×
54×
13×
54×
16×
95×
38×
95×
95×
95×
95×
8×
95×
79×
79×
79×
3×
3×
2×
27×
27×
66×
66×
275×
196×
196×
61×
61×
196×
376×
376×
153×
223×
223×
223×
223×
111×
111×
111×
111×
111×
111×
223×
315×
315×
58×
58×
58×
58×
58×
220×
2×
2×
6×
2×
2×
1×
| // SPDX-License-Identifier: agpl-3.0
pragma solidity 0.6.12;
pragma experimental ABIEncoderV2;
import { ILendingPool } from "@aave/protocol-v2/contracts/interfaces/ILendingPool.sol";
import { IERC20 } from "@aave/protocol-v2/contracts/dependencies/openzeppelin/contracts/IERC20.sol";
import { IERC20Detailed } from "@aave/protocol-v2/contracts/dependencies/openzeppelin/contracts/IERC20Detailed.sol";
import { IAToken } from "./IAToken.sol";
import { IStaticATokenLM } from "./IStaticATokenLM.sol";
import { IAaveIncentivesController } from "./IAaveIncentivesController.sol";
import { StaticATokenErrors } from "./StaticATokenErrors.sol";
import { ERC20 } from "./ERC20.sol";
import { ReentrancyGuard } from "./ReentrancyGuard.sol";
import { SafeERC20 } from "@aave/protocol-v2/contracts/dependencies/openzeppelin/contracts/SafeERC20.sol";
import { WadRayMath } from "@aave/protocol-v2/contracts/protocol/libraries/math/WadRayMath.sol";
import { RayMathNoRounding } from "./RayMathNoRounding.sol";
import { SafeMath } from "@aave/protocol-v2/contracts/dependencies/openzeppelin/contracts/SafeMath.sol";
/**
* @title StaticATokenLM
* @notice 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
* From: https://github.com/aave/protocol-v2/blob/238e5af2a95c3fbb83b0c8f44501ed2541215122/contracts/protocol/tokenization/StaticATokenLM.sol#L255
**/
contract StaticATokenLM is
ReentrancyGuard,
ERC20("STATIC_ATOKEN_IMPL", "STATIC_ATOKEN_IMPL"),
IStaticATokenLM
{
using SafeERC20 for IERC20;
using SafeMath for uint256;
using WadRayMath for uint256;
using RayMathNoRounding for uint256;
bytes public constant EIP712_REVISION = bytes("1");
bytes32 internal constant EIP712_DOMAIN =
keccak256(
"EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
);
bytes32 public constant PERMIT_TYPEHASH =
keccak256(
"Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"
);
bytes32 public constant METADEPOSIT_TYPEHASH =
keccak256(
"Deposit(address depositor,address recipient,uint256 value,uint16 referralCode,bool fromUnderlying,uint256 nonce,uint256 deadline)"
);
bytes32 public constant METAWITHDRAWAL_TYPEHASH =
keccak256(
"Withdraw(address owner,address recipient,uint256 staticAmount,uint256 dynamicAmount,bool toUnderlying,uint256 nonce,uint256 deadline)"
);
uint256 public constant STATIC_ATOKEN_LM_REVISION = 0x1;
ILendingPool public override LENDING_POOL;
IAaveIncentivesController public override INCENTIVES_CONTROLLER;
IERC20 public override ATOKEN;
IERC20 public override ASSET;
IERC20 public override REWARD_TOKEN;
mapping(address => uint256) public _nonces;
uint256 internal _accRewardsPerToken;
uint256 internal _lifetimeRewardsClaimed;
uint256 internal _lifetimeRewards;
uint256 internal _lastRewardBlock;
// user => _accRewardsPerToken at last interaction (in RAYs)
mapping(address => uint256) private _userSnapshotRewardsPerToken;
// user => unclaimedRewards (in RAYs)
mapping(address => uint256) private _unclaimedRewards;
constructor(
ILendingPool pool,
address aToken,
string memory staticATokenName,
string memory staticATokenSymbol
) public {
LENDING_POOL = pool;
ATOKEN = IERC20(aToken);
_name = staticATokenName;
_symbol = staticATokenSymbol;
_setupDecimals(IERC20Detailed(aToken).decimals());
try IAToken(aToken).getIncentivesController() returns (
IAaveIncentivesController incentivesController
) {
Eif (address(incentivesController) != address(0)) {
INCENTIVES_CONTROLLER = incentivesController;
REWARD_TOKEN = IERC20(INCENTIVES_CONTROLLER.REWARD_TOKEN());
}
} catch {}
ASSET = IERC20(IAToken(aToken).UNDERLYING_ASSET_ADDRESS());
ASSET.safeApprove(address(pool), type(uint256).max);
}
///@inheritdoc IStaticATokenLM
function deposit(
address recipient,
uint256 amount,
uint16 referralCode,
bool fromUnderlying
) external override EnonReentrant returns (uint256) {
return _deposit(msg.sender, recipient, amount, referralCode, fromUnderlying);
}
///@inheritdoc IStaticATokenLM
function withdraw(
address recipient,
uint256 amount,
bool toUnderlying
) external override EnonReentrant returns (uint256, uint256) {
return _withdraw(msg.sender, recipient, amount, 0, toUnderlying);
}
///@inheritdoc IStaticATokenLM
function withdrawDynamicAmount(
address recipient,
uint256 amount,
bool toUnderlying
) external override EnonReentrant returns (uint256, uint256) {
return _withdraw(msg.sender, recipient, 0, amount, toUnderlying);
}
///@inheritdoc IStaticATokenLM
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external override {
require(owner != address(0), StaticATokenErrors.INVALID_OWNER);
//solium-disable-next-line
require(block.timestamp <= deadline, StaticATokenErrors.INVALID_EXPIRATION);
uint256 currentValidNonce = _nonces[owner];
bytes32 digest = keccak256(
abi.encodePacked(
"\x19\x01",
getDomainSeparator(),
keccak256(
abi.encode(PERMIT_TYPEHASH, owner, spender, value, currentValidNonce, deadline)
)
)
);
require(owner == ecrecover(digest, v, r, s), StaticATokenErrors.INVALID_SIGNATURE);
_nonces[owner] = currentValidNonce.add(1);
_approve(owner, spender, value);
}
///@inheritdoc IStaticATokenLM
function metaDeposit(
address depositor,
address recipient,
uint256 value,
uint16 referralCode,
bool fromUnderlying,
uint256 deadline,
SignatureParams calldata sigParams
) external override EnonReentrant returns (uint256) {
require(depositor != address(0), StaticATokenErrors.INVALID_DEPOSITOR);
//solium-disable-next-line
require(block.timestamp <= deadline, StaticATokenErrors.INVALID_EXPIRATION);
uint256 currentValidNonce = _nonces[depositor];
bytes32 digest = keccak256(
abi.encodePacked(
"\x19\x01",
getDomainSeparator(),
keccak256(
abi.encode(
METADEPOSIT_TYPEHASH,
depositor,
recipient,
value,
referralCode,
fromUnderlying,
currentValidNonce,
deadline
)
)
)
);
require(
depositor == ecrecover(digest, sigParams.v, sigParams.r, sigParams.s),
StaticATokenErrors.INVALID_SIGNATURE
);
_nonces[depositor] = currentValidNonce.add(1);
return _deposit(depositor, recipient, value, referralCode, fromUnderlying);
}
///@inheritdoc IStaticATokenLM
function metaWithdraw(
address owner,
address recipient,
uint256 staticAmount,
uint256 dynamicAmount,
bool toUnderlying,
uint256 deadline,
SignatureParams calldata sigParams
) external override EnonReentrant returns (uint256, uint256) {
require(owner != address(0), StaticATokenErrors.INVALID_OWNER);
//solium-disable-next-line
require(block.timestamp <= deadline, StaticATokenErrors.INVALID_EXPIRATION);
uint256 currentValidNonce = _nonces[owner];
bytes32 digest = keccak256(
abi.encodePacked(
"\x19\x01",
getDomainSeparator(),
keccak256(
abi.encode(
METAWITHDRAWAL_TYPEHASH,
owner,
recipient,
staticAmount,
dynamicAmount,
toUnderlying,
currentValidNonce,
deadline
)
)
)
);
require(
owner == ecrecover(digest, sigParams.v, sigParams.r, sigParams.s),
StaticATokenErrors.INVALID_SIGNATURE
);
_nonces[owner] = currentValidNonce.add(1);
return _withdraw(owner, recipient, staticAmount, dynamicAmount, toUnderlying);
}
///@inheritdoc IStaticATokenLM
function dynamicBalanceOf(address account) external view override returns (uint256) {
return _staticToDynamicAmount(balanceOf(account), rate());
}
///@inheritdoc IStaticATokenLM
function staticToDynamicAmount(uint256 amount) external view override returns (uint256) {
return _staticToDynamicAmount(amount, rate());
}
///@inheritdoc IStaticATokenLM
function dynamicToStaticAmount(uint256 amount) external view override returns (uint256) {
return _dynamicToStaticAmount(amount, rate());
}
///@inheritdoc IStaticATokenLM
function rate() public view override returns (uint256) {
return LENDING_POOL.getReserveNormalizedIncome(address(ASSET));
}
///@inheritdoc IStaticATokenLM
function getDomainSeparator() public view override returns (bytes32) {
uint256 chainId;
assembly {
chainId := chainid()
}
return
keccak256(
abi.encode(
EIP712_DOMAIN,
keccak256(bytes(name())),
keccak256(EIP712_REVISION),
chainId,
address(this)
)
);
}
function _dynamicToStaticAmount(uint256 amount, uint256 rate_) internal pure returns (uint256) {
return amount.rayDiv(rate_);
}
function _staticToDynamicAmount(uint256 amount, uint256 rate_) internal pure returns (uint256) {
return amount.rayMul(rate_);
}
function _deposit(
address depositor,
address recipient,
uint256 amount,
uint16 referralCode,
bool fromUnderlying
) internal returns (uint256) {
require(recipient != address(0), StaticATokenErrors.INVALID_RECIPIENT);
_updateRewards();
if (fromUnderlying) {
ASSET.safeTransferFrom(depositor, address(this), amount);
LENDING_POOL.deposit(address(ASSET), amount, address(this), referralCode);
} else {
ATOKEN.safeTransferFrom(depositor, address(this), amount);
}
uint256 amountToMint = _dynamicToStaticAmount(amount, rate());
_mint(recipient, amountToMint);
return amountToMint;
}
function _withdraw(
address owner,
address recipient,
uint256 staticAmount,
uint256 dynamicAmount,
bool toUnderlying
) internal returns (uint256, uint256) {
require(recipient != address(0), StaticATokenErrors.INVALID_RECIPIENT);
require(
staticAmount == 0 || dynamicAmount == 0,
StaticATokenErrors.ONLY_ONE_AMOUNT_FORMAT_ALLOWED
);
_updateRewards();
uint256 userBalance = balanceOf(owner);
uint256 amountToWithdraw;
uint256 amountToBurn;
uint256 currentRate = rate();
if (staticAmount > 0) {
amountToBurn = (staticAmount > userBalance) ? userBalance : staticAmount;
amountToWithdraw = _staticToDynamicAmount(amountToBurn, currentRate);
} else {
uint256 dynamicUserBalance = _staticToDynamicAmount(userBalance, currentRate);
amountToWithdraw = (dynamicAmount > dynamicUserBalance)
? IdynamicUserBalance
: dynamicAmount;
amountToBurn = _dynamicToStaticAmount(amountToWithdraw, currentRate);
}
_burn(owner, amountToBurn);
if (toUnderlying) {
uint256 amt = LENDING_POOL.withdraw(address(ASSET), amountToWithdraw, recipient);
assert(amt == amountToWithdraw);
} else {
ATOKEN.safeTransfer(recipient, amountToWithdraw);
}
return (amountToBurn, amountToWithdraw);
}
/**
* @notice Updates rewards for senders and receiver in a transfer (not updating rewards for address(0))
* @param from The address of the sender of tokens
* @param to The address of the receiver of tokens
*/
function _beforeTokenTransfer(
address from,
address to,
uint256
) internal override {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return;
}
if (from != address(0)) {
_updateUser(from);
}
if (to != address(0)) {
_updateUser(to);
}
}
/**
* @notice Updates virtual internal accounting of rewards.
*/
function _updateRewards() internal {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return;
}
if (block.number > _lastRewardBlock) {
_lastRewardBlock = block.number;
uint256 supply = totalSupply();
if (supply == 0) {
// No rewards can have accrued since last because there were no funds.
return;
}
address[] memory assets = new address[](1);
assets[0] = address(ATOKEN);
uint256 freshRewards = INCENTIVES_CONTROLLER.getRewardsBalance(assets, address(this));
uint256 lifetimeRewards = _lifetimeRewardsClaimed.add(freshRewards);
uint256 rewardsAccrued = lifetimeRewards.sub(_lifetimeRewards).wadToRay();
_accRewardsPerToken = _accRewardsPerToken.add(
(rewardsAccrued).rayDivNoRounding(supply.wadToRay())
);
_lifetimeRewards = lifetimeRewards;
}
}
function _collectAndUpdateRewards() internal {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return;
}
_lastRewardBlock = block.number;
uint256 supply = totalSupply();
address[] memory assets = new address[](1);
assets[0] = address(ATOKEN);
uint256 freshlyClaimed = INCENTIVES_CONTROLLER.claimRewards(
assets,
type(uint256).max,
address(this)
);
uint256 lifetimeRewards = _lifetimeRewardsClaimed.add(freshlyClaimed);
uint256 rewardsAccrued = lifetimeRewards.sub(_lifetimeRewards).wadToRay();
if (supply > 0 && rewardsAccrued > 0) {
_accRewardsPerToken = _accRewardsPerToken.add(
(rewardsAccrued).rayDivNoRounding(supply.wadToRay())
);
}
if (rewardsAccrued > 0) {
_lifetimeRewards = lifetimeRewards;
}
_lifetimeRewardsClaimed = lifetimeRewards;
}
///@inheritdoc IStaticATokenLM
function collectAndUpdateRewards() external override EnonReentrant {
_collectAndUpdateRewards();
}
/**
* @notice Claim rewards on behalf of a user and send them to a receiver
* @param onBehalfOf The address to claim on behalf of
* @param receiver The address to receive the rewards
* @param forceUpdate Flag to retrieve latest rewards from `INCENTIVES_CONTROLLER`
*/
function _claimRewardsOnBehalf(
address onBehalfOf,
address receiver,
bool forceUpdate
) internal {
if (forceUpdate) {
_collectAndUpdateRewards();
}
uint256 balance = balanceOf(onBehalfOf);
uint256 reward = _getClaimableRewards(onBehalfOf, balance, false);
uint256 totBal = REWARD_TOKEN.balanceOf(address(this));
if (reward > totBal) {
reward = totBal;
}
if (reward > 0) {
_unclaimedRewards[onBehalfOf] = 0;
_updateUserSnapshotRewardsPerToken(onBehalfOf);
REWARD_TOKEN.safeTransfer(receiver, reward);
}
}
function claimRewardsOnBehalf(
address onBehalfOf,
address receiver,
bool forceUpdate
) external override EnonReentrant {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return;
}
require(
msg.sender == onBehalfOf || msg.sender == INCENTIVES_CONTROLLER.getClaimer(onBehalfOf),
StaticATokenErrors.INVALID_CLAIMER
);
_claimRewardsOnBehalf(onBehalfOf, receiver, forceUpdate);
}
function claimRewards(address receiver, bool forceUpdate) external override EnonReentrant {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return;
}
_claimRewardsOnBehalf(msg.sender, receiver, forceUpdate);
}
function claimRewardsToSelf(bool forceUpdate) external override EnonReentrant {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return;
}
_claimRewardsOnBehalf(msg.sender, msg.sender, forceUpdate);
}
/**
* @notice Update the rewardDebt for a user with balance as his balance
* @param user The user to update
*/
function _updateUserSnapshotRewardsPerToken(address user) internal {
_userSnapshotRewardsPerToken[user] = _accRewardsPerToken;
}
/**
* @notice Adding the pending rewards to the unclaimed for specific user and updating user index
* @param user The address of the user to update
*/
function _updateUser(address user) internal {
uint256 balance = balanceOf(user);
if (balance > 0) {
uint256 pending = _getPendingRewards(user, balance, false);
_unclaimedRewards[user] = _unclaimedRewards[user].add(pending);
}
_updateUserSnapshotRewardsPerToken(user);
}
/**
* @notice Compute the pending in RAY (rounded down). Pending is the amount to add (not yet unclaimed) rewards in RAY (rounded down).
* @param user The user to compute for
* @param balance The balance of the user
* @param fresh Flag to account for rewards not claimed by contract yet
* @return The amound of pending rewards in RAY
*/
function _getPendingRewards(
address user,
uint256 balance,
bool fresh
) internal view returns (uint256) {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return 0;
}
if (balance == 0) {
return 0;
}
uint256 rayBalance = balance.wadToRay();
uint256 supply = totalSupply();
uint256 accRewardsPerToken = _accRewardsPerToken;
if (supply != 0 && fresh) {
address[] memory assets = new address[](1);
assets[0] = address(ATOKEN);
uint256 freshReward = INCENTIVES_CONTROLLER.getRewardsBalance(assets, address(this));
uint256 lifetimeRewards = _lifetimeRewardsClaimed.add(freshReward);
uint256 rewardsAccrued = lifetimeRewards.sub(_lifetimeRewards).wadToRay();
accRewardsPerToken = accRewardsPerToken.add(
(rewardsAccrued).rayDivNoRounding(supply.wadToRay())
);
}
return
rayBalance.rayMulNoRounding(accRewardsPerToken.sub(_userSnapshotRewardsPerToken[user]));
}
/**
* @notice Compute the claimable rewards for a user
* @param user The address of the user
* @param balance The balance of the user in WAD
* @param fresh Flag to account for rewards not claimed by contract yet
* @return The total rewards that can be claimed by the user (if `fresh` flag true, after updating rewards)
*/
function _getClaimableRewards(
address user,
uint256 balance,
bool fresh
) internal view returns (uint256) {
uint256 reward = _unclaimedRewards[user].add(_getPendingRewards(user, balance, fresh));
return reward.rayToWadNoRounding();
}
///@inheritdoc IStaticATokenLM
function getTotalClaimableRewards() external view override returns (uint256) {
Iif (address(INCENTIVES_CONTROLLER) == address(0)) {
return 0;
}
address[] memory assets = new address[](1);
assets[0] = address(ATOKEN);
uint256 freshRewards = INCENTIVES_CONTROLLER.getRewardsBalance(assets, address(this));
return REWARD_TOKEN.balanceOf(address(this)).add(freshRewards);
}
///@inheritdoc IStaticATokenLM
function getClaimableRewards(address user) external view override returns (uint256) {
return _getClaimableRewards(user, balanceOf(user), true);
}
///@inheritdoc IStaticATokenLM
function getUnclaimedRewards(address user) external view override returns (uint256) {
return _unclaimedRewards[user].rayToWadNoRounding();
}
function getAccRewardsPerToken() external view override returns (uint256) {
return _accRewardsPerToken;
}
function getLifetimeRewardsClaimed() external view override returns (uint256) {
return _lifetimeRewardsClaimed;
}
function getLifetimeRewards() external view override returns (uint256) {
return _lifetimeRewards;
}
function getLastRewardBlock() external view override returns (uint256) {
return _lastRewardBlock;
}
function getIncentivesController() external view override returns (IAaveIncentivesController) {
return INCENTIVES_CONTROLLER;
}
function UNDERLYING_ASSET_ADDRESS() external view override returns (address) {
return address(ASSET);
}
}
|