-
Notifications
You must be signed in to change notification settings - Fork 16
/
WagPool.sol
1600 lines (1409 loc) · 54.2 KB
/
WagPool.sol
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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Sources flattened with hardhat v2.9.7 https://hardhat.org
// File @openzeppelin/contracts/utils/[email protected]
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/*
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
return msg.data;
}
}
// File @openzeppelin/contracts/access/[email protected]
pragma solidity ^0.8.0;
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor () {
address msgSender = _msgSender();
_owner = msgSender;
emit OwnershipTransferred(address(0), msgSender);
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
emit OwnershipTransferred(_owner, address(0));
_owner = address(0);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
}
// File @openzeppelin/contracts/token/ERC20/[email protected]
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
}
// File @openzeppelin/contracts/utils/[email protected]
pragma solidity ^0.8.0;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
// solhint-disable-next-line no-inline-assembly
assembly { size := extcodesize(account) }
return size > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value
(bool success, ) = recipient.call{ value: amount }("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain`call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value, string memory errorMessage) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.call{ value: value }(data);
return _verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data, string memory errorMessage) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.staticcall(data);
return _verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) {
require(isContract(target), "Address: delegate call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.delegatecall(data);
return _verifyCallResult(success, returndata, errorMessage);
}
function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private pure returns(bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
// solhint-disable-next-line no-inline-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// File @openzeppelin/contracts/token/ERC20/utils/[email protected]
pragma solidity ^0.8.0;
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20 token, address spender, uint256 value) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
// solhint-disable-next-line max-line-length
require((value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) { // Return data is optional
// solhint-disable-next-line max-line-length
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// File @openzeppelin/contracts/security/[email protected]
pragma solidity ^0.8.0;
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract Pausable is Context {
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
bool private _paused;
/**
* @dev Initializes the contract in unpaused state.
*/
constructor () {
_paused = false;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
require(!paused(), "Pausable: paused");
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
require(paused(), "Pausable: not paused");
_;
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
}
// File contracts/interfaces/IMasterChefV2.sol
pragma solidity ^0.8.0;
interface IMasterChefV2 {
function deposit(uint256 _pid, uint256 _amount) external;
function withdraw(uint256 _pid, uint256 _amount) external;
function pendingCake(uint256 _pid, address _user)
external
view
returns (uint256);
function userInfo(uint256 _pid, address _user)
external
view
returns (uint256, uint256);
function emergencyWithdraw(uint256 _pid) external;
}
// File contracts/interfaces/IBoostContract.sol
pragma solidity ^0.8.0;
interface IBoostContract {
function onCakePoolUpdate(
address _user,
uint256 _lockedAmount,
uint256 _lockedDuration,
uint256 _totalLockedAmount,
uint256 _maxLockDuration
) external;
}
// File contracts/interfaces/IVCake.sol
pragma solidity ^0.8.0;
interface IVCake {
function deposit(
address _user,
uint256 _amount,
uint256 _lockDuration
) external;
function withdraw(address _user) external;
}
// File contracts/WagPool.sol
pragma solidity ^0.8.0;
contract WagPool is Ownable, Pausable {
using SafeERC20 for IERC20;
struct UserInfo {
uint256 shares; // number of shares for a user.
uint256 lastDepositedTime; // keep track of deposited time for potential penalty.
uint256 cakeAtLastUserAction; // keep track of cake deposited at the last user action.
uint256 lastUserActionTime; // keep track of the last user action time.
uint256 lockStartTime; // lock start time.
uint256 lockEndTime; // lock end time.
uint256 userBoostedShare; // boost share, in order to give the user higher reward. The user only enjoys the reward, so the principal needs to be recorded as a debt.
bool locked; //lock status.
uint256 lockedAmount; // amount deposited during lock period.
}
IERC20 public immutable token; // cake token.
IMasterChefV2 public immutable masterchefV2;
address public boostContract; // boost contract used in Masterchef.
address public VCake;
mapping(address => UserInfo) public userInfo;
mapping(address => bool) public freePerformanceFeeUsers; // free performance fee users.
mapping(address => bool) public freeWithdrawFeeUsers; // free withdraw fee users.
mapping(address => bool) public freeOverdueFeeUsers; // free overdue fee users.
uint256 public totalShares;
address public admin;
address public treasury;
address public operator;
uint256 public cakePoolPID;
uint256 public totalBoostDebt; // total boost debt.
uint256 public totalLockedAmount; // total lock amount.
uint256 public constant MAX_PERFORMANCE_FEE = 2000; // 20%
uint256 public constant MAX_WITHDRAW_FEE = 500; // 5%
uint256 public constant MAX_OVERDUE_FEE = 100 * 1e10; // 100%
uint256 public constant MAX_WITHDRAW_FEE_PERIOD = 1 weeks; // 1 week
uint256 public constant MIN_LOCK_DURATION = 1 weeks; // 1 week
uint256 public constant MAX_LOCK_DURATION_LIMIT = 1000 days; // 1000 days
uint256 public constant BOOST_WEIGHT_LIMIT = 5000 * 1e10; // 5000%
uint256 public constant PRECISION_FACTOR = 1e12; // precision factor.
uint256 public constant PRECISION_FACTOR_SHARE = 1e28; // precision factor for share.
uint256 public constant MIN_DEPOSIT_AMOUNT = 0.00001 ether;
uint256 public constant MIN_WITHDRAW_AMOUNT = 0.00001 ether;
uint256 public UNLOCK_FREE_DURATION = 1 weeks; // 1 week
uint256 public MAX_LOCK_DURATION = 365 days; // 365 days
uint256 public DURATION_FACTOR = 365 days; // 365 days, in order to calculate user additional boost.
uint256 public DURATION_FACTOR_OVERDUE = 180 days; // 180 days, in order to calculate overdue fee.
uint256 public BOOST_WEIGHT = 100 * 1e10; // 100%
uint256 public performanceFee = 200; // 2%
uint256 public performanceFeeContract = 200; // 2%
uint256 public withdrawFee = 10; // 0.1%
uint256 public withdrawFeeContract = 10; // 0.1%
uint256 public overdueFee = 100 * 1e10; // 100%
uint256 public withdrawFeePeriod = 72 hours; // 3 days
event Deposit(
address indexed sender,
uint256 amount,
uint256 shares,
uint256 duration,
uint256 lastDepositedTime
);
event Withdraw(address indexed sender, uint256 amount, uint256 shares);
event Harvest(address indexed sender, uint256 amount);
event Pause();
event Unpause();
event Init();
event Lock(
address indexed sender,
uint256 lockedAmount,
uint256 shares,
uint256 lockedDuration,
uint256 blockTimestamp
);
event Unlock(
address indexed sender,
uint256 amount,
uint256 blockTimestamp
);
event NewAdmin(address admin);
event NewTreasury(address treasury);
event NewOperator(address operator);
event NewBoostContract(address boostContract);
event NewVCakeContract(address VCake);
event FreeFeeUser(address indexed user, bool indexed free);
event NewPerformanceFee(uint256 performanceFee);
event NewPerformanceFeeContract(uint256 performanceFeeContract);
event NewWithdrawFee(uint256 withdrawFee);
event NewOverdueFee(uint256 overdueFee);
event NewWithdrawFeeContract(uint256 withdrawFeeContract);
event NewWithdrawFeePeriod(uint256 withdrawFeePeriod);
event NewMaxLockDuration(uint256 maxLockDuration);
event NewDurationFactor(uint256 durationFactor);
event NewDurationFactorOverdue(uint256 durationFactorOverdue);
event NewUnlockFreeDuration(uint256 unlockFreeDuration);
event NewBoostWeight(uint256 boostWeight);
/**
* @notice Constructor
* @param _token: Cake token contract
* @param _masterchefV2: MasterChefV2 contract
* @param _admin: address of the admin
* @param _treasury: address of the treasury (collects fees)
* @param _operator: address of operator
* @param _pid: cake pool ID in MasterChefV2
*/
constructor(
IERC20 _token,
IMasterChefV2 _masterchefV2,
address _admin,
address _treasury,
address _operator,
uint256 _pid
) {
token = _token;
masterchefV2 = _masterchefV2;
admin = _admin;
treasury = _treasury;
operator = _operator;
cakePoolPID = _pid;
}
/**
* @notice Deposits a dummy token to `MASTER_CHEF` MCV2.
* It will transfer all the `dummyToken` in the tx sender address.
* @param dummyToken The address of the token to be deposited into MCV2.
*/
function init(IERC20 dummyToken) external onlyOwner {
uint256 balance = dummyToken.balanceOf(msg.sender);
require(balance != 0, "Balance must exceed 0");
dummyToken.safeTransferFrom(msg.sender, address(this), balance);
dummyToken.approve(address(masterchefV2), balance);
masterchefV2.deposit(cakePoolPID, balance);
emit Init();
}
/**
* @notice Checks if the msg.sender is the admin address.
*/
modifier onlyAdmin() {
require(msg.sender == admin, "admin: wut?");
_;
}
/**
* @notice Checks if the msg.sender is either the cake owner address or the operator address.
*/
modifier onlyOperatorOrCakeOwner(address _user) {
require(
msg.sender == _user || msg.sender == operator,
"Not operator or cake owner"
);
_;
}
/**
* @notice Update user info in Boost Contract.
* @param _user: User address
*/
function updateBoostContractInfo(address _user) internal {
if (boostContract != address(0)) {
UserInfo storage user = userInfo[_user];
uint256 lockDuration = user.lockEndTime - user.lockStartTime;
IBoostContract(boostContract).onCakePoolUpdate(
_user,
user.lockedAmount,
lockDuration,
totalLockedAmount,
DURATION_FACTOR
);
}
}
/**
* @notice Update user share When need to unlock or charges a fee.
* @param _user: User address
*/
function updateUserShare(address _user) internal {
UserInfo storage user = userInfo[_user];
if (user.shares > 0) {
if (user.locked) {
// Calculate the user's current token amount and update related parameters.
uint256 currentAmount = (balanceOf() * (user.shares)) /
totalShares -
user.userBoostedShare;
totalBoostDebt -= user.userBoostedShare;
user.userBoostedShare = 0;
totalShares -= user.shares;
//Charge a overdue fee after the free duration has expired.
if (
!freeOverdueFeeUsers[_user] &&
((user.lockEndTime + UNLOCK_FREE_DURATION) <
block.timestamp)
) {
uint256 earnAmount = currentAmount - user.lockedAmount;
uint256 overdueDuration = block.timestamp -
user.lockEndTime -
UNLOCK_FREE_DURATION;
if (overdueDuration > DURATION_FACTOR_OVERDUE) {
overdueDuration = DURATION_FACTOR_OVERDUE;
}
// Rates are calculated based on the user's overdue duration.
uint256 overdueWeight = (overdueDuration * overdueFee) /
DURATION_FACTOR_OVERDUE;
uint256 currentOverdueFee = (earnAmount * overdueWeight) /
PRECISION_FACTOR;
token.safeTransfer(treasury, currentOverdueFee);
currentAmount -= currentOverdueFee;
}
// Recalculate the user's share.
uint256 pool = balanceOf();
uint256 currentShares;
if (totalShares != 0) {
currentShares =
(currentAmount * totalShares) /
(pool - currentAmount);
} else {
currentShares = currentAmount;
}
user.shares = currentShares;
totalShares += currentShares;
// After the lock duration, update related parameters.
if (user.lockEndTime < block.timestamp) {
user.locked = false;
user.lockStartTime = 0;
user.lockEndTime = 0;
totalLockedAmount -= user.lockedAmount;
user.lockedAmount = 0;
emit Unlock(_user, currentAmount, block.timestamp);
}
} else if (!freePerformanceFeeUsers[_user]) {
// Calculate Performance fee.
uint256 totalAmount = (user.shares * balanceOf()) / totalShares;
totalShares -= user.shares;
user.shares = 0;
uint256 earnAmount = totalAmount - user.cakeAtLastUserAction;
uint256 feeRate = performanceFee;
if (_isContract(_user)) {
feeRate = performanceFeeContract;
}
uint256 currentPerformanceFee = (earnAmount * feeRate) / 10000;
if (currentPerformanceFee > 0) {
token.safeTransfer(treasury, currentPerformanceFee);
totalAmount -= currentPerformanceFee;
}
// Recalculate the user's share.
uint256 pool = balanceOf();
uint256 newShares;
if (totalShares != 0) {
newShares =
(totalAmount * totalShares) /
(pool - totalAmount);
} else {
newShares = totalAmount;
}
user.shares = newShares;
totalShares += newShares;
}
}
}
/**
* @notice Unlock user cake funds.
* @dev Only possible when contract not paused.
* @param _user: User address
*/
function unlock(address _user)
external
onlyOperatorOrCakeOwner(_user)
whenNotPaused
{
UserInfo storage user = userInfo[_user];
require(
user.locked && user.lockEndTime < block.timestamp,
"Cannot unlock yet"
);
depositOperation(0, 0, _user);
}
/**
* @notice Deposit funds into the Cake Pool.
* @dev Only possible when contract not paused.
* @param _amount: number of tokens to deposit (in CAKE)
* @param _lockDuration: Token lock duration
*/
function deposit(uint256 _amount, uint256 _lockDuration)
external
whenNotPaused
{
require(_amount > 0 || _lockDuration > 0, "Nothing to deposit");
depositOperation(_amount, _lockDuration, msg.sender);
}
/**
* @notice The operation of deposite.
* @param _amount: number of tokens to deposit (in CAKE)
* @param _lockDuration: Token lock duration
* @param _user: User address
*/
function depositOperation(
uint256 _amount,
uint256 _lockDuration,
address _user
) internal {
UserInfo storage user = userInfo[_user];
if (user.shares == 0 || _amount > 0) {
require(
_amount > MIN_DEPOSIT_AMOUNT,
"Deposit amount must be greater than MIN_DEPOSIT_AMOUNT"
);
}
// Calculate the total lock duration and check whether the lock duration meets the conditions.
uint256 totalLockDuration = _lockDuration;
if (user.lockEndTime >= block.timestamp) {
// Adding funds during the lock duration is equivalent to re-locking the position, needs to update some variables.
if (_amount > 0) {
user.lockStartTime = block.timestamp;
totalLockedAmount -= user.lockedAmount;
user.lockedAmount = 0;
}
totalLockDuration += user.lockEndTime - user.lockStartTime;
}
require(
_lockDuration == 0 || totalLockDuration >= MIN_LOCK_DURATION,
"Minimum lock period is one week"
);
require(
totalLockDuration <= MAX_LOCK_DURATION,
"Maximum lock period exceeded"
);
if (VCake != address(0)) {
IVCake(VCake).deposit(_user, _amount, _lockDuration);
}
// Harvest tokens from Masterchef.
harvest();
// Handle stock funds.
if (totalShares == 0) {
uint256 stockAmount = available();
token.safeTransfer(treasury, stockAmount);
}
// Update user share.
updateUserShare(_user);
// Update lock duration.
if (_lockDuration > 0) {
if (user.lockEndTime < block.timestamp) {
user.lockStartTime = block.timestamp;
user.lockEndTime = block.timestamp + _lockDuration;
} else {
user.lockEndTime += _lockDuration;
}
user.locked = true;
}
uint256 currentShares;
uint256 currentAmount;
uint256 userCurrentLockedBalance;
uint256 pool = balanceOf();
if (_amount > 0) {
token.safeTransferFrom(_user, address(this), _amount);
currentAmount = _amount;
}
// Calculate lock funds
if (user.shares > 0 && user.locked) {
userCurrentLockedBalance = (pool * user.shares) / totalShares;
currentAmount += userCurrentLockedBalance;
totalShares -= user.shares;
user.shares = 0;
// Update lock amount
if (user.lockStartTime == block.timestamp) {
user.lockedAmount = userCurrentLockedBalance;
totalLockedAmount += user.lockedAmount;
}
}
if (totalShares != 0) {
currentShares =
(currentAmount * totalShares) /
(pool - userCurrentLockedBalance);
} else {