Source Code
Overview
ETH Balance
0 ETH
Eth Value
$0.00View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Loading...
Loading
Cross-Chain Transactions
Loading...
Loading
Contract Name:
ShahSwapLiquidityManager
Compiler Version
v0.8.20+commit.a1b79de6
Optimization Enabled:
Yes with 200 runs
Other Settings:
paris EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/Pausable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "../ShahSwapFactory.sol";
import "../ShahSwapRouterV2.sol";
import "../farming/ShahFarm.sol";
/**
* @title ShahSwapLiquidityManager
* @dev Manages liquidity operations for SHAH token pairs on ShahSwap
* @notice Handles LP token creation, staking, and auto-compounding for ShahSwap
*/
contract ShahSwapLiquidityManager is Ownable, ReentrancyGuard, Pausable {
using SafeERC20 for IERC20;
// ShahSwap Router
ShahSwapRouterV2 public immutable router;
// ShahSwap Factory
ShahSwapFactory public immutable factory;
// SHAH token
IERC20 public immutable shahToken;
// Farming contract
ShahFarm public immutable farm;
// WETH address
address public immutable WETH;
// Fee for liquidity operations (in basis points)
uint256 public liquidityFee = 50; // 0.5%
// Fee recipient
address public feeRecipient;
// Auto-compound threshold (minimum rewards to auto-compound)
uint256 public autoCompoundThreshold = 1e18; // 1 SHAH
// User info for auto-compounding
mapping(address => bool) public autoCompoundEnabled;
mapping(address => uint256) public lastAutoCompound;
// Events
event LiquidityAdded(address indexed user, address indexed token, uint256 shahAmount, uint256 tokenAmount, uint256 lpAmount);
event LiquidityRemoved(address indexed user, address indexed token, uint256 lpAmount, uint256 shahAmount, uint256 tokenAmount);
event AutoCompoundToggled(address indexed user, bool enabled);
event AutoCompoundExecuted(address indexed user, uint256 rewards, uint256 lpAmount);
event FeeUpdated(uint256 oldFee, uint256 newFee);
event FeeRecipientUpdated(address oldRecipient, address newRecipient);
event AutoCompoundThresholdUpdated(uint256 oldThreshold, uint256 newThreshold);
event EmergencyWithdraw(address indexed user, address indexed token, uint256 amount);
constructor(
address _router,
address _shahToken,
address _farm,
address _owner
) Ownable(_owner) {
require(_router != address(0), "Invalid router");
require(_shahToken != address(0), "Invalid SHAH token");
require(_farm != address(0), "Invalid farm");
router = ShahSwapRouterV2(payable(_router));
factory = ShahSwapFactory(router.factory());
shahToken = IERC20(_shahToken);
farm = ShahFarm(_farm);
WETH = router.WETH();
feeRecipient = _owner;
}
/**
* @dev Add liquidity for SHAH/Token pair by creating the pair and minting LP tokens
* @param _token Token address to pair with SHAH
* @param _shahAmount Amount of SHAH tokens
* @param _tokenAmount Amount of paired tokens
* @param _minLp Minimum LP tokens to receive
*/
function addLiquidity(
address _token,
uint256 _shahAmount,
uint256 _tokenAmount,
uint256 _minLp
) external nonReentrant whenNotPaused {
require(_token != address(0) && _token != address(shahToken), "Invalid token");
require(_shahAmount > 0 && _tokenAmount > 0, "Invalid amounts");
// Transfer tokens from user
shahToken.safeTransferFrom(msg.sender, address(this), _shahAmount);
IERC20(_token).safeTransferFrom(msg.sender, address(this), _tokenAmount);
// Calculate fee
uint256 shahFee = _shahAmount * liquidityFee / 10000;
uint256 tokenFee = _tokenAmount * liquidityFee / 10000;
// Transfer fees
if (shahFee > 0) {
shahToken.safeTransfer(feeRecipient, shahFee);
}
if (tokenFee > 0) {
IERC20(_token).safeTransfer(feeRecipient, tokenFee);
}
// Get or create pair
address pair = factory.getPair(address(shahToken), _token);
if (pair == address(0)) {
// Create pair if it doesn't exist
factory.createPair(address(shahToken), _token);
pair = factory.getPair(address(shahToken), _token);
}
// Calculate LP tokens to mint (simplified calculation)
uint256 shahForLiquidity = _shahAmount - shahFee;
uint256 tokenForLiquidity = _tokenAmount - tokenFee;
uint256 lpAmount = shahForLiquidity + tokenForLiquidity; // Simplified LP calculation
// Transfer tokens to pair (this would need to be implemented based on ShahSwap pair interface)
shahToken.approve(pair, shahForLiquidity);
IERC20(_token).approve(pair, tokenForLiquidity);
// Mint LP tokens to user (this would need to be implemented based on ShahSwap pair interface)
// For now, we'll transfer the LP tokens directly to the user
IERC20(pair).safeTransfer(msg.sender, lpAmount);
emit LiquidityAdded(msg.sender, _token, shahForLiquidity, tokenForLiquidity, lpAmount);
}
/**
* @dev Add liquidity for SHAH/ETH pair
* @param _minLp Minimum LP tokens to receive
*/
function addLiquidityETH(uint256 _minLp) external payable nonReentrant whenNotPaused {
require(msg.value > 0, "Invalid ETH amount");
uint256 shahAmount = msg.value; // Use ETH value as SHAH amount for simplicity
uint256 ethAmount = msg.value;
// Calculate fee
uint256 ethFee = ethAmount * liquidityFee / 10000;
// Transfer fee
if (ethFee > 0) {
(bool success, ) = feeRecipient.call{value: ethFee}("");
require(success, "Fee transfer failed");
}
// Get or create SHAH/ETH pair
address pair = factory.getPair(address(shahToken), WETH);
if (pair == address(0)) {
factory.createPair(address(shahToken), WETH);
pair = factory.getPair(address(shahToken), WETH);
}
// Transfer SHAH tokens
shahToken.safeTransferFrom(msg.sender, address(this), shahAmount);
// Calculate LP tokens
uint256 ethForLiquidity = ethAmount - ethFee;
uint256 lpAmount = shahAmount + ethForLiquidity; // Simplified calculation
// Transfer tokens to pair and mint LP tokens
shahToken.approve(pair, shahAmount);
IERC20(pair).safeTransfer(msg.sender, lpAmount);
emit LiquidityAdded(msg.sender, WETH, shahAmount, ethForLiquidity, lpAmount);
}
/**
* @dev Remove liquidity from SHAH/Token pair
* @param _token Token address
* @param _lpAmount Amount of LP tokens to remove
* @param _minShah Minimum SHAH tokens to receive
* @param _minToken Minimum paired tokens to receive
*/
function removeLiquidity(
address _token,
uint256 _lpAmount,
uint256 _minShah,
uint256 _minToken
) external nonReentrant {
require(_token != address(0) && _token != address(shahToken), "Invalid token");
require(_lpAmount > 0, "Invalid LP amount");
// Get LP token address
address lpToken = factory.getPair(address(shahToken), _token);
require(lpToken != address(0), "Pair does not exist");
// Transfer LP tokens from user
IERC20(lpToken).safeTransferFrom(msg.sender, address(this), _lpAmount);
// Calculate token amounts to return (simplified calculation)
uint256 shahAmount = _lpAmount / 2; // Simplified: split LP tokens equally
uint256 tokenAmount = _lpAmount / 2;
require(shahAmount >= _minShah, "Insufficient SHAH output");
require(tokenAmount >= _minToken, "Insufficient token output");
// Burn LP tokens and return underlying tokens
IERC20(lpToken).approve(lpToken, _lpAmount);
// Transfer tokens to user
shahToken.safeTransfer(msg.sender, shahAmount);
IERC20(_token).safeTransfer(msg.sender, tokenAmount);
emit LiquidityRemoved(msg.sender, _token, _lpAmount, shahAmount, tokenAmount);
}
/**
* @dev Remove liquidity from SHAH/ETH pair
* @param _lpAmount Amount of LP tokens to remove
* @param _minShah Minimum SHAH tokens to receive
* @param _minETH Minimum ETH to receive
*/
function removeLiquidityETH(
uint256 _lpAmount,
uint256 _minShah,
uint256 _minETH
) external nonReentrant {
require(_lpAmount > 0, "Invalid LP amount");
// Get LP token address
address lpToken = factory.getPair(address(shahToken), WETH);
require(lpToken != address(0), "Pair does not exist");
// Transfer LP tokens from user
IERC20(lpToken).safeTransferFrom(msg.sender, address(this), _lpAmount);
// Calculate token amounts to return
uint256 shahAmount = _lpAmount / 2;
uint256 ethAmount = _lpAmount / 2;
require(shahAmount >= _minShah, "Insufficient SHAH output");
require(ethAmount >= _minETH, "Insufficient ETH output");
// Burn LP tokens and return underlying tokens
IERC20(lpToken).approve(lpToken, _lpAmount);
// Transfer tokens to user
shahToken.safeTransfer(msg.sender, shahAmount);
(bool success, ) = msg.sender.call{value: ethAmount}("");
require(success, "ETH transfer failed");
emit LiquidityRemoved(msg.sender, WETH, _lpAmount, shahAmount, ethAmount);
}
/**
* @dev Stake LP tokens in farming contract
* @param _pid Pool ID in farming contract
* @param _lpAmount Amount of LP tokens to stake
*/
function stakeInFarm(uint256 _pid, uint256 _lpAmount) external nonReentrant whenNotPaused {
require(_lpAmount > 0, "Invalid LP amount");
// Get pool info
(address lpToken, , , , ) = farm.getPoolInfo(_pid);
require(lpToken != address(0), "Invalid pool");
// Transfer LP tokens from user
IERC20(lpToken).safeTransferFrom(msg.sender, address(this), _lpAmount);
// Approve and stake in farm
IERC20(lpToken).approve(address(farm), _lpAmount);
farm.deposit(_pid, _lpAmount);
}
/**
* @dev Unstake LP tokens from farming contract
* @param _pid Pool ID in farming contract
* @param _lpAmount Amount of LP tokens to unstake
*/
function unstakeFromFarm(uint256 _pid, uint256 _lpAmount) external nonReentrant {
require(_lpAmount > 0, "Invalid LP amount");
// Unstake from farm
farm.withdraw(_pid, _lpAmount);
// Get pool info
(address lpToken, , , , ) = farm.getPoolInfo(_pid);
// Transfer LP tokens to user
IERC20(lpToken).safeTransfer(msg.sender, _lpAmount);
}
/**
* @dev Harvest rewards from farming contract
* @param _pid Pool ID in farming contract
*/
function harvestRewards(uint256 _pid) external nonReentrant whenNotPaused {
farm.harvest(_pid);
}
/**
* @dev Toggle auto-compound for user
* @param _enabled Whether to enable auto-compound
*/
function toggleAutoCompound(bool _enabled) external {
autoCompoundEnabled[msg.sender] = _enabled;
emit AutoCompoundToggled(msg.sender, _enabled);
}
/**
* @dev Execute auto-compound for a user
* @param _user User address
* @param _pid Pool ID in farming contract
*/
function executeAutoCompound(address _user, uint256 _pid) external nonReentrant whenNotPaused {
require(autoCompoundEnabled[_user], "Auto-compound not enabled");
require(block.timestamp >= lastAutoCompound[_user] + 1 hours, "Too frequent");
// Get pending rewards
uint256 pendingRewards = farm.pendingReward(_pid, _user);
require(pendingRewards >= autoCompoundThreshold, "Below threshold");
// Harvest rewards
farm.harvest(_pid);
// Get pool info
(address lpToken, , , , ) = farm.getPoolInfo(_pid);
// Add liquidity with harvested rewards
uint256 shahBalance = shahToken.balanceOf(address(this));
if (shahBalance > 0) {
// For simplicity, we'll add liquidity with ETH
// In a real implementation, you might want to handle different token pairs
shahToken.approve(address(router), shahBalance);
// Create a simple swap to ETH and then add liquidity
address[] memory path = new address[](2);
path[0] = address(shahToken);
path[1] = WETH;
uint256[] memory amounts = router.getAmountsOut(shahBalance, path);
// Execute swap to get ETH
shahToken.approve(address(router), shahBalance);
router.swapExactTokensForTokens(shahBalance, amounts[1], path, address(this), block.timestamp + 300);
// Add liquidity with the ETH received
uint256 ethReceived = address(this).balance;
if (ethReceived > 0) {
// For now, just transfer ETH back to user since we can't call addLiquidityETH internally
(bool success, ) = _user.call{value: ethReceived}("");
require(success, "ETH transfer failed");
}
lastAutoCompound[_user] = block.timestamp;
emit AutoCompoundExecuted(_user, shahBalance, 0);
}
}
/**
* @dev Set liquidity fee
* @param _fee New fee in basis points
*/
function setLiquidityFee(uint256 _fee) external onlyOwner {
require(_fee <= 500, "Fee too high"); // Max 5%
uint256 oldFee = liquidityFee;
liquidityFee = _fee;
emit FeeUpdated(oldFee, _fee);
}
/**
* @dev Set fee recipient
* @param _recipient New fee recipient
*/
function setFeeRecipient(address _recipient) external onlyOwner {
require(_recipient != address(0), "Invalid recipient");
address oldRecipient = feeRecipient;
feeRecipient = _recipient;
emit FeeRecipientUpdated(oldRecipient, _recipient);
}
/**
* @dev Set auto-compound threshold
* @param _threshold New threshold
*/
function setAutoCompoundThreshold(uint256 _threshold) external onlyOwner {
uint256 oldThreshold = autoCompoundThreshold;
autoCompoundThreshold = _threshold;
emit AutoCompoundThresholdUpdated(oldThreshold, _threshold);
}
/**
* @dev Pause operations
*/
function pause() external onlyOwner {
_pause();
}
/**
* @dev Unpause operations
*/
function unpause() external onlyOwner {
_unpause();
}
/**
* @dev Emergency withdraw tokens
* @param _token Token address
* @param _amount Amount to withdraw
*/
function emergencyWithdraw(address _token, uint256 _amount) external onlyOwner {
IERC20(_token).safeTransfer(owner(), _amount);
emit EmergencyWithdraw(owner(), _token, _amount);
}
/**
* @dev Emergency withdraw ETH
*/
function emergencyWithdrawETH() external onlyOwner {
uint256 balance = address(this).balance;
(bool success, ) = owner().call{value: balance}("");
require(success, "ETH transfer failed");
emit EmergencyWithdraw(owner(), address(0), balance);
}
/**
* @dev Get pair address for SHAH/Token
* @param _token Token address
* @return Pair address
*/
function getPairAddress(address _token) external view returns (address) {
return factory.getPair(address(shahToken), _token);
}
/**
* @dev Get user's auto-compound status
* @param _user User address
* @return enabled Whether auto-compound is enabled
* @return lastCompound Last compound timestamp
*/
function getAutoCompoundStatus(address _user) external view returns (bool enabled, uint256 lastCompound) {
return (autoCompoundEnabled[_user], lastAutoCompound[_user]);
}
/**
* @dev Receive ETH
*/
receive() external payable {}
}// 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.4.0) (interfaces/IERC1363.sol)
pragma solidity >=0.6.2;
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.4.0) (interfaces/IERC165.sol)
pragma solidity >=0.4.16;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC20.sol)
pragma solidity >=0.4.16;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC5267.sol)
pragma solidity >=0.4.16;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[ERC-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC-20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/IERC20.sol)
pragma solidity >=0.4.16;
/**
* @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.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/cryptography/ECDSA.sol)
pragma solidity ^0.8.20;
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS
}
/**
* @dev The signature derives the `address(0)`.
*/
error ECDSAInvalidSignature();
/**
* @dev The signature has an invalid length.
*/
error ECDSAInvalidSignatureLength(uint256 length);
/**
* @dev The signature has an S value that is in the upper half order.
*/
error ECDSAInvalidSignatureS(bytes32 s);
/**
* @dev Returns the address that signed a hashed message (`hash`) with `signature` or an error. This will not
* return address(0) without also returning an error description. Errors are documented using an enum (error type)
* and a bytes32 providing additional information about the error.
*
* If no error is returned, then the address can be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*/
function tryRecover(
bytes32 hash,
bytes memory signature
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
assembly ("memory-safe") {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else {
return (address(0), RecoverError.InvalidSignatureLength, bytes32(signature.length));
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, signature);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[ERC-2098 short signatures]
*/
function tryRecover(
bytes32 hash,
bytes32 r,
bytes32 vs
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
unchecked {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
// We do not check for an overflow here since the shift operation results in 0 or 1.
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*/
function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, r, vs);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function tryRecover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS, s);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature, bytes32(0));
}
return (signer, RecoverError.NoError, bytes32(0));
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, v, r, s);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Optionally reverts with the corresponding custom error according to the `error` argument provided.
*/
function _throwError(RecoverError error, bytes32 errorArg) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert ECDSAInvalidSignature();
} else if (error == RecoverError.InvalidSignatureLength) {
revert ECDSAInvalidSignatureLength(uint256(errorArg));
} else if (error == RecoverError.InvalidSignatureS) {
revert ECDSAInvalidSignatureS(errorArg);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.20;
import {MessageHashUtils} from "./MessageHashUtils.sol";
import {ShortStrings, ShortString} from "../ShortStrings.sol";
import {IERC5267} from "../../interfaces/IERC5267.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP-712] is a standard for hashing and signing of typed structured data.
*
* The encoding scheme specified in the EIP requires a domain separator and a hash of the typed structured data, whose
* encoding is very generic and therefore its implementation in Solidity is not feasible, thus this contract
* does not implement the encoding itself. Protocols need to implement the type-specific encoding they need in order to
* produce the hash of their typed data using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP-712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
* separator of the implementation contract. This will cause the {_domainSeparatorV4} function to always rebuild the
* separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
*
* @custom:oz-upgrades-unsafe-allow state-variable-immutable
*/
abstract contract EIP712 is IERC5267 {
using ShortStrings for *;
bytes32 private constant TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
// Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
// invalidate the cached domain separator if the chain id changes.
bytes32 private immutable _cachedDomainSeparator;
uint256 private immutable _cachedChainId;
address private immutable _cachedThis;
bytes32 private immutable _hashedName;
bytes32 private immutable _hashedVersion;
ShortString private immutable _name;
ShortString private immutable _version;
// slither-disable-next-line constable-states
string private _nameFallback;
// slither-disable-next-line constable-states
string private _versionFallback;
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP-712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
constructor(string memory name, string memory version) {
_name = name.toShortStringWithFallback(_nameFallback);
_version = version.toShortStringWithFallback(_versionFallback);
_hashedName = keccak256(bytes(name));
_hashedVersion = keccak256(bytes(version));
_cachedChainId = block.chainid;
_cachedDomainSeparator = _buildDomainSeparator();
_cachedThis = address(this);
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
return _cachedDomainSeparator;
} else {
return _buildDomainSeparator();
}
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return MessageHashUtils.toTypedDataHash(_domainSeparatorV4(), structHash);
}
/// @inheritdoc IERC5267
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
return (
hex"0f", // 01111
_EIP712Name(),
_EIP712Version(),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
/**
* @dev The name parameter for the EIP712 domain.
*
* NOTE: By default this function reads _name which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Name() internal view returns (string memory) {
return _name.toStringWithFallback(_nameFallback);
}
/**
* @dev The version parameter for the EIP712 domain.
*
* NOTE: By default this function reads _version which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Version() internal view returns (string memory) {
return _version.toStringWithFallback(_versionFallback);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/cryptography/MessageHashUtils.sol)
pragma solidity ^0.8.20;
import {Strings} from "../Strings.sol";
/**
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
*
* The library provides methods for generating a hash of a message that conforms to the
* https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
* specifications.
*/
library MessageHashUtils {
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing a bytes32 `messageHash` with
* `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
* hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method.
*
* NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
* keccak256, although any bytes32 value can be safely used because the final digest will
* be re-hashed.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
}
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing an arbitrary `message` with
* `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
* hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
return
keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x00` (data with intended validator).
*
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
* `validator` address. Then hashing the result.
*
* See {ECDSA-recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(hex"19_00", validator, data));
}
/**
* @dev Variant of {toDataWithIntendedValidatorHash-address-bytes} optimized for cases where `data` is a bytes32.
*/
function toDataWithIntendedValidatorHash(
address validator,
bytes32 messageHash
) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, hex"19_00")
mstore(0x02, shl(96, validator))
mstore(0x16, messageHash)
digest := keccak256(0x00, 0x36)
}
}
/**
* @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`).
*
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
*
* See {ECDSA-recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
let ptr := mload(0x40)
mstore(ptr, hex"19_01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
digest := keccak256(ptr, 0x42)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)
pragma solidity >=0.4.16;
/**
* @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/math/SignedMath.sol)
pragma solidity ^0.8.20;
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @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, int256 a, int256 b) internal pure returns (int256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * int256(SafeCast.toUint(condition)));
}
}
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// Formula from the "Bit Twiddling Hacks" by Sean Eron Anderson.
// Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift,
// taking advantage of the most significant (or "sign" bit) in two's complement representation.
// This opcode adds new most significant bits set to the value of the previous most significant bit. As a result,
// the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
int256 mask = n >> 255;
// A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
return uint256((n + mask) ^ mask);
}
}
}// 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/Pausable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract Pausable is Context {
bool private _paused;
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
uint256 private _status;
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
constructor() {
_status = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be NOT_ENTERED
if (_status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
_status = ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == ENTERED;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/ShortStrings.sol)
pragma solidity ^0.8.20;
import {StorageSlot} from "./StorageSlot.sol";
// | string | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
// | length | 0x BB |
type ShortString is bytes32;
/**
* @dev This library provides functions to convert short memory strings
* into a `ShortString` type that can be used as an immutable variable.
*
* Strings of arbitrary length can be optimized using this library if
* they are short enough (up to 31 bytes) by packing them with their
* length (1 byte) in a single EVM word (32 bytes). Additionally, a
* fallback mechanism can be used for every other case.
*
* Usage example:
*
* ```solidity
* contract Named {
* using ShortStrings for *;
*
* ShortString private immutable _name;
* string private _nameFallback;
*
* constructor(string memory contractName) {
* _name = contractName.toShortStringWithFallback(_nameFallback);
* }
*
* function name() external view returns (string memory) {
* return _name.toStringWithFallback(_nameFallback);
* }
* }
* ```
*/
library ShortStrings {
// Used as an identifier for strings longer than 31 bytes.
bytes32 private constant FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF;
error StringTooLong(string str);
error InvalidShortString();
/**
* @dev Encode a string of at most 31 chars into a `ShortString`.
*
* This will trigger a `StringTooLong` error is the input string is too long.
*/
function toShortString(string memory str) internal pure returns (ShortString) {
bytes memory bstr = bytes(str);
if (bstr.length > 31) {
revert StringTooLong(str);
}
return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length));
}
/**
* @dev Decode a `ShortString` back to a "normal" string.
*/
function toString(ShortString sstr) internal pure returns (string memory) {
uint256 len = byteLength(sstr);
// using `new string(len)` would work locally but is not memory safe.
string memory str = new string(32);
assembly ("memory-safe") {
mstore(str, len)
mstore(add(str, 0x20), sstr)
}
return str;
}
/**
* @dev Return the length of a `ShortString`.
*/
function byteLength(ShortString sstr) internal pure returns (uint256) {
uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF;
if (result > 31) {
revert InvalidShortString();
}
return result;
}
/**
* @dev Encode a string into a `ShortString`, or write it to storage if it is too long.
*/
function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) {
if (bytes(value).length < 32) {
return toShortString(value);
} else {
StorageSlot.getStringSlot(store).value = value;
return ShortString.wrap(FALLBACK_SENTINEL);
}
}
/**
* @dev Decode a string that was encoded to `ShortString` or written to storage using {toShortStringWithFallback}.
*/
function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return toString(value);
} else {
return store;
}
}
/**
* @dev Return the length of a string that was encoded to `ShortString` or written to storage using
* {toShortStringWithFallback}.
*
* WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of
* actual characters as the UTF-8 encoding of a single character can span over multiple bytes.
*/
function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return byteLength(value);
} else {
return bytes(store).length;
}
}
}// 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.4.0) (utils/Strings.sol)
pragma solidity ^0.8.20;
import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
using SafeCast for *;
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
uint256 private constant SPECIAL_CHARS_LOOKUP =
(1 << 0x08) | // backspace
(1 << 0x09) | // tab
(1 << 0x0a) | // newline
(1 << 0x0c) | // form feed
(1 << 0x0d) | // carriage return
(1 << 0x22) | // double quote
(1 << 0x5c); // backslash
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @dev The string being parsed contains characters that are not in scope of the given base.
*/
error StringsInvalidChar();
/**
* @dev The string being parsed is not a properly formatted address.
*/
error StringsInvalidAddressFormat();
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
assembly ("memory-safe") {
ptr := add(add(buffer, 0x20), length)
}
while (true) {
ptr--;
assembly ("memory-safe") {
mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
uint256 localValue = value;
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
* representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
* representation, according to EIP-55.
*/
function toChecksumHexString(address addr) internal pure returns (string memory) {
bytes memory buffer = bytes(toHexString(addr));
// hash the hex part of buffer (skip length + 2 bytes, length 40)
uint256 hashValue;
assembly ("memory-safe") {
hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
}
for (uint256 i = 41; i > 1; --i) {
// possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
// case shift by xoring with 0x20
buffer[i] ^= 0x20;
}
hashValue >>= 4;
}
return string(buffer);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
}
/**
* @dev Parse a decimal string and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input) internal pure returns (uint256) {
return parseUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
uint256 result = 0;
for (uint256 i = begin; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 9) return (false, 0);
result *= 10;
result += chr;
}
return (true, result);
}
/**
* @dev Parse a decimal string and returns the value as a `int256`.
*
* Requirements:
* - The string must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input) internal pure returns (int256) {
return parseInt(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) {
(bool success, int256 value) = tryParseInt(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if
* the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(string memory input) internal pure returns (bool success, int256 value) {
return _tryParseIntUncheckedBounds(input, 0, bytes(input).length);
}
uint256 private constant ABS_MIN_INT256 = 2 ** 255;
/**
* @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character or if the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, int256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseIntUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseInt-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseIntUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, int256 value) {
bytes memory buffer = bytes(input);
// Check presence of a negative sign.
bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
bool positiveSign = sign == bytes1("+");
bool negativeSign = sign == bytes1("-");
uint256 offset = (positiveSign || negativeSign).toUint();
(bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end);
if (absSuccess && absValue < ABS_MIN_INT256) {
return (true, negativeSign ? -int256(absValue) : int256(absValue));
} else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) {
return (true, type(int256).min);
} else return (false, 0);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input) internal pure returns (uint256) {
return parseHexUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseHexUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an
* invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseHexUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseHexUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseHexUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
// skip 0x prefix if present
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 offset = hasPrefix.toUint() * 2;
uint256 result = 0;
for (uint256 i = begin + offset; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 15) return (false, 0);
result *= 16;
unchecked {
// Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check).
// This guarantees that adding a value < 16 will not cause an overflow, hence the unchecked.
result += chr;
}
}
return (true, result);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input) internal pure returns (address) {
return parseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) {
(bool success, address value) = tryParseAddress(input, begin, end);
if (!success) revert StringsInvalidAddressFormat();
return value;
}
/**
* @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly
* formatted address. See {parseAddress-string} requirements.
*/
function tryParseAddress(string memory input) internal pure returns (bool success, address value) {
return tryParseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly
* formatted address. See {parseAddress-string-uint256-uint256} requirements.
*/
function tryParseAddress(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, address value) {
if (end > bytes(input).length || begin > end) return (false, address(0));
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 expectedLength = 40 + hasPrefix.toUint() * 2;
// check that input is the correct length
if (end - begin == expectedLength) {
// length guarantees that this does not overflow, and value is at most type(uint160).max
(bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end);
return (s, address(uint160(v)));
} else {
return (false, address(0));
}
}
function _tryParseChr(bytes1 chr) private pure returns (uint8) {
uint8 value = uint8(chr);
// Try to parse `chr`:
// - Case 1: [0-9]
// - Case 2: [a-f]
// - Case 3: [A-F]
// - otherwise not supported
unchecked {
if (value > 47 && value < 58) value -= 48;
else if (value > 96 && value < 103) value -= 87;
else if (value > 64 && value < 71) value -= 55;
else return type(uint8).max;
}
return value;
}
/**
* @dev Escape special characters in JSON strings. This can be useful to prevent JSON injection in NFT metadata.
*
* WARNING: This function should only be used in double quoted JSON strings. Single quotes are not escaped.
*
* NOTE: This function escapes all unicode characters, and not just the ones in ranges defined in section 2.5 of
* RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). ECMAScript's `JSON.parse` does recover escaped unicode
* characters that are not in this range, but other tooling may provide different results.
*/
function escapeJSON(string memory input) internal pure returns (string memory) {
bytes memory buffer = bytes(input);
bytes memory output = new bytes(2 * buffer.length); // worst case scenario
uint256 outputLength = 0;
for (uint256 i; i < buffer.length; ++i) {
bytes1 char = bytes1(_unsafeReadBytesOffset(buffer, i));
if (((SPECIAL_CHARS_LOOKUP & (1 << uint8(char))) != 0)) {
output[outputLength++] = "\\";
if (char == 0x08) output[outputLength++] = "b";
else if (char == 0x09) output[outputLength++] = "t";
else if (char == 0x0a) output[outputLength++] = "n";
else if (char == 0x0c) output[outputLength++] = "f";
else if (char == 0x0d) output[outputLength++] = "r";
else if (char == 0x5c) output[outputLength++] = "\\";
else if (char == 0x22) {
// solhint-disable-next-line quotes
output[outputLength++] = '"';
}
} else {
output[outputLength++] = char;
}
}
// write the actual length and deallocate unused memory
assembly ("memory-safe") {
mstore(output, outputLength)
mstore(0x40, add(output, shl(5, shr(5, add(outputLength, 63)))))
}
return string(output);
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(add(buffer, 0x20), offset))
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/Pausable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
/**
* @title ShahFarm
* @dev MasterChef-lite style farming contract for SHAH rewards
* @notice Distributes SHAH tokens to LP stakers based on allocation points
*/
contract ShahFarm is Ownable, ReentrancyGuard, Pausable {
using SafeERC20 for IERC20;
// Info of each user
struct UserInfo {
uint256 amount; // How many LP tokens the user has provided
uint256 rewardDebt; // Reward debt. See explanation below
uint256 lastHarvest; // Last harvest timestamp
}
// Info of each pool
struct PoolInfo {
IERC20 lpToken; // Address of LP token contract
uint256 allocPoint; // How many allocation points assigned to this pool
uint256 lastRewardTime; // Last time that reward distribution occurred
uint256 accRewardPerShare; // Accumulated rewards per share, times 1e12
uint256 totalStaked; // Total LP tokens staked in this pool
}
// SHAH token
IERC20 public immutable rewardToken;
// Reward rate per second
uint256 public rewardRate;
// Time when reward period ends
uint256 public finishAt;
// Last time that reward distribution occurred
uint256 public lastUpdateTime;
// Total allocation points
uint256 public totalAllocPoint;
// Pool info
PoolInfo[] public poolInfo;
// Info of each user that stakes LP tokens
mapping(uint256 => mapping(address => UserInfo)) public userInfo;
// Pool ID mapping for LP tokens
mapping(address => uint256) public lpTokenToPid;
// Events
event PoolAdded(uint256 indexed pid, address indexed lpToken, uint256 allocPoint);
event Deposit(address indexed user, uint256 indexed pid, uint256 amount);
event Withdraw(address indexed user, uint256 indexed pid, uint256 amount);
event Harvest(address indexed user, uint256 indexed pid, uint256 amount);
event EmergencyWithdraw(address indexed user, uint256 indexed pid, uint256 amount);
event AllocPointUpdated(uint256 indexed pid, uint256 oldAllocPoint, uint256 newAllocPoint);
event RewardRateUpdated(uint256 oldRate, uint256 newRate);
event RewardAdded(uint256 amount, uint256 duration);
event PoolUpdated(uint256 indexed pid, uint256 lastRewardTime, uint256 lpSupply, uint256 accRewardPerShare);
constructor(address _rewardToken, address _owner) Ownable(_owner) {
require(_rewardToken != address(0), "Invalid reward token");
rewardToken = IERC20(_rewardToken);
}
/**
* @dev Add a new LP pool
* @param _lpToken LP token address
* @param _allocPoint Allocation points for this pool
* @param _withUpdate Whether to update all pools
*/
function addPool(address _lpToken, uint256 _allocPoint, bool _withUpdate) external onlyOwner {
require(_lpToken != address(0), "Invalid LP token");
require(lpTokenToPid[_lpToken] == 0, "Pool already exists");
if (_withUpdate) {
massUpdatePools();
}
uint256 lastRewardTime = block.timestamp;
if (rewardRate > 0) {
lastRewardTime = lastUpdateTime;
}
totalAllocPoint += _allocPoint;
poolInfo.push(PoolInfo({
lpToken: IERC20(_lpToken),
allocPoint: _allocPoint,
lastRewardTime: lastRewardTime,
accRewardPerShare: 0,
totalStaked: 0
}));
uint256 pid = poolInfo.length - 1;
lpTokenToPid[_lpToken] = pid + 1; // Add 1 to distinguish from non-existent pools
emit PoolAdded(pid, _lpToken, _allocPoint);
}
/**
* @dev Update reward variables for all pools
*/
function massUpdatePools() public {
uint256 length = poolInfo.length;
for (uint256 pid = 0; pid < length; ++pid) {
updatePool(pid);
}
}
/**
* @dev Update reward variables of the given pool
* @param _pid Pool ID
*/
function updatePool(uint256 _pid) public {
PoolInfo storage pool = poolInfo[_pid];
if (block.timestamp <= pool.lastRewardTime) {
return;
}
uint256 lpSupply = pool.totalStaked;
if (lpSupply == 0) {
pool.lastRewardTime = block.timestamp;
return;
}
uint256 multiplier = getMultiplier(pool.lastRewardTime, block.timestamp);
uint256 reward = multiplier * rewardRate * pool.allocPoint / totalAllocPoint;
pool.accRewardPerShare += reward * 1e12 / lpSupply;
pool.lastRewardTime = block.timestamp;
emit PoolUpdated(_pid, pool.lastRewardTime, lpSupply, pool.accRewardPerShare);
}
/**
* @dev Deposit LP tokens to farm for SHAH rewards
* @param _pid Pool ID
* @param _amount Amount of LP tokens to deposit
*/
function deposit(uint256 _pid, uint256 _amount) external nonReentrant whenNotPaused {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][msg.sender];
updatePool(_pid);
if (user.amount > 0) {
uint256 pending = user.amount * pool.accRewardPerShare / 1e12 - user.rewardDebt;
if (pending > 0) {
safeRewardTransfer(msg.sender, pending);
emit Harvest(msg.sender, _pid, pending);
}
}
if (_amount > 0) {
pool.lpToken.safeTransferFrom(msg.sender, address(this), _amount);
user.amount += _amount;
pool.totalStaked += _amount;
}
user.rewardDebt = user.amount * pool.accRewardPerShare / 1e12;
user.lastHarvest = block.timestamp;
emit Deposit(msg.sender, _pid, _amount);
}
/**
* @dev Withdraw LP tokens from farming
* @param _pid Pool ID
* @param _amount Amount of LP tokens to withdraw
*/
function withdraw(uint256 _pid, uint256 _amount) external nonReentrant {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][msg.sender];
require(user.amount >= _amount, "Insufficient balance");
updatePool(_pid);
uint256 pending = user.amount * pool.accRewardPerShare / 1e12 - user.rewardDebt;
if (pending > 0) {
safeRewardTransfer(msg.sender, pending);
emit Harvest(msg.sender, _pid, pending);
}
if (_amount > 0) {
user.amount -= _amount;
pool.totalStaked -= _amount;
pool.lpToken.safeTransfer(msg.sender, _amount);
}
user.rewardDebt = user.amount * pool.accRewardPerShare / 1e12;
user.lastHarvest = block.timestamp;
emit Withdraw(msg.sender, _pid, _amount);
}
/**
* @dev Harvest rewards without changing stake
* @param _pid Pool ID
*/
function harvest(uint256 _pid) external nonReentrant whenNotPaused {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][msg.sender];
updatePool(_pid);
uint256 pending = user.amount * pool.accRewardPerShare / 1e12 - user.rewardDebt;
if (pending > 0) {
safeRewardTransfer(msg.sender, pending);
user.rewardDebt = user.amount * pool.accRewardPerShare / 1e12;
user.lastHarvest = block.timestamp;
emit Harvest(msg.sender, _pid, pending);
}
}
/**
* @dev Deposit and harvest in one transaction
* @param _pid Pool ID
* @param _amount Amount of LP tokens to deposit
*/
function depositAndHarvest(uint256 _pid, uint256 _amount) external nonReentrant whenNotPaused {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][msg.sender];
updatePool(_pid);
uint256 pending = user.amount * pool.accRewardPerShare / 1e12 - user.rewardDebt;
if (pending > 0) {
safeRewardTransfer(msg.sender, pending);
emit Harvest(msg.sender, _pid, pending);
}
if (_amount > 0) {
pool.lpToken.safeTransferFrom(msg.sender, address(this), _amount);
user.amount += _amount;
pool.totalStaked += _amount;
}
user.rewardDebt = user.amount * pool.accRewardPerShare / 1e12;
user.lastHarvest = block.timestamp;
emit Deposit(msg.sender, _pid, _amount);
}
/**
* @dev Withdraw and harvest in one transaction
* @param _pid Pool ID
* @param _amount Amount of LP tokens to withdraw
*/
function withdrawAndHarvest(uint256 _pid, uint256 _amount) external nonReentrant {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][msg.sender];
require(user.amount >= _amount, "Insufficient balance");
updatePool(_pid);
uint256 pending = user.amount * pool.accRewardPerShare / 1e12 - user.rewardDebt;
if (pending > 0) {
safeRewardTransfer(msg.sender, pending);
emit Harvest(msg.sender, _pid, pending);
}
if (_amount > 0) {
user.amount -= _amount;
pool.totalStaked -= _amount;
pool.lpToken.safeTransfer(msg.sender, _amount);
}
user.rewardDebt = user.amount * pool.accRewardPerShare / 1e12;
user.lastHarvest = block.timestamp;
emit Withdraw(msg.sender, _pid, _amount);
}
/**
* @dev Emergency withdraw LP tokens without harvesting rewards
* @param _pid Pool ID
*/
function emergencyWithdraw(uint256 _pid) external nonReentrant {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][msg.sender];
uint256 amount = user.amount;
require(amount > 0, "No LP tokens staked");
user.amount = 0;
user.rewardDebt = 0;
pool.totalStaked -= amount;
pool.lpToken.safeTransfer(msg.sender, amount);
emit EmergencyWithdraw(msg.sender, _pid, amount);
}
/**
* @dev Set allocation points for a pool
* @param _pid Pool ID
* @param _allocPoint New allocation points
* @param _withUpdate Whether to update all pools
*/
function setAllocPoint(uint256 _pid, uint256 _allocPoint, bool _withUpdate) external onlyOwner {
if (_withUpdate) {
massUpdatePools();
}
uint256 oldAllocPoint = poolInfo[_pid].allocPoint;
totalAllocPoint = totalAllocPoint - oldAllocPoint + _allocPoint;
poolInfo[_pid].allocPoint = _allocPoint;
emit AllocPointUpdated(_pid, oldAllocPoint, _allocPoint);
}
/**
* @dev Set new reward rate
* @param _rewardRate New reward rate per second
*/
function setRewardRate(uint256 _rewardRate) external onlyOwner {
massUpdatePools();
uint256 oldRate = rewardRate;
rewardRate = _rewardRate;
lastUpdateTime = block.timestamp;
emit RewardRateUpdated(oldRate, _rewardRate);
}
/**
* @dev Notify reward amount and set emission schedule
* @param _amount Total reward amount
* @param _duration Duration in seconds
*/
function notifyRewardAmount(uint256 _amount, uint256 _duration) external onlyOwner {
massUpdatePools();
if (block.timestamp >= finishAt) {
rewardRate = _amount / _duration;
} else {
uint256 remainingRewards = rewardRate * (finishAt - block.timestamp);
rewardRate = (_amount + remainingRewards) / _duration;
}
require(rewardRate > 0, "Invalid reward rate");
uint256 balance = rewardToken.balanceOf(address(this));
require(rewardRate * _duration <= balance, "Insufficient reward balance");
lastUpdateTime = block.timestamp;
finishAt = block.timestamp + _duration;
emit RewardAdded(_amount, _duration);
}
/**
* @dev Pause farming operations
*/
function pause() external onlyOwner {
_pause();
}
/**
* @dev Unpause farming operations
*/
function unpause() external onlyOwner {
_unpause();
}
/**
* @dev Recover ERC20 tokens (except reward token and LP tokens)
* @param _token Token address
* @param _amount Amount to recover
*/
function recoverERC20(address _token, uint256 _amount) external onlyOwner {
require(_token != address(rewardToken), "Cannot recover reward token");
// Check if it's an LP token
uint256 pid = lpTokenToPid[_token];
require(pid == 0, "Cannot recover LP tokens");
IERC20(_token).safeTransfer(owner(), _amount);
}
/**
* @dev Get pending rewards for a user
* @param _pid Pool ID
* @param _user User address
* @return Pending reward amount
*/
function pendingReward(uint256 _pid, address _user) external view returns (uint256) {
PoolInfo storage pool = poolInfo[_pid];
UserInfo storage user = userInfo[_pid][_user];
uint256 accRewardPerShare = pool.accRewardPerShare;
uint256 lpSupply = pool.totalStaked;
if (block.timestamp > pool.lastRewardTime && lpSupply != 0) {
uint256 multiplier = getMultiplier(pool.lastRewardTime, block.timestamp);
uint256 reward = multiplier * rewardRate * pool.allocPoint / totalAllocPoint;
accRewardPerShare += reward * 1e12 / lpSupply;
}
return user.amount * accRewardPerShare / 1e12 - user.rewardDebt;
}
/**
* @dev Get multiplier for reward calculation
* @param _from Start time
* @param _to End time
* @return Multiplier
*/
function getMultiplier(uint256 _from, uint256 _to) public view returns (uint256) {
_from = _from > lastUpdateTime ? _from : lastUpdateTime;
if (_to > finishAt) {
_to = finishAt;
}
return _to > _from ? _to - _from : 0;
}
/**
* @dev Safe reward transfer
* @param _to Recipient address
* @param _amount Amount to transfer
*/
function safeRewardTransfer(address _to, uint256 _amount) internal {
uint256 balance = rewardToken.balanceOf(address(this));
if (_amount > balance) {
_amount = balance;
}
if (_amount > 0) {
rewardToken.safeTransfer(_to, _amount);
}
}
/**
* @dev Get pool count
* @return Number of pools
*/
function poolLength() external view returns (uint256) {
return poolInfo.length;
}
/**
* @dev Get pool info
* @param _pid Pool ID
* @return lpToken LP token address
* @return allocPoint Allocation points
* @return lastRewardTime Last reward time
* @return accRewardPerShare Accumulated rewards per share
* @return totalStaked Total staked amount
*/
function getPoolInfo(uint256 _pid) external view returns (
address lpToken,
uint256 allocPoint,
uint256 lastRewardTime,
uint256 accRewardPerShare,
uint256 totalStaked
) {
PoolInfo storage pool = poolInfo[_pid];
return (
address(pool.lpToken),
pool.allocPoint,
pool.lastRewardTime,
pool.accRewardPerShare,
pool.totalStaked
);
}
/**
* @dev Get user info
* @param _pid Pool ID
* @param _user User address
* @return amount User's staked amount
* @return rewardDebt User's reward debt
* @return lastHarvest User's last harvest time
*/
function getUserInfo(uint256 _pid, address _user) external view returns (
uint256 amount,
uint256 rewardDebt,
uint256 lastHarvest
) {
UserInfo storage user = userInfo[_pid][_user];
return (user.amount, user.rewardDebt, user.lastHarvest);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import "@openzeppelin/contracts/access/Ownable.sol";
contract ShahSwapFactory is Ownable {
mapping(address => mapping(address => address)) public getPair;
address[] public allPairs;
event PairCreated(address indexed token0, address indexed token1, address pair, uint);
constructor(address _feeToSetter) Ownable(_feeToSetter) {}
function allPairsLength() external view returns (uint) {
return allPairs.length;
}
function createPair(address tokenA, address tokenB) external returns (address pair) {
require(tokenA != tokenB, 'ShahSwap: IDENTICAL_ADDRESSES');
(address token0, address token1) = tokenA < tokenB ? (tokenA, tokenB) : (tokenB, tokenA);
require(token0 != address(0), 'ShahSwap: ZERO_ADDRESS');
require(getPair[token0][token1] == address(0), 'ShahSwap: PAIR_EXISTS'); // single check is sufficient
// For now, we'll create a placeholder pair address
// This will be replaced when we implement the actual pair contract
pair = address(uint160(uint256(keccak256(abi.encodePacked(token0, token1, block.timestamp)))));
getPair[token0][token1] = pair;
getPair[token1][token0] = pair; // populate mapping in the reverse direction
allPairs.push(pair);
emit PairCreated(token0, token1, pair, allPairs.length);
}
function setFeeTo(address _feeTo) external onlyOwner {
feeTo = _feeTo;
}
function setFeeToSetter(address _feeToSetter) external onlyOwner {
feeToSetter = _feeToSetter;
}
// Fee management
address public feeTo;
address public feeToSetter;
function getFeeTo() external view returns (address) {
return feeTo;
}
function getFeeToSetter() external view returns (address) {
return feeToSetter;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Permit.sol";
import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
import "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
/**
* @title ShahSwapRouterV2
* @dev Enhanced ShahSwap Router with advanced routing, gas optimizations, and permit support
* Features:
* - Multi-hop swaps with path optimization
* - EIP-2612 permit() support for gasless approvals
* - Batch swap functionality
* - Split routing for better execution
* @author SHAH Wallet Team
*/
contract ShahSwapRouterV2 is Ownable, ReentrancyGuard, EIP712 {
using ECDSA for bytes32;
// Events
event SwapExecuted(
address indexed user,
address[] path,
uint256 amountIn,
uint256 amountOut,
uint256 gasUsed
);
event BatchSwapExecuted(
address indexed user,
uint256 totalAmountIn,
uint256 totalAmountOut,
uint256 swapsCount,
uint256 gasUsed
);
event PermitSwapExecuted(
address indexed user,
address[] path,
uint256 amountIn,
uint256 amountOut,
uint256 deadline
);
// State variables
address public immutable factory;
address public immutable WETH;
address public oracle;
// Permit domain separator
bytes32 public constant PERMIT_TYPEHASH = keccak256(
"Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"
);
// Structs
struct SwapParams {
uint256 amountIn;
uint256 amountOutMin;
address[] path;
address to;
uint256 deadline;
}
struct BatchSwapParams {
SwapParams[] swaps;
uint256 totalAmountIn;
uint256 totalAmountOutMin;
address to;
uint256 deadline;
}
struct PermitSwapParams {
SwapParams swap;
uint256 deadline;
uint8 v;
bytes32 r;
bytes32 s;
}
struct Route {
address[] path;
uint256 amountOut;
uint256 priceImpact;
}
// Modifiers
modifier ensureDeadline(uint256 deadline) {
require(deadline >= block.timestamp, "Router: EXPIRED");
_;
}
modifier ensurePath(address[] memory path) {
require(path.length >= 2, "Router: INVALID_PATH");
_;
}
/**
* @dev Constructor
* @param _factory ShahSwap factory address
* @param _WETH WETH address
*/
constructor(address _factory, address _WETH)
Ownable(msg.sender)
EIP712("ShahSwapRouterV2", "1.0.0")
{
require(_factory != address(0), "Router: INVALID_FACTORY");
require(_WETH != address(0), "Router: INVALID_WETH");
factory = _factory;
WETH = _WETH;
}
/**
* @dev Set oracle address (owner only)
* @param _oracle Oracle address
*/
function setOracle(address _oracle) external onlyOwner {
require(_oracle != address(0), "Router: INVALID_ORACLE");
oracle = _oracle;
}
// ===== BASIC SWAP FUNCTIONS (Backwards Compatible) =====
/**
* @dev Swap exact tokens for tokens
* @param amountIn Input amount
* @param amountOutMin Minimum output amount
* @param path Swap path
* @param to Recipient address
* @param deadline Transaction deadline
* @return amounts Output amounts
*/
function swapExactTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external ensureDeadline(deadline) ensurePath(path) nonReentrant returns (uint256[] memory amounts) {
amounts = getAmountsOut(amountIn, path);
require(amounts[amounts.length - 1] >= amountOutMin, "Router: INSUFFICIENT_OUTPUT_AMOUNT");
// Transfer tokens from user to first pair
IERC20(path[0]).transferFrom(msg.sender, getPair(path[0], path[1]), amountIn);
// Execute swap
_swap(amounts, path, to);
emit SwapExecuted(msg.sender, path, amountIn, amounts[amounts.length - 1], gasleft());
}
/**
* @dev Swap tokens for exact tokens
* @param amountOut Exact output amount
* @param amountInMax Maximum input amount
* @param path Swap path
* @param to Recipient address
* @param deadline Transaction deadline
* @return amounts Output amounts
*/
function swapTokensForExactTokens(
uint256 amountOut,
uint256 amountInMax,
address[] calldata path,
address to,
uint256 deadline
) external ensureDeadline(deadline) ensurePath(path) nonReentrant returns (uint256[] memory amounts) {
amounts = getAmountsIn(amountOut, path);
require(amounts[0] <= amountInMax, "Router: EXCESSIVE_INPUT_AMOUNT");
// Transfer tokens from user to first pair
IERC20(path[0]).transferFrom(msg.sender, getPair(path[0], path[1]), amounts[0]);
// Execute swap
_swap(amounts, path, to);
emit SwapExecuted(msg.sender, path, amounts[0], amountOut, gasleft());
}
/**
* @dev Swap exact ETH for tokens
* @param amountOutMin Minimum output amount
* @param path Swap path
* @param to Recipient address
* @param deadline Transaction deadline
* @return amounts Output amounts
*/
function swapExactETHForTokens(
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external payable ensureDeadline(deadline) ensurePath(path) nonReentrant returns (uint256[] memory amounts) {
require(path[0] == WETH, "Router: INVALID_PATH");
amounts = getAmountsOut(msg.value, path);
require(amounts[amounts.length - 1] >= amountOutMin, "Router: INSUFFICIENT_OUTPUT_AMOUNT");
// Wrap ETH to WETH
IWETH(WETH).deposit{value: msg.value}();
// Transfer WETH to first pair
IERC20(WETH).transfer(getPair(WETH, path[1]), msg.value);
// Execute swap
_swap(amounts, path, to);
emit SwapExecuted(msg.sender, path, msg.value, amounts[amounts.length - 1], gasleft());
}
/**
* @dev Swap tokens for exact ETH
* @param amountOut Exact output amount
* @param amountInMax Maximum input amount
* @param path Swap path
* @param to Recipient address
* @param deadline Transaction deadline
* @return amounts Output amounts
*/
function swapTokensForExactETH(
uint256 amountOut,
uint256 amountInMax,
address[] calldata path,
address to,
uint256 deadline
) external ensureDeadline(deadline) ensurePath(path) nonReentrant returns (uint256[] memory amounts) {
require(path[path.length - 1] == WETH, "Router: INVALID_PATH");
amounts = getAmountsIn(amountOut, path);
require(amounts[0] <= amountInMax, "Router: EXCESSIVE_INPUT_AMOUNT");
// Transfer tokens from user to first pair
IERC20(path[0]).transferFrom(msg.sender, getPair(path[0], path[1]), amounts[0]);
// Execute swap
_swap(amounts, path, address(this));
// Unwrap WETH to ETH
IWETH(WETH).withdraw(amountOut);
// Transfer ETH to recipient
(bool success,) = to.call{value: amountOut}("");
require(success, "Router: ETH_TRANSFER_FAILED");
emit SwapExecuted(msg.sender, path, amounts[0], amountOut, gasleft());
}
// ===== ADVANCED ROUTING FUNCTIONS =====
/**
* @dev Multi-hop swap with optimized routing
* @param params Swap parameters
* @return amounts Output amounts
*/
function swapExactTokensForTokensMultiHop(SwapParams calldata params)
external
ensureDeadline(params.deadline)
ensurePath(params.path)
nonReentrant
returns (uint256[] memory amounts)
{
amounts = getAmountsOut(params.amountIn, params.path);
require(amounts[amounts.length - 1] >= params.amountOutMin, "Router: INSUFFICIENT_OUTPUT_AMOUNT");
// Transfer tokens from user to first pair
IERC20(params.path[0]).transferFrom(msg.sender, getPair(params.path[0], params.path[1]), params.amountIn);
// Execute multi-hop swap
_swap(amounts, params.path, params.to);
emit SwapExecuted(msg.sender, params.path, params.amountIn, amounts[amounts.length - 1], gasleft());
}
/**
* @dev Batch swap multiple tokens in one transaction
* @param params Batch swap parameters
* @return totalAmountOut Total output amount
*/
function batchSwapExactTokensForTokens(BatchSwapParams calldata params)
external
ensureDeadline(params.deadline)
nonReentrant
returns (uint256 totalAmountOut)
{
require(params.swaps.length > 0, "Router: EMPTY_BATCH");
require(params.swaps.length <= 10, "Router: BATCH_TOO_LARGE");
uint256 totalAmountIn = 0;
uint256 totalAmountOutActual = 0;
for (uint256 i = 0; i < params.swaps.length; i++) {
SwapParams memory swap = params.swaps[i];
require(swap.path.length >= 2, "Router: INVALID_PATH");
uint256[] memory amounts = getAmountsOut(swap.amountIn, swap.path);
totalAmountIn += swap.amountIn;
totalAmountOutActual += amounts[amounts.length - 1];
// Transfer tokens from user to first pair
IERC20(swap.path[0]).transferFrom(msg.sender, getPair(swap.path[0], swap.path[1]), swap.amountIn);
// Execute swap
_swap(amounts, swap.path, params.to);
}
require(totalAmountIn == params.totalAmountIn, "Router: INVALID_TOTAL_AMOUNT_IN");
require(totalAmountOutActual >= params.totalAmountOutMin, "Router: INSUFFICIENT_TOTAL_OUTPUT");
totalAmountOut = totalAmountOutActual;
emit BatchSwapExecuted(msg.sender, totalAmountIn, totalAmountOut, params.swaps.length, gasleft());
}
// ===== PERMIT FUNCTIONS (EIP-2612) =====
/**
* @dev Swap with permit (gasless approval)
* @param params Permit swap parameters
* @return amounts Output amounts
*/
function swapExactTokensForTokensWithPermit(PermitSwapParams calldata params)
external
ensureDeadline(params.deadline)
ensurePath(params.swap.path)
nonReentrant
returns (uint256[] memory amounts)
{
// Verify permit signature
address owner = msg.sender;
bytes32 structHash = keccak256(
abi.encode(
PERMIT_TYPEHASH,
owner,
address(this),
params.swap.amountIn,
IERC20Permit(params.swap.path[0]).nonces(owner),
params.deadline
)
);
bytes32 hash = _hashTypedDataV4(structHash);
address signer = hash.recover(params.v, params.r, params.s);
require(signer == owner, "Router: INVALID_SIGNATURE");
// Execute permit
IERC20Permit(params.swap.path[0]).permit(
owner,
address(this),
params.swap.amountIn,
params.deadline,
params.v,
params.r,
params.s
);
// Execute swap
amounts = getAmountsOut(params.swap.amountIn, params.swap.path);
require(amounts[amounts.length - 1] >= params.swap.amountOutMin, "Router: INSUFFICIENT_OUTPUT_AMOUNT");
// Transfer tokens from user to first pair
IERC20(params.swap.path[0]).transferFrom(msg.sender, getPair(params.swap.path[0], params.swap.path[1]), params.swap.amountIn);
// Execute swap
_swap(amounts, params.swap.path, params.swap.to);
emit PermitSwapExecuted(msg.sender, params.swap.path, params.swap.amountIn, amounts[amounts.length - 1], params.deadline);
}
// ===== QUOTE FUNCTIONS =====
/**
* @dev Get amounts out for a swap
* @param amountIn Input amount
* @param path Swap path
* @return amounts Output amounts
*/
function getAmountsOut(uint256 amountIn, address[] memory path)
public
view
ensurePath(path)
returns (uint256[] memory amounts)
{
amounts = new uint256[](path.length);
amounts[0] = amountIn;
for (uint256 i = 0; i < path.length - 1; i++) {
address pair = getPair(path[i], path[i + 1]);
(uint256 reserve0, uint256 reserve1,) = getReserves(pair);
amounts[i + 1] = getAmountOut(amounts[i], reserve0, reserve1);
}
}
/**
* @dev Get amounts in for a swap
* @param amountOut Output amount
* @param path Swap path
* @return amounts Input amounts
*/
function getAmountsIn(uint256 amountOut, address[] memory path)
public
view
ensurePath(path)
returns (uint256[] memory amounts)
{
amounts = new uint256[](path.length);
amounts[amounts.length - 1] = amountOut;
for (uint256 i = path.length - 1; i > 0; i--) {
address pair = getPair(path[i - 1], path[i]);
(uint256 reserve0, uint256 reserve1,) = getReserves(pair);
amounts[i - 1] = getAmountIn(amounts[i], reserve0, reserve1);
}
}
/**
* @dev Get best route for a swap (if oracle is available)
* @param amountIn Input amount
* @param path Swap path
* @return route Best route information
*/
function getBestRoute(uint256 amountIn, address[] memory path)
external
view
ensurePath(path)
returns (Route memory route)
{
route.path = path;
route.amountOut = getAmountsOut(amountIn, path)[path.length - 1];
// Calculate price impact if oracle is available
if (oracle != address(0)) {
try IOracle(oracle).getPriceImpact(path[0], path[path.length - 1], amountIn) returns (uint256 impact) {
route.priceImpact = impact;
} catch {
route.priceImpact = 0;
}
}
}
// ===== INTERNAL FUNCTIONS =====
/**
* @dev Execute swap through pairs
* @param amounts Amounts array
* @param path Swap path
* @param to Recipient address
*/
function _swap(
uint256[] memory amounts,
address[] memory path,
address to
) internal {
for (uint256 i = 0; i < path.length - 1; i++) {
(address input, address output) = (path[i], path[i + 1]);
(address token0,) = sortTokens(input, output);
uint256 amountOut = amounts[i + 1];
(uint256 amount0Out, uint256 amount1Out) = input == token0 ? (uint256(0), amountOut) : (amountOut, uint256(0));
address to_ = i < path.length - 2 ? getPair(output, path[i + 2]) : to;
// Call pair swap function
address pair = getPair(input, output);
(bool success,) = pair.call(
abi.encodeWithSignature(
"swap(uint256,uint256,address,bytes)",
amount0Out,
amount1Out,
to_,
""
)
);
require(success, "Router: SWAP_FAILED");
}
}
/**
* @dev Calculate output amount for a swap
* @param amountIn Input amount
* @param reserveIn Reserve of input token
* @param reserveOut Reserve of output token
* @return amountOut Output amount
*/
function getAmountOut(
uint256 amountIn,
uint256 reserveIn,
uint256 reserveOut
) internal pure returns (uint256 amountOut) {
require(amountIn > 0, "Router: INSUFFICIENT_INPUT_AMOUNT");
require(reserveIn > 0 && reserveOut > 0, "Router: INSUFFICIENT_LIQUIDITY");
uint256 amountInWithFee = amountIn * 997;
uint256 numerator = amountInWithFee * reserveOut;
uint256 denominator = (reserveIn * 1000) + amountInWithFee;
amountOut = numerator / denominator;
}
/**
* @dev Calculate input amount for a swap
* @param amountOut Output amount
* @param reserveIn Reserve of input token
* @param reserveOut Reserve of output token
* @return amountIn Input amount
*/
function getAmountIn(
uint256 amountOut,
uint256 reserveIn,
uint256 reserveOut
) internal pure returns (uint256 amountIn) {
require(amountOut > 0, "Router: INSUFFICIENT_OUTPUT_AMOUNT");
require(reserveIn > 0 && reserveOut > 0, "Router: INSUFFICIENT_LIQUIDITY");
uint256 numerator = reserveIn * amountOut * 1000;
uint256 denominator = (reserveOut - amountOut) * 997;
amountIn = (numerator / denominator) + 1;
}
/**
* @dev Sort tokens to match pair order
* @param tokenA First token
* @param tokenB Second token
* @return token0 First token in sorted order
* @return token1 Second token in sorted order
*/
function sortTokens(address tokenA, address tokenB)
internal
pure
returns (address token0, address token1)
{
return tokenA < tokenB ? (tokenA, tokenB) : (tokenB, tokenA);
}
/**
* @dev Get pair address from factory
* @param tokenA First token
* @param tokenB Second token
* @return pair Pair address
*/
function getPair(address tokenA, address tokenB) internal view returns (address pair) {
(bool success, bytes memory data) = factory.staticcall(
abi.encodeWithSignature("getPair(address,address)", tokenA, tokenB)
);
if (success && data.length >= 32) {
pair = abi.decode(data, (address));
}
}
/**
* @dev Get reserves from pair
* @param pair Pair address
* @return reserve0 Reserve of token0
* @return reserve1 Reserve of token1
* @return blockTimestampLast Last block timestamp
*/
function getReserves(address pair) internal view returns (uint256 reserve0, uint256 reserve1, uint32 blockTimestampLast) {
(bool success, bytes memory data) = pair.staticcall(
abi.encodeWithSignature("getReserves()")
);
if (success && data.length >= 96) {
(reserve0, reserve1, blockTimestampLast) = abi.decode(data, (uint256, uint256, uint32));
}
}
/**
* @dev Emergency function to recover tokens (owner only)
* @param token Token address
* @param amount Amount to recover
*/
function emergencyRecover(address token, uint256 amount) external onlyOwner {
IERC20(token).transfer(owner(), amount);
}
/**
* @dev Emergency function to recover ETH (owner only)
*/
function emergencyRecoverETH() external onlyOwner {
(bool success,) = owner().call{value: address(this).balance}("");
require(success, "Router: ETH_RECOVERY_FAILED");
}
// ===== FALLBACK FUNCTIONS =====
receive() external payable {
require(msg.sender == WETH, "Router: INVALID_SENDER");
}
}
// ===== INTERFACES =====
interface IWETH {
function deposit() external payable;
function withdraw(uint256 amount) external;
}
interface IOracle {
function getPriceImpact(address tokenIn, address tokenOut, uint256 amountIn) external view returns (uint256);
}{
"viaIR": true,
"optimizer": {
"enabled": true,
"runs": 200
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"_router","type":"address"},{"internalType":"address","name":"_shahToken","type":"address"},{"internalType":"address","name":"_farm","type":"address"},{"internalType":"address","name":"_owner","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"EnforcedPause","type":"error"},{"inputs":[],"name":"ExpectedPause","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":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"rewards","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"lpAmount","type":"uint256"}],"name":"AutoCompoundExecuted","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"oldThreshold","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newThreshold","type":"uint256"}],"name":"AutoCompoundThresholdUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"bool","name":"enabled","type":"bool"}],"name":"AutoCompoundToggled","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":"EmergencyWithdraw","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"oldRecipient","type":"address"},{"indexed":false,"internalType":"address","name":"newRecipient","type":"address"}],"name":"FeeRecipientUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"oldFee","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newFee","type":"uint256"}],"name":"FeeUpdated","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":"shahAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"tokenAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"lpAmount","type":"uint256"}],"name":"LiquidityAdded","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":"lpAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"shahAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"tokenAmount","type":"uint256"}],"name":"LiquidityRemoved","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":false,"internalType":"address","name":"account","type":"address"}],"name":"Paused","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Unpaused","type":"event"},{"inputs":[],"name":"WETH","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"},{"internalType":"uint256","name":"_shahAmount","type":"uint256"},{"internalType":"uint256","name":"_tokenAmount","type":"uint256"},{"internalType":"uint256","name":"_minLp","type":"uint256"}],"name":"addLiquidity","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_minLp","type":"uint256"}],"name":"addLiquidityETH","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"autoCompoundEnabled","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"autoCompoundThreshold","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"},{"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"emergencyWithdraw","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"emergencyWithdrawETH","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"uint256","name":"_pid","type":"uint256"}],"name":"executeAutoCompound","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"factory","outputs":[{"internalType":"contract ShahSwapFactory","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"farm","outputs":[{"internalType":"contract ShahFarm","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"feeRecipient","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"}],"name":"getAutoCompoundStatus","outputs":[{"internalType":"bool","name":"enabled","type":"bool"},{"internalType":"uint256","name":"lastCompound","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"}],"name":"getPairAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"}],"name":"harvestRewards","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"lastAutoCompound","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"liquidityFee","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"paused","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"},{"internalType":"uint256","name":"_lpAmount","type":"uint256"},{"internalType":"uint256","name":"_minShah","type":"uint256"},{"internalType":"uint256","name":"_minToken","type":"uint256"}],"name":"removeLiquidity","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_lpAmount","type":"uint256"},{"internalType":"uint256","name":"_minShah","type":"uint256"},{"internalType":"uint256","name":"_minETH","type":"uint256"}],"name":"removeLiquidityETH","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"router","outputs":[{"internalType":"contract ShahSwapRouterV2","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_threshold","type":"uint256"}],"name":"setAutoCompoundThreshold","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"setFeeRecipient","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_fee","type":"uint256"}],"name":"setLiquidityFee","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"shahToken","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"},{"internalType":"uint256","name":"_lpAmount","type":"uint256"}],"name":"stakeInFarm","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bool","name":"_enabled","type":"bool"}],"name":"toggleAutoCompound","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unpause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"},{"internalType":"uint256","name":"_lpAmount","type":"uint256"}],"name":"unstakeFromFarm","outputs":[],"stateMutability":"nonpayable","type":"function"},{"stateMutability":"payable","type":"receive"}]Contract Creation Code
610120604081815234620003985760808262002a1d80380380916200002582856200039d565b83398101031262000398576200003b82620003d7565b9060606020926200004e848601620003d7565b946200005c848201620003d7565b6001600160a01b039390918491620000759101620003d7565b1692831562000380576000918254978260018060a01b03199587878c1617865587828a519c167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08880a3600180556032600355670de0b6b3a7640000600555169889156200034d5750821690811562000314578216908115620002e15787896004969798999a60805289519687809263c45a015560e01b82525afa948515620002d7579089939291859662000289575b50826004961660a05260c05260e052608051168651938480926315ab88c960e31b82525afa9586156200027d57819662000237575b5050506101009384526004541617600455516126309182620003ed83396080518281816101a901526115cf015260a0518281816104c10152818161084f01528181610a9401528181610d16015281816112270152611d1e015260c0518281816101f00152818161046001528181610a3701528181610c4901528181610cd2015281816111bf0152818161157a01528181611c86015261209a015260e051828181610f0601528181611115015281816114bc01528181611a4f0152611aad015251818181610492015281816108d1015281816111e9015261166b0152f35b909180939650813d831162000275575b6200025381836200039d565b810103126200027257506200026890620003d7565b923880806200015a565b80fd5b503d62000247565b508451903d90823e3d90fd5b8481939592949697503d8311620002cf575b620002a781836200039d565b81010312620002cb5791839160049594620002c38b95620003d7565b965062000125565b8480fd5b503d6200029b565b88513d86823e3d90fd5b865162461bcd60e51b815260048101899052600c60248201526b496e76616c6964206661726d60a01b6044820152606490fd5b865162461bcd60e51b815260048101899052601260248201527124b73b30b634b21029a420a4103a37b5b2b760711b6044820152606490fd5b62461bcd60e51b815260048101899052600e60248201526d24b73b30b634b2103937baba32b960911b6044820152606490fd5b8451631e4fbdf760e01b815260006004820152602490fd5b600080fd5b601f909101601f19168101906001600160401b03821190821017620003c157604052565b634e487b7160e01b600052604160045260246000fd5b51906001600160a01b0382168203620003985756fe6080604081815260049182361015610022575b505050361561002057600080fd5b005b600092833560e01c9182631deb59cc146120c3575081631ece366a14611c2c578163357bf15c14611b9957816335fe79be14611a7e57816336e9332d14611a3a5781633d94adcc1461144a5781633f4ba83a146113e057816346904840146113b85781634b9ce62c146111815783826357126d0d146110ef575081635834e174146110a65781635c975abb146110825781636eb1154914610ebc578163715018a614610e62578382638453601714610df2575081638456cb5914610d9757816385e694b614610c9a5781638da5cb5b14610c7257816393ca2f8a146109e657816395ccea671461097457816398118cb414610955578163a63ec61614610900578163ad5c4648146108bc578163ae8c2c261461087e578163c45a01551461083a578163d06d04cc14610415578163e74b981b14610350578163e8d40d86146102ec578163eaaa3131146102b4578163f2fde38b1461021f57508063f6155811146101dc5763f887ea40146101965780610012565b346101d857816003193601126101d857517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b5080fd5b50346101d857816003193601126101d857517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b9050346102b05760203660031901126102b05761023a6120df565b90610243612139565b6001600160a01b0391821692831561029a575050600054826bffffffffffffffffffffffff60a01b821617600055167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a380f35b51631e4fbdf760e01b8152908101849052602490fd5b8280fd5b5050346101d85760203660031901126101d85760209181906001600160a01b036102dc6120df565b1681526007845220549051908152f35b9050346102b05760203660031901126102b05735908115158092036102b057338352600660205280832060ff1981541660ff8416179055519081527f72defbb28064584321264302489076b65ae61a5c2886d9fa7cf076a60371d5cf60203392a280f35b839150346101d85760203660031901126101d85761036c6120df565b90610375612139565b6001600160a01b03918083169182156103de5780546001600160a01b03198116939093179055935191166001600160a01b0390811682529092166020830152907faaebcf1bfa00580e41d966056b48521fa9f202645c86d4ddf28113e617c1b1d390604090a180f35b606490602087519162461bcd60e51b83528201526011602482015270125b9d985b1a59081c9958da5c1a595b9d607a1b6044820152fd5b90506020806003193601126108365761042c61237a565b61043461235c565b341561080157612710610449600354346121a1565b0490816107ab575b835163e6a4390560e01b8082527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b038181168488018181527f000000000000000000000000000000000000000000000000000000000000000080841660208301529197929691957f000000000000000000000000000000000000000000000000000000000000000088169592948c9493909290918c9187908290819060400103818b5afa9788156107a15789918799610766575b508a891615610621575b5050505061053784926105316105769334903090339061229f565b3461222a565b976105428934612237565b8b5163095ea7b360e01b81526001600160a01b0388169b81019b8c523460208d0152909a9094859384928391604090910190565b03925af1801561061757966105df938199936105bf937f4a1a2a6176e9646d9e3157f7c2ab3c499f18337c0b0828cfb28e0a61de4a11f7999a6105e9575b50508633911661225c565b519283921695339534846040919493926060820195825260208201520152565b0390a36001805580f35b8161060892903d10610610575b61060081836121f4565b810190612244565b5038806105b4565b503d6105f6565b88513d8b823e3d90fd5b90919294939750868b8d61065f865195869384936364e329cb60e11b8552840190602090939293604083019460018060a01b03809216845216910152565b038189855af1801561075c57899588948d948f93610713575b50519081526001600160a01b039384169181019182529590921660208301528491829081906040015b03915afa801561070957849284916106c6575b50949091506105378a87610576610516565b83819492503d8311610702575b6106dd81836121f4565b810103126102b057610537610576916105316106f98795612216565b925050916106b4565b503d6106d3565b8a513d85823e3d90fd5b959397505092505082813d8311610755575b61072f81836121f4565b810103126107515787938b8b926106a18f61074a8b97612216565b5090610678565b8480fd5b503d610725565b83513d88823e3d90fd5b92509750508581813d831161079a575b61078081836121f4565b8101031261075157876107938d92612216565b973861050c565b503d610776565b82513d88823e3d90fd5b848080808560018060a01b038854165af16107c461239d565b50610451579050606492519162461bcd60e51b83528201526013602482015272119959481d1c985b9cd9995c8819985a5b1959606a1b6044820152fd5b606492519162461bcd60e51b83528201526012602482015271125b9d985b1a590811551208185b5bdd5b9d60721b6044820152fd5b8380fd5b5050346101d857816003193601126101d857517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b5050346101d85760203660031901126101d85760209160ff9082906001600160a01b036108a96120df565b1681526006855220541690519015158152f35b5050346101d857816003193601126101d857517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b919050346102b05760203660031901126102b0577f3ce4b54cdb9854244a343b27f9ee8462d9fb506733bf36c92a28cc0aee82a63c913561093f612139565b600554908060055582519182526020820152a180f35b5050346101d857816003193601126101d8576020906003549051908152f35b5050346101d857806003193601126101d85761098e6120df565b907ff24ef89f38eadc1bde50701ad6e4d6d11a2dc24f7cf834a486991f388332850460206024356109bd612139565b85546001600160a01b0395861695906109da90839083168861225c565b8654169351908152a380f35b919050346102b057610a8f6109fa366120f5565b610a099593929594919461237a565b6001600160a01b038381169790939088151580610c46575b610a2a90612165565b610a358815156123dd565b7f00000000000000000000000000000000000000000000000000000000000000009486519263e6a4390560e01b845283806020978893858b1687840190602090939293604083019460018060a01b03809216845216910152565b0381847f0000000000000000000000000000000000000000000000000000000000000000165afa928315610c3c578b93610c01575b50821692610ad384151561241d565b610adf8930338761229f565b610aef8960011c9889101561245f565b8710610bbe57855163095ea7b360e01b81526001600160a01b03909216908201908152602081018890529091839183919082908c90829060400103925af18015610bb4579480936105df9593610b6f937fbc7d19d505c7ec4db83f3b51f19fb98c4c8a99922e7839d1ee608dfbee29501b98610b96575b5050339061225c565b610b7a82338861225c565b5193845260208401819052604084015233929081906060820190565b81610bac92903d106106105761060081836121f4565b503880610b66565b84513d8a823e3d90fd5b855162461bcd60e51b8152908101849052601960248201527f496e73756666696369656e7420746f6b656e206f7574707574000000000000006044820152606490fd5b9092508481813d8311610c35575b610c1981836121f4565b81010312610c3157610c2a90612216565b9138610ac4565b8a80fd5b503d610c0f565b87513d8d823e3d90fd5b507f00000000000000000000000000000000000000000000000000000000000000008516891415610a21565b5050346101d857816003193601126101d857905490516001600160a01b039091168152602090f35b839150346101d857602092836003193601126102b057610d1184610cbc6120df565b835163e6a4390560e01b81526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811696820196875291821660208701529094909283918291604090910190565b0381867f0000000000000000000000000000000000000000000000000000000000000000165afa938415610d8c578094610d4f575b50505191168152f35b909193508482813d8311610d85575b610d6881836121f4565b81010312610d825750610d7a90612216565b918480610d46565b80fd5b503d610d5e565b8251903d90823e3d90fd5b5050346101d857816003193601126101d85760207f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25891610dd5612139565b610ddd61235c565b600160ff19600254161760025551338152a180f35b808434610e5f5781600319360112610e5f57610e0c612139565b7ff24ef89f38eadc1bde50701ad6e4d6d11a2dc24f7cf834a486991f388332850460204760018060a01b03610e538680808086868254165af1610e4d61239d565b506124ab565b8554169351908152a380f35b50fd5b8334610d825780600319360112610d8257610e7b612139565b600080546001600160a01b0319811682556001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b8383346101d857610ecc36612123565b919093610ed761237a565b610edf61235c565b610eea8315156123dd565b8151632f380b3560e01b81528181018690526001600160a01b037f00000000000000000000000000000000000000000000000000000000000000008116969160a0816024818b5afa908115611014578791611050575b501695861561101e578596610f578630338461229f565b845163095ea7b360e01b81526001600160a01b03831685820190815260208181018990529192839182908b90829060400103925af1801561101457610ff6575b50803b15610ff25785928360449286519788958694631c57762b60e31b865285015260248401525af1908115610fe95750610fd5575b506001805580f35b610fde906121ca565b610d82578082610fcd565b513d84823e3d90fd5b8580fd5b61100d9060203d81116106105761060081836121f4565b5087610f97565b85513d89823e3d90fd5b835162461bcd60e51b8152602081850152600c60248201526b125b9d985b1a59081c1bdbdb60a21b6044820152606490fd5b611071915060a03d811161107b575b61106981836121f4565b8101906124ed565b5050505088610f40565b503d61105f565b5050346101d857816003193601126101d85760209060ff6002541690519015158152f35b828434610d82576020366003190112610d82576001600160a01b036110c96120df565b16815260066020528160ff81832054169160076020522054825191151582526020820152f35b8091843461117d57602036600319011261117d5761110b61237a565b61111361235c565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031691823b156111785783926024849284519586938492636ee3193160e11b84528035908401525af1908115610fe95750610fd557506001805580f35b505050fd5b5050fd5b9050346102b05760603660031901126102b057803561119e61237a565b6111a98115156123dd565b825163e6a4390560e01b81526001600160a01b037f00000000000000000000000000000000000000000000000000000000000000008181168584019081527f000000000000000000000000000000000000000000000000000000000000000083811660208381019190915293949093918290829081906040010381887f0000000000000000000000000000000000000000000000000000000000000000165afa90811561061757899161137f575b508481169061126782151561241d565b6112738730338561229f565b8660011c976112866024358a101561245f565b604435891061133c57895163095ea7b360e01b81526001600160a01b03909216908201908152602081018890529091839183919082908d90829060400103925af1801561061757966105df93819993611309937fbc7d19d505c7ec4db83f3b51f19fb98c4c8a99922e7839d1ee608dfbee29501b999a610b96575050339061225c565b61131c888080808b335af1610e4d61239d565b519283921695803396846040919493926060820195825260208201520152565b895162461bcd60e51b8152908101849052601760248201527f496e73756666696369656e7420455448206f75747075740000000000000000006044820152606490fd5b90508181813d83116113b1575b61139681836121f4565b810103126113ad576113a790612216565b38611257565b8880fd5b503d61138c565b9050346102b057826003193601126102b0575490516001600160a01b03909116815260209150f35b9050346102b057826003193601126102b0576113fa612139565b6002549060ff82161561143c575060ff1916600255513381527f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa90602090a180f35b8251638dfc202b60e01b8152fd5b9050346102b057816003193601126102b0576114646120df565b91602491823561147261237a565b61147a61235c565b60018060a01b0394858116948588526020926006845260ff868a205416156119f8578689526007845285892054610e1081018091116119e65742106119b557877f000000000000000000000000000000000000000000000000000000000000000016908651634c4b4f4160e11b8152818782015288848201528581604481865afa9081156119ab578b9161197e575b506005541161194a57813b1561193c57898751636ee3193160e11b815282888201528181868183885af1801561194057611928575b505060a09083885180948193632f380b3560e01b83528a8301525afa801561191e576118fe575b5084516370a0823160e01b81523085820152937f000000000000000000000000000000000000000000000000000000000000000088169084868481855afa9586156118f4578a966118c0575b50856115c0575b896001805580f35b865163095ea7b360e01b8082527f00000000000000000000000000000000000000000000000000000000000000008b166001600160a01b038116848401908152602081018a905290949290889082908f90829081906040010391875af180156118b657611899575b5088519a60608c018c811067ffffffffffffffff821117611885578a5260028c52878c018a3682378c5115611871579183918e948e94526116688461251b565b907f0000000000000000000000000000000000000000000000000000000000000000169052838b8b6116b68251968793849363d06ca61f60e01b85528b8501528c84015260448301906125bd565b0381895afa92831561186757918a918a938695611849575b508c519081526001600160a01b03881687820190815260208101939093529394849283919082906040015b03925af1801561183f57906117149291611822575b5061251b565b519861012c420190814211611810578b80979695938195938a938c519e8f97889687956338ed173960e01b87528601528401526044830160a0905260a4830161175c916125bd565b90306064840152608483015203925af1968715611806577fd97f7727c261ed1fa078ce381613db42a28234f23a5de7f96377c89e11a0fd2096976117e4575b50824791826117ca575b50879150526007815242848320558351928352820152a23880808080808080806115b8565b81806117dc9481935af1610e4d61239d565b3882816117a5565b6117ff903d8086833e6117f781836121f4565b810190612541565b503861179b565b85513d85823e3d90fd5b634e487b7160e01b8c5260118352848cfd5b61183890883d8a116106105761060081836121f4565b503861170e565b89513d8e823e3d90fd5b6116f99550611861903d8089833e6117f781836121f4565b946116ce565b8b513d86823e3d90fd5b86603286634e487b7160e01b600052526000fd5b86604186634e487b7160e01b600052526000fd5b6118af90883d8a116106105761060081836121f4565b5038611628565b8a513d8f823e3d90fd5b9095508481813d83116118ed575b6118d881836121f4565b810103126118e8575194386115b1565b600080fd5b503d6118ce565b87513d8c823e3d90fd5b6119159060a03d811161107b5761106981836121f4565b50505050611565565b86513d8b823e3d90fd5b611931906121ca565b61193c57893861153e565b8980fd5b89513d84823e3d90fd5b865162461bcd60e51b8152808701869052600f818501526e10995b1bddc81d1a1c995cda1bdb19608a1b6044820152606490fd5b90508581813d83116119a4575b61199581836121f4565b810103126118e8575138611509565b503d61198b565b88513d8d823e3d90fd5b855162461bcd60e51b8152808601859052600c818401526b151bdbc8199c995c5d595b9d60a21b6044820152606490fd5b634e487b7160e01b8a5260118652828afd5b855162461bcd60e51b81528086018590526019818401527f4175746f2d636f6d706f756e64206e6f7420656e61626c6564000000000000006044820152606490fd5b5050346101d857816003193601126101d857517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b9050346102b057611a8e36612123565b9190611a9861237a565b611aa38315156123dd565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811692909190833b15611b95578551630441a3e760e41b81528282820152856024820152878160448183895af18015611b8b57611b72575b5090602460a09287519586938492632f380b3560e01b84528301525afa918215611b6857611b3d94508592611b44575b5033911661225c565b6001805580f35b611b5d91925060a03d811161107b5761106981836121f4565b505050509038611b34565b84513d87823e3d90fd5b60a0929197611b826024926121ca565b97919250611b04565b87513d8a823e3d90fd5b8680fd5b9050346102b05760203660031901126102b057803590611bb7612139565b6101f48211611bfa5750907f528d9479e9f9889a87a3c30c7f7ba537e5e59c4c85a37733b16e57c62df6130291600354908060035582519182526020820152a180f35b606490602084519162461bcd60e51b8352820152600c60248201526b08ccaca40e8dede40d0d2ced60a31b6044820152fd5b9050346102b057611c3c366120f5565b50919290611c4861237a565b611c5061235c565b6001600160a01b038481169490919085151580612097575b611c7190612165565b8115158061208e575b156120595791879187937f000000000000000000000000000000000000000000000000000000000000000091611cb28130338661229f565b611cbe8830338c61229f565b60035490612710611cdb81611cd385856121a1565b04938b6121a1565b049282612046575b83612033575b875163e6a4390560e01b8082526001600160a01b039688168781168c8401908152978416602089810191909152909a929990977f00000000000000000000000000000000000000000000000000000000000000008a1692919089908c9081906040010381865afa9a8b1561202757819b611fed575b508b8d8b8d1615611eb8575b50505050505050611d859291611d7f9161222a565b9761222a565b9386611d918682612237565b96838c8c519485809281611dc863095ea7b360e01b988983528d89840160209093929193604081019460018060a01b031681520152565b03925af1918215611eae5786938593611e91575b508b519081526001600160a01b03909316908301908152602081018790528290819060400103818d8c5af18015611e8757937f4a1a2a6176e9646d9e3157f7c2ab3c499f18337c0b0828cfb28e0a61de4a11f797989993611e4c9388936105df97611e69575b505033911661225c565b519283923396846040919493926060820195825260208201520152565b81611e7f92903d106106105761060081836121f4565b503880611e42565b89513d8c823e3d90fd5b611ea790843d86116106105761060081836121f4565b5038611ddc565b8b513d8e823e3d90fd5b85516364e329cb60e11b81526001600160a01b039283169181019182529187166020820152969b50969796949593949389918591829081906040010391865af1908115611fe05788948c948e93611f9a575b50519081526001600160a01b039384169181019182529490921660208301528391829081906040015b03915afa908115611eae578c91611f58575b5094909190611d858b38808f8b8d611d6a565b90508381813d8311611f93575b611f6f81836121f4565b81010312611f8f57611d8592611f87611d7f92612216565b915092611f45565b8b80fd5b503d611f65565b95925050925083813d8311611fd9575b611fb481836121f4565b81010312611fd5578a8a928f611f3390611fce8b97612216565b5090611f0a565b8e80fd5b503d611faa565b508f8451903d90823e3d90fd5b8980929c508195503d8311612020575b61200781836121f4565b8101031261193c576120198f93612216565b9938611d5e565b503d611ffd565b508351903d90823e3d90fd5b61204184878b54168d61225c565b611ce9565b61205483878b54168761225c565b611ce3565b865162461bcd60e51b8152602081860152600f60248201526e496e76616c696420616d6f756e747360881b6044820152606490fd5b50841515611c7a565b507f00000000000000000000000000000000000000000000000000000000000000008316861415611c68565b8490346101d857816003193601126101d8576020906005548152f35b600435906001600160a01b03821682036118e857565b60809060031901126118e8576004356001600160a01b03811681036118e85790602435906044359060643590565b60409060031901126118e8576004359060243590565b6000546001600160a01b0316330361214d57565b60405163118cdaa760e01b8152336004820152602490fd5b1561216c57565b60405162461bcd60e51b815260206004820152600d60248201526c24b73b30b634b2103a37b5b2b760991b6044820152606490fd5b818102929181159184041417156121b457565b634e487b7160e01b600052601160045260246000fd5b67ffffffffffffffff81116121de57604052565b634e487b7160e01b600052604160045260246000fd5b90601f8019910116810190811067ffffffffffffffff8211176121de57604052565b51906001600160a01b03821682036118e857565b919082039182116121b457565b919082018092116121b457565b908160209103126118e8575180151581036118e85790565b60405163a9059cbb60e01b60208201526001600160a01b0392909216602483015260448083019390935291815261229d916122986064836121f4565b6122f4565b565b6040516323b872dd60e01b60208201526001600160a01b03928316602482015292909116604483015260648083019390935291815260a081019181831067ffffffffffffffff8411176121de5761229d926040525b906000602091828151910182855af115612350576000513d61234757506001600160a01b0381163b155b6123255750565b604051635274afe760e01b81526001600160a01b039091166004820152602490fd5b6001141561231e565b6040513d6000823e3d90fd5b60ff6002541661236857565b60405163d93c066560e01b8152600490fd5b60026001541461238b576002600155565b604051633ee5aeb560e01b8152600490fd5b3d156123d8573d9067ffffffffffffffff82116121de57604051916123cc601f8201601f1916602001846121f4565b82523d6000602084013e565b606090565b156123e457565b60405162461bcd60e51b8152602060048201526011602482015270125b9d985b1a5908131408185b5bdd5b9d607a1b6044820152606490fd5b1561242457565b60405162461bcd60e51b815260206004820152601360248201527214185a5c88191bd95cc81b9bdd08195e1a5cdd606a1b6044820152606490fd5b1561246657565b60405162461bcd60e51b815260206004820152601860248201527f496e73756666696369656e742053484148206f757470757400000000000000006044820152606490fd5b156124b257565b60405162461bcd60e51b8152602060048201526013602482015272115512081d1c985b9cd9995c8819985a5b1959606a1b6044820152606490fd5b908160a09103126118e85761250181612216565b916020820151916040810151916080606083015192015190565b80516001101561252b5760400190565b634e487b7160e01b600052603260045260246000fd5b9060209081838203126118e857825167ffffffffffffffff938482116118e8570181601f820112156118e85780519384116121de578360051b906040519461258b858401876121f4565b855283808601928201019283116118e8578301905b8282106125ae575050505090565b815181529083019083016125a0565b90815180825260208080930193019160005b8281106125dd575050505090565b83516001600160a01b0316855293810193928101926001016125cf56fea2646970667358221220543c2241fb6dcc9e80522d63da78d6ca5110e00dbe308fe862adf47c2550efcf64736f6c634300081400330000000000000000000000003f21a2c05fb60cb4fee11435bce32d272a8cd06c0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede8000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd000000000000000000000000f53bedb68675e3b8221a8bf351c2892bae89aef4
Deployed Bytecode
0x6080604081815260049182361015610022575b505050361561002057600080fd5b005b600092833560e01c9182631deb59cc146120c3575081631ece366a14611c2c578163357bf15c14611b9957816335fe79be14611a7e57816336e9332d14611a3a5781633d94adcc1461144a5781633f4ba83a146113e057816346904840146113b85781634b9ce62c146111815783826357126d0d146110ef575081635834e174146110a65781635c975abb146110825781636eb1154914610ebc578163715018a614610e62578382638453601714610df2575081638456cb5914610d9757816385e694b614610c9a5781638da5cb5b14610c7257816393ca2f8a146109e657816395ccea671461097457816398118cb414610955578163a63ec61614610900578163ad5c4648146108bc578163ae8c2c261461087e578163c45a01551461083a578163d06d04cc14610415578163e74b981b14610350578163e8d40d86146102ec578163eaaa3131146102b4578163f2fde38b1461021f57508063f6155811146101dc5763f887ea40146101965780610012565b346101d857816003193601126101d857517f0000000000000000000000003f21a2c05fb60cb4fee11435bce32d272a8cd06c6001600160a01b03168152602090f35b5080fd5b50346101d857816003193601126101d857517f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede86001600160a01b03168152602090f35b9050346102b05760203660031901126102b05761023a6120df565b90610243612139565b6001600160a01b0391821692831561029a575050600054826bffffffffffffffffffffffff60a01b821617600055167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a380f35b51631e4fbdf760e01b8152908101849052602490fd5b8280fd5b5050346101d85760203660031901126101d85760209181906001600160a01b036102dc6120df565b1681526007845220549051908152f35b9050346102b05760203660031901126102b05735908115158092036102b057338352600660205280832060ff1981541660ff8416179055519081527f72defbb28064584321264302489076b65ae61a5c2886d9fa7cf076a60371d5cf60203392a280f35b839150346101d85760203660031901126101d85761036c6120df565b90610375612139565b6001600160a01b03918083169182156103de5780546001600160a01b03198116939093179055935191166001600160a01b0390811682529092166020830152907faaebcf1bfa00580e41d966056b48521fa9f202645c86d4ddf28113e617c1b1d390604090a180f35b606490602087519162461bcd60e51b83528201526011602482015270125b9d985b1a59081c9958da5c1a595b9d607a1b6044820152fd5b90506020806003193601126108365761042c61237a565b61043461235c565b341561080157612710610449600354346121a1565b0490816107ab575b835163e6a4390560e01b8082527f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede86001600160a01b038181168488018181527f000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc280841660208301529197929691957f0000000000000000000000006943c5d80d4fbc2fc351e40c8f469c3b0e98a20488169592948c9493909290918c9187908290819060400103818b5afa9788156107a15789918799610766575b508a891615610621575b5050505061053784926105316105769334903090339061229f565b3461222a565b976105428934612237565b8b5163095ea7b360e01b81526001600160a01b0388169b81019b8c523460208d0152909a9094859384928391604090910190565b03925af1801561061757966105df938199936105bf937f4a1a2a6176e9646d9e3157f7c2ab3c499f18337c0b0828cfb28e0a61de4a11f7999a6105e9575b50508633911661225c565b519283921695339534846040919493926060820195825260208201520152565b0390a36001805580f35b8161060892903d10610610575b61060081836121f4565b810190612244565b5038806105b4565b503d6105f6565b88513d8b823e3d90fd5b90919294939750868b8d61065f865195869384936364e329cb60e11b8552840190602090939293604083019460018060a01b03809216845216910152565b038189855af1801561075c57899588948d948f93610713575b50519081526001600160a01b039384169181019182529590921660208301528491829081906040015b03915afa801561070957849284916106c6575b50949091506105378a87610576610516565b83819492503d8311610702575b6106dd81836121f4565b810103126102b057610537610576916105316106f98795612216565b925050916106b4565b503d6106d3565b8a513d85823e3d90fd5b959397505092505082813d8311610755575b61072f81836121f4565b810103126107515787938b8b926106a18f61074a8b97612216565b5090610678565b8480fd5b503d610725565b83513d88823e3d90fd5b92509750508581813d831161079a575b61078081836121f4565b8101031261075157876107938d92612216565b973861050c565b503d610776565b82513d88823e3d90fd5b848080808560018060a01b038854165af16107c461239d565b50610451579050606492519162461bcd60e51b83528201526013602482015272119959481d1c985b9cd9995c8819985a5b1959606a1b6044820152fd5b606492519162461bcd60e51b83528201526012602482015271125b9d985b1a590811551208185b5bdd5b9d60721b6044820152fd5b8380fd5b5050346101d857816003193601126101d857517f0000000000000000000000006943c5d80d4fbc2fc351e40c8f469c3b0e98a2046001600160a01b03168152602090f35b5050346101d85760203660031901126101d85760209160ff9082906001600160a01b036108a96120df565b1681526006855220541690519015158152f35b5050346101d857816003193601126101d857517f000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc26001600160a01b03168152602090f35b919050346102b05760203660031901126102b0577f3ce4b54cdb9854244a343b27f9ee8462d9fb506733bf36c92a28cc0aee82a63c913561093f612139565b600554908060055582519182526020820152a180f35b5050346101d857816003193601126101d8576020906003549051908152f35b5050346101d857806003193601126101d85761098e6120df565b907ff24ef89f38eadc1bde50701ad6e4d6d11a2dc24f7cf834a486991f388332850460206024356109bd612139565b85546001600160a01b0395861695906109da90839083168861225c565b8654169351908152a380f35b919050346102b057610a8f6109fa366120f5565b610a099593929594919461237a565b6001600160a01b038381169790939088151580610c46575b610a2a90612165565b610a358815156123dd565b7f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede89486519263e6a4390560e01b845283806020978893858b1687840190602090939293604083019460018060a01b03809216845216910152565b0381847f0000000000000000000000006943c5d80d4fbc2fc351e40c8f469c3b0e98a204165afa928315610c3c578b93610c01575b50821692610ad384151561241d565b610adf8930338761229f565b610aef8960011c9889101561245f565b8710610bbe57855163095ea7b360e01b81526001600160a01b03909216908201908152602081018890529091839183919082908c90829060400103925af18015610bb4579480936105df9593610b6f937fbc7d19d505c7ec4db83f3b51f19fb98c4c8a99922e7839d1ee608dfbee29501b98610b96575b5050339061225c565b610b7a82338861225c565b5193845260208401819052604084015233929081906060820190565b81610bac92903d106106105761060081836121f4565b503880610b66565b84513d8a823e3d90fd5b855162461bcd60e51b8152908101849052601960248201527f496e73756666696369656e7420746f6b656e206f7574707574000000000000006044820152606490fd5b9092508481813d8311610c35575b610c1981836121f4565b81010312610c3157610c2a90612216565b9138610ac4565b8a80fd5b503d610c0f565b87513d8d823e3d90fd5b507f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede88516891415610a21565b5050346101d857816003193601126101d857905490516001600160a01b039091168152602090f35b839150346101d857602092836003193601126102b057610d1184610cbc6120df565b835163e6a4390560e01b81526001600160a01b037f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede8811696820196875291821660208701529094909283918291604090910190565b0381867f0000000000000000000000006943c5d80d4fbc2fc351e40c8f469c3b0e98a204165afa938415610d8c578094610d4f575b50505191168152f35b909193508482813d8311610d85575b610d6881836121f4565b81010312610d825750610d7a90612216565b918480610d46565b80fd5b503d610d5e565b8251903d90823e3d90fd5b5050346101d857816003193601126101d85760207f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25891610dd5612139565b610ddd61235c565b600160ff19600254161760025551338152a180f35b808434610e5f5781600319360112610e5f57610e0c612139565b7ff24ef89f38eadc1bde50701ad6e4d6d11a2dc24f7cf834a486991f388332850460204760018060a01b03610e538680808086868254165af1610e4d61239d565b506124ab565b8554169351908152a380f35b50fd5b8334610d825780600319360112610d8257610e7b612139565b600080546001600160a01b0319811682556001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b8383346101d857610ecc36612123565b919093610ed761237a565b610edf61235c565b610eea8315156123dd565b8151632f380b3560e01b81528181018690526001600160a01b037f000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd8116969160a0816024818b5afa908115611014578791611050575b501695861561101e578596610f578630338461229f565b845163095ea7b360e01b81526001600160a01b03831685820190815260208181018990529192839182908b90829060400103925af1801561101457610ff6575b50803b15610ff25785928360449286519788958694631c57762b60e31b865285015260248401525af1908115610fe95750610fd5575b506001805580f35b610fde906121ca565b610d82578082610fcd565b513d84823e3d90fd5b8580fd5b61100d9060203d81116106105761060081836121f4565b5087610f97565b85513d89823e3d90fd5b835162461bcd60e51b8152602081850152600c60248201526b125b9d985b1a59081c1bdbdb60a21b6044820152606490fd5b611071915060a03d811161107b575b61106981836121f4565b8101906124ed565b5050505088610f40565b503d61105f565b5050346101d857816003193601126101d85760209060ff6002541690519015158152f35b828434610d82576020366003190112610d82576001600160a01b036110c96120df565b16815260066020528160ff81832054169160076020522054825191151582526020820152f35b8091843461117d57602036600319011261117d5761110b61237a565b61111361235c565b7f000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd6001600160a01b031691823b156111785783926024849284519586938492636ee3193160e11b84528035908401525af1908115610fe95750610fd557506001805580f35b505050fd5b5050fd5b9050346102b05760603660031901126102b057803561119e61237a565b6111a98115156123dd565b825163e6a4390560e01b81526001600160a01b037f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede88181168584019081527f000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc283811660208381019190915293949093918290829081906040010381887f0000000000000000000000006943c5d80d4fbc2fc351e40c8f469c3b0e98a204165afa90811561061757899161137f575b508481169061126782151561241d565b6112738730338561229f565b8660011c976112866024358a101561245f565b604435891061133c57895163095ea7b360e01b81526001600160a01b03909216908201908152602081018890529091839183919082908d90829060400103925af1801561061757966105df93819993611309937fbc7d19d505c7ec4db83f3b51f19fb98c4c8a99922e7839d1ee608dfbee29501b999a610b96575050339061225c565b61131c888080808b335af1610e4d61239d565b519283921695803396846040919493926060820195825260208201520152565b895162461bcd60e51b8152908101849052601760248201527f496e73756666696369656e7420455448206f75747075740000000000000000006044820152606490fd5b90508181813d83116113b1575b61139681836121f4565b810103126113ad576113a790612216565b38611257565b8880fd5b503d61138c565b9050346102b057826003193601126102b0575490516001600160a01b03909116815260209150f35b9050346102b057826003193601126102b0576113fa612139565b6002549060ff82161561143c575060ff1916600255513381527f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa90602090a180f35b8251638dfc202b60e01b8152fd5b9050346102b057816003193601126102b0576114646120df565b91602491823561147261237a565b61147a61235c565b60018060a01b0394858116948588526020926006845260ff868a205416156119f8578689526007845285892054610e1081018091116119e65742106119b557877f000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd16908651634c4b4f4160e11b8152818782015288848201528581604481865afa9081156119ab578b9161197e575b506005541161194a57813b1561193c57898751636ee3193160e11b815282888201528181868183885af1801561194057611928575b505060a09083885180948193632f380b3560e01b83528a8301525afa801561191e576118fe575b5084516370a0823160e01b81523085820152937f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede888169084868481855afa9586156118f4578a966118c0575b50856115c0575b896001805580f35b865163095ea7b360e01b8082527f0000000000000000000000003f21a2c05fb60cb4fee11435bce32d272a8cd06c8b166001600160a01b038116848401908152602081018a905290949290889082908f90829081906040010391875af180156118b657611899575b5088519a60608c018c811067ffffffffffffffff821117611885578a5260028c52878c018a3682378c5115611871579183918e948e94526116688461251b565b907f000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2169052838b8b6116b68251968793849363d06ca61f60e01b85528b8501528c84015260448301906125bd565b0381895afa92831561186757918a918a938695611849575b508c519081526001600160a01b03881687820190815260208101939093529394849283919082906040015b03925af1801561183f57906117149291611822575b5061251b565b519861012c420190814211611810578b80979695938195938a938c519e8f97889687956338ed173960e01b87528601528401526044830160a0905260a4830161175c916125bd565b90306064840152608483015203925af1968715611806577fd97f7727c261ed1fa078ce381613db42a28234f23a5de7f96377c89e11a0fd2096976117e4575b50824791826117ca575b50879150526007815242848320558351928352820152a23880808080808080806115b8565b81806117dc9481935af1610e4d61239d565b3882816117a5565b6117ff903d8086833e6117f781836121f4565b810190612541565b503861179b565b85513d85823e3d90fd5b634e487b7160e01b8c5260118352848cfd5b61183890883d8a116106105761060081836121f4565b503861170e565b89513d8e823e3d90fd5b6116f99550611861903d8089833e6117f781836121f4565b946116ce565b8b513d86823e3d90fd5b86603286634e487b7160e01b600052526000fd5b86604186634e487b7160e01b600052526000fd5b6118af90883d8a116106105761060081836121f4565b5038611628565b8a513d8f823e3d90fd5b9095508481813d83116118ed575b6118d881836121f4565b810103126118e8575194386115b1565b600080fd5b503d6118ce565b87513d8c823e3d90fd5b6119159060a03d811161107b5761106981836121f4565b50505050611565565b86513d8b823e3d90fd5b611931906121ca565b61193c57893861153e565b8980fd5b89513d84823e3d90fd5b865162461bcd60e51b8152808701869052600f818501526e10995b1bddc81d1a1c995cda1bdb19608a1b6044820152606490fd5b90508581813d83116119a4575b61199581836121f4565b810103126118e8575138611509565b503d61198b565b88513d8d823e3d90fd5b855162461bcd60e51b8152808601859052600c818401526b151bdbc8199c995c5d595b9d60a21b6044820152606490fd5b634e487b7160e01b8a5260118652828afd5b855162461bcd60e51b81528086018590526019818401527f4175746f2d636f6d706f756e64206e6f7420656e61626c6564000000000000006044820152606490fd5b5050346101d857816003193601126101d857517f000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd6001600160a01b03168152602090f35b9050346102b057611a8e36612123565b9190611a9861237a565b611aa38315156123dd565b6001600160a01b037f000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd811692909190833b15611b95578551630441a3e760e41b81528282820152856024820152878160448183895af18015611b8b57611b72575b5090602460a09287519586938492632f380b3560e01b84528301525afa918215611b6857611b3d94508592611b44575b5033911661225c565b6001805580f35b611b5d91925060a03d811161107b5761106981836121f4565b505050509038611b34565b84513d87823e3d90fd5b60a0929197611b826024926121ca565b97919250611b04565b87513d8a823e3d90fd5b8680fd5b9050346102b05760203660031901126102b057803590611bb7612139565b6101f48211611bfa5750907f528d9479e9f9889a87a3c30c7f7ba537e5e59c4c85a37733b16e57c62df6130291600354908060035582519182526020820152a180f35b606490602084519162461bcd60e51b8352820152600c60248201526b08ccaca40e8dede40d0d2ced60a31b6044820152fd5b9050346102b057611c3c366120f5565b50919290611c4861237a565b611c5061235c565b6001600160a01b038481169490919085151580612097575b611c7190612165565b8115158061208e575b156120595791879187937f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede891611cb28130338661229f565b611cbe8830338c61229f565b60035490612710611cdb81611cd385856121a1565b04938b6121a1565b049282612046575b83612033575b875163e6a4390560e01b8082526001600160a01b039688168781168c8401908152978416602089810191909152909a929990977f0000000000000000000000006943c5d80d4fbc2fc351e40c8f469c3b0e98a2048a1692919089908c9081906040010381865afa9a8b1561202757819b611fed575b508b8d8b8d1615611eb8575b50505050505050611d859291611d7f9161222a565b9761222a565b9386611d918682612237565b96838c8c519485809281611dc863095ea7b360e01b988983528d89840160209093929193604081019460018060a01b031681520152565b03925af1918215611eae5786938593611e91575b508b519081526001600160a01b03909316908301908152602081018790528290819060400103818d8c5af18015611e8757937f4a1a2a6176e9646d9e3157f7c2ab3c499f18337c0b0828cfb28e0a61de4a11f797989993611e4c9388936105df97611e69575b505033911661225c565b519283923396846040919493926060820195825260208201520152565b81611e7f92903d106106105761060081836121f4565b503880611e42565b89513d8c823e3d90fd5b611ea790843d86116106105761060081836121f4565b5038611ddc565b8b513d8e823e3d90fd5b85516364e329cb60e11b81526001600160a01b039283169181019182529187166020820152969b50969796949593949389918591829081906040010391865af1908115611fe05788948c948e93611f9a575b50519081526001600160a01b039384169181019182529490921660208301528391829081906040015b03915afa908115611eae578c91611f58575b5094909190611d858b38808f8b8d611d6a565b90508381813d8311611f93575b611f6f81836121f4565b81010312611f8f57611d8592611f87611d7f92612216565b915092611f45565b8b80fd5b503d611f65565b95925050925083813d8311611fd9575b611fb481836121f4565b81010312611fd5578a8a928f611f3390611fce8b97612216565b5090611f0a565b8e80fd5b503d611faa565b508f8451903d90823e3d90fd5b8980929c508195503d8311612020575b61200781836121f4565b8101031261193c576120198f93612216565b9938611d5e565b503d611ffd565b508351903d90823e3d90fd5b61204184878b54168d61225c565b611ce9565b61205483878b54168761225c565b611ce3565b865162461bcd60e51b8152602081860152600f60248201526e496e76616c696420616d6f756e747360881b6044820152606490fd5b50841515611c7a565b507f0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede88316861415611c68565b8490346101d857816003193601126101d8576020906005548152f35b600435906001600160a01b03821682036118e857565b60809060031901126118e8576004356001600160a01b03811681036118e85790602435906044359060643590565b60409060031901126118e8576004359060243590565b6000546001600160a01b0316330361214d57565b60405163118cdaa760e01b8152336004820152602490fd5b1561216c57565b60405162461bcd60e51b815260206004820152600d60248201526c24b73b30b634b2103a37b5b2b760991b6044820152606490fd5b818102929181159184041417156121b457565b634e487b7160e01b600052601160045260246000fd5b67ffffffffffffffff81116121de57604052565b634e487b7160e01b600052604160045260246000fd5b90601f8019910116810190811067ffffffffffffffff8211176121de57604052565b51906001600160a01b03821682036118e857565b919082039182116121b457565b919082018092116121b457565b908160209103126118e8575180151581036118e85790565b60405163a9059cbb60e01b60208201526001600160a01b0392909216602483015260448083019390935291815261229d916122986064836121f4565b6122f4565b565b6040516323b872dd60e01b60208201526001600160a01b03928316602482015292909116604483015260648083019390935291815260a081019181831067ffffffffffffffff8411176121de5761229d926040525b906000602091828151910182855af115612350576000513d61234757506001600160a01b0381163b155b6123255750565b604051635274afe760e01b81526001600160a01b039091166004820152602490fd5b6001141561231e565b6040513d6000823e3d90fd5b60ff6002541661236857565b60405163d93c066560e01b8152600490fd5b60026001541461238b576002600155565b604051633ee5aeb560e01b8152600490fd5b3d156123d8573d9067ffffffffffffffff82116121de57604051916123cc601f8201601f1916602001846121f4565b82523d6000602084013e565b606090565b156123e457565b60405162461bcd60e51b8152602060048201526011602482015270125b9d985b1a5908131408185b5bdd5b9d607a1b6044820152606490fd5b1561242457565b60405162461bcd60e51b815260206004820152601360248201527214185a5c88191bd95cc81b9bdd08195e1a5cdd606a1b6044820152606490fd5b1561246657565b60405162461bcd60e51b815260206004820152601860248201527f496e73756666696369656e742053484148206f757470757400000000000000006044820152606490fd5b156124b257565b60405162461bcd60e51b8152602060048201526013602482015272115512081d1c985b9cd9995c8819985a5b1959606a1b6044820152606490fd5b908160a09103126118e85761250181612216565b916020820151916040810151916080606083015192015190565b80516001101561252b5760400190565b634e487b7160e01b600052603260045260246000fd5b9060209081838203126118e857825167ffffffffffffffff938482116118e8570181601f820112156118e85780519384116121de578360051b906040519461258b858401876121f4565b855283808601928201019283116118e8578301905b8282106125ae575050505090565b815181529083019083016125a0565b90815180825260208080930193019160005b8281106125dd575050505090565b83516001600160a01b0316855293810193928101926001016125cf56fea2646970667358221220543c2241fb6dcc9e80522d63da78d6ca5110e00dbe308fe862adf47c2550efcf64736f6c63430008140033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
0000000000000000000000003f21a2c05fb60cb4fee11435bce32d272a8cd06c0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede8000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd000000000000000000000000f53bedb68675e3b8221a8bf351c2892bae89aef4
-----Decoded View---------------
Arg [0] : _router (address): 0x3f21A2c05FB60CB4feE11435BcE32d272A8cd06C
Arg [1] : _shahToken (address): 0x6E0cFA42F797E316ff147A21f7F1189cd610ede8
Arg [2] : _farm (address): 0xB63A61874636669C0D71C20CBfE0DcB3E00aFafD
Arg [3] : _owner (address): 0xF53Bedb68675e3B8221a8bf351C2892Bae89Aef4
-----Encoded View---------------
4 Constructor Arguments found :
Arg [0] : 0000000000000000000000003f21a2c05fb60cb4fee11435bce32d272a8cd06c
Arg [1] : 0000000000000000000000006e0cfa42f797e316ff147a21f7f1189cd610ede8
Arg [2] : 000000000000000000000000b63a61874636669c0d71c20cbfe0dcb3e00afafd
Arg [3] : 000000000000000000000000f53bedb68675e3b8221a8bf351c2892bae89aef4
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.