Source Code
More Info
Private Name Tags
ContractCreator
TokenTracker
Latest 25 from a total of 919 transactions
| Transaction Hash |
Method
|
Block
|
From
|
|
To
|
||||
|---|---|---|---|---|---|---|---|---|---|
| Harvest Rewards | 24669269 | 1 hr ago | IN | 0 ETH | 0.00001162 | ||||
| Harvest Rewards | 24668596 | 3 hrs ago | IN | 0 ETH | 0.00000476 | ||||
| Harvest Rewards | 24668492 | 3 hrs ago | IN | 0 ETH | 0.00001728 | ||||
| Harvest Rewards | 24665185 | 14 hrs ago | IN | 0 ETH | 0.00001382 | ||||
| Harvest Rewards | 24664924 | 15 hrs ago | IN | 0 ETH | 0.00000471 | ||||
| Harvest Rewards | 24664034 | 18 hrs ago | IN | 0 ETH | 0.00001562 | ||||
| Harvest Rewards | 24663754 | 19 hrs ago | IN | 0 ETH | 0.00019245 | ||||
| Harvest Rewards | 24662658 | 23 hrs ago | IN | 0 ETH | 0.00001422 | ||||
| Harvest Rewards | 24662651 | 23 hrs ago | IN | 0 ETH | 0.000003 | ||||
| Harvest Rewards | 24660828 | 29 hrs ago | IN | 0 ETH | 0.00001281 | ||||
| Harvest Rewards | 24660272 | 31 hrs ago | IN | 0 ETH | 0.00001112 | ||||
| Harvest Rewards | 24659218 | 34 hrs ago | IN | 0 ETH | 0.00000295 | ||||
| Harvest Rewards | 24659187 | 34 hrs ago | IN | 0 ETH | 0.00000286 | ||||
| Harvest Rewards | 24657185 | 41 hrs ago | IN | 0 ETH | 0.0000091 | ||||
| Harvest Rewards | 24655022 | 2 days ago | IN | 0 ETH | 0.00001308 | ||||
| Harvest Rewards | 24654278 | 2 days ago | IN | 0 ETH | 0.00000468 | ||||
| Harvest Rewards | 24652568 | 2 days ago | IN | 0 ETH | 0.00022632 | ||||
| Harvest Rewards | 24651446 | 2 days ago | IN | 0 ETH | 0.00001694 | ||||
| Harvest Rewards | 24651063 | 2 days ago | IN | 0 ETH | 0.000003 | ||||
| Harvest Rewards | 24650812 | 2 days ago | IN | 0 ETH | 0.00000495 | ||||
| Harvest Rewards | 24649366 | 2 days ago | IN | 0 ETH | 0.00010296 | ||||
| Harvest Rewards | 24648591 | 2 days ago | IN | 0 ETH | 0.00001776 | ||||
| Harvest Rewards | 24647607 | 3 days ago | IN | 0 ETH | 0.00001525 | ||||
| Harvest Rewards | 24646671 | 3 days ago | IN | 0 ETH | 0.00000663 | ||||
| Harvest Rewards | 24645677 | 3 days ago | IN | 0 ETH | 0.00001482 |
View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Loading...
Loading
Cross-Chain Transactions
Loading...
Loading
Contract Name:
Staking
Compiler Version
v0.8.30+commit.73712a01
Optimization Enabled:
No with 200 runs
Other Settings:
prague EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity 0.8.30;
import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IStaking} from "src/interfaces/IStaking.sol";
import {IEscrowTokenUsage} from "src/interfaces/IEscrowTokenUsage.sol";
/**
* @title Staking
* @author Camelot
* @notice This contract is used to distribute rewards
* to users that allocated EscrowToken here.
* Staking can be distributed in the form of one or more tokens.
* The freshly received rewards are stored in a pending slot.
* The content of this pending slot will be progressively transferred
* over time into a distribution slot.
* This distribution slot is the source of the rewards distribution
* to EscrowToken allocators during the current cycle.
* This transfer from the pending slot to the distribution slot is
* based on cycleRewardsPercent and CYCLE_DURATION_SECONDS.
* A receipt token is minted to users when they allocate EscrowToken,
* which represents their share of the rewards pool.
* It's non-transferable and can be burned to deallocate EscrowToken.
*/
contract Staking is ERC20, Ownable, IEscrowTokenUsage, IStaking {
using EnumerableSet for EnumerableSet.AddressSet;
using SafeERC20 for IERC20;
/// @notice Maximum number of tokens that can be actively distributed as rewards.
uint256 public constant MAX_DISTRIBUTED_TOKENS = 10;
/// @notice Minimum percentage of rewards that can be distributed in a cycle (0.01%).
uint256 public constant MIN_CYCLE_REWARDS_PERCENT = 1;
/// @notice Default percentage of rewards that can be distributed in a cycle (1%).
uint256 public constant DEFAULT_CYCLE_REWARDS_PERCENT = 100;
/// @notice Maximum percentage of rewards that can be distributed in a cycle (100%).
uint256 public constant MAX_CYCLE_REWARDS_PERCENT = 10_000;
/// @notice Cycle duration in seconds (7 days).
/// @dev Rewards will be added to the currentDistributionAmount on each new cycle
uint256 public constant CYCLE_DURATION_SECONDS = 7 days;
/// @notice EscrowToken contract address.
address public immutable escrowToken;
/// @notice Contract's total EscrowToken allocation.
uint256 public totalAllocation;
/// @notice Current cycle start time in Unix timestamp.
uint256 public currentCycleStartTime;
/// @notice List of actively distributed tokens.
EnumerableSet.AddressSet private _distributedTokens;
/// @notice Information about each distributed token's staking.
mapping(address => StakingInfo) public stakingInfo;
/// @notice Information about each user's rewards and allocation for each distributed token.
mapping(address => mapping(address => UserInfo)) public users;
/// @notice Information about each user's EscrowToken allocation.
mapping(address => uint256) public usersAllocation;
/**
* @dev Checks if a distributed token index is valid.
* @param index The index to validate.
*/
modifier validateDistributedTokensIndex(uint256 index) {
if (index >= _distributedTokens.length()) revert IndexDoesNotExist();
_;
}
/**
* @dev Checks if a token is a valid distributed token.
* @param token The token address to validate.
*/
modifier validateDistributedToken(address token) {
if (!_distributedTokens.contains(token)) revert TokenDoesNotExist();
_;
}
/**
* @dev Restricts function execution to the EscrowToken contract.
*/
modifier escrowTokenOnly() {
if (msg.sender != escrowToken) revert CallerNotEscrow(msg.sender);
_;
}
/**
* @notice Initializes the Staking contract.
* @param _escrowToken The address of the EscrowToken contract.
* @param _startTime The initial start time for the first rewards cycle.
* @param _name The name of the receipt token.
* @param _symbol The symbol of the receipt token.
*/
constructor(address _escrowToken, uint256 _startTime, string memory _name, string memory _symbol)
Ownable(msg.sender)
ERC20(_name, _symbol)
{
if (_escrowToken == address(0)) revert AddressZero();
escrowToken = _escrowToken;
currentCycleStartTime = _startTime;
}
/// @inheritdoc IStaking
function updateStakingInfo(address token) external validateDistributedToken(token) {
_updateStakingInfo(token);
}
/// @inheritdoc IStaking
function massUpdateStakingInfo() external {
uint256 length = _distributedTokens.length();
for (uint256 index; index < length; ++index) {
_updateStakingInfo(_distributedTokens.at(index));
}
}
/// @inheritdoc IStaking
function harvestRewards(address token) external {
if (!_distributedTokens.contains(token) && stakingInfo[token].distributedAmount == 0) {
revert InvalidToken();
}
_harvestRewards(token);
}
/// @inheritdoc IStaking
function harvestAllRewards() external {
uint256 length = _distributedTokens.length();
for (uint256 index; index < length; ++index) {
_harvestRewards(_distributedTokens.at(index));
}
}
/// @inheritdoc IStaking
function addRewardsToPending(address token, uint256 amount) external override {
uint256 prevTokenBalance = IERC20(token).balanceOf(address(this));
StakingInfo storage stakingInfo_ = stakingInfo[token];
IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
// handle tokens with transfer tax
uint256 receivedAmount = IERC20(token).balanceOf(address(this)) - prevTokenBalance;
stakingInfo_.pendingAmount += receivedAmount;
emit RewardsAddedToPending(token, receivedAmount);
}
/// @inheritdoc IStaking
function emergencyWithdrawAll() external onlyOwner {
uint256 length = _distributedTokens.length();
for (uint256 index; index < length; ++index) {
emergencyWithdraw(IERC20(_distributedTokens.at(index)));
}
}
/// @inheritdoc IStaking
function enableDistributedToken(address token) external onlyOwner {
StakingInfo storage stakingInfo_ = stakingInfo[token];
uint256 length = _distributedTokens.length();
uint256 lastUpdateTime = stakingInfo_.lastUpdateTime;
if (lastUpdateTime != 0 && !stakingInfo_.distributionDisabled) {
revert DistributedTokenAlreadyEnabled(token);
}
if (length >= MAX_DISTRIBUTED_TOKENS) revert TooManyDistributedTokens();
// initialize lastUpdateTime if never set before
if (lastUpdateTime == 0) {
stakingInfo_.lastUpdateTime = _currentBlockTimestamp();
}
// initialize cycleRewardsPercent to the minimum if never set before
if (stakingInfo_.cycleRewardsPercent == 0) {
stakingInfo_.cycleRewardsPercent = DEFAULT_CYCLE_REWARDS_PERCENT;
}
stakingInfo_.distributionDisabled = false;
_distributedTokens.add(token);
emit DistributedTokenEnabled(token);
}
/// @inheritdoc IStaking
function disableDistributedToken(address token) external onlyOwner {
StakingInfo storage stakingInfo_ = stakingInfo[token];
if (stakingInfo_.lastUpdateTime == 0 || stakingInfo_.distributionDisabled) {
revert DistributedTokenAlreadyDisabled(token);
}
stakingInfo_.distributionDisabled = true;
emit DistributedTokenDisabled(token);
}
/// @inheritdoc IStaking
function updateCycleRewardsPercent(address token, uint256 percent) external onlyOwner {
if (percent > MAX_CYCLE_REWARDS_PERCENT) revert MaximumCycleRewardsPercentExceeded();
if (percent < MIN_CYCLE_REWARDS_PERCENT) revert MinimumCycleRewardsPercentExceeded();
StakingInfo storage stakingInfo_ = stakingInfo[token];
uint256 previousPercent = stakingInfo_.cycleRewardsPercent;
stakingInfo_.cycleRewardsPercent = percent;
emit CycleRewardsPercentUpdated(token, previousPercent, percent);
}
/// @inheritdoc IStaking
function removeTokenFromDistributedTokens(address tokenToRemove) external onlyOwner {
StakingInfo storage _stakingInfo = stakingInfo[tokenToRemove];
if (!_stakingInfo.distributionDisabled || _stakingInfo.currentDistributionAmount != 0) {
revert TokenCannotBeRemoved();
}
_distributedTokens.remove(tokenToRemove);
emit DistributedTokenRemoved(tokenToRemove);
}
/**
* @notice Allocates a user's EscrowToken to this rewards contract.
* @dev This function is called by the escrowToken contract when a user allocates EscrowToken.
* It updates the user's and total allocations and recalculates reward debts.
* "data" is only here for compatibility reasons (IEscrowTokenUsage).
* @param userAddress The address of the user allocating EscrowToken.
* @param amount The amount of EscrowToken being allocated.
*/
function allocate(address userAddress, uint256 amount, bytes calldata /*data*/ )
external
override
escrowTokenOnly
{
uint256 newUserAllocation = usersAllocation[userAddress] + amount;
uint256 newTotalAllocation = totalAllocation + amount;
_updateUser(userAddress, newUserAllocation, newTotalAllocation);
_mint(userAddress, amount);
}
/**
* @notice Deallocates a user's EscrowToken from this rewards contract.
* @dev This function is called by the escrowToken contract when a user deallocates EscrowToken.
* It updates the user's and total allocations and recalculates reward debts.
* "data" is only here for compatibility reasons (IEscrowTokenUsage).
* @param userAddress The address of the user deallocating EscrowToken.
* @param amount The amount of EscrowToken being deallocated.
*/
function deallocate(address userAddress, uint256 amount, bytes calldata /*data*/ )
external
override
escrowTokenOnly
{
_burn(userAddress, amount);
uint256 newUserAllocation = usersAllocation[userAddress] - amount;
uint256 newTotalAllocation = totalAllocation - amount;
_updateUser(userAddress, newUserAllocation, newTotalAllocation);
}
/// @inheritdoc IStaking
function pendingRewardsAmount(address token, address userAddress) external view returns (uint256) {
uint256 cumAllocation = totalAllocation;
if (cumAllocation == 0) {
return 0;
}
StakingInfo storage stakingInfo_ = stakingInfo[token];
uint256 accRewardsPerShare = stakingInfo_.accRewardsPerShare;
uint256 lastUpdateTime = stakingInfo_.lastUpdateTime;
uint256 rewardsAmountPerSecond_ = _rewardsAmountPerSecond(token);
// check if the current cycle has changed since last update
if (_currentBlockTimestamp() > nextCycleStartTime()) {
// get remaining rewards from last cycle
accRewardsPerShare = accRewardsPerShare
+ ((nextCycleStartTime() - lastUpdateTime) * rewardsAmountPerSecond_ * 1e16 / cumAllocation);
lastUpdateTime = nextCycleStartTime();
rewardsAmountPerSecond_ =
stakingInfo_.pendingAmount * stakingInfo_.cycleRewardsPercent / 100 / CYCLE_DURATION_SECONDS;
}
// get pending rewards from current cycle
accRewardsPerShare = accRewardsPerShare
+ ((_currentBlockTimestamp() - lastUpdateTime) * rewardsAmountPerSecond_ * 1e16 / cumAllocation);
return usersAllocation[userAddress] * accRewardsPerShare / 1e18 - users[token][userAddress].rewardDebt
+ users[token][userAddress].pendingRewards;
}
/// @inheritdoc IStaking
function distributedTokensLength() external view override returns (uint256) {
return _distributedTokens.length();
}
/// @inheritdoc IStaking
function distributedToken(uint256 index)
external
view
override
validateDistributedTokensIndex(index)
returns (address)
{
return address(_distributedTokens.at(index));
}
/// @inheritdoc IStaking
function isDistributedToken(address token) external view override returns (bool) {
return _distributedTokens.contains(token);
}
/// @inheritdoc IStaking
function emergencyWithdraw(IERC20 token) public onlyOwner {
uint256 balance = token.balanceOf(address(this));
if (balance == 0) revert ZeroBalance();
_safeTokenTransfer(token, msg.sender, balance);
}
/// @inheritdoc IStaking
function updateCurrentCycleStartTime() public {
uint256 currentBlockTimestamp = _currentBlockTimestamp();
if (currentBlockTimestamp >= currentCycleStartTime + CYCLE_DURATION_SECONDS) {
uint256 cyclesPassed = (currentBlockTimestamp - currentCycleStartTime) / CYCLE_DURATION_SECONDS;
currentCycleStartTime += cyclesPassed * CYCLE_DURATION_SECONDS;
}
}
/// @inheritdoc IStaking
function nextCycleStartTime() public view returns (uint256) {
return currentCycleStartTime + CYCLE_DURATION_SECONDS;
}
/**
* @notice Internal function to update reward information for a specific token.
* It recalculates `accRewardsPerShare` based on
* time elapsed and new rewards added to distribution.
* Handles cycle transitions and ensures distribution amounts are consistent.
* @param token The address of the token whose reward info is to be updated.
*/
function _updateStakingInfo(address token) internal {
uint256 currentBlockTimestamp = _currentBlockTimestamp();
StakingInfo storage stakingInfo_ = stakingInfo[token];
updateCurrentCycleStartTime();
uint256 lastUpdateTime = stakingInfo_.lastUpdateTime;
uint256 cumAllocation = totalAllocation;
if (currentBlockTimestamp < currentCycleStartTime || cumAllocation == 0) {
stakingInfo_.lastUpdateTime = currentBlockTimestamp;
return;
}
uint256 accRewardsPerShare = stakingInfo_.accRewardsPerShare;
uint256 currentDistributionAmount = stakingInfo_.currentDistributionAmount;
uint256 currentCycleDistributedAmount = stakingInfo_.currentCycleDistributedAmount;
uint256 pendingAmount = stakingInfo_.pendingAmount;
uint256 distributedAmount = stakingInfo_.distributedAmount;
uint256 cyclePercent = stakingInfo_.cycleRewardsPercent;
bool distributionDisabled = stakingInfo_.distributionDisabled;
uint256 cycleStartTime = currentCycleStartTime;
if (lastUpdateTime < cycleStartTime) {
// complete the previous partial cycle
accRewardsPerShare +=
((currentDistributionAmount * 1e2 - currentCycleDistributedAmount) * 1e16 / cumAllocation);
distributedAmount += currentDistributionAmount;
if (!distributionDisabled) {
// calculate how many full cycles were skipped
uint256 totalCyclesPassed =
(cycleStartTime - lastUpdateTime + CYCLE_DURATION_SECONDS - 1) / CYCLE_DURATION_SECONDS;
uint256 skippedDistribution;
// process each skipped cycle
for (uint256 i = 1; i < totalCyclesPassed; ++i) {
skippedDistribution = pendingAmount * cyclePercent / 10000;
pendingAmount -= skippedDistribution;
distributedAmount += skippedDistribution;
accRewardsPerShare += (skippedDistribution * 1e18 / cumAllocation);
}
// setup current cycle
currentDistributionAmount = pendingAmount * cyclePercent / 10000;
pendingAmount -= currentDistributionAmount;
} else {
currentDistributionAmount = 0;
}
currentCycleDistributedAmount = 0;
lastUpdateTime = cycleStartTime;
}
// process time in current cycle
if (currentDistributionAmount > 0) {
uint256 timeInCurrentCycle = currentBlockTimestamp - lastUpdateTime;
uint256 toDistribute = timeInCurrentCycle * currentDistributionAmount * 1e2 / CYCLE_DURATION_SECONDS;
currentCycleDistributedAmount += toDistribute;
accRewardsPerShare += (toDistribute * 1e16 / cumAllocation);
}
stakingInfo_.accRewardsPerShare = accRewardsPerShare;
stakingInfo_.currentDistributionAmount = currentDistributionAmount;
stakingInfo_.currentCycleDistributedAmount = currentCycleDistributedAmount;
stakingInfo_.pendingAmount = pendingAmount;
stakingInfo_.distributedAmount = distributedAmount;
stakingInfo_.lastUpdateTime = currentBlockTimestamp;
}
/**
* @notice Internal function to update a user's allocation and reward debt across all distributed tokens.
* Called during allocation or deallocation of EscrowToken.
* @param userAddress The address of the user being updated.
* @param newUserAllocation The new EscrowToken allocation amount for the user.
* @param newTotalAllocation The new total EscrowToken allocation in the contract.
*/
function _updateUser(address userAddress, uint256 newUserAllocation, uint256 newTotalAllocation) internal {
uint256 previousUserAllocation = usersAllocation[userAddress];
// for each distributedToken
uint256 length = _distributedTokens.length();
for (uint256 index; index < length; ++index) {
address token = _distributedTokens.at(index);
_updateStakingInfo(token);
UserInfo storage user = users[token][userAddress];
uint256 accRewardsPerShare = stakingInfo[token].accRewardsPerShare;
uint256 pending = previousUserAllocation * accRewardsPerShare / 1e18 - user.rewardDebt;
user.pendingRewards += pending;
user.rewardDebt = newUserAllocation * accRewardsPerShare / 1e18;
}
usersAllocation[userAddress] = newUserAllocation;
totalAllocation = newTotalAllocation;
emit UserUpdated(userAddress, previousUserAllocation, newUserAllocation);
}
/**
* @notice Internal function to process the harvesting of rewards
* for the message sender for a specific token.
* Updates reward info, calculates pending rewards, transfers tokens, and updates user's reward debt.
* @param token The address of the token for which rewards are being harvested.
*/
function _harvestRewards(address token) internal {
_updateStakingInfo(token);
UserInfo storage user = users[token][msg.sender];
uint256 accRewardsPerShare = stakingInfo[token].accRewardsPerShare;
uint256 userEscrowAllocation = usersAllocation[msg.sender];
uint256 pending = user.pendingRewards + (userEscrowAllocation * accRewardsPerShare / 1e18 - user.rewardDebt);
user.pendingRewards = 0;
user.rewardDebt = userEscrowAllocation * accRewardsPerShare / 1e18;
_safeTokenTransfer(IERC20(token), msg.sender, pending);
emit RewardsCollected(msg.sender, token, pending);
}
/**
* @notice Safe token transfer function, in case rounding error causes pool to not have enough tokens.
* @param token The IERC20 token to transfer.
* @param to The address to which the tokens are being transferred.
* @param amount The amount of tokens to transfer.
*/
function _safeTokenTransfer(IERC20 token, address to, uint256 amount) internal {
if (amount > 0) {
uint256 tokenBal = token.balanceOf(address(this));
if (amount > tokenBal) {
token.safeTransfer(to, tokenBal);
} else {
token.safeTransfer(to, amount);
}
}
}
/**
* @notice Hook override to forbid transfers.
* @param from The address sending the tokens.
* @param to The address receiving the tokens.
* @param value The amount of tokens being transferred.
*/
function _update(address from, address to, uint256 value) internal override {
if (from != address(0) && to != address(0)) {
revert TransferNotAllowed();
}
super._update(from, to, value);
}
/**
* @notice Internal view function to calculate the rate of reward distribution per second for a token.
* The result is scaled by 1e2.
* @param token The address of the reward token.
* @return The amount of the token distributed per second, scaled by 1e2. Returns 0 if the token is not distributed.
*/
function _rewardsAmountPerSecond(address token) internal view returns (uint256) {
if (!_distributedTokens.contains(token)) return 0;
return stakingInfo[token].currentDistributionAmount * 1e2 / CYCLE_DURATION_SECONDS;
}
/**
* @notice Internal utility function to get the current block timestamp.
* @return The current block timestamp.
*/
function _currentBlockTimestamp() internal view virtual returns (uint256) {
/* solhint-disable not-rely-on-time */
return block.timestamp;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.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.
*
* The initial owner is set to the address provided by the deployer. 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;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(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 {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.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}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* Both values are immutable: they can only be set once during construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual 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 default value returned by this function, unless
* it's 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 returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` 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.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner`'s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @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
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @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);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) 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 a `value` amount of tokens 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 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 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 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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).
*
* This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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).
*
* This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/Arrays.sol)
// This file was procedurally generated from scripts/generate/templates/Arrays.js.
pragma solidity ^0.8.20;
import {Comparators} from "./Comparators.sol";
import {SlotDerivation} from "./SlotDerivation.sol";
import {StorageSlot} from "./StorageSlot.sol";
import {Math} from "./math/Math.sol";
/**
* @dev Collection of functions related to array types.
*/
library Arrays {
using SlotDerivation for bytes32;
using StorageSlot for bytes32;
/**
* @dev Sort an array of uint256 (in memory) following the provided comparator function.
*
* This function does the sorting "in place", meaning that it overrides the input. The object is returned for
* convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
*
* NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
* array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
* when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
* consume more gas than is available in a block, leading to potential DoS.
*
* IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
*/
function sort(
uint256[] memory array,
function(uint256, uint256) pure returns (bool) comp
) internal pure returns (uint256[] memory) {
_quickSort(_begin(array), _end(array), comp);
return array;
}
/**
* @dev Variant of {sort} that sorts an array of uint256 in increasing order.
*/
function sort(uint256[] memory array) internal pure returns (uint256[] memory) {
sort(array, Comparators.lt);
return array;
}
/**
* @dev Sort an array of address (in memory) following the provided comparator function.
*
* This function does the sorting "in place", meaning that it overrides the input. The object is returned for
* convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
*
* NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
* array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
* when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
* consume more gas than is available in a block, leading to potential DoS.
*
* IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
*/
function sort(
address[] memory array,
function(address, address) pure returns (bool) comp
) internal pure returns (address[] memory) {
sort(_castToUint256Array(array), _castToUint256Comp(comp));
return array;
}
/**
* @dev Variant of {sort} that sorts an array of address in increasing order.
*/
function sort(address[] memory array) internal pure returns (address[] memory) {
sort(_castToUint256Array(array), Comparators.lt);
return array;
}
/**
* @dev Sort an array of bytes32 (in memory) following the provided comparator function.
*
* This function does the sorting "in place", meaning that it overrides the input. The object is returned for
* convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
*
* NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
* array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
* when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
* consume more gas than is available in a block, leading to potential DoS.
*
* IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
*/
function sort(
bytes32[] memory array,
function(bytes32, bytes32) pure returns (bool) comp
) internal pure returns (bytes32[] memory) {
sort(_castToUint256Array(array), _castToUint256Comp(comp));
return array;
}
/**
* @dev Variant of {sort} that sorts an array of bytes32 in increasing order.
*/
function sort(bytes32[] memory array) internal pure returns (bytes32[] memory) {
sort(_castToUint256Array(array), Comparators.lt);
return array;
}
/**
* @dev Performs a quick sort of a segment of memory. The segment sorted starts at `begin` (inclusive), and stops
* at end (exclusive). Sorting follows the `comp` comparator.
*
* Invariant: `begin <= end`. This is the case when initially called by {sort} and is preserved in subcalls.
*
* IMPORTANT: Memory locations between `begin` and `end` are not validated/zeroed. This function should
* be used only if the limits are within a memory array.
*/
function _quickSort(uint256 begin, uint256 end, function(uint256, uint256) pure returns (bool) comp) private pure {
unchecked {
if (end - begin < 0x40) return;
// Use first element as pivot
uint256 pivot = _mload(begin);
// Position where the pivot should be at the end of the loop
uint256 pos = begin;
for (uint256 it = begin + 0x20; it < end; it += 0x20) {
if (comp(_mload(it), pivot)) {
// If the value stored at the iterator's position comes before the pivot, we increment the
// position of the pivot and move the value there.
pos += 0x20;
_swap(pos, it);
}
}
_swap(begin, pos); // Swap pivot into place
_quickSort(begin, pos, comp); // Sort the left side of the pivot
_quickSort(pos + 0x20, end, comp); // Sort the right side of the pivot
}
}
/**
* @dev Pointer to the memory location of the first element of `array`.
*/
function _begin(uint256[] memory array) private pure returns (uint256 ptr) {
assembly ("memory-safe") {
ptr := add(array, 0x20)
}
}
/**
* @dev Pointer to the memory location of the first memory word (32bytes) after `array`. This is the memory word
* that comes just after the last element of the array.
*/
function _end(uint256[] memory array) private pure returns (uint256 ptr) {
unchecked {
return _begin(array) + array.length * 0x20;
}
}
/**
* @dev Load memory word (as a uint256) at location `ptr`.
*/
function _mload(uint256 ptr) private pure returns (uint256 value) {
assembly {
value := mload(ptr)
}
}
/**
* @dev Swaps the elements memory location `ptr1` and `ptr2`.
*/
function _swap(uint256 ptr1, uint256 ptr2) private pure {
assembly {
let value1 := mload(ptr1)
let value2 := mload(ptr2)
mstore(ptr1, value2)
mstore(ptr2, value1)
}
}
/// @dev Helper: low level cast address memory array to uint256 memory array
function _castToUint256Array(address[] memory input) private pure returns (uint256[] memory output) {
assembly {
output := input
}
}
/// @dev Helper: low level cast bytes32 memory array to uint256 memory array
function _castToUint256Array(bytes32[] memory input) private pure returns (uint256[] memory output) {
assembly {
output := input
}
}
/// @dev Helper: low level cast address comp function to uint256 comp function
function _castToUint256Comp(
function(address, address) pure returns (bool) input
) private pure returns (function(uint256, uint256) pure returns (bool) output) {
assembly {
output := input
}
}
/// @dev Helper: low level cast bytes32 comp function to uint256 comp function
function _castToUint256Comp(
function(bytes32, bytes32) pure returns (bool) input
) private pure returns (function(uint256, uint256) pure returns (bool) output) {
assembly {
output := input
}
}
/**
* @dev Searches a sorted `array` and returns the first index that contains
* a value greater or equal to `element`. If no such index exists (i.e. all
* values in the array are strictly less than `element`), the array length is
* returned. Time complexity O(log n).
*
* NOTE: The `array` is expected to be sorted in ascending order, and to
* contain no repeated elements.
*
* IMPORTANT: Deprecated. This implementation behaves as {lowerBound} but lacks
* support for repeated elements in the array. The {lowerBound} function should
* be used instead.
*/
function findUpperBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeAccess(array, mid).value > element) {
high = mid;
} else {
low = mid + 1;
}
}
// At this point `low` is the exclusive upper bound. We will return the inclusive upper bound.
if (low > 0 && unsafeAccess(array, low - 1).value == element) {
return low - 1;
} else {
return low;
}
}
/**
* @dev Searches an `array` sorted in ascending order and returns the first
* index that contains a value greater or equal than `element`. If no such index
* exists (i.e. all values in the array are strictly less than `element`), the array
* length is returned. Time complexity O(log n).
*
* See C++'s https://en.cppreference.com/w/cpp/algorithm/lower_bound[lower_bound].
*/
function lowerBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeAccess(array, mid).value < element) {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
} else {
high = mid;
}
}
return low;
}
/**
* @dev Searches an `array` sorted in ascending order and returns the first
* index that contains a value strictly greater than `element`. If no such index
* exists (i.e. all values in the array are strictly less than `element`), the array
* length is returned. Time complexity O(log n).
*
* See C++'s https://en.cppreference.com/w/cpp/algorithm/upper_bound[upper_bound].
*/
function upperBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeAccess(array, mid).value > element) {
high = mid;
} else {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
}
}
return low;
}
/**
* @dev Same as {lowerBound}, but with an array in memory.
*/
function lowerBoundMemory(uint256[] memory array, uint256 element) internal pure returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeMemoryAccess(array, mid) < element) {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
} else {
high = mid;
}
}
return low;
}
/**
* @dev Same as {upperBound}, but with an array in memory.
*/
function upperBoundMemory(uint256[] memory array, uint256 element) internal pure returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeMemoryAccess(array, mid) > element) {
high = mid;
} else {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
}
}
return low;
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeAccess(address[] storage arr, uint256 pos) internal pure returns (StorageSlot.AddressSlot storage) {
bytes32 slot;
assembly ("memory-safe") {
slot := arr.slot
}
return slot.deriveArray().offset(pos).getAddressSlot();
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeAccess(bytes32[] storage arr, uint256 pos) internal pure returns (StorageSlot.Bytes32Slot storage) {
bytes32 slot;
assembly ("memory-safe") {
slot := arr.slot
}
return slot.deriveArray().offset(pos).getBytes32Slot();
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeAccess(uint256[] storage arr, uint256 pos) internal pure returns (StorageSlot.Uint256Slot storage) {
bytes32 slot;
assembly ("memory-safe") {
slot := arr.slot
}
return slot.deriveArray().offset(pos).getUint256Slot();
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeMemoryAccess(address[] memory arr, uint256 pos) internal pure returns (address res) {
assembly {
res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
}
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeMemoryAccess(bytes32[] memory arr, uint256 pos) internal pure returns (bytes32 res) {
assembly {
res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
}
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeMemoryAccess(uint256[] memory arr, uint256 pos) internal pure returns (uint256 res) {
assembly {
res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
}
}
/**
* @dev Helper to set the length of a dynamic array. Directly writing to `.length` is forbidden.
*
* WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
*/
function unsafeSetLength(address[] storage array, uint256 len) internal {
assembly ("memory-safe") {
sstore(array.slot, len)
}
}
/**
* @dev Helper to set the length of a dynamic array. Directly writing to `.length` is forbidden.
*
* WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
*/
function unsafeSetLength(bytes32[] storage array, uint256 len) internal {
assembly ("memory-safe") {
sstore(array.slot, len)
}
}
/**
* @dev Helper to set the length of a dynamic array. Directly writing to `.length` is forbidden.
*
* WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
*/
function unsafeSetLength(uint256[] storage array, uint256 len) internal {
assembly ("memory-safe") {
sstore(array.slot, len)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Comparators.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides a set of functions to compare values.
*
* _Available since v5.1._
*/
library Comparators {
function lt(uint256 a, uint256 b) internal pure returns (bool) {
return a < b;
}
function gt(uint256 a, uint256 b) internal pure returns (bool) {
return a > b;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @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) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Return the 512-bit addition of two uint256.
*
* The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
*/
function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
assembly ("memory-safe") {
low := add(a, b)
high := lt(low, a)
}
}
/**
* @dev Return the 512-bit multiplication of two uint256.
*
* The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
*/
function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
// 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = high * 2²⁵⁶ + low.
assembly ("memory-safe") {
let mm := mulmod(a, b, not(0))
low := mul(a, b)
high := sub(sub(mm, low), lt(mm, low))
}
}
/**
* @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
success = c >= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a - b;
success = c <= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a * b;
assembly ("memory-safe") {
// Only true when the multiplication doesn't overflow
// (c / a == b) || (a == 0)
success := or(eq(div(c, a), b), iszero(a))
}
// equivalent to: success ? c : 0
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `DIV` opcode returns zero when the denominator is 0.
result := div(a, b)
}
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `MOD` opcode returns zero when the denominator is 0.
result := mod(a, b)
}
}
}
/**
* @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryAdd(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
*/
function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
(, uint256 result) = trySub(a, b);
return result;
}
/**
* @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryMul(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
// Handle non-overflow cases, 256 by 256 division.
if (high == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return low / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= high) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [high low].
uint256 remainder;
assembly ("memory-safe") {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
high := sub(high, gt(remainder, low))
low := sub(low, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly ("memory-safe") {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [high low] by twos.
low := div(low, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from high into low.
low |= high * twos;
// Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
// is no longer required.
result = low * inverse;
return result;
}
}
/**
* @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
*/
function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
if (high >= 1 << n) {
Panic.panic(Panic.UNDER_OVERFLOW);
}
return (high << (256 - n)) | (low >> n);
}
}
/**
* @dev Calculates x * y >> n with full precision, following the selected rounding direction.
*/
function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
for (uint256 i = 0; i < byteArray.length; ++i) {
if (byteArray[i] != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// If upper 8 bits of 16-bit half set, add 8 to result
r |= SafeCast.toUint((x >> r) > 0xff) << 3;
// If upper 4 bits of 8-bit half set, add 4 to result
r |= SafeCast.toUint((x >> r) > 0xf) << 2;
// Shifts value right by the current result and use it as an index into this lookup table:
//
// | x (4 bits) | index | table[index] = MSB position |
// |------------|---------|-----------------------------|
// | 0000 | 0 | table[0] = 0 |
// | 0001 | 1 | table[1] = 0 |
// | 0010 | 2 | table[2] = 1 |
// | 0011 | 3 | table[3] = 1 |
// | 0100 | 4 | table[4] = 2 |
// | 0101 | 5 | table[5] = 2 |
// | 0110 | 6 | table[6] = 2 |
// | 0111 | 7 | table[7] = 2 |
// | 1000 | 8 | table[8] = 3 |
// | 1001 | 9 | table[9] = 3 |
// | 1010 | 10 | table[10] = 3 |
// | 1011 | 11 | table[11] = 3 |
// | 1100 | 12 | table[12] = 3 |
// | 1101 | 13 | table[13] = 3 |
// | 1110 | 14 | table[14] = 3 |
// | 1111 | 15 | table[15] = 3 |
//
// The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the last 16 bytes.
assembly ("memory-safe") {
r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
}
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.
pragma solidity ^0.8.20;
/**
* @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*/
library SafeCast {
/**
* @dev Value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
/**
* @dev An int value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedIntToUint(int256 value);
/**
* @dev Value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);
/**
* @dev An uint value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedUintToInt(uint256 value);
/**
* @dev Returns the downcasted uint248 from uint256, reverting on
* overflow (when the input is greater than largest uint248).
*
* Counterpart to Solidity's `uint248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toUint248(uint256 value) internal pure returns (uint248) {
if (value > type(uint248).max) {
revert SafeCastOverflowedUintDowncast(248, value);
}
return uint248(value);
}
/**
* @dev Returns the downcasted uint240 from uint256, reverting on
* overflow (when the input is greater than largest uint240).
*
* Counterpart to Solidity's `uint240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toUint240(uint256 value) internal pure returns (uint240) {
if (value > type(uint240).max) {
revert SafeCastOverflowedUintDowncast(240, value);
}
return uint240(value);
}
/**
* @dev Returns the downcasted uint232 from uint256, reverting on
* overflow (when the input is greater than largest uint232).
*
* Counterpart to Solidity's `uint232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toUint232(uint256 value) internal pure returns (uint232) {
if (value > type(uint232).max) {
revert SafeCastOverflowedUintDowncast(232, value);
}
return uint232(value);
}
/**
* @dev Returns the downcasted uint224 from uint256, reverting on
* overflow (when the input is greater than largest uint224).
*
* Counterpart to Solidity's `uint224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toUint224(uint256 value) internal pure returns (uint224) {
if (value > type(uint224).max) {
revert SafeCastOverflowedUintDowncast(224, value);
}
return uint224(value);
}
/**
* @dev Returns the downcasted uint216 from uint256, reverting on
* overflow (when the input is greater than largest uint216).
*
* Counterpart to Solidity's `uint216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toUint216(uint256 value) internal pure returns (uint216) {
if (value > type(uint216).max) {
revert SafeCastOverflowedUintDowncast(216, value);
}
return uint216(value);
}
/**
* @dev Returns the downcasted uint208 from uint256, reverting on
* overflow (when the input is greater than largest uint208).
*
* Counterpart to Solidity's `uint208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toUint208(uint256 value) internal pure returns (uint208) {
if (value > type(uint208).max) {
revert SafeCastOverflowedUintDowncast(208, value);
}
return uint208(value);
}
/**
* @dev Returns the downcasted uint200 from uint256, reverting on
* overflow (when the input is greater than largest uint200).
*
* Counterpart to Solidity's `uint200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toUint200(uint256 value) internal pure returns (uint200) {
if (value > type(uint200).max) {
revert SafeCastOverflowedUintDowncast(200, value);
}
return uint200(value);
}
/**
* @dev Returns the downcasted uint192 from uint256, reverting on
* overflow (when the input is greater than largest uint192).
*
* Counterpart to Solidity's `uint192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toUint192(uint256 value) internal pure returns (uint192) {
if (value > type(uint192).max) {
revert SafeCastOverflowedUintDowncast(192, value);
}
return uint192(value);
}
/**
* @dev Returns the downcasted uint184 from uint256, reverting on
* overflow (when the input is greater than largest uint184).
*
* Counterpart to Solidity's `uint184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toUint184(uint256 value) internal pure returns (uint184) {
if (value > type(uint184).max) {
revert SafeCastOverflowedUintDowncast(184, value);
}
return uint184(value);
}
/**
* @dev Returns the downcasted uint176 from uint256, reverting on
* overflow (when the input is greater than largest uint176).
*
* Counterpart to Solidity's `uint176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toUint176(uint256 value) internal pure returns (uint176) {
if (value > type(uint176).max) {
revert SafeCastOverflowedUintDowncast(176, value);
}
return uint176(value);
}
/**
* @dev Returns the downcasted uint168 from uint256, reverting on
* overflow (when the input is greater than largest uint168).
*
* Counterpart to Solidity's `uint168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toUint168(uint256 value) internal pure returns (uint168) {
if (value > type(uint168).max) {
revert SafeCastOverflowedUintDowncast(168, value);
}
return uint168(value);
}
/**
* @dev Returns the downcasted uint160 from uint256, reverting on
* overflow (when the input is greater than largest uint160).
*
* Counterpart to Solidity's `uint160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toUint160(uint256 value) internal pure returns (uint160) {
if (value > type(uint160).max) {
revert SafeCastOverflowedUintDowncast(160, value);
}
return uint160(value);
}
/**
* @dev Returns the downcasted uint152 from uint256, reverting on
* overflow (when the input is greater than largest uint152).
*
* Counterpart to Solidity's `uint152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toUint152(uint256 value) internal pure returns (uint152) {
if (value > type(uint152).max) {
revert SafeCastOverflowedUintDowncast(152, value);
}
return uint152(value);
}
/**
* @dev Returns the downcasted uint144 from uint256, reverting on
* overflow (when the input is greater than largest uint144).
*
* Counterpart to Solidity's `uint144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toUint144(uint256 value) internal pure returns (uint144) {
if (value > type(uint144).max) {
revert SafeCastOverflowedUintDowncast(144, value);
}
return uint144(value);
}
/**
* @dev Returns the downcasted uint136 from uint256, reverting on
* overflow (when the input is greater than largest uint136).
*
* Counterpart to Solidity's `uint136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toUint136(uint256 value) internal pure returns (uint136) {
if (value > type(uint136).max) {
revert SafeCastOverflowedUintDowncast(136, value);
}
return uint136(value);
}
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toUint128(uint256 value) internal pure returns (uint128) {
if (value > type(uint128).max) {
revert SafeCastOverflowedUintDowncast(128, value);
}
return uint128(value);
}
/**
* @dev Returns the downcasted uint120 from uint256, reverting on
* overflow (when the input is greater than largest uint120).
*
* Counterpart to Solidity's `uint120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toUint120(uint256 value) internal pure returns (uint120) {
if (value > type(uint120).max) {
revert SafeCastOverflowedUintDowncast(120, value);
}
return uint120(value);
}
/**
* @dev Returns the downcasted uint112 from uint256, reverting on
* overflow (when the input is greater than largest uint112).
*
* Counterpart to Solidity's `uint112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toUint112(uint256 value) internal pure returns (uint112) {
if (value > type(uint112).max) {
revert SafeCastOverflowedUintDowncast(112, value);
}
return uint112(value);
}
/**
* @dev Returns the downcasted uint104 from uint256, reverting on
* overflow (when the input is greater than largest uint104).
*
* Counterpart to Solidity's `uint104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toUint104(uint256 value) internal pure returns (uint104) {
if (value > type(uint104).max) {
revert SafeCastOverflowedUintDowncast(104, value);
}
return uint104(value);
}
/**
* @dev Returns the downcasted uint96 from uint256, reverting on
* overflow (when the input is greater than largest uint96).
*
* Counterpart to Solidity's `uint96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toUint96(uint256 value) internal pure returns (uint96) {
if (value > type(uint96).max) {
revert SafeCastOverflowedUintDowncast(96, value);
}
return uint96(value);
}
/**
* @dev Returns the downcasted uint88 from uint256, reverting on
* overflow (when the input is greater than largest uint88).
*
* Counterpart to Solidity's `uint88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toUint88(uint256 value) internal pure returns (uint88) {
if (value > type(uint88).max) {
revert SafeCastOverflowedUintDowncast(88, value);
}
return uint88(value);
}
/**
* @dev Returns the downcasted uint80 from uint256, reverting on
* overflow (when the input is greater than largest uint80).
*
* Counterpart to Solidity's `uint80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toUint80(uint256 value) internal pure returns (uint80) {
if (value > type(uint80).max) {
revert SafeCastOverflowedUintDowncast(80, value);
}
return uint80(value);
}
/**
* @dev Returns the downcasted uint72 from uint256, reverting on
* overflow (when the input is greater than largest uint72).
*
* Counterpart to Solidity's `uint72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toUint72(uint256 value) internal pure returns (uint72) {
if (value > type(uint72).max) {
revert SafeCastOverflowedUintDowncast(72, value);
}
return uint72(value);
}
/**
* @dev Returns the downcasted uint64 from uint256, reverting on
* overflow (when the input is greater than largest uint64).
*
* Counterpart to Solidity's `uint64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toUint64(uint256 value) internal pure returns (uint64) {
if (value > type(uint64).max) {
revert SafeCastOverflowedUintDowncast(64, value);
}
return uint64(value);
}
/**
* @dev Returns the downcasted uint56 from uint256, reverting on
* overflow (when the input is greater than largest uint56).
*
* Counterpart to Solidity's `uint56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toUint56(uint256 value) internal pure returns (uint56) {
if (value > type(uint56).max) {
revert SafeCastOverflowedUintDowncast(56, value);
}
return uint56(value);
}
/**
* @dev Returns the downcasted uint48 from uint256, reverting on
* overflow (when the input is greater than largest uint48).
*
* Counterpart to Solidity's `uint48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toUint48(uint256 value) internal pure returns (uint48) {
if (value > type(uint48).max) {
revert SafeCastOverflowedUintDowncast(48, value);
}
return uint48(value);
}
/**
* @dev Returns the downcasted uint40 from uint256, reverting on
* overflow (when the input is greater than largest uint40).
*
* Counterpart to Solidity's `uint40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toUint40(uint256 value) internal pure returns (uint40) {
if (value > type(uint40).max) {
revert SafeCastOverflowedUintDowncast(40, value);
}
return uint40(value);
}
/**
* @dev Returns the downcasted uint32 from uint256, reverting on
* overflow (when the input is greater than largest uint32).
*
* Counterpart to Solidity's `uint32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toUint32(uint256 value) internal pure returns (uint32) {
if (value > type(uint32).max) {
revert SafeCastOverflowedUintDowncast(32, value);
}
return uint32(value);
}
/**
* @dev Returns the downcasted uint24 from uint256, reverting on
* overflow (when the input is greater than largest uint24).
*
* Counterpart to Solidity's `uint24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toUint24(uint256 value) internal pure returns (uint24) {
if (value > type(uint24).max) {
revert SafeCastOverflowedUintDowncast(24, value);
}
return uint24(value);
}
/**
* @dev Returns the downcasted uint16 from uint256, reverting on
* overflow (when the input is greater than largest uint16).
*
* Counterpart to Solidity's `uint16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toUint16(uint256 value) internal pure returns (uint16) {
if (value > type(uint16).max) {
revert SafeCastOverflowedUintDowncast(16, value);
}
return uint16(value);
}
/**
* @dev Returns the downcasted uint8 from uint256, reverting on
* overflow (when the input is greater than largest uint8).
*
* Counterpart to Solidity's `uint8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toUint8(uint256 value) internal pure returns (uint8) {
if (value > type(uint8).max) {
revert SafeCastOverflowedUintDowncast(8, value);
}
return uint8(value);
}
/**
* @dev Converts a signed int256 into an unsigned uint256.
*
* Requirements:
*
* - input must be greater than or equal to 0.
*/
function toUint256(int256 value) internal pure returns (uint256) {
if (value < 0) {
revert SafeCastOverflowedIntToUint(value);
}
return uint256(value);
}
/**
* @dev Returns the downcasted int248 from int256, reverting on
* overflow (when the input is less than smallest int248 or
* greater than largest int248).
*
* Counterpart to Solidity's `int248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toInt248(int256 value) internal pure returns (int248 downcasted) {
downcasted = int248(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(248, value);
}
}
/**
* @dev Returns the downcasted int240 from int256, reverting on
* overflow (when the input is less than smallest int240 or
* greater than largest int240).
*
* Counterpart to Solidity's `int240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toInt240(int256 value) internal pure returns (int240 downcasted) {
downcasted = int240(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(240, value);
}
}
/**
* @dev Returns the downcasted int232 from int256, reverting on
* overflow (when the input is less than smallest int232 or
* greater than largest int232).
*
* Counterpart to Solidity's `int232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toInt232(int256 value) internal pure returns (int232 downcasted) {
downcasted = int232(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(232, value);
}
}
/**
* @dev Returns the downcasted int224 from int256, reverting on
* overflow (when the input is less than smallest int224 or
* greater than largest int224).
*
* Counterpart to Solidity's `int224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toInt224(int256 value) internal pure returns (int224 downcasted) {
downcasted = int224(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(224, value);
}
}
/**
* @dev Returns the downcasted int216 from int256, reverting on
* overflow (when the input is less than smallest int216 or
* greater than largest int216).
*
* Counterpart to Solidity's `int216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toInt216(int256 value) internal pure returns (int216 downcasted) {
downcasted = int216(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(216, value);
}
}
/**
* @dev Returns the downcasted int208 from int256, reverting on
* overflow (when the input is less than smallest int208 or
* greater than largest int208).
*
* Counterpart to Solidity's `int208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toInt208(int256 value) internal pure returns (int208 downcasted) {
downcasted = int208(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(208, value);
}
}
/**
* @dev Returns the downcasted int200 from int256, reverting on
* overflow (when the input is less than smallest int200 or
* greater than largest int200).
*
* Counterpart to Solidity's `int200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toInt200(int256 value) internal pure returns (int200 downcasted) {
downcasted = int200(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(200, value);
}
}
/**
* @dev Returns the downcasted int192 from int256, reverting on
* overflow (when the input is less than smallest int192 or
* greater than largest int192).
*
* Counterpart to Solidity's `int192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toInt192(int256 value) internal pure returns (int192 downcasted) {
downcasted = int192(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(192, value);
}
}
/**
* @dev Returns the downcasted int184 from int256, reverting on
* overflow (when the input is less than smallest int184 or
* greater than largest int184).
*
* Counterpart to Solidity's `int184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toInt184(int256 value) internal pure returns (int184 downcasted) {
downcasted = int184(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(184, value);
}
}
/**
* @dev Returns the downcasted int176 from int256, reverting on
* overflow (when the input is less than smallest int176 or
* greater than largest int176).
*
* Counterpart to Solidity's `int176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toInt176(int256 value) internal pure returns (int176 downcasted) {
downcasted = int176(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(176, value);
}
}
/**
* @dev Returns the downcasted int168 from int256, reverting on
* overflow (when the input is less than smallest int168 or
* greater than largest int168).
*
* Counterpart to Solidity's `int168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toInt168(int256 value) internal pure returns (int168 downcasted) {
downcasted = int168(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(168, value);
}
}
/**
* @dev Returns the downcasted int160 from int256, reverting on
* overflow (when the input is less than smallest int160 or
* greater than largest int160).
*
* Counterpart to Solidity's `int160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toInt160(int256 value) internal pure returns (int160 downcasted) {
downcasted = int160(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(160, value);
}
}
/**
* @dev Returns the downcasted int152 from int256, reverting on
* overflow (when the input is less than smallest int152 or
* greater than largest int152).
*
* Counterpart to Solidity's `int152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toInt152(int256 value) internal pure returns (int152 downcasted) {
downcasted = int152(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(152, value);
}
}
/**
* @dev Returns the downcasted int144 from int256, reverting on
* overflow (when the input is less than smallest int144 or
* greater than largest int144).
*
* Counterpart to Solidity's `int144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toInt144(int256 value) internal pure returns (int144 downcasted) {
downcasted = int144(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(144, value);
}
}
/**
* @dev Returns the downcasted int136 from int256, reverting on
* overflow (when the input is less than smallest int136 or
* greater than largest int136).
*
* Counterpart to Solidity's `int136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toInt136(int256 value) internal pure returns (int136 downcasted) {
downcasted = int136(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(136, value);
}
}
/**
* @dev Returns the downcasted int128 from int256, reverting on
* overflow (when the input is less than smallest int128 or
* greater than largest int128).
*
* Counterpart to Solidity's `int128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toInt128(int256 value) internal pure returns (int128 downcasted) {
downcasted = int128(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(128, value);
}
}
/**
* @dev Returns the downcasted int120 from int256, reverting on
* overflow (when the input is less than smallest int120 or
* greater than largest int120).
*
* Counterpart to Solidity's `int120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toInt120(int256 value) internal pure returns (int120 downcasted) {
downcasted = int120(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(120, value);
}
}
/**
* @dev Returns the downcasted int112 from int256, reverting on
* overflow (when the input is less than smallest int112 or
* greater than largest int112).
*
* Counterpart to Solidity's `int112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toInt112(int256 value) internal pure returns (int112 downcasted) {
downcasted = int112(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(112, value);
}
}
/**
* @dev Returns the downcasted int104 from int256, reverting on
* overflow (when the input is less than smallest int104 or
* greater than largest int104).
*
* Counterpart to Solidity's `int104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toInt104(int256 value) internal pure returns (int104 downcasted) {
downcasted = int104(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(104, value);
}
}
/**
* @dev Returns the downcasted int96 from int256, reverting on
* overflow (when the input is less than smallest int96 or
* greater than largest int96).
*
* Counterpart to Solidity's `int96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toInt96(int256 value) internal pure returns (int96 downcasted) {
downcasted = int96(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(96, value);
}
}
/**
* @dev Returns the downcasted int88 from int256, reverting on
* overflow (when the input is less than smallest int88 or
* greater than largest int88).
*
* Counterpart to Solidity's `int88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toInt88(int256 value) internal pure returns (int88 downcasted) {
downcasted = int88(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(88, value);
}
}
/**
* @dev Returns the downcasted int80 from int256, reverting on
* overflow (when the input is less than smallest int80 or
* greater than largest int80).
*
* Counterpart to Solidity's `int80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toInt80(int256 value) internal pure returns (int80 downcasted) {
downcasted = int80(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(80, value);
}
}
/**
* @dev Returns the downcasted int72 from int256, reverting on
* overflow (when the input is less than smallest int72 or
* greater than largest int72).
*
* Counterpart to Solidity's `int72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toInt72(int256 value) internal pure returns (int72 downcasted) {
downcasted = int72(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(72, value);
}
}
/**
* @dev Returns the downcasted int64 from int256, reverting on
* overflow (when the input is less than smallest int64 or
* greater than largest int64).
*
* Counterpart to Solidity's `int64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toInt64(int256 value) internal pure returns (int64 downcasted) {
downcasted = int64(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(64, value);
}
}
/**
* @dev Returns the downcasted int56 from int256, reverting on
* overflow (when the input is less than smallest int56 or
* greater than largest int56).
*
* Counterpart to Solidity's `int56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toInt56(int256 value) internal pure returns (int56 downcasted) {
downcasted = int56(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(56, value);
}
}
/**
* @dev Returns the downcasted int48 from int256, reverting on
* overflow (when the input is less than smallest int48 or
* greater than largest int48).
*
* Counterpart to Solidity's `int48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toInt48(int256 value) internal pure returns (int48 downcasted) {
downcasted = int48(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(48, value);
}
}
/**
* @dev Returns the downcasted int40 from int256, reverting on
* overflow (when the input is less than smallest int40 or
* greater than largest int40).
*
* Counterpart to Solidity's `int40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toInt40(int256 value) internal pure returns (int40 downcasted) {
downcasted = int40(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(40, value);
}
}
/**
* @dev Returns the downcasted int32 from int256, reverting on
* overflow (when the input is less than smallest int32 or
* greater than largest int32).
*
* Counterpart to Solidity's `int32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toInt32(int256 value) internal pure returns (int32 downcasted) {
downcasted = int32(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(32, value);
}
}
/**
* @dev Returns the downcasted int24 from int256, reverting on
* overflow (when the input is less than smallest int24 or
* greater than largest int24).
*
* Counterpart to Solidity's `int24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toInt24(int256 value) internal pure returns (int24 downcasted) {
downcasted = int24(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(24, value);
}
}
/**
* @dev Returns the downcasted int16 from int256, reverting on
* overflow (when the input is less than smallest int16 or
* greater than largest int16).
*
* Counterpart to Solidity's `int16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toInt16(int256 value) internal pure returns (int16 downcasted) {
downcasted = int16(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(16, value);
}
}
/**
* @dev Returns the downcasted int8 from int256, reverting on
* overflow (when the input is less than smallest int8 or
* greater than largest int8).
*
* Counterpart to Solidity's `int8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toInt8(int256 value) internal pure returns (int8 downcasted) {
downcasted = int8(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(8, value);
}
}
/**
* @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) {
// Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
if (value > uint256(type(int256).max)) {
revert SafeCastOverflowedUintToInt(value);
}
return int256(value);
}
/**
* @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
*/
function toUint(bool b) internal pure returns (uint256 u) {
assembly ("memory-safe") {
u := iszero(iszero(b))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)
pragma solidity ^0.8.20;
/**
* @dev Helper library for emitting standardized panic codes.
*
* ```solidity
* contract Example {
* using Panic for uint256;
*
* // Use any of the declared internal constants
* function foo() { Panic.GENERIC.panic(); }
*
* // Alternatively
* function foo() { Panic.panic(Panic.GENERIC); }
* }
* ```
*
* Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
*
* _Available since v5.1._
*/
// slither-disable-next-line unused-state
library Panic {
/// @dev generic / unspecified error
uint256 internal constant GENERIC = 0x00;
/// @dev used by the assert() builtin
uint256 internal constant ASSERT = 0x01;
/// @dev arithmetic underflow or overflow
uint256 internal constant UNDER_OVERFLOW = 0x11;
/// @dev division or modulo by zero
uint256 internal constant DIVISION_BY_ZERO = 0x12;
/// @dev enum conversion error
uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
/// @dev invalid encoding in storage
uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
/// @dev empty array pop
uint256 internal constant EMPTY_ARRAY_POP = 0x31;
/// @dev array out of bounds access
uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
/// @dev resource error (too large allocation or too large array)
uint256 internal constant RESOURCE_ERROR = 0x41;
/// @dev calling invalid internal function
uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
/// @dev Reverts with a panic code. Recommended to use with
/// the internal constants with predefined codes.
function panic(uint256 code) internal pure {
assembly ("memory-safe") {
mstore(0x00, 0x4e487b71)
mstore(0x20, code)
revert(0x1c, 0x24)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/SlotDerivation.sol)
// This file was procedurally generated from scripts/generate/templates/SlotDerivation.js.
pragma solidity ^0.8.20;
/**
* @dev Library for computing storage (and transient storage) locations from namespaces and deriving slots
* corresponding to standard patterns. The derivation method for array and mapping matches the storage layout used by
* the solidity language / compiler.
*
* See https://docs.soliditylang.org/en/v0.8.20/internals/layout_in_storage.html#mappings-and-dynamic-arrays[Solidity docs for mappings and dynamic arrays.].
*
* Example usage:
* ```solidity
* contract Example {
* // Add the library methods
* using StorageSlot for bytes32;
* using SlotDerivation for bytes32;
*
* // Declare a namespace
* string private constant _NAMESPACE = "<namespace>"; // eg. OpenZeppelin.Slot
*
* function setValueInNamespace(uint256 key, address newValue) internal {
* _NAMESPACE.erc7201Slot().deriveMapping(key).getAddressSlot().value = newValue;
* }
*
* function getValueInNamespace(uint256 key) internal view returns (address) {
* return _NAMESPACE.erc7201Slot().deriveMapping(key).getAddressSlot().value;
* }
* }
* ```
*
* TIP: Consider using this library along with {StorageSlot}.
*
* NOTE: This library provides a way to manipulate storage locations in a non-standard way. Tooling for checking
* upgrade safety will ignore the slots accessed through this library.
*
* _Available since v5.1._
*/
library SlotDerivation {
/**
* @dev Derive an ERC-7201 slot from a string (namespace).
*/
function erc7201Slot(string memory namespace) internal pure returns (bytes32 slot) {
assembly ("memory-safe") {
mstore(0x00, sub(keccak256(add(namespace, 0x20), mload(namespace)), 1))
slot := and(keccak256(0x00, 0x20), not(0xff))
}
}
/**
* @dev Add an offset to a slot to get the n-th element of a structure or an array.
*/
function offset(bytes32 slot, uint256 pos) internal pure returns (bytes32 result) {
unchecked {
return bytes32(uint256(slot) + pos);
}
}
/**
* @dev Derive the location of the first element in an array from the slot where the length is stored.
*/
function deriveArray(bytes32 slot) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, slot)
result := keccak256(0x00, 0x20)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, address key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, and(key, shr(96, not(0))))
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, bool key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, iszero(iszero(key)))
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, bytes32 key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, key)
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, uint256 key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, key)
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, int256 key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, key)
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, string memory key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
let length := mload(key)
let begin := add(key, 0x20)
let end := add(begin, length)
let cache := mload(end)
mstore(end, slot)
result := keccak256(begin, add(length, 0x20))
mstore(end, cache)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, bytes memory key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
let length := mload(key)
let begin := add(key, 0x20)
let end := add(begin, length)
let cache := mload(end)
mstore(end, slot)
result := keccak256(begin, add(length, 0x20))
mstore(end, cache)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.20;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC-1967 implementation slot:
* ```solidity
* contract ERC1967 {
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(newImplementation.code.length > 0);
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct Int256Slot {
int256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Int256Slot` with member `value` located at `slot`.
*/
function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
/**
* @dev Returns a `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/structs/EnumerableSet.sol)
// This file was procedurally generated from scripts/generate/templates/EnumerableSet.js.
pragma solidity ^0.8.20;
import {Arrays} from "../Arrays.sol";
/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
* - Set can be cleared (all elements removed) in O(n).
*
* ```solidity
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*
* [WARNING]
* ====
* Trying to delete such a structure from storage will likely result in data corruption, rendering the structure
* unusable.
* See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
*
* In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an
* array of EnumerableSet.
* ====
*/
library EnumerableSet {
// To implement this library for multiple types with as little code
// repetition as possible, we write it in terms of a generic Set type with
// bytes32 values.
// The Set implementation uses private functions, and user-facing
// implementations (such as AddressSet) are just wrappers around the
// underlying Set.
// This means that we can only create new EnumerableSets for types that fit
// in bytes32.
struct Set {
// Storage of set values
bytes32[] _values;
// Position is the index of the value in the `values` array plus 1.
// Position 0 is used to mean a value is not in the set.
mapping(bytes32 value => uint256) _positions;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function _add(Set storage set, bytes32 value) private returns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes
// and use 0 as a sentinel value
set._positions[value] = set._values.length;
return true;
} else {
return false;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function _remove(Set storage set, bytes32 value) private returns (bool) {
// We cache the value's position to prevent multiple reads from the same storage slot
uint256 position = set._positions[value];
if (position != 0) {
// Equivalent to contains(set, value)
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in
// the array, and then remove the last element (sometimes called as 'swap and pop').
// This modifies the order of the array, as noted in {at}.
uint256 valueIndex = position - 1;
uint256 lastIndex = set._values.length - 1;
if (valueIndex != lastIndex) {
bytes32 lastValue = set._values[lastIndex];
// Move the lastValue to the index where the value to delete is
set._values[valueIndex] = lastValue;
// Update the tracked position of the lastValue (that was just moved)
set._positions[lastValue] = position;
}
// Delete the slot where the moved value was stored
set._values.pop();
// Delete the tracked position for the deleted slot
delete set._positions[value];
return true;
} else {
return false;
}
}
/**
* @dev Removes all the values from a set. O(n).
*
* WARNING: Developers should keep in mind that this function has an unbounded cost and using it may render the
* function uncallable if the set grows to the point where clearing it consumes too much gas to fit in a block.
*/
function _clear(Set storage set) private {
uint256 len = _length(set);
for (uint256 i = 0; i < len; ++i) {
delete set._positions[set._values[i]];
}
Arrays.unsafeSetLength(set._values, 0);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function _contains(Set storage set, bytes32 value) private view returns (bool) {
return set._positions[value] != 0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function _length(Set storage set) private view returns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function _at(Set storage set, uint256 index) private view returns (bytes32) {
return set._values[index];
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function _values(Set storage set) private view returns (bytes32[] memory) {
return set._values;
}
// Bytes32Set
struct Bytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Removes all the values from a set. O(n).
*
* WARNING: Developers should keep in mind that this function has an unbounded cost and using it may render the
* function uncallable if the set grows to the point where clearing it consumes too much gas to fit in a block.
*/
function clear(Bytes32Set storage set) internal {
_clear(set._inner);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(Bytes32Set storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
return _at(set._inner, index);
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
bytes32[] memory store = _values(set._inner);
bytes32[] memory result;
assembly ("memory-safe") {
result := store
}
return result;
}
// AddressSet
struct AddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(AddressSet storage set, address value) internal returns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(AddressSet storage set, address value) internal returns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes all the values from a set. O(n).
*
* WARNING: Developers should keep in mind that this function has an unbounded cost and using it may render the
* function uncallable if the set grows to the point where clearing it consumes too much gas to fit in a block.
*/
function clear(AddressSet storage set) internal {
_clear(set._inner);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(AddressSet storage set, address value) internal view returns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(AddressSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(AddressSet storage set, uint256 index) internal view returns (address) {
return address(uint160(uint256(_at(set._inner, index))));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(AddressSet storage set) internal view returns (address[] memory) {
bytes32[] memory store = _values(set._inner);
address[] memory result;
assembly ("memory-safe") {
result := store
}
return result;
}
// UintSet
struct UintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(UintSet storage set, uint256 value) internal returns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(UintSet storage set, uint256 value) internal returns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Removes all the values from a set. O(n).
*
* WARNING: Developers should keep in mind that this function has an unbounded cost and using it may render the
* function uncallable if the set grows to the point where clearing it consumes too much gas to fit in a block.
*/
function clear(UintSet storage set) internal {
_clear(set._inner);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(UintSet storage set, uint256 value) internal view returns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(UintSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(UintSet storage set, uint256 index) internal view returns (uint256) {
return uint256(_at(set._inner, index));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(UintSet storage set) internal view returns (uint256[] memory) {
bytes32[] memory store = _values(set._inner);
uint256[] memory result;
assembly ("memory-safe") {
result := store
}
return result;
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.30;
/**
* @title IEscrowTokenUsage
* @author Camelot
* @notice Interface for contracts that can utilize allocated escrow tokens.
* @dev Implement this interface to create usage contracts that can receive allocations from users.
*/
interface IEscrowTokenUsage {
/**
* @notice Called when a user allocates escrow tokens to this usage contract.
* @param userAddress The address of the user allocating tokens.
* @param amount The amount of escrow tokens being allocated.
* @param data Additional data passed by the user for custom logic.
*/
function allocate(address userAddress, uint256 amount, bytes calldata data) external;
/**
* @notice Called when a user deallocates escrow tokens from this usage contract.
* @param userAddress The address of the user deallocating tokens.
* @param amount The amount of escrow tokens being deallocated.
* @param data Additional data passed by the user for custom logic.
*/
function deallocate(address userAddress, uint256 amount, bytes calldata data) external;
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.30;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
/**
* @title IStaking
* @author Camelot
* @notice Interface for the staking contract that manages reward distributions.
* @dev Handles multiple reward tokens with cycle-based distribution.
*/
interface IStaking {
/**
* @notice Information about a user's rewards.
* @param pendingRewards The amount of pending rewards not yet claimed.
* @param rewardDebt The reward debt for accurate reward calculation.
*/
struct UserInfo {
uint256 pendingRewards;
uint256 rewardDebt;
}
/**
* @notice Information about a reward token's distribution.
* @param currentDistributionAmount Total amount to distribute during the current cycle.
* @param currentCycleDistributedAmount Amount already distributed for the current cycle (times 1e2).
* @param pendingAmount Total amount in the pending slot, not distributed yet.
* @param distributedAmount Total amount that has been distributed since initialization.
* @param accRewardsPerShare Accumulated rewards per share (times 1e18).
* @param lastUpdateTime Last time the rewards distribution occurred.
* @param cycleRewardsPercent Fixed part of the pending rewards to assign to currentDistributionAmount on every cycle.
* @param distributionDisabled Deactivate a token distribution (for temporary rewards).
*/
struct StakingInfo {
uint256 currentDistributionAmount;
uint256 currentCycleDistributedAmount;
uint256 pendingAmount;
uint256 distributedAmount;
uint256 accRewardsPerShare;
uint256 lastUpdateTime;
uint256 cycleRewardsPercent;
bool distributionDisabled;
}
/**
* @notice Storage structure for staking state.
* @param userInfo User info mapping.
* @param rewardsInfo Token info mapping.
* @param isDistributedToken Check if a token is distributed.
* @param distributedTokens List of distributed tokens.
*/
struct StakingStorage {
mapping(address => UserInfo) userInfo;
mapping(address => StakingInfo) rewardsInfo;
mapping(address => bool) isDistributedToken;
address[] distributedTokens;
}
/**
* @notice Thrown when a zero address is provided where it's not allowed.
*/
error AddressZero();
/**
* @notice Thrown when the specified index does not exist.
*/
error IndexDoesNotExist();
/**
* @notice Thrown when the specified token does not exist.
*/
error TokenDoesNotExist();
/**
* @notice Thrown when the caller is not the escrow contract.
* @param caller The address of the caller.
*/
error CallerNotEscrow(address caller);
/**
* @notice Thrown when an invalid token is provided.
*/
error InvalidToken();
/**
* @notice Thrown when attempting to operate with a zero balance.
*/
error ZeroBalance();
/**
* @notice Thrown when attempting to enable an already enabled distributed token.
* @param token The address of the token.
*/
error DistributedTokenAlreadyEnabled(address token);
/**
* @notice Thrown when the maximum number of distributed tokens is reached.
*/
error TooManyDistributedTokens();
/**
* @notice Thrown when attempting to disable an already disabled distributed token.
* @param token The address of the token.
*/
error DistributedTokenAlreadyDisabled(address token);
/**
* @notice Thrown when the cycle rewards percent is below the minimum.
*/
error MinimumCycleRewardsPercentExceeded();
/**
* @notice Thrown when the cycle rewards percent exceeds the maximum.
*/
error MaximumCycleRewardsPercentExceeded();
/**
* @notice Thrown when attempting to remove a token that cannot be removed.
*/
error TokenCannotBeRemoved();
/**
* @notice Thrown when a transfer is not allowed.
*/
error TransferNotAllowed();
/**
* @notice Emitted when the cycle rewards percent is updated for a token.
* @param token The address of the token.
* @param previousValue The previous cycle rewards percent.
* @param newValue The new cycle rewards percent.
*/
event CycleRewardsPercentUpdated(address indexed token, uint256 previousValue, uint256 newValue);
/**
* @notice Emitted when a distributed token is disabled.
* @param token The address of the token.
*/
event DistributedTokenDisabled(address indexed token);
/**
* @notice Emitted when a distributed token is enabled.
* @param token The address of the token.
*/
event DistributedTokenEnabled(address indexed token);
/**
* @notice Emitted when a distributed token is removed.
* @param token The address of the token.
*/
event DistributedTokenRemoved(address indexed token);
/**
* @notice Emitted when rewards are added to the pending pool.
* @param token The address of the reward token.
* @param amount The amount of rewards added.
*/
event RewardsAddedToPending(address indexed token, uint256 amount);
/**
* @notice Emitted when a user collects their rewards.
* @param user The address of the user.
* @param token The address of the reward token.
* @param amount The amount of rewards collected.
*/
event RewardsCollected(address indexed user, address indexed token, uint256 amount);
/**
* @notice Emitted when a user's staking balance is updated.
* @param user The address of the user.
* @param previousBalance The previous staking balance.
* @param newBalance The new staking balance.
*/
event UserUpdated(address indexed user, uint256 previousBalance, uint256 newBalance);
/**
* @notice Adds a specified amount of a token to the pending rewards pool.
* @dev This function is intended to be called by trusted sources (e.g., FeeManager) to supply reward tokens.
* It handles tokens with transfer taxes by calculating the actual received amount.
* @param token The address of the reward token.
* @param amount The amount of the token to add.
*/
function addRewardsToPending(address token, uint256 amount) external;
/**
* @notice Updates the current cycle start time if the previous cycle has ended.
* @dev This function can be called to manually advance the cycle if needed,
* though other functions also trigger this update.
*/
function updateCurrentCycleStartTime() external;
/**
* @notice Updates rewards information for a specific token.
* @dev This recalculates accumulated rewards per share for the token.
* @param token The address of the token to update.
*/
function updateStakingInfo(address token) external;
/**
* @notice Updates rewards information for all distributed tokens.
* @dev Iterates through all distributed tokens and calls `_updateStakingInfo` for each.
*/
function massUpdateStakingInfo() external;
/**
* @notice Harvests the caller's pending rewards for a specific token.
* @param token The address of the token for which to harvest rewards.
*/
function harvestRewards(address token) external;
/**
* @notice Harvests all of the caller's pending rewards across all distributed tokens.
*/
function harvestAllRewards() external;
/**
* @notice Allows the owner to withdraw the entire balance of a specific token from the contract.
* @dev This is an emergency function and should be used with caution.
* @param token The IERC20 token to withdraw.
*/
function emergencyWithdraw(IERC20 token) external;
/**
* @notice Allows the owner to withdraw the entire balance of all distributed tokens from the contract.
* @dev This is an emergency function and should be used with caution.
*/
function emergencyWithdrawAll() external;
/**
* @notice Enables a token to be distributed as rewards.
* @dev Only the owner can call this. The change takes effect from the next cycle.
* Initializes `lastUpdateTime` and `cycleRewardsPercent` if not previously set.
* @param token The address of the token to enable.
*/
function enableDistributedToken(address token) external;
/**
* @notice Disables the distribution of a given token as rewards.
* @dev Only the owner can call this. The change takes effect from the next cycle.
* @param token The address of the token to disable.
*/
function disableDistributedToken(address token) external;
/**
* @notice Updates the percentage of pending rewards for
* a token that will be distributed during the next cycle.
* @dev Only the owner can call this. The percentage must be within
* defined min/max bounds (MIN_CYCLE_REWARDS_PERCENT and MAX_CYCLE_REWARDS_PERCENT).
* @param token The address of the token for which to update the percentage.
* @param percent The new percentage (e.g., 100 for 1%).
*/
function updateCycleRewardsPercent(address token, uint256 percent) external;
/**
* @notice Removes a token from the list of distributed tokens.
* @dev Only the owner can call this. The token must be disabled and have no current distribution amount.
* @param tokenToRemove The address of the token to remove.
*/
function removeTokenFromDistributedTokens(address tokenToRemove) external;
/**
* @notice Returns the total number of tokens currently configured for reward distribution.
* @return The count of distributed tokens.
*/
function distributedTokensLength() external view returns (uint256);
/**
* @notice Returns the address of a distributed token at a specific index.
* @param index The index in the list of distributed tokens.
* @return The address of the token at the given index.
*/
function distributedToken(uint256 index) external view returns (address);
/**
* @notice Checks if a given token is currently configured for reward distribution.
* @param token The address of the token to check.
* @return True if the token is a distributed token, false otherwise.
*/
function isDistributedToken(address token) external view returns (bool);
/**
* @notice Calculates the start time of the next reward cycle.
* @return The Unix timestamp for the start of the next cycle.
*/
function nextCycleStartTime() external view returns (uint256);
/**
* @notice Calculates the amount of pending rewards for a specific user and token.
* @dev This is a view function and does not change state. It simulates updates to calculate pending rewards.
* @param token The address of the reward token.
* @param userAddress The address of the user.
* @return The amount of pending rewards for the user and token.
*/
function pendingRewardsAmount(address token, address userAddress) external view returns (uint256);
}{
"evmVersion": "prague",
"optimizer": {
"enabled": false,
"runs": 200
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"metadata": {
"useLiteralContent": true
}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"_escrowToken","type":"address"},{"internalType":"uint256","name":"_startTime","type":"uint256"},{"internalType":"string","name":"_name","type":"string"},{"internalType":"string","name":"_symbol","type":"string"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"AddressZero","type":"error"},{"inputs":[{"internalType":"address","name":"caller","type":"address"}],"name":"CallerNotEscrow","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"DistributedTokenAlreadyDisabled","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"DistributedTokenAlreadyEnabled","type":"error"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"allowance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientAllowance","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"balance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientBalance","type":"error"},{"inputs":[{"internalType":"address","name":"approver","type":"address"}],"name":"ERC20InvalidApprover","type":"error"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"ERC20InvalidReceiver","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"ERC20InvalidSender","type":"error"},{"inputs":[{"internalType":"address","name":"spender","type":"address"}],"name":"ERC20InvalidSpender","type":"error"},{"inputs":[],"name":"IndexDoesNotExist","type":"error"},{"inputs":[],"name":"InvalidToken","type":"error"},{"inputs":[],"name":"MaximumCycleRewardsPercentExceeded","type":"error"},{"inputs":[],"name":"MinimumCycleRewardsPercentExceeded","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[],"name":"TokenCannotBeRemoved","type":"error"},{"inputs":[],"name":"TokenDoesNotExist","type":"error"},{"inputs":[],"name":"TooManyDistributedTokens","type":"error"},{"inputs":[],"name":"TransferNotAllowed","type":"error"},{"inputs":[],"name":"ZeroBalance","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":false,"internalType":"uint256","name":"previousValue","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newValue","type":"uint256"}],"name":"CycleRewardsPercentUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"}],"name":"DistributedTokenDisabled","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"}],"name":"DistributedTokenEnabled","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"}],"name":"DistributedTokenRemoved","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RewardsAddedToPending","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RewardsCollected","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"previousBalance","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newBalance","type":"uint256"}],"name":"UserUpdated","type":"event"},{"inputs":[],"name":"CYCLE_DURATION_SECONDS","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"DEFAULT_CYCLE_REWARDS_PERCENT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_CYCLE_REWARDS_PERCENT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_DISTRIBUTED_TOKENS","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MIN_CYCLE_REWARDS_PERCENT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"addRewardsToPending","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"userAddress","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"allocate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"currentCycleStartTime","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"userAddress","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"deallocate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"disableDistributedToken","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"index","type":"uint256"}],"name":"distributedToken","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"distributedTokensLength","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"contract IERC20","name":"token","type":"address"}],"name":"emergencyWithdraw","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"emergencyWithdrawAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"enableDistributedToken","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"escrowToken","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"harvestAllRewards","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"harvestRewards","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"isDistributedToken","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"massUpdateStakingInfo","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"nextCycleStartTime","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"address","name":"userAddress","type":"address"}],"name":"pendingRewardsAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"tokenToRemove","type":"address"}],"name":"removeTokenFromDistributedTokens","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"stakingInfo","outputs":[{"internalType":"uint256","name":"currentDistributionAmount","type":"uint256"},{"internalType":"uint256","name":"currentCycleDistributedAmount","type":"uint256"},{"internalType":"uint256","name":"pendingAmount","type":"uint256"},{"internalType":"uint256","name":"distributedAmount","type":"uint256"},{"internalType":"uint256","name":"accRewardsPerShare","type":"uint256"},{"internalType":"uint256","name":"lastUpdateTime","type":"uint256"},{"internalType":"uint256","name":"cycleRewardsPercent","type":"uint256"},{"internalType":"bool","name":"distributionDisabled","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalAllocation","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"updateCurrentCycleStartTime","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"percent","type":"uint256"}],"name":"updateCycleRewardsPercent","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"updateStakingInfo","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"users","outputs":[{"internalType":"uint256","name":"pendingRewards","type":"uint256"},{"internalType":"uint256","name":"rewardDebt","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"usersAllocation","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]Contract Creation Code
60a060405234801561000f575f5ffd5b50604051613f8d380380613f8d8339818101604052810190610031919061041c565b338282816003908161004391906106bf565b50806004908161005391906106bf565b5050505f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036100c6575f6040517f1e4fbdf70000000000000000000000000000000000000000000000000000000081526004016100bd919061079d565b60405180910390fd5b6100d58161017f60201b60201c565b505f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff160361013b576040517f9fabe1c100000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8373ffffffffffffffffffffffffffffffffffffffff1660808173ffffffffffffffffffffffffffffffffffffffff168152505082600781905550505050506107b6565b5f60055f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1690508160055f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055508173ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a35050565b5f604051905090565b5f5ffd5b5f5ffd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f61027c82610253565b9050919050565b61028c81610272565b8114610296575f5ffd5b50565b5f815190506102a781610283565b92915050565b5f819050919050565b6102bf816102ad565b81146102c9575f5ffd5b50565b5f815190506102da816102b6565b92915050565b5f5ffd5b5f5ffd5b5f601f19601f8301169050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b61032e826102e8565b810181811067ffffffffffffffff8211171561034d5761034c6102f8565b5b80604052505050565b5f61035f610242565b905061036b8282610325565b919050565b5f67ffffffffffffffff82111561038a576103896102f8565b5b610393826102e8565b9050602081019050919050565b8281835e5f83830152505050565b5f6103c06103bb84610370565b610356565b9050828152602081018484840111156103dc576103db6102e4565b5b6103e78482856103a0565b509392505050565b5f82601f830112610403576104026102e0565b5b81516104138482602086016103ae565b91505092915050565b5f5f5f5f608085870312156104345761043361024b565b5b5f61044187828801610299565b9450506020610452878288016102cc565b935050604085015167ffffffffffffffff8111156104735761047261024f565b5b61047f878288016103ef565b925050606085015167ffffffffffffffff8111156104a05761049f61024f565b5b6104ac878288016103ef565b91505092959194509250565b5f81519050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f600282049050600182168061050657607f821691505b602082108103610519576105186104c2565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f6008830261057b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82610540565b6105858683610540565b95508019841693508086168417925050509392505050565b5f819050919050565b5f6105c06105bb6105b6846102ad565b61059d565b6102ad565b9050919050565b5f819050919050565b6105d9836105a6565b6105ed6105e5826105c7565b84845461054c565b825550505050565b5f5f905090565b6106046105f5565b61060f8184846105d0565b505050565b5b81811015610632576106275f826105fc565b600181019050610615565b5050565b601f821115610677576106488161051f565b61065184610531565b81016020851015610660578190505b61067461066c85610531565b830182610614565b50505b505050565b5f82821c905092915050565b5f6106975f198460080261067c565b1980831691505092915050565b5f6106af8383610688565b9150826002028217905092915050565b6106c8826104b8565b67ffffffffffffffff8111156106e1576106e06102f8565b5b6106eb82546104ef565b6106f6828285610636565b5f60209050601f831160018114610727575f8415610715578287015190505b61071f85826106a4565b865550610786565b601f1984166107358661051f565b5f5b8281101561075c57848901518255600182019150602085019450602081019050610737565b868310156107795784890151610775601f891682610688565b8355505b6001600288020188555050505b505050505050565b61079781610272565b82525050565b5f6020820190506107b05f83018461078e565b92915050565b6080516137b16107dc5f395f81816108d101528181610a090152610ad801526137b15ff3fe608060405234801561000f575f5ffd5b506004361061025c575f3560e01c80638e464baa11610144578063d637ff83116100c1578063e4c26d9611610085578063e4c26d96146106f2578063e895cca3146106fc578063eb013a2014610718578063ed93e40614610748578063f2bfbcc414610766578063f2fde38b146107845761025c565b8063d637ff8314610660578063dd1917191461067e578063dd62ed3e14610688578063de9d477e146106b8578063e0c1b6bb146106d45761025c565b8063a9059cbb11610108578063a9059cbb146105a8578063bd394a8d146105d8578063c4d3e083146105f6578063cc2dae8314610626578063d2af0b94146106425761025c565b80638e464baa1461050f57806393c563af1461052d57806394eecb501461054957806395d89b4114610580578063a125e0981461059e5761025c565b8063549230c9116101dd57806370a08231116101a157806370a082311461045f578063715018a61461048f57806379203dc414610499578063799fb965146104b75780638ca8fef9146104d55780638da5cb5b146104f15761025c565b8063549230c9146103bc5780635726d26e146103d85780635d9b436a146103e25780635e80536a146104125780636ff1c9bc146104435761025c565b80631c75e369116102245780631c75e3691461031857806323b872dd146103345780632fe319da14610364578063313ce56714610382578063515ce517146103a05761025c565b8063034d7fcb1461026057806306fdde0314610290578063095ea7b3146102ae5780631039850a146102de57806318160ddd146102fa575b5f5ffd5b61027a6004803603810190610275919061304c565b6107a0565b6040516102879190613091565b60405180910390f35b6102986107bc565b6040516102a5919061311a565b60405180910390f35b6102c860048036038101906102c3919061316d565b61084c565b6040516102d59190613091565b60405180910390f35b6102f860048036038101906102f3919061304c565b61086e565b005b6103026108c6565b60405161030f91906131ba565b60405180910390f35b610332600480360381019061032d9190613234565b6108cf565b005b61034e600480360381019061034991906132a5565b6109d9565b60405161035b9190613091565b60405180910390f35b61036c610a07565b6040516103799190613304565b60405180910390f35b61038a610a2b565b6040516103979190613338565b60405180910390f35b6103ba60048036038101906103b5919061304c565b610a33565b005b6103d660048036038101906103d19190613234565b610ad6565b005b6103e0610be0565b005b6103fc60048036038101906103f79190613351565b610c4c565b6040516104099190613304565b60405180910390f35b61042c6004803603810190610427919061337c565b610cac565b60405161043a9291906133ba565b60405180910390f35b61045d6004803603810190610458919061341c565b610cd7565b005b6104796004803603810190610474919061304c565b610da2565b60405161048691906131ba565b60405180910390f35b610497610de7565b005b6104a1610dfa565b6040516104ae91906131ba565b60405180910390f35b6104bf610e00565b6040516104cc91906131ba565b60405180910390f35b6104ef60048036038101906104ea919061316d565b610e06565b005b6104f9610f2c565b6040516105069190613304565b60405180910390f35b610517610f54565b60405161052491906131ba565b60405180910390f35b6105476004803603810190610542919061304c565b610f5a565b005b610563600480360381019061055e919061304c565b6110f8565b604051610577989796959493929190613447565b60405180910390f35b610588611148565b604051610595919061311a565b60405180910390f35b6105a66111d8565b005b6105c260048036038101906105bd919061316d565b61121a565b6040516105cf9190613091565b60405180910390f35b6105e061123c565b6040516105ed91906131ba565b60405180910390f35b610610600480360381019061060b919061304c565b61124c565b60405161061d91906131ba565b60405180910390f35b610640600480360381019061063b919061316d565b611261565b005b61064a61143e565b60405161065791906131ba565b60405180910390f35b610668611443565b60405161067591906131ba565b60405180910390f35b61068661145a565b005b6106a2600480360381019061069d919061337c565b6114a4565b6040516106af91906131ba565b60405180910390f35b6106d260048036038101906106cd919061304c565b611526565b005b6106dc611621565b6040516106e991906131ba565b60405180910390f35b6106fa611626565b005b6107166004803603810190610711919061304c565b611668565b005b610732600480360381019061072d919061337c565b611774565b60405161073f91906131ba565b60405180910390f35b610750611a3d565b60405161075d91906131ba565b60405180910390f35b61076e611a44565b60405161077b91906131ba565b60405180910390f35b61079e6004803603810190610799919061304c565b611a49565b005b5f6107b5826008611acd90919063ffffffff16565b9050919050565b6060600380546107cb906134f0565b80601f01602080910402602001604051908101604052809291908181526020018280546107f7906134f0565b80156108425780601f1061081957610100808354040283529160200191610842565b820191905f5260205f20905b81548152906001019060200180831161082557829003601f168201915b5050505050905090565b5f5f610856611afa565b9050610863818585611b01565b600191505092915050565b80610883816008611acd90919063ffffffff16565b6108b9576040517fceea21b600000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6108c282611b13565b5050565b5f600254905090565b7f000000000000000000000000000000000000000000000000000000000000000073ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161461095f57336040517f1af2a6ce0000000000000000000000000000000000000000000000000000000081526004016109569190613304565b60405180910390fd5b5f83600c5f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20546109a9919061354d565b90505f846006546109ba919061354d565b90506109c7868383611df1565b6109d18686612049565b505050505050565b5f5f6109e3611afa565b90506109f08582856120c8565b6109fb85858561215b565b60019150509392505050565b7f000000000000000000000000000000000000000000000000000000000000000081565b5f6012905090565b610a47816008611acd90919063ffffffff16565b158015610a9357505f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2060030154145b15610aca576040517fc1ab6dc100000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610ad38161224b565b50565b7f000000000000000000000000000000000000000000000000000000000000000073ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610b6657336040517f1af2a6ce000000000000000000000000000000000000000000000000000000008152600401610b5d9190613304565b60405180910390fd5b610b708484612439565b5f83600c5f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054610bba9190613580565b90505f84600654610bcb9190613580565b9050610bd8868383611df1565b505050505050565b5f610be96124b8565b905062093a80600754610bfc919061354d565b8110610c49575f62093a8060075483610c159190613580565b610c1f91906135e0565b905062093a8081610c309190613610565b60075f828254610c40919061354d565b92505081905550505b50565b5f81610c5860086124bf565b8110610c90576040517f2238ba5800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610ca48360086124d290919063ffffffff16565b915050919050565b600b602052815f5260405f20602052805f5260405f205f9150915050805f0154908060010154905082565b610cdf6124e9565b5f8173ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b8152600401610d199190613304565b602060405180830381865afa158015610d34573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610d589190613665565b90505f8103610d93576040517f669567ea00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610d9e823383612570565b5050565b5f5f5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b610def6124e9565b610df85f61265e565b565b60065481565b60075481565b610e0e6124e9565b612710811115610e4a576040517ff5ba08df00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001811015610e85576040517f1bd477c000000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f816006015490508282600601819055508373ffffffffffffffffffffffffffffffffffffffff167f0d8168d755f5c8a7e102241b41e7561ab7536fba6348dc00388334d62d26878e8285604051610f1e9291906133ba565b60405180910390a250505050565b5f60055f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b61271081565b610f626124e9565b5f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f610fad60086124bf565b90505f826005015490505f8114158015610fd55750826007015f9054906101000a900460ff16155b1561101757836040517f44323cd000000000000000000000000000000000000000000000000000000000815260040161100e9190613304565b60405180910390fd5b600a8210611051576040517fb206b09e00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f8103611069576110606124b8565b83600501819055505b5f83600601540361107f57606483600601819055505b5f836007015f6101000a81548160ff0219169083151502179055506110ae84600861272190919063ffffffff16565b508373ffffffffffffffffffffffffffffffffffffffff167fefa645a0ab6703d2f2e7f177f50d16c90ce1c71e317bb91cbbdab430e0a3968260405160405180910390a250505050565b600a602052805f5260405f205f91509050805f015490806001015490806002015490806003015490806004015490806005015490806006015490806007015f9054906101000a900460ff16905088565b606060048054611157906134f0565b80601f0160208091040260200160405190810160405280929190818152602001828054611183906134f0565b80156111ce5780601f106111a5576101008083540402835291602001916111ce565b820191905f5260205f20905b8154815290600101906020018083116111b157829003601f168201915b5050505050905090565b5f6111e360086124bf565b90505f5b818110156112165761120b6112068260086124d290919063ffffffff16565b611b13565b8060010190506111e7565b5050565b5f5f611224611afa565b905061123181858561215b565b600191505092915050565b5f61124760086124bf565b905090565b600c602052805f5260405f205f915090505481565b5f8273ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b815260040161129b9190613304565b602060405180830381865afa1580156112b6573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906112da9190613665565b90505f600a5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090506113493330858773ffffffffffffffffffffffffffffffffffffffff1661274e909392919063ffffffff16565b5f828573ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b81526004016113849190613304565b602060405180830381865afa15801561139f573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906113c39190613665565b6113cd9190613580565b905080826002015f8282546113e2919061354d565b925050819055508473ffffffffffffffffffffffffffffffffffffffff167f6be8535fae97a5677bece5c298a5838092d0e8c92b11a3e81e10449194219bbf8260405161142f91906131ba565b60405180910390a25050505050565b600a81565b5f62093a80600754611455919061354d565b905090565b6114626124e9565b5f61146d60086124bf565b90505f5b818110156114a0576114956114908260086124d290919063ffffffff16565b610cd7565b806001019050611471565b5050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b61152e6124e9565b5f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f209050806007015f9054906101000a900460ff16158061158e57505f815f015414155b156115c5576040517f4d70ca9400000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6115d98260086127d090919063ffffffff16565b508173ffffffffffffffffffffffffffffffffffffffff167f17cd3cc84c669de8c5c4218fd1d9814e647b547d1e7f59287ea6989aa4e032c260405160405180910390a25050565b606481565b5f61163160086124bf565b90505f5b81811015611664576116596116548260086124d290919063ffffffff16565b61224b565b806001019050611635565b5050565b6116706124e9565b5f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f816005015414806116cf5750806007015f9054906101000a900460ff165b1561171157816040517fd42fd6310000000000000000000000000000000000000000000000000000000081526004016117089190613304565b60405180910390fd5b6001816007015f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff167f961f10509197d967c55f8720c2b6a80d48433ef36db1b12cf3bf6bcf66da434660405160405180910390a25050565b5f5f60065490505f810361178b575f915050611a37565b5f600a5f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f816004015490505f826005015490505f6117e5886127fd565b90506117ef611443565b6117f76124b8565b11156118805784662386f26fc100008284611810611443565b61181a9190613580565b6118249190613610565b61182e9190613610565b61183891906135e0565b83611843919061354d565b925061184d611443565b915062093a806064856006015486600201546118699190613610565b61187391906135e0565b61187d91906135e0565b90505b84662386f26fc1000082846118936124b8565b61189d9190613580565b6118a79190613610565b6118b19190613610565b6118bb91906135e0565b836118c6919061354d565b9250600b5f8973ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8873ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f0154600b5f8a73ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8973ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2060010154670de0b6b3a764000085600c5f8c73ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054611a119190613610565b611a1b91906135e0565b611a259190613580565b611a2f919061354d565b955050505050505b92915050565b62093a8081565b600181565b611a516124e9565b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1603611ac1575f6040517f1e4fbdf7000000000000000000000000000000000000000000000000000000008152600401611ab89190613304565b60405180910390fd5b611aca8161265e565b50565b5f611af2835f018373ffffffffffffffffffffffffffffffffffffffff165f1b612880565b905092915050565b5f33905090565b611b0e83838360016128a0565b505050565b5f611b1c6124b8565b90505f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f209050611b66610be0565b5f816005015490505f6006549050600754841080611b8357505f81145b15611b9a5783836005018190555050505050611dee565b5f836004015490505f845f015490505f856001015490505f866002015490505f876003015490505f886006015490505f896007015f9054906101000a900460ff1690505f6007549050808a1015611d305788662386f26fc100008760648a611c029190613610565b611c0c9190613580565b611c169190613610565b611c2091906135e0565b88611c2b919061354d565b97508684611c39919061354d565b935081611d25575f62093a80600162093a808d85611c579190613580565b611c61919061354d565b611c6b9190613580565b611c7591906135e0565b90505f5f600190505b82811015611cf4576127108689611c959190613610565b611c9f91906135e0565b91508188611cad9190613580565b97508187611cbb919061354d565b96508b670de0b6b3a764000083611cd29190613610565b611cdc91906135e0565b8b611ce7919061354d565b9a50806001019050611c7e565b506127108588611d049190613610565b611d0e91906135e0565b98508887611d1c9190613580565b96505050611d29565b5f96505b5f95508099505b5f871115611dac575f8a8d611d459190613580565b90505f62093a8060648a84611d5a9190613610565b611d649190613610565b611d6e91906135e0565b90508088611d7c919061354d565b97508a662386f26fc1000082611d929190613610565b611d9c91906135e0565b8a611da7919061354d565b995050505b878b60040181905550868b5f0181905550858b60010181905550848b60020181905550838b600301819055508b8b600501819055505050505050505050505050505b50565b5f600c5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205490505f611e3d60086124bf565b90505f5b81811015611fa8575f611e5e8260086124d290919063ffffffff16565b9050611e6981611b13565b5f600b5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8973ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f206004015490505f8260010154670de0b6b3a76400008389611f439190613610565b611f4d91906135e0565b611f579190613580565b905080835f015f828254611f6b919061354d565b92505081905550670de0b6b3a7640000828a611f879190613610565b611f9191906135e0565b836001018190555050505050806001019050611e41565b5083600c5f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550826006819055508473ffffffffffffffffffffffffffffffffffffffff167f97ce9d7086176d6da45e4e7999788176e2629a7591ffe505b0c1b13fe8052cc6838660405161203a9291906133ba565b60405180910390a25050505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036120b9575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016120b09190613304565b60405180910390fd5b6120c45f8383612a6f565b5050565b5f6120d384846114a4565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8110156121555781811015612146578281836040517ffb8f41b200000000000000000000000000000000000000000000000000000000815260040161213d93929190613690565b60405180910390fd5b61215484848484035f6128a0565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036121cb575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016121c29190613304565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff160361223b575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016122329190613304565b60405180910390fd5b612246838383612a6f565b505050565b61225481611b13565b5f600b5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f3373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f206004015490505f600c5f3373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205490505f8360010154670de0b6b3a7640000848461236f9190613610565b61237991906135e0565b6123839190613580565b845f0154612391919061354d565b90505f845f0181905550670de0b6b3a764000083836123b09190613610565b6123ba91906135e0565b84600101819055506123cd853383612570565b8473ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff167f5cbc2d25e94cfcae49c20ef253b5bdba9c8fba9e437f0423f0ac464d4897d6458360405161242a91906131ba565b60405180910390a35050505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036124a9575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016124a09190613304565b60405180910390fd5b6124b4825f83612a6f565b5050565b5f42905090565b5f6124cb825f01612b1e565b9050919050565b5f6124df835f0183612b2d565b5f1c905092915050565b6124f1611afa565b73ffffffffffffffffffffffffffffffffffffffff1661250f610f2c565b73ffffffffffffffffffffffffffffffffffffffff161461256e57612532611afa565b6040517f118cdaa70000000000000000000000000000000000000000000000000000000081526004016125659190613304565b60405180910390fd5b565b5f811115612659575f8373ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b81526004016125b29190613304565b602060405180830381865afa1580156125cd573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906125f19190613665565b90508082111561262b5761262683828673ffffffffffffffffffffffffffffffffffffffff16612b549092919063ffffffff16565b612657565b61265683838673ffffffffffffffffffffffffffffffffffffffff16612b549092919063ffffffff16565b5b505b505050565b5f60055f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1690508160055f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055508173ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a35050565b5f612746835f018373ffffffffffffffffffffffffffffffffffffffff165f1b612bd3565b905092915050565b6127ca848573ffffffffffffffffffffffffffffffffffffffff166323b872dd868686604051602401612783939291906136c5565b604051602081830303815290604052915060e01b6020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050612c3a565b50505050565b5f6127f5835f018373ffffffffffffffffffffffffffffffffffffffff165f1b612cd5565b905092915050565b5f612812826008611acd90919063ffffffff16565b61281e575f905061287b565b62093a806064600a5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f015461286e9190613610565b61287891906135e0565b90505b919050565b5f5f836001015f8481526020019081526020015f20541415905092915050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603612910575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016129079190613304565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603612980575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016129779190613304565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20819055508015612a69578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92584604051612a6091906131ba565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1614158015612ad757505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b15612b0e576040517f8cd22d1900000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b612b19838383612dd1565b505050565b5f815f01805490509050919050565b5f825f018281548110612b4357612b426136fa565b5b905f5260205f200154905092915050565b612bce838473ffffffffffffffffffffffffffffffffffffffff1663a9059cbb8585604051602401612b87929190613727565b604051602081830303815290604052915060e01b6020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050612c3a565b505050565b5f612bde8383612880565b612c3057825f0182908060018154018082558091505060019003905f5260205f20015f9091909190915055825f0180549050836001015f8481526020019081526020015f208190555060019050612c34565b5f90505b92915050565b5f5f60205f8451602086015f885af180612c59576040513d5f823e3d81fd5b3d92505f519150505f8214612c72576001811415612c8d565b5f8473ffffffffffffffffffffffffffffffffffffffff163b145b15612ccf57836040517f5274afe7000000000000000000000000000000000000000000000000000000008152600401612cc69190613304565b60405180910390fd5b50505050565b5f5f836001015f8481526020019081526020015f205490505f8114612dc6575f600182612d029190613580565b90505f6001865f0180549050612d189190613580565b9050808214612d7e575f865f018281548110612d3757612d366136fa565b5b905f5260205f200154905080875f018481548110612d5857612d576136fa565b5b905f5260205f20018190555083876001015f8381526020019081526020015f2081905550505b855f01805480612d9157612d9061374e565b5b600190038181905f5260205f20015f90559055856001015f8681526020019081526020015f205f905560019350505050612dcb565b5f9150505b92915050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603612e21578060025f828254612e15919061354d565b92505081905550612eef565b5f5f5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905081811015612eaa578381836040517fe450d38c000000000000000000000000000000000000000000000000000000008152600401612ea193929190613690565b60405180910390fd5b8181035f5f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603612f36578060025f8282540392505081905550612f80565b805f5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef83604051612fdd91906131ba565b60405180910390a3505050565b5f5ffd5b5f5ffd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f61301b82612ff2565b9050919050565b61302b81613011565b8114613035575f5ffd5b50565b5f8135905061304681613022565b92915050565b5f6020828403121561306157613060612fea565b5b5f61306e84828501613038565b91505092915050565b5f8115159050919050565b61308b81613077565b82525050565b5f6020820190506130a45f830184613082565b92915050565b5f81519050919050565b5f82825260208201905092915050565b8281835e5f83830152505050565b5f601f19601f8301169050919050565b5f6130ec826130aa565b6130f681856130b4565b93506131068185602086016130c4565b61310f816130d2565b840191505092915050565b5f6020820190508181035f83015261313281846130e2565b905092915050565b5f819050919050565b61314c8161313a565b8114613156575f5ffd5b50565b5f8135905061316781613143565b92915050565b5f5f6040838503121561318357613182612fea565b5b5f61319085828601613038565b92505060206131a185828601613159565b9150509250929050565b6131b48161313a565b82525050565b5f6020820190506131cd5f8301846131ab565b92915050565b5f5ffd5b5f5ffd5b5f5ffd5b5f5f83601f8401126131f4576131f36131d3565b5b8235905067ffffffffffffffff811115613211576132106131d7565b5b60208301915083600182028301111561322d5761322c6131db565b5b9250929050565b5f5f5f5f6060858703121561324c5761324b612fea565b5b5f61325987828801613038565b945050602061326a87828801613159565b935050604085013567ffffffffffffffff81111561328b5761328a612fee565b5b613297878288016131df565b925092505092959194509250565b5f5f5f606084860312156132bc576132bb612fea565b5b5f6132c986828701613038565b93505060206132da86828701613038565b92505060406132eb86828701613159565b9150509250925092565b6132fe81613011565b82525050565b5f6020820190506133175f8301846132f5565b92915050565b5f60ff82169050919050565b6133328161331d565b82525050565b5f60208201905061334b5f830184613329565b92915050565b5f6020828403121561336657613365612fea565b5b5f61337384828501613159565b91505092915050565b5f5f6040838503121561339257613391612fea565b5b5f61339f85828601613038565b92505060206133b085828601613038565b9150509250929050565b5f6040820190506133cd5f8301856131ab565b6133da60208301846131ab565b9392505050565b5f6133eb82613011565b9050919050565b6133fb816133e1565b8114613405575f5ffd5b50565b5f81359050613416816133f2565b92915050565b5f6020828403121561343157613430612fea565b5b5f61343e84828501613408565b91505092915050565b5f6101008201905061345b5f83018b6131ab565b613468602083018a6131ab565b61347560408301896131ab565b61348260608301886131ab565b61348f60808301876131ab565b61349c60a08301866131ab565b6134a960c08301856131ab565b6134b660e0830184613082565b9998505050505050505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f600282049050600182168061350757607f821691505b60208210810361351a576135196134c3565b5b50919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f6135578261313a565b91506135628361313a565b925082820190508082111561357a57613579613520565b5b92915050565b5f61358a8261313a565b91506135958361313a565b92508282039050818111156135ad576135ac613520565b5b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f6135ea8261313a565b91506135f58361313a565b925082613605576136046135b3565b5b828204905092915050565b5f61361a8261313a565b91506136258361313a565b92508282026136338161313a565b9150828204841483151761364a57613649613520565b5b5092915050565b5f8151905061365f81613143565b92915050565b5f6020828403121561367a57613679612fea565b5b5f61368784828501613651565b91505092915050565b5f6060820190506136a35f8301866132f5565b6136b060208301856131ab565b6136bd60408301846131ab565b949350505050565b5f6060820190506136d85f8301866132f5565b6136e560208301856132f5565b6136f260408301846131ab565b949350505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b5f60408201905061373a5f8301856132f5565b61374760208301846131ab565b9392505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603160045260245ffdfea26469706673582212206b73b2483dd608297a2ac42df561c9ba0dd00bcd414839d59096be6745fd364764736f6c634300081e00330000000000000000000000005163b56b5275401bdfa5e46c75eb7c9d728848b60000000000000000000000000000000000000000000000000000000069443310000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000001c437970686572205374616b696e67205265636569707420546f6b656e0000000000000000000000000000000000000000000000000000000000000000000000067378435950480000000000000000000000000000000000000000000000000000
Deployed Bytecode
0x608060405234801561000f575f5ffd5b506004361061025c575f3560e01c80638e464baa11610144578063d637ff83116100c1578063e4c26d9611610085578063e4c26d96146106f2578063e895cca3146106fc578063eb013a2014610718578063ed93e40614610748578063f2bfbcc414610766578063f2fde38b146107845761025c565b8063d637ff8314610660578063dd1917191461067e578063dd62ed3e14610688578063de9d477e146106b8578063e0c1b6bb146106d45761025c565b8063a9059cbb11610108578063a9059cbb146105a8578063bd394a8d146105d8578063c4d3e083146105f6578063cc2dae8314610626578063d2af0b94146106425761025c565b80638e464baa1461050f57806393c563af1461052d57806394eecb501461054957806395d89b4114610580578063a125e0981461059e5761025c565b8063549230c9116101dd57806370a08231116101a157806370a082311461045f578063715018a61461048f57806379203dc414610499578063799fb965146104b75780638ca8fef9146104d55780638da5cb5b146104f15761025c565b8063549230c9146103bc5780635726d26e146103d85780635d9b436a146103e25780635e80536a146104125780636ff1c9bc146104435761025c565b80631c75e369116102245780631c75e3691461031857806323b872dd146103345780632fe319da14610364578063313ce56714610382578063515ce517146103a05761025c565b8063034d7fcb1461026057806306fdde0314610290578063095ea7b3146102ae5780631039850a146102de57806318160ddd146102fa575b5f5ffd5b61027a6004803603810190610275919061304c565b6107a0565b6040516102879190613091565b60405180910390f35b6102986107bc565b6040516102a5919061311a565b60405180910390f35b6102c860048036038101906102c3919061316d565b61084c565b6040516102d59190613091565b60405180910390f35b6102f860048036038101906102f3919061304c565b61086e565b005b6103026108c6565b60405161030f91906131ba565b60405180910390f35b610332600480360381019061032d9190613234565b6108cf565b005b61034e600480360381019061034991906132a5565b6109d9565b60405161035b9190613091565b60405180910390f35b61036c610a07565b6040516103799190613304565b60405180910390f35b61038a610a2b565b6040516103979190613338565b60405180910390f35b6103ba60048036038101906103b5919061304c565b610a33565b005b6103d660048036038101906103d19190613234565b610ad6565b005b6103e0610be0565b005b6103fc60048036038101906103f79190613351565b610c4c565b6040516104099190613304565b60405180910390f35b61042c6004803603810190610427919061337c565b610cac565b60405161043a9291906133ba565b60405180910390f35b61045d6004803603810190610458919061341c565b610cd7565b005b6104796004803603810190610474919061304c565b610da2565b60405161048691906131ba565b60405180910390f35b610497610de7565b005b6104a1610dfa565b6040516104ae91906131ba565b60405180910390f35b6104bf610e00565b6040516104cc91906131ba565b60405180910390f35b6104ef60048036038101906104ea919061316d565b610e06565b005b6104f9610f2c565b6040516105069190613304565b60405180910390f35b610517610f54565b60405161052491906131ba565b60405180910390f35b6105476004803603810190610542919061304c565b610f5a565b005b610563600480360381019061055e919061304c565b6110f8565b604051610577989796959493929190613447565b60405180910390f35b610588611148565b604051610595919061311a565b60405180910390f35b6105a66111d8565b005b6105c260048036038101906105bd919061316d565b61121a565b6040516105cf9190613091565b60405180910390f35b6105e061123c565b6040516105ed91906131ba565b60405180910390f35b610610600480360381019061060b919061304c565b61124c565b60405161061d91906131ba565b60405180910390f35b610640600480360381019061063b919061316d565b611261565b005b61064a61143e565b60405161065791906131ba565b60405180910390f35b610668611443565b60405161067591906131ba565b60405180910390f35b61068661145a565b005b6106a2600480360381019061069d919061337c565b6114a4565b6040516106af91906131ba565b60405180910390f35b6106d260048036038101906106cd919061304c565b611526565b005b6106dc611621565b6040516106e991906131ba565b60405180910390f35b6106fa611626565b005b6107166004803603810190610711919061304c565b611668565b005b610732600480360381019061072d919061337c565b611774565b60405161073f91906131ba565b60405180910390f35b610750611a3d565b60405161075d91906131ba565b60405180910390f35b61076e611a44565b60405161077b91906131ba565b60405180910390f35b61079e6004803603810190610799919061304c565b611a49565b005b5f6107b5826008611acd90919063ffffffff16565b9050919050565b6060600380546107cb906134f0565b80601f01602080910402602001604051908101604052809291908181526020018280546107f7906134f0565b80156108425780601f1061081957610100808354040283529160200191610842565b820191905f5260205f20905b81548152906001019060200180831161082557829003601f168201915b5050505050905090565b5f5f610856611afa565b9050610863818585611b01565b600191505092915050565b80610883816008611acd90919063ffffffff16565b6108b9576040517fceea21b600000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6108c282611b13565b5050565b5f600254905090565b7f0000000000000000000000005163b56b5275401bdfa5e46c75eb7c9d728848b673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161461095f57336040517f1af2a6ce0000000000000000000000000000000000000000000000000000000081526004016109569190613304565b60405180910390fd5b5f83600c5f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20546109a9919061354d565b90505f846006546109ba919061354d565b90506109c7868383611df1565b6109d18686612049565b505050505050565b5f5f6109e3611afa565b90506109f08582856120c8565b6109fb85858561215b565b60019150509392505050565b7f0000000000000000000000005163b56b5275401bdfa5e46c75eb7c9d728848b681565b5f6012905090565b610a47816008611acd90919063ffffffff16565b158015610a9357505f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2060030154145b15610aca576040517fc1ab6dc100000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610ad38161224b565b50565b7f0000000000000000000000005163b56b5275401bdfa5e46c75eb7c9d728848b673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610b6657336040517f1af2a6ce000000000000000000000000000000000000000000000000000000008152600401610b5d9190613304565b60405180910390fd5b610b708484612439565b5f83600c5f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054610bba9190613580565b90505f84600654610bcb9190613580565b9050610bd8868383611df1565b505050505050565b5f610be96124b8565b905062093a80600754610bfc919061354d565b8110610c49575f62093a8060075483610c159190613580565b610c1f91906135e0565b905062093a8081610c309190613610565b60075f828254610c40919061354d565b92505081905550505b50565b5f81610c5860086124bf565b8110610c90576040517f2238ba5800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610ca48360086124d290919063ffffffff16565b915050919050565b600b602052815f5260405f20602052805f5260405f205f9150915050805f0154908060010154905082565b610cdf6124e9565b5f8173ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b8152600401610d199190613304565b602060405180830381865afa158015610d34573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610d589190613665565b90505f8103610d93576040517f669567ea00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610d9e823383612570565b5050565b5f5f5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b610def6124e9565b610df85f61265e565b565b60065481565b60075481565b610e0e6124e9565b612710811115610e4a576040517ff5ba08df00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001811015610e85576040517f1bd477c000000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f816006015490508282600601819055508373ffffffffffffffffffffffffffffffffffffffff167f0d8168d755f5c8a7e102241b41e7561ab7536fba6348dc00388334d62d26878e8285604051610f1e9291906133ba565b60405180910390a250505050565b5f60055f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b61271081565b610f626124e9565b5f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f610fad60086124bf565b90505f826005015490505f8114158015610fd55750826007015f9054906101000a900460ff16155b1561101757836040517f44323cd000000000000000000000000000000000000000000000000000000000815260040161100e9190613304565b60405180910390fd5b600a8210611051576040517fb206b09e00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f8103611069576110606124b8565b83600501819055505b5f83600601540361107f57606483600601819055505b5f836007015f6101000a81548160ff0219169083151502179055506110ae84600861272190919063ffffffff16565b508373ffffffffffffffffffffffffffffffffffffffff167fefa645a0ab6703d2f2e7f177f50d16c90ce1c71e317bb91cbbdab430e0a3968260405160405180910390a250505050565b600a602052805f5260405f205f91509050805f015490806001015490806002015490806003015490806004015490806005015490806006015490806007015f9054906101000a900460ff16905088565b606060048054611157906134f0565b80601f0160208091040260200160405190810160405280929190818152602001828054611183906134f0565b80156111ce5780601f106111a5576101008083540402835291602001916111ce565b820191905f5260205f20905b8154815290600101906020018083116111b157829003601f168201915b5050505050905090565b5f6111e360086124bf565b90505f5b818110156112165761120b6112068260086124d290919063ffffffff16565b611b13565b8060010190506111e7565b5050565b5f5f611224611afa565b905061123181858561215b565b600191505092915050565b5f61124760086124bf565b905090565b600c602052805f5260405f205f915090505481565b5f8273ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b815260040161129b9190613304565b602060405180830381865afa1580156112b6573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906112da9190613665565b90505f600a5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090506113493330858773ffffffffffffffffffffffffffffffffffffffff1661274e909392919063ffffffff16565b5f828573ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b81526004016113849190613304565b602060405180830381865afa15801561139f573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906113c39190613665565b6113cd9190613580565b905080826002015f8282546113e2919061354d565b925050819055508473ffffffffffffffffffffffffffffffffffffffff167f6be8535fae97a5677bece5c298a5838092d0e8c92b11a3e81e10449194219bbf8260405161142f91906131ba565b60405180910390a25050505050565b600a81565b5f62093a80600754611455919061354d565b905090565b6114626124e9565b5f61146d60086124bf565b90505f5b818110156114a0576114956114908260086124d290919063ffffffff16565b610cd7565b806001019050611471565b5050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b61152e6124e9565b5f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f209050806007015f9054906101000a900460ff16158061158e57505f815f015414155b156115c5576040517f4d70ca9400000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6115d98260086127d090919063ffffffff16565b508173ffffffffffffffffffffffffffffffffffffffff167f17cd3cc84c669de8c5c4218fd1d9814e647b547d1e7f59287ea6989aa4e032c260405160405180910390a25050565b606481565b5f61163160086124bf565b90505f5b81811015611664576116596116548260086124d290919063ffffffff16565b61224b565b806001019050611635565b5050565b6116706124e9565b5f600a5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f816005015414806116cf5750806007015f9054906101000a900460ff165b1561171157816040517fd42fd6310000000000000000000000000000000000000000000000000000000081526004016117089190613304565b60405180910390fd5b6001816007015f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff167f961f10509197d967c55f8720c2b6a80d48433ef36db1b12cf3bf6bcf66da434660405160405180910390a25050565b5f5f60065490505f810361178b575f915050611a37565b5f600a5f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f816004015490505f826005015490505f6117e5886127fd565b90506117ef611443565b6117f76124b8565b11156118805784662386f26fc100008284611810611443565b61181a9190613580565b6118249190613610565b61182e9190613610565b61183891906135e0565b83611843919061354d565b925061184d611443565b915062093a806064856006015486600201546118699190613610565b61187391906135e0565b61187d91906135e0565b90505b84662386f26fc1000082846118936124b8565b61189d9190613580565b6118a79190613610565b6118b19190613610565b6118bb91906135e0565b836118c6919061354d565b9250600b5f8973ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8873ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f0154600b5f8a73ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8973ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2060010154670de0b6b3a764000085600c5f8c73ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054611a119190613610565b611a1b91906135e0565b611a259190613580565b611a2f919061354d565b955050505050505b92915050565b62093a8081565b600181565b611a516124e9565b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1603611ac1575f6040517f1e4fbdf7000000000000000000000000000000000000000000000000000000008152600401611ab89190613304565b60405180910390fd5b611aca8161265e565b50565b5f611af2835f018373ffffffffffffffffffffffffffffffffffffffff165f1b612880565b905092915050565b5f33905090565b611b0e83838360016128a0565b505050565b5f611b1c6124b8565b90505f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f209050611b66610be0565b5f816005015490505f6006549050600754841080611b8357505f81145b15611b9a5783836005018190555050505050611dee565b5f836004015490505f845f015490505f856001015490505f866002015490505f876003015490505f886006015490505f896007015f9054906101000a900460ff1690505f6007549050808a1015611d305788662386f26fc100008760648a611c029190613610565b611c0c9190613580565b611c169190613610565b611c2091906135e0565b88611c2b919061354d565b97508684611c39919061354d565b935081611d25575f62093a80600162093a808d85611c579190613580565b611c61919061354d565b611c6b9190613580565b611c7591906135e0565b90505f5f600190505b82811015611cf4576127108689611c959190613610565b611c9f91906135e0565b91508188611cad9190613580565b97508187611cbb919061354d565b96508b670de0b6b3a764000083611cd29190613610565b611cdc91906135e0565b8b611ce7919061354d565b9a50806001019050611c7e565b506127108588611d049190613610565b611d0e91906135e0565b98508887611d1c9190613580565b96505050611d29565b5f96505b5f95508099505b5f871115611dac575f8a8d611d459190613580565b90505f62093a8060648a84611d5a9190613610565b611d649190613610565b611d6e91906135e0565b90508088611d7c919061354d565b97508a662386f26fc1000082611d929190613610565b611d9c91906135e0565b8a611da7919061354d565b995050505b878b60040181905550868b5f0181905550858b60010181905550848b60020181905550838b600301819055508b8b600501819055505050505050505050505050505b50565b5f600c5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205490505f611e3d60086124bf565b90505f5b81811015611fa8575f611e5e8260086124d290919063ffffffff16565b9050611e6981611b13565b5f600b5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8973ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f206004015490505f8260010154670de0b6b3a76400008389611f439190613610565b611f4d91906135e0565b611f579190613580565b905080835f015f828254611f6b919061354d565b92505081905550670de0b6b3a7640000828a611f879190613610565b611f9191906135e0565b836001018190555050505050806001019050611e41565b5083600c5f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550826006819055508473ffffffffffffffffffffffffffffffffffffffff167f97ce9d7086176d6da45e4e7999788176e2629a7591ffe505b0c1b13fe8052cc6838660405161203a9291906133ba565b60405180910390a25050505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036120b9575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016120b09190613304565b60405180910390fd5b6120c45f8383612a6f565b5050565b5f6120d384846114a4565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8110156121555781811015612146578281836040517ffb8f41b200000000000000000000000000000000000000000000000000000000815260040161213d93929190613690565b60405180910390fd5b61215484848484035f6128a0565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036121cb575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016121c29190613304565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff160361223b575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016122329190613304565b60405180910390fd5b612246838383612a6f565b505050565b61225481611b13565b5f600b5f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f3373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2090505f600a5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f206004015490505f600c5f3373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205490505f8360010154670de0b6b3a7640000848461236f9190613610565b61237991906135e0565b6123839190613580565b845f0154612391919061354d565b90505f845f0181905550670de0b6b3a764000083836123b09190613610565b6123ba91906135e0565b84600101819055506123cd853383612570565b8473ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff167f5cbc2d25e94cfcae49c20ef253b5bdba9c8fba9e437f0423f0ac464d4897d6458360405161242a91906131ba565b60405180910390a35050505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036124a9575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016124a09190613304565b60405180910390fd5b6124b4825f83612a6f565b5050565b5f42905090565b5f6124cb825f01612b1e565b9050919050565b5f6124df835f0183612b2d565b5f1c905092915050565b6124f1611afa565b73ffffffffffffffffffffffffffffffffffffffff1661250f610f2c565b73ffffffffffffffffffffffffffffffffffffffff161461256e57612532611afa565b6040517f118cdaa70000000000000000000000000000000000000000000000000000000081526004016125659190613304565b60405180910390fd5b565b5f811115612659575f8373ffffffffffffffffffffffffffffffffffffffff166370a08231306040518263ffffffff1660e01b81526004016125b29190613304565b602060405180830381865afa1580156125cd573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906125f19190613665565b90508082111561262b5761262683828673ffffffffffffffffffffffffffffffffffffffff16612b549092919063ffffffff16565b612657565b61265683838673ffffffffffffffffffffffffffffffffffffffff16612b549092919063ffffffff16565b5b505b505050565b5f60055f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1690508160055f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055508173ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a35050565b5f612746835f018373ffffffffffffffffffffffffffffffffffffffff165f1b612bd3565b905092915050565b6127ca848573ffffffffffffffffffffffffffffffffffffffff166323b872dd868686604051602401612783939291906136c5565b604051602081830303815290604052915060e01b6020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050612c3a565b50505050565b5f6127f5835f018373ffffffffffffffffffffffffffffffffffffffff165f1b612cd5565b905092915050565b5f612812826008611acd90919063ffffffff16565b61281e575f905061287b565b62093a806064600a5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f015461286e9190613610565b61287891906135e0565b90505b919050565b5f5f836001015f8481526020019081526020015f20541415905092915050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603612910575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016129079190613304565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603612980575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016129779190613304565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20819055508015612a69578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92584604051612a6091906131ba565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1614158015612ad757505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b15612b0e576040517f8cd22d1900000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b612b19838383612dd1565b505050565b5f815f01805490509050919050565b5f825f018281548110612b4357612b426136fa565b5b905f5260205f200154905092915050565b612bce838473ffffffffffffffffffffffffffffffffffffffff1663a9059cbb8585604051602401612b87929190613727565b604051602081830303815290604052915060e01b6020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050612c3a565b505050565b5f612bde8383612880565b612c3057825f0182908060018154018082558091505060019003905f5260205f20015f9091909190915055825f0180549050836001015f8481526020019081526020015f208190555060019050612c34565b5f90505b92915050565b5f5f60205f8451602086015f885af180612c59576040513d5f823e3d81fd5b3d92505f519150505f8214612c72576001811415612c8d565b5f8473ffffffffffffffffffffffffffffffffffffffff163b145b15612ccf57836040517f5274afe7000000000000000000000000000000000000000000000000000000008152600401612cc69190613304565b60405180910390fd5b50505050565b5f5f836001015f8481526020019081526020015f205490505f8114612dc6575f600182612d029190613580565b90505f6001865f0180549050612d189190613580565b9050808214612d7e575f865f018281548110612d3757612d366136fa565b5b905f5260205f200154905080875f018481548110612d5857612d576136fa565b5b905f5260205f20018190555083876001015f8381526020019081526020015f2081905550505b855f01805480612d9157612d9061374e565b5b600190038181905f5260205f20015f90559055856001015f8681526020019081526020015f205f905560019350505050612dcb565b5f9150505b92915050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603612e21578060025f828254612e15919061354d565b92505081905550612eef565b5f5f5f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905081811015612eaa578381836040517fe450d38c000000000000000000000000000000000000000000000000000000008152600401612ea193929190613690565b60405180910390fd5b8181035f5f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603612f36578060025f8282540392505081905550612f80565b805f5f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef83604051612fdd91906131ba565b60405180910390a3505050565b5f5ffd5b5f5ffd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f61301b82612ff2565b9050919050565b61302b81613011565b8114613035575f5ffd5b50565b5f8135905061304681613022565b92915050565b5f6020828403121561306157613060612fea565b5b5f61306e84828501613038565b91505092915050565b5f8115159050919050565b61308b81613077565b82525050565b5f6020820190506130a45f830184613082565b92915050565b5f81519050919050565b5f82825260208201905092915050565b8281835e5f83830152505050565b5f601f19601f8301169050919050565b5f6130ec826130aa565b6130f681856130b4565b93506131068185602086016130c4565b61310f816130d2565b840191505092915050565b5f6020820190508181035f83015261313281846130e2565b905092915050565b5f819050919050565b61314c8161313a565b8114613156575f5ffd5b50565b5f8135905061316781613143565b92915050565b5f5f6040838503121561318357613182612fea565b5b5f61319085828601613038565b92505060206131a185828601613159565b9150509250929050565b6131b48161313a565b82525050565b5f6020820190506131cd5f8301846131ab565b92915050565b5f5ffd5b5f5ffd5b5f5ffd5b5f5f83601f8401126131f4576131f36131d3565b5b8235905067ffffffffffffffff811115613211576132106131d7565b5b60208301915083600182028301111561322d5761322c6131db565b5b9250929050565b5f5f5f5f6060858703121561324c5761324b612fea565b5b5f61325987828801613038565b945050602061326a87828801613159565b935050604085013567ffffffffffffffff81111561328b5761328a612fee565b5b613297878288016131df565b925092505092959194509250565b5f5f5f606084860312156132bc576132bb612fea565b5b5f6132c986828701613038565b93505060206132da86828701613038565b92505060406132eb86828701613159565b9150509250925092565b6132fe81613011565b82525050565b5f6020820190506133175f8301846132f5565b92915050565b5f60ff82169050919050565b6133328161331d565b82525050565b5f60208201905061334b5f830184613329565b92915050565b5f6020828403121561336657613365612fea565b5b5f61337384828501613159565b91505092915050565b5f5f6040838503121561339257613391612fea565b5b5f61339f85828601613038565b92505060206133b085828601613038565b9150509250929050565b5f6040820190506133cd5f8301856131ab565b6133da60208301846131ab565b9392505050565b5f6133eb82613011565b9050919050565b6133fb816133e1565b8114613405575f5ffd5b50565b5f81359050613416816133f2565b92915050565b5f6020828403121561343157613430612fea565b5b5f61343e84828501613408565b91505092915050565b5f6101008201905061345b5f83018b6131ab565b613468602083018a6131ab565b61347560408301896131ab565b61348260608301886131ab565b61348f60808301876131ab565b61349c60a08301866131ab565b6134a960c08301856131ab565b6134b660e0830184613082565b9998505050505050505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f600282049050600182168061350757607f821691505b60208210810361351a576135196134c3565b5b50919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f6135578261313a565b91506135628361313a565b925082820190508082111561357a57613579613520565b5b92915050565b5f61358a8261313a565b91506135958361313a565b92508282039050818111156135ad576135ac613520565b5b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f6135ea8261313a565b91506135f58361313a565b925082613605576136046135b3565b5b828204905092915050565b5f61361a8261313a565b91506136258361313a565b92508282026136338161313a565b9150828204841483151761364a57613649613520565b5b5092915050565b5f8151905061365f81613143565b92915050565b5f6020828403121561367a57613679612fea565b5b5f61368784828501613651565b91505092915050565b5f6060820190506136a35f8301866132f5565b6136b060208301856131ab565b6136bd60408301846131ab565b949350505050565b5f6060820190506136d85f8301866132f5565b6136e560208301856132f5565b6136f260408301846131ab565b949350505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b5f60408201905061373a5f8301856132f5565b61374760208301846131ab565b9392505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603160045260245ffdfea26469706673582212206b73b2483dd608297a2ac42df561c9ba0dd00bcd414839d59096be6745fd364764736f6c634300081e0033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
0000000000000000000000005163b56b5275401bdfa5e46c75eb7c9d728848b60000000000000000000000000000000000000000000000000000000069443310000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000001c437970686572205374616b696e67205265636569707420546f6b656e0000000000000000000000000000000000000000000000000000000000000000000000067378435950480000000000000000000000000000000000000000000000000000
-----Decoded View---------------
Arg [0] : _escrowToken (address): 0x5163b56B5275401BdFa5e46c75Eb7c9D728848B6
Arg [1] : _startTime (uint256): 1766077200
Arg [2] : _name (string): Cypher Staking Receipt Token
Arg [3] : _symbol (string): sxCYPH
-----Encoded View---------------
8 Constructor Arguments found :
Arg [0] : 0000000000000000000000005163b56b5275401bdfa5e46c75eb7c9d728848b6
Arg [1] : 0000000000000000000000000000000000000000000000000000000069443310
Arg [2] : 0000000000000000000000000000000000000000000000000000000000000080
Arg [3] : 00000000000000000000000000000000000000000000000000000000000000c0
Arg [4] : 000000000000000000000000000000000000000000000000000000000000001c
Arg [5] : 437970686572205374616b696e67205265636569707420546f6b656e00000000
Arg [6] : 0000000000000000000000000000000000000000000000000000000000000006
Arg [7] : 7378435950480000000000000000000000000000000000000000000000000000
Loading...
Loading
Loading...
Loading
Net Worth in USD
$0.00
Net Worth in ETH
0
Multichain Portfolio | 33 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
Loading...
Loading
[ Download: CSV Export ]
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.