Contract Name:
NFTXLPStaking
Contract Source Code:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./util/PausableUpgradeable.sol";
import "./util/SafeERC20Upgradeable.sol";
import "./proxy/ClonesUpgradeable.sol";
import "./token/TimelockRewardDistributionTokenImpl.sol";
import "./interface/INFTXVaultFactory.sol";
import "./interface/INFTXVault.sol";
import "./interface/IRewardDistributionToken.sol";
import "./StakingTokenProvider.sol";
// Author: 0xKiwi.
// Pausing codes for LP staking are:
// 10: Deposit
contract NFTXLPStaking is PausableUpgradeable {
using SafeERC20Upgradeable for IERC20Upgradeable;
INFTXVaultFactory public nftxVaultFactory;
IRewardDistributionToken public rewardDistTokenImpl;
StakingTokenProvider public stakingTokenProvider;
event PoolCreated(uint256 vaultId, address pool);
event PoolUpdated(uint256 vaultId, address pool);
event FeesReceived(uint256 vaultId, uint256 amount);
event Deposit(uint256 vaultId, address stakingToken, uint256 amount, address account, uint256 timelockLength);
event Withdraw(uint256 vaultId, address stakingToken, uint256 amount, address account);
struct StakingPool {
address stakingToken;
address rewardToken;
}
mapping(uint256 => StakingPool) public vaultStakingInfo;
TimelockRewardDistributionTokenImpl public newTimelockRewardDistTokenImpl;
function __NFTXLPStaking__init(address _stakingTokenProvider)
external
initializer
{
__Ownable_init();
require(_stakingTokenProvider != address(0), "Provider != address(0)");
require(
address(newTimelockRewardDistTokenImpl) == address(0),
"Already assigned"
);
stakingTokenProvider = StakingTokenProvider(_stakingTokenProvider);
newTimelockRewardDistTokenImpl = new TimelockRewardDistributionTokenImpl();
newTimelockRewardDistTokenImpl.__TimelockRewardDistributionToken_init(
IERC20Upgradeable(address(0)),
"",
""
);
}
modifier onlyAdmin() {
require(
msg.sender == owner() ||
msg.sender == nftxVaultFactory.feeDistributor(),
"LPStaking: Not authorized"
);
_;
}
function setNFTXVaultFactory(address newFactory) external onlyOwner {
require(
address(nftxVaultFactory) == address(0),
"nftxVaultFactory is immutable"
);
nftxVaultFactory = INFTXVaultFactory(newFactory);
}
function setStakingTokenProvider(address newProvider) external onlyOwner {
require(newProvider != address(0));
stakingTokenProvider = StakingTokenProvider(newProvider);
}
function addPoolForVault(uint256 vaultId) external onlyAdmin {
require(
address(nftxVaultFactory) != address(0),
"LPStaking: Factory not set"
);
require(
vaultStakingInfo[vaultId].stakingToken == address(0),
"LPStaking: Pool already exists"
);
address _rewardToken = nftxVaultFactory.vault(vaultId);
address _stakingToken = stakingTokenProvider.stakingTokenForVaultToken(
_rewardToken
);
StakingPool memory pool = StakingPool(_stakingToken, _rewardToken);
vaultStakingInfo[vaultId] = pool;
address newRewardDistToken = _deployDividendToken(pool);
emit PoolCreated(vaultId, newRewardDistToken);
}
function updatePoolForVaults(uint256[] calldata vaultIds) external {
uint256 length = vaultIds.length;
for (uint256 i; i < length; ++i) {
updatePoolForVault(vaultIds[i]);
}
}
// In case the provider changes, this lets the pool be updated. Anyone can call it.
function updatePoolForVault(uint256 vaultId) public {
StakingPool memory pool = vaultStakingInfo[vaultId];
// Not letting people use this function to create new pools.
require(
pool.stakingToken != address(0),
"LPStaking: Pool doesn't exist"
);
address _stakingToken = stakingTokenProvider.stakingTokenForVaultToken(
pool.rewardToken
);
StakingPool memory newPool = StakingPool(
_stakingToken,
pool.rewardToken
);
vaultStakingInfo[vaultId] = newPool;
// If the pool is already deployed, ignore the update.
address addr = address(_rewardDistributionTokenAddr(newPool));
if (isContract(addr)) {
return;
}
address newRewardDistToken = _deployDividendToken(newPool);
emit PoolUpdated(vaultId, newRewardDistToken);
}
function receiveRewards(uint256 vaultId, uint256 amount)
external
onlyAdmin
returns (bool)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
if (pool.stakingToken == address(0)) {
// In case the pair is updated, but not yet
return false;
}
TimelockRewardDistributionTokenImpl rewardDistToken = _rewardDistributionTokenAddr(
pool
);
// Don't distribute rewards unless there are people to distribute to.
// Also added here if the distribution token is not deployed, just forfeit rewards for now.
if (
!isContract(address(rewardDistToken)) ||
rewardDistToken.totalSupply() == 0
) {
return false;
}
// We "pull" to the dividend tokens so the vault only needs to approve this contract.
IERC20Upgradeable(pool.rewardToken).safeTransferFrom(
msg.sender,
address(rewardDistToken),
amount
);
rewardDistToken.distributeRewards(amount);
emit FeesReceived(vaultId, amount);
return true;
}
function deposit(uint256 vaultId, uint256 amount) external {
onlyOwnerIfPaused(10);
// Check the pool in case its been updated.
updatePoolForVault(vaultId);
StakingPool memory pool = vaultStakingInfo[vaultId];
require(pool.stakingToken != address(0), "LPStaking: Nonexistent pool");
IERC20Upgradeable(pool.stakingToken).safeTransferFrom(
msg.sender,
address(this),
amount
);
TimelockRewardDistributionTokenImpl xSLPToken = _rewardDistributionTokenAddr(
pool
);
// If the user has an existing timelock, check if it is in the future.
uint256 currentTimelock = xSLPToken.timelockUntil(msg.sender);
if (currentTimelock > block.timestamp) {
// Maintain the same timelock if they already have one.
// We do this instead of patching in the token because
// the xSLP contracts as currently deployed are not upgradeable.
uint256 timestamp = currentTimelock - block.timestamp;
xSLPToken.timelockMint(
msg.sender,
amount,
timestamp
);
emit Deposit(vaultId, pool.stakingToken, amount, msg.sender, timestamp);
} else {
// Timelock for 2 seconds if they don't already have a timelock to prevent flash loans.
xSLPToken.timelockMint(msg.sender, amount, 2);
emit Deposit(vaultId, pool.stakingToken, amount, msg.sender, 2);
}
}
function timelockDepositFor(
uint256 vaultId,
address account,
uint256 amount,
uint256 timelockLength
) external {
require(timelockLength < 2592000, "Timelock too long");
require(nftxVaultFactory.excludedFromFees(msg.sender), "Not zap");
onlyOwnerIfPaused(10);
// Check the pool in case its been updated.
updatePoolForVault(vaultId);
StakingPool memory pool = vaultStakingInfo[vaultId];
require(pool.stakingToken != address(0), "LPStaking: Nonexistent pool");
IERC20Upgradeable(pool.stakingToken).safeTransferFrom(
msg.sender,
address(this),
amount
);
_rewardDistributionTokenAddr(pool).timelockMint(
account,
amount,
timelockLength
);
emit Deposit(vaultId, pool.stakingToken, amount, account, timelockLength);
}
function exit(uint256 vaultId) external {
StakingPool memory pool = vaultStakingInfo[vaultId];
_claimRewards(pool, msg.sender);
_withdraw(vaultId, pool, balanceOf(vaultId, msg.sender), msg.sender);
}
function emergencyExitAndClaim(address _stakingToken, address _rewardToken)
external
{
StakingPool memory pool = StakingPool(_stakingToken, _rewardToken);
TimelockRewardDistributionTokenImpl dist = _rewardDistributionTokenAddr(
pool
);
require(isContract(address(dist)), "Not a pool");
_claimRewards(pool, msg.sender);
_withdraw(INFTXVault(_rewardToken).vaultId(), pool, dist.balanceOf(msg.sender), msg.sender);
}
function emergencyExit(address _stakingToken, address _rewardToken)
external
{
StakingPool memory pool = StakingPool(_stakingToken, _rewardToken);
TimelockRewardDistributionTokenImpl dist = _rewardDistributionTokenAddr(
pool
);
require(isContract(address(dist)), "Not a pool");
_withdraw(INFTXVault(_rewardToken).vaultId(), pool, dist.balanceOf(msg.sender), msg.sender);
}
function emergencyMigrate(uint256 vaultId) external {
StakingPool memory pool = vaultStakingInfo[vaultId];
IRewardDistributionToken unusedDist = _unusedRewardDistributionTokenAddr(
pool
);
IRewardDistributionToken oldDist = _oldRewardDistributionTokenAddr(
pool
);
uint256 unusedDistBal;
if (isContract(address(unusedDist))) {
unusedDistBal = unusedDist.balanceOf(msg.sender);
if (unusedDistBal > 0) {
unusedDist.burnFrom(msg.sender, unusedDistBal);
}
}
uint256 oldDistBal;
if (isContract(address(oldDist))) {
oldDistBal = oldDist.balanceOf(msg.sender);
if (oldDistBal > 0) {
oldDist.withdrawReward(msg.sender);
oldDist.burnFrom(msg.sender, oldDistBal);
}
}
TimelockRewardDistributionTokenImpl newDist = _rewardDistributionTokenAddr(
pool
);
if (!isContract(address(newDist))) {
address deployedDist = _deployDividendToken(pool);
require(
deployedDist == address(newDist),
"Not deploying proper distro"
);
emit PoolUpdated(vaultId, deployedDist);
}
require(unusedDistBal + oldDistBal > 0, "Nothing to migrate");
newDist.mint(msg.sender, unusedDistBal + oldDistBal);
}
function withdraw(uint256 vaultId, uint256 amount) external {
StakingPool memory pool = vaultStakingInfo[vaultId];
_claimRewards(pool, msg.sender);
_withdraw(vaultId, pool, amount, msg.sender);
}
function claimRewards(uint256 vaultId) public {
StakingPool memory pool = vaultStakingInfo[vaultId];
_claimRewards(pool, msg.sender);
}
function claimMultipleRewards(uint256[] calldata vaultIds) external {
uint256 length = vaultIds.length;
for (uint256 i; i < length; ++i) {
claimRewards(vaultIds[i]);
}
}
function newRewardDistributionToken(uint256 vaultId)
external
view
returns (TimelockRewardDistributionTokenImpl)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
if (pool.stakingToken == address(0)) {
return TimelockRewardDistributionTokenImpl(address(0));
}
return _rewardDistributionTokenAddr(pool);
}
function rewardDistributionToken(uint256 vaultId)
external
view
returns (IRewardDistributionToken)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
if (pool.stakingToken == address(0)) {
return IRewardDistributionToken(address(0));
}
return _unusedRewardDistributionTokenAddr(pool);
}
function oldRewardDistributionToken(uint256 vaultId)
external
view
returns (address)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
if (pool.stakingToken == address(0)) {
return address(0);
}
return address(_oldRewardDistributionTokenAddr(pool));
}
function unusedRewardDistributionToken(uint256 vaultId)
external
view
returns (address)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
if (pool.stakingToken == address(0)) {
return address(0);
}
return address(_unusedRewardDistributionTokenAddr(pool));
}
function rewardDistributionTokenAddr(
address stakedToken,
address rewardToken
) public view returns (address) {
StakingPool memory pool = StakingPool(stakedToken, rewardToken);
return address(_rewardDistributionTokenAddr(pool));
}
function balanceOf(uint256 vaultId, address addr)
public
view
returns (uint256)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
TimelockRewardDistributionTokenImpl dist = _rewardDistributionTokenAddr(
pool
);
require(isContract(address(dist)), "Not a pool");
return dist.balanceOf(addr);
}
function oldBalanceOf(uint256 vaultId, address addr)
public
view
returns (uint256)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
IRewardDistributionToken dist = _oldRewardDistributionTokenAddr(pool);
require(isContract(address(dist)), "Not a pool");
return dist.balanceOf(addr);
}
function unusedBalanceOf(uint256 vaultId, address addr)
public
view
returns (uint256)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
IRewardDistributionToken dist = _unusedRewardDistributionTokenAddr(
pool
);
require(isContract(address(dist)), "Not a pool");
return dist.balanceOf(addr);
}
function lockedUntil(uint256 vaultId, address who)
external
view
returns (uint256)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
TimelockRewardDistributionTokenImpl dist = _rewardDistributionTokenAddr(
pool
);
return dist.timelockUntil(who);
}
function lockedLPBalance(uint256 vaultId, address who)
external
view
returns (uint256)
{
StakingPool memory pool = vaultStakingInfo[vaultId];
TimelockRewardDistributionTokenImpl dist = _rewardDistributionTokenAddr(
pool
);
if (block.timestamp > dist.timelockUntil(who)) {
return 0;
}
return dist.balanceOf(who);
}
function _claimRewards(StakingPool memory pool, address account) internal {
require(pool.stakingToken != address(0), "LPStaking: Nonexistent pool");
_rewardDistributionTokenAddr(pool).withdrawReward(account);
}
function _withdraw(
uint256 vaultId,
StakingPool memory pool,
uint256 amount,
address account
) internal {
require(pool.stakingToken != address(0), "LPStaking: Nonexistent pool");
_rewardDistributionTokenAddr(pool).burnFrom(account, amount);
IERC20Upgradeable(pool.stakingToken).safeTransfer(account, amount);
emit Withdraw(vaultId, pool.stakingToken, amount, account);
}
function _deployDividendToken(StakingPool memory pool)
internal
returns (address)
{
// Changed to use new nonces.
bytes32 salt = keccak256(
abi.encodePacked(pool.stakingToken, pool.rewardToken, uint256(2))
);
address rewardDistToken = ClonesUpgradeable.cloneDeterministic(
address(newTimelockRewardDistTokenImpl),
salt
);
string memory name = stakingTokenProvider.nameForStakingToken(
pool.rewardToken
);
TimelockRewardDistributionTokenImpl(rewardDistToken)
.__TimelockRewardDistributionToken_init(
IERC20Upgradeable(pool.rewardToken),
name,
name
);
return rewardDistToken;
}
// Note: this function does not guarantee the token is deployed, we leave that check to elsewhere to save gas.
function _rewardDistributionTokenAddr(StakingPool memory pool)
public
view
returns (TimelockRewardDistributionTokenImpl)
{
bytes32 salt = keccak256(
abi.encodePacked(
pool.stakingToken,
pool.rewardToken,
uint256(2) /* small nonce to change tokens */
)
);
address tokenAddr = ClonesUpgradeable.predictDeterministicAddress(
address(newTimelockRewardDistTokenImpl),
salt
);
return TimelockRewardDistributionTokenImpl(tokenAddr);
}
// Note: this function does not guarantee the token is deployed, we leave that check to elsewhere to save gas.
function _oldRewardDistributionTokenAddr(StakingPool memory pool)
public
view
returns (IRewardDistributionToken)
{
bytes32 salt = keccak256(
abi.encodePacked(pool.stakingToken, pool.rewardToken, uint256(1))
);
address tokenAddr = ClonesUpgradeable.predictDeterministicAddress(
address(rewardDistTokenImpl),
salt
);
return IRewardDistributionToken(tokenAddr);
}
// Note: this function does not guarantee the token is deployed, we leave that check to elsewhere to save gas.
function _unusedRewardDistributionTokenAddr(StakingPool memory pool)
public
view
returns (IRewardDistributionToken)
{
bytes32 salt = keccak256(
abi.encodePacked(pool.stakingToken, pool.rewardToken)
);
address tokenAddr = ClonesUpgradeable.predictDeterministicAddress(
address(rewardDistTokenImpl),
salt
);
return IRewardDistributionToken(tokenAddr);
}
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;
}
function retrieveTokens(
uint256 vaultId,
uint256 amount,
address from,
address to
) public onlyOwner {
StakingPool memory pool = vaultStakingInfo[vaultId];
TimelockRewardDistributionTokenImpl xSlp = _rewardDistributionTokenAddr(
pool
);
xSlp.burnFrom(from, amount);
xSlp.mint(to, amount);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./util/OwnableUpgradeable.sol";
import "./token/IERC20Metadata.sol";
// Author: 0xKiwi.
contract StakingTokenProvider is OwnableUpgradeable {
address public uniLikeExchange;
address public defaultPairedToken;
string public defaultPrefix;
mapping(address => address) public pairedToken;
mapping(address => string) public pairedPrefix;
event NewDefaultPaired(address oldPaired, address newPaired);
event NewPairedTokenForVault(
address vaultToken,
address oldPairedtoken,
address newPairedToken
);
// This is an address provder to allow us to abstract out what liquidity
// our vault tokens should be paired with.
function __StakingTokenProvider_init(
address _uniLikeExchange,
address _defaultPairedtoken,
string memory _defaultPrefix
) public initializer {
__Ownable_init();
require(_uniLikeExchange != address(0), "Cannot be address(0)");
require(_defaultPairedtoken != address(0), "Cannot be address(0)");
uniLikeExchange = _uniLikeExchange;
defaultPairedToken = _defaultPairedtoken;
defaultPrefix = _defaultPrefix;
}
function setPairedTokenForVaultToken(
address _vaultToken,
address _newPairedToken,
string calldata _newPrefix
) external onlyOwner {
require(_newPairedToken != address(0), "Cannot be address(0)");
emit NewPairedTokenForVault(
_vaultToken,
pairedToken[_vaultToken],
_newPairedToken
);
pairedToken[_vaultToken] = _newPairedToken;
pairedPrefix[_vaultToken] = _newPrefix;
}
function setDefaultPairedToken(
address _newDefaultPaired,
string calldata _newDefaultPrefix
) external onlyOwner {
emit NewDefaultPaired(defaultPairedToken, _newDefaultPaired);
defaultPairedToken = _newDefaultPaired;
defaultPrefix = _newDefaultPrefix;
}
function stakingTokenForVaultToken(address _vaultToken)
external
view
returns (address)
{
address _pairedToken = pairedToken[_vaultToken];
if (_pairedToken == address(0)) {
_pairedToken = defaultPairedToken;
}
return pairFor(uniLikeExchange, _vaultToken, _pairedToken);
}
function nameForStakingToken(address _vaultToken)
external
view
returns (string memory)
{
string memory _pairedPrefix = pairedPrefix[_vaultToken];
if (bytes(_pairedPrefix).length == 0) {
_pairedPrefix = defaultPrefix;
}
address _pairedToken = pairedToken[_vaultToken];
if (_pairedToken == address(0)) {
_pairedToken = defaultPairedToken;
}
string memory symbol1 = IERC20Metadata(_vaultToken).symbol();
string memory symbol2 = IERC20Metadata(_pairedToken).symbol();
return string(abi.encodePacked(_pairedPrefix, symbol1, symbol2));
}
function pairForVaultToken(address _vaultToken, address _pairedToken)
external
view
returns (address)
{
return pairFor(uniLikeExchange, _vaultToken, _pairedToken);
}
// returns sorted token addresses, used to handle return values from pairs sorted in this order
function sortTokens(address tokenA, address tokenB)
internal
pure
returns (address token0, address token1)
{
require(tokenA != tokenB, "UniswapV2Library: IDENTICAL_ADDRESSES");
(token0, token1) = tokenA < tokenB
? (tokenA, tokenB)
: (tokenB, tokenA);
require(token0 != address(0), "UniswapV2Library: ZERO_ADDRESS");
}
// calculates the CREATE2 address for a pair without making any external calls
function pairFor(
address factory,
address tokenA,
address tokenB
) internal pure returns (address pair) {
(address token0, address token1) = sortTokens(tokenA, tokenB);
pair = address(
uint160(
uint256(
keccak256(
abi.encodePacked(
hex"ff",
factory,
keccak256(abi.encodePacked(token0, token1)),
hex"e18a34eb0e04b04f7a0ac29a6e80748dca96319b42c54d679cb821dca90c6303" // init code hash
)
)
)
)
);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
interface INFTXEligibility {
// Read functions.
function name() external pure returns (string memory);
function finalized() external view returns (bool);
function targetAsset() external pure returns (address);
function checkAllEligible(uint256[] calldata tokenIds)
external
view
returns (bool);
function checkEligible(uint256[] calldata tokenIds)
external
view
returns (bool[] memory);
function checkAllIneligible(uint256[] calldata tokenIds)
external
view
returns (bool);
function checkIsEligible(uint256 tokenId) external view returns (bool);
// Write functions.
function __NFTXEligibility_init_bytes(bytes calldata configData) external;
function beforeMintHook(uint256[] calldata tokenIds) external;
function afterMintHook(uint256[] calldata tokenIds) external;
function beforeRedeemHook(uint256[] calldata tokenIds) external;
function afterRedeemHook(uint256[] calldata tokenIds) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../token/IERC20Upgradeable.sol";
import "./INFTXVaultFactory.sol";
import "./INFTXEligibility.sol";
interface INFTXVault is IERC20Upgradeable {
function manager() external view returns (address);
function assetAddress() external view returns (address);
function vaultFactory() external view returns (INFTXVaultFactory);
function eligibilityStorage() external view returns (INFTXEligibility);
function is1155() external view returns (bool);
function allowAllItems() external view returns (bool);
function enableMint() external view returns (bool);
function enableRandomRedeem() external view returns (bool);
function enableTargetRedeem() external view returns (bool);
function enableRandomSwap() external view returns (bool);
function enableTargetSwap() external view returns (bool);
function vaultId() external view returns (uint256);
function nftIdAt(uint256 holdingsIndex) external view returns (uint256);
function allHoldings() external view returns (uint256[] memory);
function totalHoldings() external view returns (uint256);
function mintFee() external view returns (uint256);
function randomRedeemFee() external view returns (uint256);
function targetRedeemFee() external view returns (uint256);
function randomSwapFee() external view returns (uint256);
function targetSwapFee() external view returns (uint256);
function vaultFees()
external
view
returns (
uint256,
uint256,
uint256,
uint256,
uint256
);
event VaultInit(
uint256 indexed vaultId,
address assetAddress,
bool is1155,
bool allowAllItems
);
event ManagerSet(address manager);
event EligibilityDeployed(uint256 moduleIndex, address eligibilityAddr);
// event CustomEligibilityDeployed(address eligibilityAddr);
event EnableMintUpdated(bool enabled);
event EnableRandomRedeemUpdated(bool enabled);
event EnableTargetRedeemUpdated(bool enabled);
event EnableRandomSwapUpdated(bool enabled);
event EnableTargetSwapUpdated(bool enabled);
event Minted(uint256[] nftIds, uint256[] amounts, address to);
event Redeemed(uint256[] nftIds, uint256[] specificIds, address to);
event Swapped(
uint256[] nftIds,
uint256[] amounts,
uint256[] specificIds,
uint256[] redeemedIds,
address to
);
function __NFTXVault_init(
string calldata _name,
string calldata _symbol,
address _assetAddress,
bool _is1155,
bool _allowAllItems
) external;
function finalizeVault() external;
function setVaultMetadata(string memory name_, string memory symbol_)
external;
function setVaultFeatures(
bool _enableMint,
bool _enableRandomRedeem,
bool _enableTargetRedeem,
bool _enableRandomSwap,
bool _enableTargetSwap
) external;
function setFees(
uint256 _mintFee,
uint256 _randomRedeemFee,
uint256 _targetRedeemFee,
uint256 _randomSwapFee,
uint256 _targetSwapFee
) external;
function disableVaultFees() external;
// This function allows for an easy setup of any eligibility module contract from the EligibilityManager.
// It takes in ABI encoded parameters for the desired module. This is to make sure they can all follow
// a similar interface.
function deployEligibilityStorage(
uint256 moduleIndex,
bytes calldata initData
) external returns (address);
// The manager has control over options like fees and features
function setManager(address _manager) external;
function mint(
uint256[] calldata tokenIds,
uint256[] calldata amounts /* ignored for ERC721 vaults */
) external returns (uint256);
function mintTo(
uint256[] calldata tokenIds,
uint256[] calldata amounts, /* ignored for ERC721 vaults */
address to
) external returns (uint256);
function redeem(uint256 amount, uint256[] calldata specificIds)
external
returns (uint256[] calldata);
function redeemTo(
uint256 amount,
uint256[] calldata specificIds,
address to
) external returns (uint256[] calldata);
function swap(
uint256[] calldata tokenIds,
uint256[] calldata amounts, /* ignored for ERC721 vaults */
uint256[] calldata specificIds
) external returns (uint256[] calldata);
function swapTo(
uint256[] calldata tokenIds,
uint256[] calldata amounts, /* ignored for ERC721 vaults */
uint256[] calldata specificIds,
address to
) external returns (uint256[] calldata);
function allValidNFTs(uint256[] calldata tokenIds)
external
view
returns (bool);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../proxy/IBeacon.sol";
interface INFTXVaultFactory is IBeacon {
// Read functions.
function numVaults() external view returns (uint256);
function zapContract() external view returns (address);
function zapContracts(address addr) external view returns (bool);
function feeDistributor() external view returns (address);
function eligibilityManager() external view returns (address);
function vault(uint256 vaultId) external view returns (address);
function allVaults() external view returns (address[] memory);
function vaultsForAsset(address asset)
external
view
returns (address[] memory);
function isLocked(uint256 id) external view returns (bool);
function excludedFromFees(address addr) external view returns (bool);
function factoryMintFee() external view returns (uint64);
function factoryRandomRedeemFee() external view returns (uint64);
function factoryTargetRedeemFee() external view returns (uint64);
function factoryRandomSwapFee() external view returns (uint64);
function factoryTargetSwapFee() external view returns (uint64);
function vaultFees(uint256 vaultId)
external
view
returns (
uint256,
uint256,
uint256,
uint256,
uint256
);
event NewFeeDistributor(address oldDistributor, address newDistributor);
event NewZapContract(address oldZap, address newZap);
event UpdatedZapContract(address zap, bool excluded);
event FeeExclusion(address feeExcluded, bool excluded);
event NewEligibilityManager(address oldEligManager, address newEligManager);
event NewVault(
uint256 indexed vaultId,
address vaultAddress,
address assetAddress
);
event UpdateVaultFees(
uint256 vaultId,
uint256 mintFee,
uint256 randomRedeemFee,
uint256 targetRedeemFee,
uint256 randomSwapFee,
uint256 targetSwapFee
);
event DisableVaultFees(uint256 vaultId);
event UpdateFactoryFees(
uint256 mintFee,
uint256 randomRedeemFee,
uint256 targetRedeemFee,
uint256 randomSwapFee,
uint256 targetSwapFee
);
// Write functions.
function __NFTXVaultFactory_init(
address _vaultImpl,
address _feeDistributor
) external;
function createVault(
string calldata name,
string calldata symbol,
address _assetAddress,
bool is1155,
bool allowAllItems
) external returns (uint256);
function setFeeDistributor(address _feeDistributor) external;
function setEligibilityManager(address _eligibilityManager) external;
function setZapContract(address _zapContract, bool _excluded) external;
function setFeeExclusion(address _excludedAddr, bool excluded) external;
function setFactoryFees(
uint256 mintFee,
uint256 randomRedeemFee,
uint256 targetRedeemFee,
uint256 randomSwapFee,
uint256 targetSwapFee
) external;
function setVaultFees(
uint256 vaultId,
uint256 mintFee,
uint256 randomRedeemFee,
uint256 targetRedeemFee,
uint256 randomSwapFee,
uint256 targetSwapFee
) external;
function disableVaultFees(uint256 vaultId) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../token/IERC20Upgradeable.sol";
interface IRewardDistributionToken is IERC20Upgradeable {
function distributeRewards(uint256 amount) external;
function __RewardDistributionToken_init(
IERC20Upgradeable _target,
string memory _name,
string memory _symbol
) external;
function mint(
address account,
address to,
uint256 amount
) external;
function burnFrom(address account, uint256 amount) external;
function withdrawReward(address user) external;
function dividendOf(address _owner) external view returns (uint256);
function withdrawnRewardOf(address _owner) external view returns (uint256);
function accumulativeRewardOf(address _owner)
external
view
returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev https://eips.ethereum.org/EIPS/eip-1167[EIP 1167] is a standard for
* deploying minimal proxy contracts, also known as "clones".
*
* > To simply and cheaply clone contract functionality in an immutable way, this standard specifies
* > a minimal bytecode implementation that delegates all calls to a known, fixed address.
*
* The library includes functions to deploy a proxy using either `create` (traditional deployment) or `create2`
* (salted deterministic deployment). It also includes functions to predict the addresses of clones deployed using the
* deterministic method.
*
* _Available since v3.4._
*/
library ClonesUpgradeable {
/**
* @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
*
* This function uses the create opcode, which should never revert.
*/
function clone(address implementation) internal returns (address instance) {
// solhint-disable-next-line no-inline-assembly
assembly {
let ptr := mload(0x40)
mstore(
ptr,
0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000000000000000000000
)
mstore(add(ptr, 0x14), shl(0x60, implementation))
mstore(
add(ptr, 0x28),
0x5af43d82803e903d91602b57fd5bf30000000000000000000000000000000000
)
instance := create(0, ptr, 0x37)
}
require(instance != address(0), "ERC1167: create failed");
}
/**
* @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
*
* This function uses the create2 opcode and a `salt` to deterministically deploy
* the clone. Using the same `implementation` and `salt` multiple time will revert, since
* the clones cannot be deployed twice at the same address.
*/
function cloneDeterministic(address implementation, bytes32 salt)
internal
returns (address instance)
{
// solhint-disable-next-line no-inline-assembly
assembly {
let ptr := mload(0x40)
mstore(
ptr,
0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000000000000000000000
)
mstore(add(ptr, 0x14), shl(0x60, implementation))
mstore(
add(ptr, 0x28),
0x5af43d82803e903d91602b57fd5bf30000000000000000000000000000000000
)
instance := create2(0, ptr, 0x37, salt)
}
require(instance != address(0), "ERC1167: create2 failed");
}
/**
* @dev Computes the address of a clone deployed using {Clones-cloneDeterministic}.
*/
function predictDeterministicAddress(
address implementation,
bytes32 salt,
address deployer
) internal pure returns (address predicted) {
// solhint-disable-next-line no-inline-assembly
assembly {
let ptr := mload(0x40)
mstore(
ptr,
0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000000000000000000000
)
mstore(add(ptr, 0x14), shl(0x60, implementation))
mstore(
add(ptr, 0x28),
0x5af43d82803e903d91602b57fd5bf3ff00000000000000000000000000000000
)
mstore(add(ptr, 0x38), shl(0x60, deployer))
mstore(add(ptr, 0x4c), salt)
mstore(add(ptr, 0x6c), keccak256(ptr, 0x37))
predicted := keccak256(add(ptr, 0x37), 0x55)
}
}
/**
* @dev Computes the address of a clone deployed using {Clones-cloneDeterministic}.
*/
function predictDeterministicAddress(address implementation, bytes32 salt)
internal
view
returns (address predicted)
{
return predictDeterministicAddress(implementation, salt, address(this));
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeacon {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {BeaconProxy} will check that this address is a contract.
*/
function childImplementation() external view returns (address);
function upgradeChildTo(address newImplementation) external;
}
// SPDX-License-Identifier: MIT
// solhint-disable-next-line compiler-version
pragma solidity ^0.8.0;
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since a proxied contract can't have a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
*/
bool private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Modifier to protect an initializer function from being invoked twice.
*/
modifier initializer() {
require(
_initializing || !_initialized,
"Initializable: contract is already initialized"
);
bool isTopLevelCall = !_initializing;
if (isTopLevelCall) {
_initializing = true;
_initialized = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../proxy/Initializable.sol";
import "../util/ContextUpgradeable.sol";
import "./IERC20Upgradeable.sol";
import "./IERC20Metadata.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* We have followed general OpenZeppelin guidelines: functions revert instead
* of returning `false` on failure. This behavior is nonetheless conventional
* and does not conflict with the expectations of ERC20 applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
contract ERC20Upgradeable is
Initializable,
ContextUpgradeable,
IERC20Upgradeable,
IERC20Metadata
{
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* The default value of {decimals} is 18. To select a different value for
* {decimals} you should overload it.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
function __ERC20_init(string memory name_, string memory symbol_)
internal
initializer
{
__Context_init_unchained();
__ERC20_init_unchained(name_, symbol_);
}
function __ERC20_init_unchained(string memory name_, string memory symbol_)
internal
initializer
{
_name = name_;
_symbol = symbol_;
}
function _setMetadata(string memory name_, string memory symbol_) internal {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5,05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the value {ERC20} uses, unless this function is
* overridden;
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual override returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account)
public
view
virtual
override
returns (uint256)
{
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `recipient` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address recipient, uint256 amount)
public
virtual
override
returns (bool)
{
_transfer(_msgSender(), recipient, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender)
public
view
virtual
override
returns (uint256)
{
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount)
public
virtual
override
returns (bool)
{
_approve(_msgSender(), spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* Requirements:
*
* - `sender` and `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
* - the caller must have allowance for ``sender``'s tokens of at least
* `amount`.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) public virtual override returns (bool) {
_transfer(sender, recipient, amount);
uint256 currentAllowance = _allowances[sender][_msgSender()];
require(
currentAllowance >= amount,
"ERC20: transfer amount exceeds allowance"
);
_approve(sender, _msgSender(), currentAllowance - amount);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue)
public
virtual
returns (bool)
{
_approve(
_msgSender(),
spender,
_allowances[_msgSender()][spender] + addedValue
);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue)
public
virtual
returns (bool)
{
uint256 currentAllowance = _allowances[_msgSender()][spender];
require(
currentAllowance >= subtractedValue,
"ERC20: decreased allowance below zero"
);
_approve(_msgSender(), spender, currentAllowance - subtractedValue);
return true;
}
/**
* @dev Moves tokens `amount` from `sender` to `recipient`.
*
* This is internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `sender` cannot be the zero address.
* - `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
*/
function _transfer(
address sender,
address recipient,
uint256 amount
) internal virtual {
require(sender != address(0), "ERC20: transfer from the zero address");
require(recipient != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(sender, recipient, amount);
uint256 senderBalance = _balances[sender];
require(
senderBalance >= amount,
"ERC20: transfer amount exceeds balance"
);
_balances[sender] = senderBalance - amount;
_balances[recipient] += amount;
emit Transfer(sender, recipient, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: mint to the zero address");
_beforeTokenTransfer(address(0), account, amount);
_totalSupply += amount;
_balances[account] += amount;
emit Transfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: burn from the zero address");
_beforeTokenTransfer(account, address(0), amount);
uint256 accountBalance = _balances[account];
require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
_balances[account] = accountBalance - amount;
_totalSupply -= amount;
emit Transfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be to transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
uint256[45] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./IERC20Upgradeable.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20Upgradeable {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20Upgradeable {
/**
* @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
);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../util/OwnableUpgradeable.sol";
import "../util/SafeMathUpgradeable.sol";
import "../util/SafeMathInt.sol";
import "../util/SafeERC20Upgradeable.sol";
import "./ERC20Upgradeable.sol";
/// @title Reward-Paying Token (renamed from Dividend)
/// @author Roger Wu (https://github.com/roger-wu)
/// @dev A mintable ERC20 token that allows anyone to pay and distribute a target token
/// to token holders as dividends and allows token holders to withdraw their dividends.
/// Reference: the source code of PoWH3D: https://etherscan.io/address/0xB3775fB83F7D12A36E0475aBdD1FCA35c091efBe#code
contract TimelockRewardDistributionTokenImpl is
OwnableUpgradeable,
ERC20Upgradeable
{
using SafeMathUpgradeable for uint256;
using SafeMathInt for int256;
using SafeERC20Upgradeable for IERC20Upgradeable;
IERC20Upgradeable public target;
// With `magnitude`, we can properly distribute dividends even if the amount of received target is small.
// For more discussion about choosing the value of `magnitude`,
// see https://github.com/ethereum/EIPs/issues/1726#issuecomment-472352728
uint256 internal constant magnitude = 2**128;
uint256 internal magnifiedRewardPerShare;
// About dividendCorrection:
// If the token balance of a `_user` is never changed, the dividend of `_user` can be computed with:
// `dividendOf(_user) = dividendPerShare * balanceOf(_user)`.
// When `balanceOf(_user)` is changed (via minting/burning/transferring tokens),
// `dividendOf(_user)` should not be changed,
// but the computed value of `dividendPerShare * balanceOf(_user)` is changed.
// To keep the `dividendOf(_user)` unchanged, we add a correction term:
// `dividendOf(_user) = dividendPerShare * balanceOf(_user) + dividendCorrectionOf(_user)`,
// where `dividendCorrectionOf(_user)` is updated whenever `balanceOf(_user)` is changed:
// `dividendCorrectionOf(_user) = dividendPerShare * (old balanceOf(_user)) - (new balanceOf(_user))`.
// So now `dividendOf(_user)` returns the same value before and after `balanceOf(_user)` is changed.
mapping(address => int256) internal magnifiedRewardCorrections;
mapping(address => uint256) internal withdrawnRewards;
mapping(address => uint256) internal timelock;
event Timelocked(address user, uint256 amount, uint256 until);
function __TimelockRewardDistributionToken_init(
IERC20Upgradeable _target,
string memory _name,
string memory _symbol
) public initializer {
__Ownable_init();
__ERC20_init(_name, _symbol);
target = _target;
}
function transfer(address recipient, uint256 amount)
public
virtual
override
returns (bool)
{
_transfer(_msgSender(), recipient, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* Requirements:
*
* - `sender` and `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
* - the caller must have allowance for ``sender``'s tokens of at least
* `amount`.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) public virtual override returns (bool) {
_transfer(sender, recipient, amount);
_approve(
sender,
_msgSender(),
allowance(sender, _msgSender()).sub(
amount,
"ERC20: transfer amount exceeds allowance"
)
);
return true;
}
function mint(address account, uint256 amount) public virtual onlyOwner {
_mint(account, amount);
}
function timelockMint(
address account,
uint256 amount,
uint256 timelockLength
) public virtual onlyOwner {
uint256 timelockFinish = block.timestamp + timelockLength;
timelock[account] = timelockFinish;
emit Timelocked(account, amount, timelockFinish);
_mint(account, amount);
}
function timelockUntil(address account) public view returns (uint256) {
return timelock[account];
}
/**
* @dev Destroys `amount` tokens from `account`, without deducting from the caller's
* allowance. Dangerous.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*/
function burnFrom(address account, uint256 amount)
public
virtual
onlyOwner
{
_burn(account, amount);
}
/// @notice Distributes target to token holders as dividends.
/// @dev It reverts if the total supply of tokens is 0.
/// It emits the `RewardsDistributed` event if the amount of received target is greater than 0.
/// About undistributed target tokens:
/// In each distribution, there is a small amount of target not distributed,
/// the magnified amount of which is
/// `(amount * magnitude) % totalSupply()`.
/// With a well-chosen `magnitude`, the amount of undistributed target
/// (de-magnified) in a distribution can be less than 1 wei.
/// We can actually keep track of the undistributed target in a distribution
/// and try to distribute it in the next distribution,
/// but keeping track of such data on-chain costs much more than
/// the saved target, so we don't do that.
function distributeRewards(uint256 amount) external virtual onlyOwner {
require(totalSupply() > 0, "RewardDist: 0 supply");
require(amount > 0, "RewardDist: 0 amount");
// Because we receive the tokens from the staking contract, we assume the tokens have been received.
magnifiedRewardPerShare = magnifiedRewardPerShare.add(
(amount).mul(magnitude) / totalSupply()
);
emit RewardsDistributed(msg.sender, amount);
}
/// @notice Withdraws the target distributed to the sender.
/// @dev It emits a `RewardWithdrawn` event if the amount of withdrawn target is greater than 0.
function withdrawReward(address user) external onlyOwner {
uint256 _withdrawableReward = withdrawableRewardOf(user);
if (_withdrawableReward > 0) {
withdrawnRewards[user] = withdrawnRewards[user].add(
_withdrawableReward
);
target.safeTransfer(user, _withdrawableReward);
emit RewardWithdrawn(user, _withdrawableReward);
}
}
/// @notice View the amount of dividend in wei that an address can withdraw.
/// @param _owner The address of a token holder.
/// @return The amount of dividend in wei that `_owner` can withdraw.
function dividendOf(address _owner) public view returns (uint256) {
return withdrawableRewardOf(_owner);
}
/// @notice View the amount of dividend in wei that an address can withdraw.
/// @param _owner The address of a token holder.
/// @return The amount of dividend in wei that `_owner` can withdraw.
function withdrawableRewardOf(address _owner)
internal
view
returns (uint256)
{
return accumulativeRewardOf(_owner).sub(withdrawnRewards[_owner]);
}
/// @notice View the amount of dividend in wei that an address has withdrawn.
/// @param _owner The address of a token holder.
/// @return The amount of dividend in wei that `_owner` has withdrawn.
function withdrawnRewardOf(address _owner) public view returns (uint256) {
return withdrawnRewards[_owner];
}
/// @notice View the amount of dividend in wei that an address has earned in total.
/// @dev accumulativeRewardOf(_owner) = withdrawableRewardOf(_owner) + withdrawnRewardOf(_owner)
/// = (magnifiedRewardPerShare * balanceOf(_owner) + magnifiedRewardCorrections[_owner]) / magnitude
/// @param _owner The address of a token holder.
/// @return The amount of dividend in wei that `_owner` has earned in total.
function accumulativeRewardOf(address _owner)
public
view
returns (uint256)
{
return
magnifiedRewardPerShare
.mul(balanceOf(_owner))
.toInt256()
.add(magnifiedRewardCorrections[_owner])
.toUint256Safe() / magnitude;
}
/// @dev Internal function that transfer tokens from one address to another.
/// Update magnifiedRewardCorrections to keep dividends unchanged.
/// @param from The address to transfer from.
/// @param to The address to transfer to.
/// @param value The amount to be transferred.
function _transfer(
address from,
address to,
uint256 value
) internal override {
require(block.timestamp > timelock[from], "User locked");
super._transfer(from, to, value);
int256 _magCorrection = magnifiedRewardPerShare.mul(value).toInt256();
magnifiedRewardCorrections[from] = magnifiedRewardCorrections[from].add(
_magCorrection
);
magnifiedRewardCorrections[to] = magnifiedRewardCorrections[to].sub(
_magCorrection
);
}
/// @dev Internal function that mints tokens to an account.
/// Update magnifiedRewardCorrections to keep dividends unchanged.
/// @param account The account that will receive the created tokens.
/// @param value The amount that will be created.
function _mint(address account, uint256 value) internal override {
super._mint(account, value);
magnifiedRewardCorrections[account] = magnifiedRewardCorrections[
account
].sub((magnifiedRewardPerShare.mul(value)).toInt256());
}
/// @dev Internal function that burns an amount of the token of a given account.
/// Update magnifiedRewardCorrections to keep dividends unchanged.
/// @param account The account whose tokens will be burnt.
/// @param value The amount that will be burnt.
function _burn(address account, uint256 value) internal override {
require(block.timestamp > timelock[account], "User locked");
super._burn(account, value);
magnifiedRewardCorrections[account] = magnifiedRewardCorrections[
account
].add((magnifiedRewardPerShare.mul(value)).toInt256());
}
/// @dev This event MUST emit when target is distributed to token holders.
/// @param from The address which sends target to this contract.
/// @param weiAmount The amount of distributed target in wei.
event RewardsDistributed(address indexed from, uint256 weiAmount);
/// @dev This event MUST emit when an address withdraws their dividend.
/// @param to The address which withdraws target from this contract.
/// @param weiAmount The amount of withdrawn target in wei.
event RewardWithdrawn(address indexed to, uint256 weiAmount);
}
// SPDX-License-Identifier: MIT
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);
}
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../proxy/Initializable.sol";
/*
* @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 ContextUpgradeable is Initializable {
function __Context_init() internal initializer {
__Context_init_unchained();
}
function __Context_init_unchained() internal initializer {}
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;
}
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../proxy/Initializable.sol";
import "./ContextUpgradeable.sol";
/**
* @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 OwnableUpgradeable is Initializable, ContextUpgradeable {
address private _owner;
event OwnershipTransferred(
address indexed previousOwner,
address indexed newOwner
);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
function __Ownable_init() internal initializer {
__Context_init_unchained();
__Ownable_init_unchained();
}
function __Ownable_init_unchained() internal initializer {
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;
}
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./OwnableUpgradeable.sol";
contract PausableUpgradeable is OwnableUpgradeable {
function __Pausable_init() internal initializer {
__Ownable_init();
}
event SetPaused(uint256 lockId, bool paused);
event SetIsGuardian(address addr, bool isGuardian);
mapping(address => bool) public isGuardian;
mapping(uint256 => bool) public isPaused;
// 0 : createVault
// 1 : mint
// 2 : redeem
// 3 : swap
// 4 : flashloan
function onlyOwnerIfPaused(uint256 lockId) public view virtual {
require(!isPaused[lockId] || msg.sender == owner(), "Paused");
}
function unpause(uint256 lockId) public virtual onlyOwner {
isPaused[lockId] = false;
emit SetPaused(lockId, false);
}
function pause(uint256 lockId) public virtual {
require(isGuardian[msg.sender], "Can't pause");
isPaused[lockId] = true;
emit SetPaused(lockId, true);
}
function setIsGuardian(address addr, bool _isGuardian)
public
virtual
onlyOwner
{
isGuardian[addr] = _isGuardian;
emit SetIsGuardian(addr, _isGuardian);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./Address.sol";
import "../token/IERC20Upgradeable.sol";
/**
* @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 SafeERC20Upgradeable {
using Address for address;
function safeTransfer(
IERC20Upgradeable token,
address to,
uint256 value
) internal {
_callOptionalReturn(
token,
abi.encodeWithSelector(token.transfer.selector, to, value)
);
}
function safeTransferFrom(
IERC20Upgradeable 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(
IERC20Upgradeable 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(
IERC20Upgradeable 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(
IERC20Upgradeable 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(IERC20Upgradeable 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"
);
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @title SafeMathInt
* @dev Math operations with safety checks that revert on error
* @dev SafeMath adapted for int256
* Based on code of https://github.com/RequestNetwork/requestNetwork/blob/master/packages/requestNetworkSmartContracts/contracts/base/math/SafeMathInt.sol
*/
library SafeMathInt {
function mul(int256 a, int256 b) internal pure returns (int256) {
// Prevent overflow when multiplying INT256_MIN with -1
// https://github.com/RequestNetwork/requestNetwork/issues/43
require(!(a == -2**255 && b == -1) && !(b == -2**255 && a == -1));
int256 c = a * b;
require((b == 0) || (c / b == a));
return c;
}
function div(int256 a, int256 b) internal pure returns (int256) {
// Prevent overflow when dividing INT256_MIN by -1
// https://github.com/RequestNetwork/requestNetwork/issues/43
require(!(a == -2**255 && b == -1) && (b > 0));
return a / b;
}
function sub(int256 a, int256 b) internal pure returns (int256) {
require((b >= 0 && a - b <= a) || (b < 0 && a - b > a));
return a - b;
}
function add(int256 a, int256 b) internal pure returns (int256) {
int256 c = a + b;
require((b >= 0 && c >= a) || (b < 0 && c < a));
return c;
}
function toUint256Safe(int256 a) internal pure returns (uint256) {
require(a >= 0);
return uint256(a);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
// CAUTION
// This version of SafeMath should only be used with Solidity 0.8 or later,
// because it relies on the compiler's built in overflow checks.
/**
* @dev Wrappers over Solidity's arithmetic operations.
*
* NOTE: `SafeMath` is no longer needed starting with Solidity 0.8. The compiler
* now has built in overflow checking.
*/
library SafeMathUpgradeable {
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryAdd(uint256 a, uint256 b)
internal
pure
returns (bool, uint256)
{
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the substraction of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function trySub(uint256 a, uint256 b)
internal
pure
returns (bool, uint256)
{
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryMul(uint256 a, uint256 b)
internal
pure
returns (bool, uint256)
{
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryDiv(uint256 a, uint256 b)
internal
pure
returns (bool, uint256)
{
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryMod(uint256 a, uint256 b)
internal
pure
returns (bool, uint256)
{
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
return a - b;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
return a * b;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator.
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
return a % b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {trySub}.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b <= a, errorMessage);
return a - b;
}
}
/**
* @dev Returns the integer division of two unsigned integers, reverting with custom message on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b > 0, errorMessage);
return a / b;
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting with custom message when dividing by zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryMod}.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b > 0, errorMessage);
return a % b;
}
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
require(value < 2**255, "SafeCast: value doesn't fit in an int256");
return int256(value);
}
}