Overview
Max Total Supply
3,876,670.7110900940848286 XBURN
Holders
1,058 (0.00%)
Market
Price
$0.00 @ 0.000000 ETH
Onchain Market Cap
-
Circulating Supply Market Cap
-
Other Info
Token Contract (WITH 18 Decimals)
Balance
814.273807923692443327 XBURNValue
$0.00Loading...
Loading
Loading...
Loading
Loading...
Loading
Contract Name:
XBurnMinter
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;
/**
* @title XBurnMinter
* @dev Main contract for burning XEN tokens to get XBURN tokens.
* Creates NFTs representing locked positions and handles reward distribution.
* Optimized for gas efficiency and security.
*/
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import "@uniswap/v2-core/contracts/interfaces/IUniswapV2Factory.sol";
import "@uniswap/v2-core/contracts/interfaces/IUniswapV2Pair.sol";
import "@uniswap/v2-periphery/contracts/interfaces/IUniswapV2Router02.sol";
import {XBurnNFT} from "./XBurnNFT.sol";
// ------------------------------------------------
// ================ Interfaces ===================
// ------------------------------------------------
/**
* @dev Interface for tokens that can be burned
*/
interface IBurnableToken {
function burn(address account, uint256 amount) external;
}
/**
* @dev Interface for contracts that receive burn callbacks
*/
interface IBurnRedeemable {
function onTokenBurned(address user, uint256 amount) external;
}
/**
* @dev Extended interface for XBURN token
*/
interface IXBURN is IERC20 {
function mint(address to, uint256 amount) external;
function burn(address account, uint256 amount) external;
}
/**
* @dev Extended interface for Uniswap V2 pairs
*/
interface IUniswapV2PairExtended is IUniswapV2Pair {
function token0() external view returns (address);
function token1() external view returns (address);
}
/**
* @dev Interface for XBurnNFT contract
*/
interface IXBurnNFT {
function mint(
address to,
uint256 xenAmount,
uint256 termDays,
uint256 ampSnapshot,
uint256 rewardAmount
) external returns (uint256);
function setClaimed(uint256 tokenId) external;
function burn(uint256 tokenId) external;
function ownerOf(uint256 tokenId) external view returns (address);
function getLockDetails(uint256 tokenId) external view returns (
uint256 xenAmount,
uint256 maturityTs,
uint256 ampSnapshot,
uint256 termDays,
bool claimed,
uint256 rewardAmount,
uint256 baseMint,
address owner
);
function getAllUserLocks(address user, uint256 page, uint256 pageSize) external view returns (uint256[] memory, uint256 totalPages);
function setMinter(address newMinter) external;
}
/**
* @title XBurnMinter
* @dev Main contract for burning XEN tokens and minting XBURN tokens
*/
contract XBurnMinter is ERC20, Ownable, ReentrancyGuard, IBurnRedeemable, IERC165 {
using SafeERC20 for IERC20;
// ------------------------------------------------
// ================ Constants ====================
// ------------------------------------------------
uint256 public constant AMP_START = 1;
uint256 public constant AMP_END = 1;
uint256 public constant BASE_RATIO = 1_000_000; // 1M XEN = 1 XBURN (Updated)
uint256 public constant MIN_TERM = 1 days;
uint256 public constant MAX_TERM = 3650 days; // ~10 years
uint256 public constant INITIAL_SUPPLY = 50_000 * 10**18;
uint256 public constant SWAP_THRESHOLD = 500_000_000 * 1e18; // Mainnet: 500M XEN
uint256 public constant CALLER_REWARD_PERCENTAGE = 5;
uint256 public constant MAX_DEADLINE = 15 minutes;
uint256 public constant MINIMUM_LIQUIDITY = 100_000 * 1e18;
uint256 public constant MAX_BATCH_SIZE = 50; // Re-added: Maximum batch size for view function loops
// ------------------------------------------------
// ================ State Variables ==============
// ------------------------------------------------
// External contract references (immutable for gas savings)
IERC20 public immutable XEN;
XBurnNFT public immutable nftContract;
IUniswapV2Router02 public immutable uniswapRouter;
uint256 public immutable LAUNCH_TS; // Timestamp when contract was launched
// Tracking state variables (uint256 grouped together for storage optimization)
uint256 public globalBurnRank; // Number of burning participants
uint256 public totalXenBurned;
uint256 public totalXburnMinted;
uint256 public totalXburnBurned;
uint256 public pendingXen; // XEN waiting to be swapped
// Address variables
address public liquidityPair; // Uniswap pair address
// Boolean variables
bool public liquidityInitialized;
// Mappings
mapping(address => uint256) public userXenBurned;
mapping(address => uint256) public userXburnMinted;
mapping(address => uint256) public userXburnBurned;
// ------------------------------------------------
// ================ Custom Errors ================
// ------------------------------------------------
error LiquidityAlreadyInitialized();
error InsufficientXen(uint256 required, uint256 provided);
error LiquidityPairNotSet();
error LiquidityNotInitialized();
error PendingXenTooLow(uint256 current, uint256 required);
error SwapFailedError(string reason);
error InvalidAmount(uint256 amount);
error InvalidTerm(uint256 providedDays, uint256 maxDays);
error NotTokenOwner(uint256 tokenId, address provided, address actual);
error TokenNotClaimable(uint256 tokenId);
error TokenAlreadyClaimed(uint256 tokenId);
error TokenNotMatured(uint256 tokenId, uint256 maturityTs, uint256 currentTime);
error UnauthorizedCallback(address sender, address expected);
// ------------------------------------------------
// ================== Events =====================
// ------------------------------------------------
event XENBurned(address indexed user, uint256 amount);
event XBURNClaimed(address indexed user, uint256 baseAmount, uint256 bonusAmount);
event EmergencyEnd(address indexed user, uint256 baseAmount);
event GlobalStatsUpdated(uint256 totalXenBurned, uint256 totalXburnMinted);
event XBURNBurned(address indexed user, uint256 amount);
event CallerRewarded(address indexed caller, uint256 amount);
event SwapFailed(string reason, string message, uint256 xenAmount);
event BurnNFTMinted(address indexed user, uint256 tokenId, uint256 xenAmount, uint256 termDays);
event LiquidityInitialized(uint256 amountXBURN, uint256 amountXEN, uint256 liquidity);
// ------------------------------------------------
// ================ Constructor =================
// ------------------------------------------------
/**
* @dev Initializes the contract
* @param _xen XEN token address
* @param _router Uniswap router address
* @param _nft XBurnNFT contract address
*/
constructor(
address _xen,
address _router,
address _nft
) ERC20("XBURN", "XBURN") Ownable(msg.sender) {
// Initialize constants
LAUNCH_TS = block.timestamp;
globalBurnRank = 1;
// Store contract references
XEN = IERC20(_xen);
uniswapRouter = IUniswapV2Router02(_router);
nftContract = XBurnNFT(_nft);
// Mint initial supply to this contract
_mint(address(this), INITIAL_SUPPLY);
}
// ------------------------------------------------
// ================ Liquidity ====================
// ------------------------------------------------
/**
* @dev Initializes liquidity in Uniswap
* @param xenAmount Amount of XEN to provide for liquidity
*/
function initializeLiquidity(uint256 xenAmount) external onlyOwner nonReentrant {
if (liquidityInitialized) revert LiquidityAlreadyInitialized();
if (xenAmount < MINIMUM_LIQUIDITY) revert InsufficientXen(MINIMUM_LIQUIDITY, xenAmount);
if (XEN.balanceOf(msg.sender) < xenAmount) revert InsufficientXen(xenAmount, XEN.balanceOf(msg.sender));
// Transfer XEN to this contract
XEN.safeTransferFrom(msg.sender, address(this), xenAmount);
// Approve tokens for Uniswap router
_approve(address(this), address(uniswapRouter), INITIAL_SUPPLY);
XEN.approve(address(uniswapRouter), xenAmount);
// Add liquidity
_doAddLiquidity(xenAmount);
}
/**
* @dev Helper to add liquidity (reduces stack depth)
* @param xenAmount Amount of XEN to provide
*/
function _doAddLiquidity(uint256 xenAmount) private {
(uint256 xburnUsed, uint256 xenUsed, uint256 liquidity) = uniswapRouter.addLiquidity(
address(this),
address(XEN),
INITIAL_SUPPLY,
xenAmount,
(INITIAL_SUPPLY * 95) / 100, // Allow 5% slippage
(xenAmount * 95) / 100, // Allow 5% slippage
msg.sender, // LP tokens to owner
block.timestamp + MAX_DEADLINE
);
// Ensure liquidity was created successfully
if (liquidity == 0) revert InsufficientXen(MINIMUM_LIQUIDITY, xenAmount);
// Get the pair address from factory
liquidityPair = IUniswapV2Factory(uniswapRouter.factory()).getPair(address(this), address(XEN));
if (liquidityPair == address(0)) revert LiquidityPairNotSet();
// Mark as initialized
liquidityInitialized = true;
// Emit event
emit LiquidityInitialized(xburnUsed, xenUsed, liquidity);
}
// ------------------------------------------------
// ================ Swapping ====================
// ------------------------------------------------
/**
* @dev Swaps accumulated XEN for XBURN and burns it
* @param minXburnReceived Minimum amount of XBURN to receive
*/
function swapXenForXburn(uint256 minXburnReceived) external nonReentrant {
if (!liquidityInitialized) revert LiquidityNotInitialized();
if (liquidityPair == address(0)) revert LiquidityPairNotSet();
if (pendingXen < SWAP_THRESHOLD) revert PendingXenTooLow(pendingXen, SWAP_THRESHOLD);
// Get amount to swap and reset pending counter
uint256 xenToSwap = pendingXen;
pendingXen = 0;
// Execute swap
_executeSwap(xenToSwap, minXburnReceived);
}
/**
* @dev Helper to execute the swap (reduces stack depth)
* @param xenToSwap Amount of XEN to swap
* @param minXburnReceived Minimum amount of XBURN to receive
*/
function _executeSwap(uint256 xenToSwap, uint256 minXburnReceived) private {
// Calculate caller reward
uint256 callerReward = (xenToSwap * CALLER_REWARD_PERCENTAGE) / 100;
uint256 xenForSwap = xenToSwap - callerReward;
// Send reward to caller
XEN.safeTransfer(msg.sender, callerReward);
emit CallerRewarded(msg.sender, callerReward);
// Set up swap path
address[] memory path = new address[](2);
path[0] = address(XEN);
path[1] = address(this);
// Approve router to spend XEN
XEN.safeIncreaseAllowance(address(uniswapRouter), xenForSwap);
// Execute swap with try/catch for safety
try uniswapRouter.swapExactTokensForTokens(
xenForSwap,
minXburnReceived,
path,
msg.sender, // Changed: Send to caller first, not contract
block.timestamp + MAX_DEADLINE
) returns (uint256[] memory amounts) {
uint256 xburnReceived = amounts[1];
// Transfer tokens back to contract
_transfer(msg.sender, address(this), xburnReceived);
// Burn the received XBURN tokens
_burn(address(this), xburnReceived);
totalXburnBurned += xburnReceived;
// Add event to match old contract
emit XBURNBurned(address(this), xburnReceived);
} catch Error(string memory reason) {
// Revert pendingXen if swap fails
pendingXen = xenToSwap;
emit SwapFailed("Swap transaction failed", reason, xenToSwap);
revert SwapFailedError(reason);
} catch {
// Revert pendingXen if swap fails with no reason
pendingXen = xenToSwap;
emit SwapFailed("Swap transaction failed", "Unknown error", xenToSwap);
revert SwapFailedError("Unknown error");
}
}
// ------------------------------------------------
// ============== Main Burn Logic ================
// ------------------------------------------------
/**
* @dev Calculates reward amount based on base, amplifier, and term
* @param baseAmount Base amount of XBURN
* @param ampSnapshot Amplifier snapshot value
* @param termDays Term duration in days
* @return Total reward amount
*/
function _calculateReward(
uint256 baseAmount,
uint256 ampSnapshot,
uint256 termDays
) private pure returns (uint256) {
// Calculate percentage scaled up to MAX_TERM (3650 days)
uint256 termPercentage = (termDays * 100) / (MAX_TERM / 1 days); // Use MAX_TERM constant
uint256 ampPercentage = (ampSnapshot * 100) / AMP_START; // 0-100
// Calculate bonus (up to 100% based on term and amp)
uint256 bonus = (baseAmount * termPercentage * ampPercentage) / 10000;
return baseAmount + bonus;
}
/**
* @dev Burns XEN tokens to mint XBURN (locked in an NFT)
* @param amount Amount of XEN to burn (in wei)
* @param termDays Lock duration in days
*/
function burnXEN(uint256 amount, uint256 termDays) external nonReentrant {
// Corrected Check: Ensure at least BASE_RATIO *full* XEN tokens are burned
if (amount < BASE_RATIO * 1e18) revert InvalidAmount(amount);
if (termDays * 1 days > MAX_TERM) revert InvalidTerm(termDays, MAX_TERM / 1 days);
// Step 1: Handle XEN tokens (burn + accumulate)
_handleXenTokens(amount);
// Step 2: Create NFT representing the locked position
_createBurnNFT(amount, termDays);
}
/**
* @dev Helper to handle XEN tokens during burn (reduces stack depth)
* @param amount Total amount of XEN to handle
*/
function _handleXenTokens(uint256 amount) private {
// Split: 80% burned directly, 20% accumulated for later swaps
uint256 xenForAccumulation = (amount * 20) / 100;
uint256 xenForBurn = amount - xenForAccumulation;
// Transfer accumulation portion to contract
XEN.safeTransferFrom(msg.sender, address(this), xenForAccumulation);
pendingXen += xenForAccumulation;
// Burn directly from user's address
IBurnableToken(address(XEN)).burn(msg.sender, xenForBurn);
// Update stats
totalXenBurned += amount;
userXenBurned[msg.sender] += amount;
}
/**
* @dev Helper to create NFT during burn (reduces stack depth)
* @param amount Amount of XEN burned
* @param termDays Lock duration in days
*/
function _createBurnNFT(uint256 amount, uint256 termDays) private {
// Calculate reward values
uint256 baseAmount = amount / BASE_RATIO;
uint256 ampSnapshot = _currentAMP();
uint256 rewardAmount = _calculateReward(baseAmount, ampSnapshot, termDays);
// Create NFT lock
uint256 tokenId = nftContract.mint(
msg.sender, // NFT owner
amount, // Original XEN amount
termDays, // Term days
ampSnapshot, // Current amplifier snapshot
rewardAmount // Total reward amount including bonus
);
// Increase global burn rank
globalBurnRank++;
// Emit events
emit XENBurned(msg.sender, amount);
emit BurnNFTMinted(msg.sender, tokenId, amount, termDays);
emit GlobalStatsUpdated(totalXenBurned, totalXburnMinted);
}
// ------------------------------------------------
// ============== Claiming Lock Logic =============
// ------------------------------------------------
/**
* @dev XEN burn callback implementation
* Required by IBurnRedeemable interface
* @param user Address of the user who burned tokens
* @param amount Amount of tokens burned
*/
function onTokenBurned(address user, uint256 amount) external override {
// Only XEN contract can call this function
if (msg.sender != address(XEN)) revert UnauthorizedCallback(msg.sender, address(XEN));
}
/**
* @dev ERC165 interface support
* @param interfaceId Interface identifier to check
* @return bool True if this contract supports the interface
*/
function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
return
interfaceId == type(IBurnRedeemable).interfaceId ||
interfaceId == type(IERC165).interfaceId;
}
/**
* @dev Claims XBURN rewards from a mature lock
* @param tokenId NFT token ID to claim
*/
function claimLockedXBURN(uint256 tokenId) external nonReentrant {
// Validate ownership
address owner = nftContract.ownerOf(tokenId);
if (owner != msg.sender) revert NotTokenOwner(tokenId, msg.sender, owner);
// Validate token is claimable
(bool isValid, uint256 xenAmount, uint256 rewardAmount) = _validateTokenForClaim(tokenId);
if (!isValid) revert TokenNotClaimable(tokenId);
// Process the claim
_processClaim(tokenId, xenAmount, rewardAmount);
}
/**
* @dev Helper to validate a token for claiming (reduces stack depth)
* @param tokenId NFT token ID to validate
* @return isValid Whether the token is valid for claiming
* @return xenAmount Amount of XEN burned
* @return rewardAmount Total reward amount
*/
function _validateTokenForClaim(uint256 tokenId) private view returns (
bool isValid,
uint256 xenAmount,
uint256 rewardAmount
) {
uint256 maturityTs;
bool claimed;
uint256 baseMint;
address owner;
uint256 ampSnapshot;
uint256 termDays;
(
xenAmount,
maturityTs,
ampSnapshot,
termDays,
claimed,
rewardAmount,
baseMint,
owner
) = nftContract.getLockDetails(tokenId);
// Token is valid if not claimed and matured
isValid = !claimed && block.timestamp >= maturityTs;
return (isValid, xenAmount, rewardAmount);
}
/**
* @dev Helper to process a claim (reduces stack depth)
* @param tokenId NFT token ID to process
* @param xenAmount Amount of XEN burned
* @param rewardAmount Total reward amount
*/
function _processClaim(
uint256 tokenId,
uint256 xenAmount,
uint256 rewardAmount
) private {
// Mint the reward to the claimer
_mint(msg.sender, rewardAmount);
// Update stats
totalXburnMinted += rewardAmount;
userXburnMinted[msg.sender] += rewardAmount;
// Mark NFT as claimed and burn it
nftContract.setClaimed(tokenId);
nftContract.burn(tokenId);
// Calculate base amount for event
uint256 baseAmount = xenAmount / BASE_RATIO;
// Emit events
emit XBURNClaimed(msg.sender, baseAmount, rewardAmount - baseAmount);
emit GlobalStatsUpdated(totalXenBurned, totalXburnMinted);
}
/**
* @dev Emergency withdrawal with reduced rewards
* @param tokenId NFT token ID to emergency withdraw
*/
function emergencyEnd(uint256 tokenId) external nonReentrant {
// Verify ownership
address owner = nftContract.ownerOf(tokenId);
if (owner != msg.sender) revert NotTokenOwner(tokenId, msg.sender, owner);
// Validate token
bool isValid = false;
uint256 baseMint = 0;
(isValid, baseMint) = _validateEmergencyEnd(tokenId);
if (!isValid) revert TokenNotClaimable(tokenId);
// Process emergency end
_processEmergencyEnd(tokenId, baseMint);
}
/**
* @dev Helper to validate emergency end (reduces stack depth)
* @param tokenId NFT token ID to validate
* @return isValid Whether token is valid for emergency end
* @return baseMint Base mint amount (no bonus)
*/
function _validateEmergencyEnd(uint256 tokenId) private view returns (bool isValid, uint256 baseMint) {
uint256 xenAmount;
uint256 maturityTs;
uint256 ampSnapshot;
uint256 termDays;
bool claimed;
uint256 rewardAmount;
address tokenOwner;
(
xenAmount,
maturityTs,
ampSnapshot,
termDays,
claimed,
rewardAmount,
baseMint,
tokenOwner
) = nftContract.getLockDetails(tokenId);
// Valid if not claimed (any maturity date)
isValid = !claimed;
return (isValid, baseMint);
}
/**
* @dev Helper to process emergency end (reduces stack depth)
* @param tokenId NFT token ID to process
* @param baseMint Base mint amount to return
*/
function _processEmergencyEnd(uint256 tokenId, uint256 baseMint) private {
// Mint only the base amount (no bonus)
_mint(msg.sender, baseMint);
// Update stats
totalXburnMinted += baseMint;
userXburnMinted[msg.sender] += baseMint;
// Mark as claimed and burn NFT
nftContract.setClaimed(tokenId);
nftContract.burn(tokenId);
// Emit events
emit EmergencyEnd(msg.sender, baseMint);
emit GlobalStatsUpdated(totalXenBurned, totalXburnMinted);
}
// ------------------------------------------------
// ================ Burn XBURN ===================
// ------------------------------------------------
/**
* @dev Burns XBURN tokens
* @param amount Amount to burn
*/
function burnXburn(uint256 amount) external nonReentrant {
if (amount == 0) revert InvalidAmount(amount);
// Burn from sender
_burn(msg.sender, amount);
// Update stats
totalXburnBurned += amount;
userXburnBurned[msg.sender] += amount;
// Emit event
emit XBURNBurned(msg.sender, amount);
}
// ------------------------------------------------
// ================ View Functions ===============
// ------------------------------------------------
/**
* @dev Gets user's locked tokens with pagination
* @param user Address to query
* @param page Page number (0-indexed)
* @param pageSize Number of items per page
* @return tokenIds Array of token IDs owned by user
* @return totalPages Total number of pages
*/
function getUserLocks(address user, uint256 page, uint256 pageSize)
public
view
returns (uint256[] memory tokenIds, uint256 totalPages)
{
// Limit page size for gas optimization
if (pageSize > MAX_BATCH_SIZE) {
pageSize = MAX_BATCH_SIZE;
}
// Forward request to the NFT contract
return nftContract.getAllUserLocks(user, page, pageSize);
}
/**
* @dev Gets first page of user's locked tokens (convenience function)
* @param user Address to query
* @return Array of token IDs owned by user (first page)
*/
function getUserLocks(address user) external view returns (uint256[] memory) {
(uint256[] memory tokenIds, ) = getUserLocks(user, 0, 10); // Default: page 0, size 10
return tokenIds;
}
/**
* @dev Gets comprehensive user stats
* @param user Address to query
* @return userXenBurnedAmount Total XEN burned by user
* @return userXburnBurnedAmount Total XBURN burned by user
* @return userXburnBalance Current XBURN balance
* @return userBurnPercentage User's percentage of total XEN burned
* @return globalXenBurned Total XEN burned across all users
* @return globalXburnBurned Total XBURN burned across all users
* @return totalXburnSupply Current total XBURN supply
* @return globalBurnPercentage Percentage of total XBURN burned
*/
function getStats(address user) external view returns (
uint256 userXenBurnedAmount,
uint256 userXburnBurnedAmount,
uint256 userXburnBalance,
uint256 userBurnPercentage,
uint256 globalXenBurned,
uint256 globalXburnBurned,
uint256 totalXburnSupply,
uint256 globalBurnPercentage
) {
// Get basic stats
userXenBurnedAmount = userXenBurned[user];
userXburnBurnedAmount = userXburnBurned[user];
userXburnBalance = balanceOf(user);
globalXenBurned = totalXenBurned;
globalXburnBurned = totalXburnBurned;
totalXburnSupply = totalSupply();
// Calculate percentages
(userBurnPercentage, globalBurnPercentage) = _calculatePercentages(user, totalXburnSupply);
return (
userXenBurnedAmount,
userXburnBurnedAmount,
userXburnBalance,
userBurnPercentage,
globalXenBurned,
globalXburnBurned,
totalXburnSupply,
globalBurnPercentage
);
}
/**
* @dev Helper function to calculate percentages
* @param user Address to calculate percentages for
* @param supply Total XBURN supply
* @return userBurnPercentage User's percentage of total XEN burned (basis points)
* @return globalBurnPercentage Percentage of total XBURN burned (basis points)
*/
function _calculatePercentages(address user, uint256 supply) private view returns (
uint256 userBurnPercentage,
uint256 globalBurnPercentage
) {
userBurnPercentage = totalXenBurned > 0
? (userXenBurned[user] * 10000) / totalXenBurned
: 0;
globalBurnPercentage = supply > 0
? (totalXburnBurned * 10000) / supply
: 0;
return (userBurnPercentage, globalBurnPercentage);
}
/**
* @dev Gets detailed stats about a specific token
* @param tokenId NFT token ID to query
* @return xenAmount Amount of XEN burned
* @return baseMint Base mint amount
* @return rewardAmount Total reward amount
* @return maturityTs Maturity timestamp
* @return isClaimable Whether token is currently claimable
* @return isClaimed Whether token has been claimed
*/
function getTokenStats(uint256 tokenId) external view returns (
uint256 xenAmount,
uint256 baseMint,
uint256 rewardAmount,
uint256 maturityTs,
bool isClaimable,
bool isClaimed
) {
uint256 ampSnapshot;
uint256 termDays;
address tokenOwner;
(
xenAmount,
maturityTs,
ampSnapshot,
termDays,
isClaimed,
rewardAmount,
baseMint,
tokenOwner
) = nftContract.getLockDetails(tokenId);
isClaimable = !isClaimed && block.timestamp >= maturityTs;
return (xenAmount, baseMint, rewardAmount, maturityTs, isClaimable, isClaimed);
}
/**
* @dev Gets key stats for a user
* @param user Address to query
* @return xenBurned Total XEN burned by user
* @return xburnBalance Current XBURN balance
* @return totalTokens Total NFTs owned by user
* @return claimableTokens Number of NFTs that are claimable
*/
function getUserStats(address user) external view returns (
uint256 xenBurned,
uint256 xburnBalance,
uint256 totalTokens,
uint256 claimableTokens
) {
// Get basic stats
xenBurned = userXenBurned[user];
xburnBalance = balanceOf(user);
// Get tokens and count claimable tokens
(totalTokens, claimableTokens) = _countUserTokens(user);
return (xenBurned, xburnBalance, totalTokens, claimableTokens);
}
/**
* @dev Helper function to count user tokens with gas optimization
* @param user Address to count tokens for
* @return totalTokens Total NFTs owned by user
* @return claimableTokens Number of NFTs that are claimable
*/
function _countUserTokens(address user) private view returns (uint256 totalTokens, uint256 claimableTokens) {
// Get total tokens owned (first page only, limited to MAX_BATCH_SIZE)
(uint256[] memory tokens, ) = nftContract.getAllUserLocks(user, 0, MAX_BATCH_SIZE);
totalTokens = tokens.length;
// Count claimable tokens (with gas limit protection)
claimableTokens = 0;
uint256 loopLimit = tokens.length > MAX_BATCH_SIZE ? MAX_BATCH_SIZE : tokens.length;
for (uint256 i = 0; i < loopLimit; i++) {
uint256 xenAmount;
uint256 maturityTs;
uint256 ampSnapshot;
uint256 termDays;
bool claimed;
uint256 rewardAmount;
uint256 baseMint;
address tokenOwner;
(
xenAmount,
maturityTs,
ampSnapshot,
termDays,
claimed,
rewardAmount,
baseMint,
tokenOwner
) = nftContract.getLockDetails(tokens[i]);
if (!claimed && block.timestamp >= maturityTs) {
claimableTokens++;
}
}
return (totalTokens, claimableTokens);
}
/**
* @dev Validates that the liquidity pair tokens are correct
* @return bool True if liquidity pair tokens are correct
*/
function validatePairTokens() external view returns (bool) {
if (liquidityPair == address(0)) return false;
address token0 = IUniswapV2PairExtended(liquidityPair).token0();
address token1 = IUniswapV2PairExtended(liquidityPair).token1();
return (token0 == address(this) && token1 == address(XEN)) ||
(token0 == address(XEN) && token1 == address(this));
}
// ------------------------------------------------
// ================ Internal Functions ===========
// ------------------------------------------------
/**
* @dev Gets current amplifier value based on days since launch
* @return Current amplifier value
*/
function _currentAMP() private view returns (uint256) {
uint256 daysActive = (block.timestamp - LAUNCH_TS) / 1 days;
if (daysActive >= AMP_START) {
return AMP_END;
}
return AMP_START - daysActive;
}
/**
* @dev Verifies amplifier calculation for a given number of days
* @param daysFromLaunch Days since launch to calculate for
* @return Amplifier value at the specified day
*/
function verifyAmpCalculation(uint256 daysFromLaunch) external view returns (uint256) {
if (daysFromLaunch >= AMP_START) {
return AMP_END;
}
return AMP_START - daysFromLaunch;
}
// ------------------------------------------------
// ============== Global Stats View ==============
// ------------------------------------------------
/**
* @dev Gets global protocol stats
* @return currentAMP Current amplifier value
* @return daysSinceLaunch Days since protocol launch
* @return totalBurnedXEN Total XEN burned across all users
* @return totalMintedXBURN Total XBURN minted
* @return ampDecayDaysLeft Days until amplifier reaches minimum
*/
function getGlobalStats() external view returns (
uint256 currentAMP,
uint256 daysSinceLaunch,
uint256 totalBurnedXEN,
uint256 totalMintedXBURN,
uint256 ampDecayDaysLeft
) {
currentAMP = _currentAMP();
daysSinceLaunch = (block.timestamp - LAUNCH_TS) / 1 days;
totalBurnedXEN = totalXenBurned;
totalMintedXBURN = totalXburnMinted;
ampDecayDaysLeft = currentAMP > AMP_END ? currentAMP - AMP_END : 0;
}
/**
* @dev Gets progress towards next swap
* @return accumulated Amount of XEN accumulated for swapping
* @return threshold Threshold required for swap
* @return percentage Percentage progress towards threshold (basis points)
*/
function getAccumulationProgress() external view returns (
uint256 accumulated,
uint256 threshold,
uint256 percentage
) {
accumulated = pendingXen;
threshold = SWAP_THRESHOLD;
percentage = accumulated > 0
? (accumulated * 10000) / threshold
: 0;
return (accumulated, threshold, percentage);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC2981.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";
/**
* @dev Interface for the NFT Royalty Standard.
*
* A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
* support for royalty payments across all NFT marketplaces and ecosystem participants.
*/
interface IERC2981 is IERC165 {
/**
* @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
* exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
*
* NOTE: ERC-2981 allows setting the royalty to 100% of the price. In that case all the price would be sent to the
* royalty receiver and 0 tokens to the seller. Contracts dealing with royalty should consider empty transfers.
*/
function royaltyInfo(
uint256 tokenId,
uint256 salePrice
) external view returns (address receiver, uint256 royaltyAmount);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/common/ERC2981.sol)
pragma solidity ^0.8.20;
import {IERC2981} from "../../interfaces/IERC2981.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of the NFT Royalty Standard, a standardized way to retrieve royalty payment information.
*
* Royalty information can be specified globally for all token ids via {_setDefaultRoyalty}, and/or individually for
* specific token ids via {_setTokenRoyalty}. The latter takes precedence over the first.
*
* Royalty is specified as a fraction of sale price. {_feeDenominator} is overridable but defaults to 10000, meaning the
* fee is specified in basis points by default.
*
* IMPORTANT: ERC-2981 only specifies a way to signal royalty information and does not enforce its payment. See
* https://eips.ethereum.org/EIPS/eip-2981#optional-royalty-payments[Rationale] in the ERC. Marketplaces are expected to
* voluntarily pay royalties together with sales, but note that this standard is not yet widely supported.
*/
abstract contract ERC2981 is IERC2981, ERC165 {
struct RoyaltyInfo {
address receiver;
uint96 royaltyFraction;
}
RoyaltyInfo private _defaultRoyaltyInfo;
mapping(uint256 tokenId => RoyaltyInfo) private _tokenRoyaltyInfo;
/**
* @dev The default royalty set is invalid (eg. (numerator / denominator) >= 1).
*/
error ERC2981InvalidDefaultRoyalty(uint256 numerator, uint256 denominator);
/**
* @dev The default royalty receiver is invalid.
*/
error ERC2981InvalidDefaultRoyaltyReceiver(address receiver);
/**
* @dev The royalty set for a specific `tokenId` is invalid (eg. (numerator / denominator) >= 1).
*/
error ERC2981InvalidTokenRoyalty(uint256 tokenId, uint256 numerator, uint256 denominator);
/**
* @dev The royalty receiver for `tokenId` is invalid.
*/
error ERC2981InvalidTokenRoyaltyReceiver(uint256 tokenId, address receiver);
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC165) returns (bool) {
return interfaceId == type(IERC2981).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @inheritdoc IERC2981
*/
function royaltyInfo(
uint256 tokenId,
uint256 salePrice
) public view virtual returns (address receiver, uint256 amount) {
RoyaltyInfo storage _royaltyInfo = _tokenRoyaltyInfo[tokenId];
address royaltyReceiver = _royaltyInfo.receiver;
uint96 royaltyFraction = _royaltyInfo.royaltyFraction;
if (royaltyReceiver == address(0)) {
royaltyReceiver = _defaultRoyaltyInfo.receiver;
royaltyFraction = _defaultRoyaltyInfo.royaltyFraction;
}
uint256 royaltyAmount = (salePrice * royaltyFraction) / _feeDenominator();
return (royaltyReceiver, royaltyAmount);
}
/**
* @dev The denominator with which to interpret the fee set in {_setTokenRoyalty} and {_setDefaultRoyalty} as a
* fraction of the sale price. Defaults to 10000 so fees are expressed in basis points, but may be customized by an
* override.
*/
function _feeDenominator() internal pure virtual returns (uint96) {
return 10000;
}
/**
* @dev Sets the royalty information that all ids in this contract will default to.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/
function _setDefaultRoyalty(address receiver, uint96 feeNumerator) internal virtual {
uint256 denominator = _feeDenominator();
if (feeNumerator > denominator) {
// Royalty fee will exceed the sale price
revert ERC2981InvalidDefaultRoyalty(feeNumerator, denominator);
}
if (receiver == address(0)) {
revert ERC2981InvalidDefaultRoyaltyReceiver(address(0));
}
_defaultRoyaltyInfo = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev Removes default royalty information.
*/
function _deleteDefaultRoyalty() internal virtual {
delete _defaultRoyaltyInfo;
}
/**
* @dev Sets the royalty information for a specific token id, overriding the global default.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/
function _setTokenRoyalty(uint256 tokenId, address receiver, uint96 feeNumerator) internal virtual {
uint256 denominator = _feeDenominator();
if (feeNumerator > denominator) {
// Royalty fee will exceed the sale price
revert ERC2981InvalidTokenRoyalty(tokenId, feeNumerator, denominator);
}
if (receiver == address(0)) {
revert ERC2981InvalidTokenRoyaltyReceiver(tokenId, address(0));
}
_tokenRoyaltyInfo[tokenId] = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev Resets royalty information for the token id back to the global default.
*/
function _resetTokenRoyalty(uint256 tokenId) internal virtual {
delete _tokenRoyaltyInfo[tokenId];
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* Both values are immutable: they can only be set once during construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner`'s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.20;
import {IERC721} from "./IERC721.sol";
import {IERC721Metadata} from "./extensions/IERC721Metadata.sol";
import {ERC721Utils} from "./utils/ERC721Utils.sol";
import {Context} from "../../utils/Context.sol";
import {Strings} from "../../utils/Strings.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {IERC721Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC-721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/
abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Errors {
using Strings for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
mapping(uint256 tokenId => address) private _owners;
mapping(address owner => uint256) private _balances;
mapping(uint256 tokenId => address) private _tokenApprovals;
mapping(address owner => mapping(address operator => bool)) private _operatorApprovals;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/
function balanceOf(address owner) public view virtual returns (uint256) {
if (owner == address(0)) {
revert ERC721InvalidOwner(address(0));
}
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId) public view virtual returns (address) {
return _requireOwned(tokenId);
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId) public view virtual returns (string memory) {
_requireOwned(tokenId);
string memory baseURI = _baseURI();
return bytes(baseURI).length > 0 ? string.concat(baseURI, tokenId.toString()) : "";
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overridden in child contracts.
*/
function _baseURI() internal view virtual returns (string memory) {
return "";
}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) public virtual {
_approve(to, tokenId, _msgSender());
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId) public view virtual returns (address) {
_requireOwned(tokenId);
return _getApproved(tokenId);
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved) public virtual {
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(address from, address to, uint256 tokenId) public virtual {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
// Setting an "auth" arguments enables the `_isAuthorized` check which verifies that the token exists
// (from != 0). Therefore, it is not needed to verify that the return value is not 0 here.
address previousOwner = _update(to, tokenId, _msgSender());
if (previousOwner != from) {
revert ERC721IncorrectOwner(from, tokenId, previousOwner);
}
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) public {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual {
transferFrom(from, to, tokenId);
ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
}
/**
* @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
*
* IMPORTANT: Any overrides to this function that add ownership of tokens not tracked by the
* core ERC-721 logic MUST be matched with the use of {_increaseBalance} to keep balances
* consistent with ownership. The invariant to preserve is that for any address `a` the value returned by
* `balanceOf(a)` must be equal to the number of tokens such that `_ownerOf(tokenId)` is `a`.
*/
function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
return _owners[tokenId];
}
/**
* @dev Returns the approved address for `tokenId`. Returns 0 if `tokenId` is not minted.
*/
function _getApproved(uint256 tokenId) internal view virtual returns (address) {
return _tokenApprovals[tokenId];
}
/**
* @dev Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
* particular (ignoring whether it is owned by `owner`).
*
* WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
* assumption.
*/
function _isAuthorized(address owner, address spender, uint256 tokenId) internal view virtual returns (bool) {
return
spender != address(0) &&
(owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender);
}
/**
* @dev Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
* Reverts if:
* - `spender` does not have approval from `owner` for `tokenId`.
* - `spender` does not have approval to manage all of `owner`'s assets.
*
* WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
* assumption.
*/
function _checkAuthorized(address owner, address spender, uint256 tokenId) internal view virtual {
if (!_isAuthorized(owner, spender, tokenId)) {
if (owner == address(0)) {
revert ERC721NonexistentToken(tokenId);
} else {
revert ERC721InsufficientApproval(spender, tokenId);
}
}
}
/**
* @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
*
* NOTE: the value is limited to type(uint128).max. This protect against _balance overflow. It is unrealistic that
* a uint256 would ever overflow from increments when these increments are bounded to uint128 values.
*
* WARNING: Increasing an account's balance using this function tends to be paired with an override of the
* {_ownerOf} function to resolve the ownership of the corresponding tokens so that balances and ownership
* remain consistent with one another.
*/
function _increaseBalance(address account, uint128 value) internal virtual {
unchecked {
_balances[account] += value;
}
}
/**
* @dev Transfers `tokenId` from its current owner to `to`, or alternatively mints (or burns) if the current owner
* (or `to`) is the zero address. Returns the owner of the `tokenId` before the update.
*
* The `auth` argument is optional. If the value passed is non 0, then this function will check that
* `auth` is either the owner of the token, or approved to operate on the token (by the owner).
*
* Emits a {Transfer} event.
*
* NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
*/
function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
address from = _ownerOf(tokenId);
// Perform (optional) operator check
if (auth != address(0)) {
_checkAuthorized(from, auth, tokenId);
}
// Execute the update
if (from != address(0)) {
// Clear approval. No need to re-authorize or emit the Approval event
_approve(address(0), tokenId, address(0), false);
unchecked {
_balances[from] -= 1;
}
}
if (to != address(0)) {
unchecked {
_balances[to] += 1;
}
}
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
return from;
}
/**
* @dev Mints `tokenId` and transfers it to `to`.
*
* WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
*
* Requirements:
*
* - `tokenId` must not exist.
* - `to` cannot be the zero address.
*
* Emits a {Transfer} event.
*/
function _mint(address to, uint256 tokenId) internal {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
address previousOwner = _update(to, tokenId, address(0));
if (previousOwner != address(0)) {
revert ERC721InvalidSender(address(0));
}
}
/**
* @dev Mints `tokenId`, transfers it to `to` and checks for `to` acceptance.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeMint(address to, uint256 tokenId) internal {
_safeMint(to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeMint(address to, uint256 tokenId, bytes memory data) internal virtual {
_mint(to, tokenId);
ERC721Utils.checkOnERC721Received(_msgSender(), address(0), to, tokenId, data);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
* This is an internal function that does not check if the sender is authorized to operate on the token.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/
function _burn(uint256 tokenId) internal {
address previousOwner = _update(address(0), tokenId, address(0));
if (previousOwner == address(0)) {
revert ERC721NonexistentToken(tokenId);
}
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
* As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
*
* Emits a {Transfer} event.
*/
function _transfer(address from, address to, uint256 tokenId) internal {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
address previousOwner = _update(to, tokenId, address(0));
if (previousOwner == address(0)) {
revert ERC721NonexistentToken(tokenId);
} else if (previousOwner != from) {
revert ERC721IncorrectOwner(from, tokenId, previousOwner);
}
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking that contract recipients
* are aware of the ERC-721 standard to prevent tokens from being forever locked.
*
* `data` is additional data, it has no specified format and it is sent in call to `to`.
*
* This internal function is like {safeTransferFrom} in the sense that it invokes
* {IERC721Receiver-onERC721Received} on the receiver, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `tokenId` token must exist and be owned by `from`.
* - `to` cannot be the zero address.
* - `from` cannot be the zero address.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeTransfer(address from, address to, uint256 tokenId) internal {
_safeTransfer(from, to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeTransfer-address-address-uint256-}[`_safeTransfer`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
_transfer(from, to, tokenId);
ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* The `auth` argument is optional. If the value passed is non 0, then this function will check that `auth` is
* either the owner of the token, or approved to operate on all tokens held by this owner.
*
* Emits an {Approval} event.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address to, uint256 tokenId, address auth) internal {
_approve(to, tokenId, auth, true);
}
/**
* @dev Variant of `_approve` with an optional flag to enable or disable the {Approval} event. The event is not
* emitted in the context of transfers.
*/
function _approve(address to, uint256 tokenId, address auth, bool emitEvent) internal virtual {
// Avoid reading the owner unless necessary
if (emitEvent || auth != address(0)) {
address owner = _requireOwned(tokenId);
// We do not use _isAuthorized because single-token approvals should not be able to call approve
if (auth != address(0) && owner != auth && !isApprovedForAll(owner, auth)) {
revert ERC721InvalidApprover(auth);
}
if (emitEvent) {
emit Approval(owner, to, tokenId);
}
}
_tokenApprovals[tokenId] = to;
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Requirements:
* - operator can't be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
if (operator == address(0)) {
revert ERC721InvalidOperator(operator);
}
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
* Returns the owner.
*
* Overrides to ownership logic should be done to {_ownerOf}.
*/
function _requireOwned(uint256 tokenId) internal view returns (address) {
address owner = _ownerOf(tokenId);
if (owner == address(0)) {
revert ERC721NonexistentToken(tokenId);
}
return owner;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/extensions/ERC721Enumerable.sol)
pragma solidity ^0.8.20;
import {ERC721} from "../ERC721.sol";
import {IERC721Enumerable} from "./IERC721Enumerable.sol";
import {IERC165} from "../../../utils/introspection/ERC165.sol";
/**
* @dev This implements an optional extension of {ERC721} defined in the ERC that adds enumerability
* of all the token ids in the contract as well as all token ids owned by each account.
*
* CAUTION: {ERC721} extensions that implement custom `balanceOf` logic, such as {ERC721Consecutive},
* interfere with enumerability and should not be used together with {ERC721Enumerable}.
*/
abstract contract ERC721Enumerable is ERC721, IERC721Enumerable {
mapping(address owner => mapping(uint256 index => uint256)) private _ownedTokens;
mapping(uint256 tokenId => uint256) private _ownedTokensIndex;
uint256[] private _allTokens;
mapping(uint256 tokenId => uint256) private _allTokensIndex;
/**
* @dev An `owner`'s token query was out of bounds for `index`.
*
* NOTE: The owner being `address(0)` indicates a global out of bounds index.
*/
error ERC721OutOfBoundsIndex(address owner, uint256 index);
/**
* @dev Batch mint is not allowed.
*/
error ERC721EnumerableForbiddenBatchMint();
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721) returns (bool) {
return interfaceId == type(IERC721Enumerable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
*/
function tokenOfOwnerByIndex(address owner, uint256 index) public view virtual returns (uint256) {
if (index >= balanceOf(owner)) {
revert ERC721OutOfBoundsIndex(owner, index);
}
return _ownedTokens[owner][index];
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
return _allTokens.length;
}
/**
* @dev See {IERC721Enumerable-tokenByIndex}.
*/
function tokenByIndex(uint256 index) public view virtual returns (uint256) {
if (index >= totalSupply()) {
revert ERC721OutOfBoundsIndex(address(0), index);
}
return _allTokens[index];
}
/**
* @dev See {ERC721-_update}.
*/
function _update(address to, uint256 tokenId, address auth) internal virtual override returns (address) {
address previousOwner = super._update(to, tokenId, auth);
if (previousOwner == address(0)) {
_addTokenToAllTokensEnumeration(tokenId);
} else if (previousOwner != to) {
_removeTokenFromOwnerEnumeration(previousOwner, tokenId);
}
if (to == address(0)) {
_removeTokenFromAllTokensEnumeration(tokenId);
} else if (previousOwner != to) {
_addTokenToOwnerEnumeration(to, tokenId);
}
return previousOwner;
}
/**
* @dev Private function to add a token to this extension's ownership-tracking data structures.
* @param to address representing the new owner of the given token ID
* @param tokenId uint256 ID of the token to be added to the tokens list of the given address
*/
function _addTokenToOwnerEnumeration(address to, uint256 tokenId) private {
uint256 length = balanceOf(to) - 1;
_ownedTokens[to][length] = tokenId;
_ownedTokensIndex[tokenId] = length;
}
/**
* @dev Private function to add a token to this extension's token tracking data structures.
* @param tokenId uint256 ID of the token to be added to the tokens list
*/
function _addTokenToAllTokensEnumeration(uint256 tokenId) private {
_allTokensIndex[tokenId] = _allTokens.length;
_allTokens.push(tokenId);
}
/**
* @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that
* while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for
* gas optimizations e.g. when performing a transfer operation (avoiding double writes).
* This has O(1) time complexity, but alters the order of the _ownedTokens array.
* @param from address representing the previous owner of the given token ID
* @param tokenId uint256 ID of the token to be removed from the tokens list of the given address
*/
function _removeTokenFromOwnerEnumeration(address from, uint256 tokenId) private {
// To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = balanceOf(from);
uint256 tokenIndex = _ownedTokensIndex[tokenId];
mapping(uint256 index => uint256) storage _ownedTokensByOwner = _ownedTokens[from];
// When the token to delete is the last token, the swap operation is unnecessary
if (tokenIndex != lastTokenIndex) {
uint256 lastTokenId = _ownedTokensByOwner[lastTokenIndex];
_ownedTokensByOwner[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
}
// This also deletes the contents at the last position of the array
delete _ownedTokensIndex[tokenId];
delete _ownedTokensByOwner[lastTokenIndex];
}
/**
* @dev Private function to remove a token from this extension's token tracking data structures.
* This has O(1) time complexity, but alters the order of the _allTokens array.
* @param tokenId uint256 ID of the token to be removed from the tokens list
*/
function _removeTokenFromAllTokensEnumeration(uint256 tokenId) private {
// To prevent a gap in the tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = _allTokens.length - 1;
uint256 tokenIndex = _allTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary. However, since this occurs so
// rarely (when the last minted token is burnt) that we still do the swap here to avoid the gas cost of adding
// an 'if' statement (like in _removeTokenFromOwnerEnumeration)
uint256 lastTokenId = _allTokens[lastTokenIndex];
_allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
// This also deletes the contents at the last position of the array
delete _allTokensIndex[tokenId];
_allTokens.pop();
}
/**
* See {ERC721-_increaseBalance}. We need that to account tokens that were minted in batch
*/
function _increaseBalance(address account, uint128 amount) internal virtual override {
if (amount > 0) {
revert ERC721EnumerableForbiddenBatchMint();
}
super._increaseBalance(account, amount);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/IERC721Enumerable.sol)
pragma solidity ^0.8.20;
import {IERC721} from "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Enumerable is IERC721 {
/**
* @dev Returns the total amount of tokens stored by the contract.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns a token ID owned by `owner` at a given `index` of its token list.
* Use along with {balanceOf} to enumerate all of ``owner``'s tokens.
*/
function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);
/**
* @dev Returns a token ID at a given `index` of all the tokens stored by the contract.
* Use along with {totalSupply} to enumerate all tokens.
*/
function tokenByIndex(uint256 index) external view returns (uint256);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.20;
import {IERC721} from "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC-721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
* {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/IERC721Receiver.sol)
pragma solidity ^0.8.20;
/**
* @title ERC-721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC-721 asset contracts.
*/
interface IERC721Receiver {
/**
* @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
* by `operator` from `from`, this function is called.
*
* It must return its Solidity selector to confirm the token transfer.
* If any other value is returned or the interface is not implemented by the recipient, the transfer will be
* reverted.
*
* The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC721/utils/ERC721Utils.sol)
pragma solidity ^0.8.20;
import {IERC721Receiver} from "../IERC721Receiver.sol";
import {IERC721Errors} from "../../../interfaces/draft-IERC6093.sol";
/**
* @dev Library that provide common ERC-721 utility functions.
*
* See https://eips.ethereum.org/EIPS/eip-721[ERC-721].
*
* _Available since v5.1._
*/
library ERC721Utils {
/**
* @dev Performs an acceptance check for the provided `operator` by calling {IERC721Receiver-onERC721Received}
* on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
*
* The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
* Otherwise, the recipient must implement {IERC721Receiver-onERC721Received} and return the acceptance magic value to accept
* the transfer.
*/
function checkOnERC721Received(
address operator,
address from,
address to,
uint256 tokenId,
bytes memory data
) internal {
if (to.code.length > 0) {
try IERC721Receiver(to).onERC721Received(operator, from, tokenId, data) returns (bytes4 retval) {
if (retval != IERC721Receiver.onERC721Received.selector) {
// Token rejected
revert IERC721Errors.ERC721InvalidReceiver(to);
}
} catch (bytes memory reason) {
if (reason.length == 0) {
// non-IERC721Receiver implementer
revert IERC721Errors.ERC721InvalidReceiver(to);
} else {
assembly ("memory-safe") {
revert(add(32, reason), mload(reason))
}
}
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Base64.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides a set of functions to operate with Base64 strings.
*/
library Base64 {
/**
* @dev Base64 Encoding/Decoding Table
* See sections 4 and 5 of https://datatracker.ietf.org/doc/html/rfc4648
*/
string internal constant _TABLE = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
string internal constant _TABLE_URL = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
/**
* @dev Converts a `bytes` to its Bytes64 `string` representation.
*/
function encode(bytes memory data) internal pure returns (string memory) {
return _encode(data, _TABLE, true);
}
/**
* @dev Converts a `bytes` to its Bytes64Url `string` representation.
* Output is not padded with `=` as specified in https://www.rfc-editor.org/rfc/rfc4648[rfc4648].
*/
function encodeURL(bytes memory data) internal pure returns (string memory) {
return _encode(data, _TABLE_URL, false);
}
/**
* @dev Internal table-agnostic conversion
*/
function _encode(bytes memory data, string memory table, bool withPadding) private pure returns (string memory) {
/**
* Inspired by Brecht Devos (Brechtpd) implementation - MIT licence
* https://github.com/Brechtpd/base64/blob/e78d9fd951e7b0977ddca77d92dc85183770daf4/base64.sol
*/
if (data.length == 0) return "";
// If padding is enabled, the final length should be `bytes` data length divided by 3 rounded up and then
// multiplied by 4 so that it leaves room for padding the last chunk
// - `data.length + 2` -> Prepare for division rounding up
// - `/ 3` -> Number of 3-bytes chunks (rounded up)
// - `4 *` -> 4 characters for each chunk
// This is equivalent to: 4 * Math.ceil(data.length / 3)
//
// If padding is disabled, the final length should be `bytes` data length multiplied by 4/3 rounded up as
// opposed to when padding is required to fill the last chunk.
// - `4 * data.length` -> 4 characters for each chunk
// - ` + 2` -> Prepare for division rounding up
// - `/ 3` -> Number of 3-bytes chunks (rounded up)
// This is equivalent to: Math.ceil((4 * data.length) / 3)
uint256 resultLength = withPadding ? 4 * ((data.length + 2) / 3) : (4 * data.length + 2) / 3;
string memory result = new string(resultLength);
assembly ("memory-safe") {
// Prepare the lookup table (skip the first "length" byte)
let tablePtr := add(table, 1)
// Prepare result pointer, jump over length
let resultPtr := add(result, 0x20)
let dataPtr := data
let endPtr := add(data, mload(data))
// In some cases, the last iteration will read bytes after the end of the data. We cache the value, and
// set it to zero to make sure no dirty bytes are read in that section.
let afterPtr := add(endPtr, 0x20)
let afterCache := mload(afterPtr)
mstore(afterPtr, 0x00)
// Run over the input, 3 bytes at a time
for {
} lt(dataPtr, endPtr) {
} {
// Advance 3 bytes
dataPtr := add(dataPtr, 3)
let input := mload(dataPtr)
// To write each character, shift the 3 byte (24 bits) chunk
// 4 times in blocks of 6 bits for each character (18, 12, 6, 0)
// and apply logical AND with 0x3F to bitmask the least significant 6 bits.
// Use this as an index into the lookup table, mload an entire word
// so the desired character is in the least significant byte, and
// mstore8 this least significant byte into the result and continue.
mstore8(resultPtr, mload(add(tablePtr, and(shr(18, input), 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(add(tablePtr, and(shr(12, input), 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(add(tablePtr, and(shr(6, input), 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(add(tablePtr, and(input, 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
}
// Reset the value that was cached
mstore(afterPtr, afterCache)
if withPadding {
// When data `bytes` is not exactly 3 bytes long
// it is padded with `=` characters at the end
switch mod(mload(data), 3)
case 1 {
mstore8(sub(resultPtr, 1), 0x3d)
mstore8(sub(resultPtr, 2), 0x3d)
}
case 2 {
mstore8(sub(resultPtr, 1), 0x3d)
}
}
}
return result;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Return the 512-bit addition of two uint256.
*
* The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
*/
function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
assembly ("memory-safe") {
low := add(a, b)
high := lt(low, a)
}
}
/**
* @dev Return the 512-bit multiplication of two uint256.
*
* The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
*/
function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
// 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = high * 2²⁵⁶ + low.
assembly ("memory-safe") {
let mm := mulmod(a, b, not(0))
low := mul(a, b)
high := sub(sub(mm, low), lt(mm, low))
}
}
/**
* @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
success = c >= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a - b;
success = c <= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a * b;
assembly ("memory-safe") {
// Only true when the multiplication doesn't overflow
// (c / a == b) || (a == 0)
success := or(eq(div(c, a), b), iszero(a))
}
// equivalent to: success ? c : 0
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `DIV` opcode returns zero when the denominator is 0.
result := div(a, b)
}
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `MOD` opcode returns zero when the denominator is 0.
result := mod(a, b)
}
}
}
/**
* @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryAdd(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
*/
function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
(, uint256 result) = trySub(a, b);
return result;
}
/**
* @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryMul(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
// Handle non-overflow cases, 256 by 256 division.
if (high == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return low / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= high) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [high low].
uint256 remainder;
assembly ("memory-safe") {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
high := sub(high, gt(remainder, low))
low := sub(low, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly ("memory-safe") {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [high low] by twos.
low := div(low, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from high into low.
low |= high * twos;
// Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
// is no longer required.
result = low * inverse;
return result;
}
}
/**
* @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
*/
function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
if (high >= 1 << n) {
Panic.panic(Panic.UNDER_OVERFLOW);
}
return (high << (256 - n)) | (low >> n);
}
}
/**
* @dev Calculates x * y >> n with full precision, following the selected rounding direction.
*/
function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
for (uint256 i = 0; i < byteArray.length; ++i) {
if (byteArray[i] != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// If upper 8 bits of 16-bit half set, add 8 to result
r |= SafeCast.toUint((x >> r) > 0xff) << 3;
// If upper 4 bits of 8-bit half set, add 4 to result
r |= SafeCast.toUint((x >> r) > 0xf) << 2;
// Shifts value right by the current result and use it as an index into this lookup table:
//
// | x (4 bits) | index | table[index] = MSB position |
// |------------|---------|-----------------------------|
// | 0000 | 0 | table[0] = 0 |
// | 0001 | 1 | table[1] = 0 |
// | 0010 | 2 | table[2] = 1 |
// | 0011 | 3 | table[3] = 1 |
// | 0100 | 4 | table[4] = 2 |
// | 0101 | 5 | table[5] = 2 |
// | 0110 | 6 | table[6] = 2 |
// | 0111 | 7 | table[7] = 2 |
// | 1000 | 8 | table[8] = 3 |
// | 1001 | 9 | table[9] = 3 |
// | 1010 | 10 | table[10] = 3 |
// | 1011 | 11 | table[11] = 3 |
// | 1100 | 12 | table[12] = 3 |
// | 1101 | 13 | table[13] = 3 |
// | 1110 | 14 | table[14] = 3 |
// | 1111 | 15 | table[15] = 3 |
//
// The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the last 16 bytes.
assembly ("memory-safe") {
r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
}
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.
pragma solidity ^0.8.20;
/**
* @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*/
library SafeCast {
/**
* @dev Value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
/**
* @dev An int value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedIntToUint(int256 value);
/**
* @dev Value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);
/**
* @dev An uint value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedUintToInt(uint256 value);
/**
* @dev Returns the downcasted uint248 from uint256, reverting on
* overflow (when the input is greater than largest uint248).
*
* Counterpart to Solidity's `uint248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toUint248(uint256 value) internal pure returns (uint248) {
if (value > type(uint248).max) {
revert SafeCastOverflowedUintDowncast(248, value);
}
return uint248(value);
}
/**
* @dev Returns the downcasted uint240 from uint256, reverting on
* overflow (when the input is greater than largest uint240).
*
* Counterpart to Solidity's `uint240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toUint240(uint256 value) internal pure returns (uint240) {
if (value > type(uint240).max) {
revert SafeCastOverflowedUintDowncast(240, value);
}
return uint240(value);
}
/**
* @dev Returns the downcasted uint232 from uint256, reverting on
* overflow (when the input is greater than largest uint232).
*
* Counterpart to Solidity's `uint232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toUint232(uint256 value) internal pure returns (uint232) {
if (value > type(uint232).max) {
revert SafeCastOverflowedUintDowncast(232, value);
}
return uint232(value);
}
/**
* @dev Returns the downcasted uint224 from uint256, reverting on
* overflow (when the input is greater than largest uint224).
*
* Counterpart to Solidity's `uint224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toUint224(uint256 value) internal pure returns (uint224) {
if (value > type(uint224).max) {
revert SafeCastOverflowedUintDowncast(224, value);
}
return uint224(value);
}
/**
* @dev Returns the downcasted uint216 from uint256, reverting on
* overflow (when the input is greater than largest uint216).
*
* Counterpart to Solidity's `uint216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toUint216(uint256 value) internal pure returns (uint216) {
if (value > type(uint216).max) {
revert SafeCastOverflowedUintDowncast(216, value);
}
return uint216(value);
}
/**
* @dev Returns the downcasted uint208 from uint256, reverting on
* overflow (when the input is greater than largest uint208).
*
* Counterpart to Solidity's `uint208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toUint208(uint256 value) internal pure returns (uint208) {
if (value > type(uint208).max) {
revert SafeCastOverflowedUintDowncast(208, value);
}
return uint208(value);
}
/**
* @dev Returns the downcasted uint200 from uint256, reverting on
* overflow (when the input is greater than largest uint200).
*
* Counterpart to Solidity's `uint200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toUint200(uint256 value) internal pure returns (uint200) {
if (value > type(uint200).max) {
revert SafeCastOverflowedUintDowncast(200, value);
}
return uint200(value);
}
/**
* @dev Returns the downcasted uint192 from uint256, reverting on
* overflow (when the input is greater than largest uint192).
*
* Counterpart to Solidity's `uint192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toUint192(uint256 value) internal pure returns (uint192) {
if (value > type(uint192).max) {
revert SafeCastOverflowedUintDowncast(192, value);
}
return uint192(value);
}
/**
* @dev Returns the downcasted uint184 from uint256, reverting on
* overflow (when the input is greater than largest uint184).
*
* Counterpart to Solidity's `uint184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toUint184(uint256 value) internal pure returns (uint184) {
if (value > type(uint184).max) {
revert SafeCastOverflowedUintDowncast(184, value);
}
return uint184(value);
}
/**
* @dev Returns the downcasted uint176 from uint256, reverting on
* overflow (when the input is greater than largest uint176).
*
* Counterpart to Solidity's `uint176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toUint176(uint256 value) internal pure returns (uint176) {
if (value > type(uint176).max) {
revert SafeCastOverflowedUintDowncast(176, value);
}
return uint176(value);
}
/**
* @dev Returns the downcasted uint168 from uint256, reverting on
* overflow (when the input is greater than largest uint168).
*
* Counterpart to Solidity's `uint168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toUint168(uint256 value) internal pure returns (uint168) {
if (value > type(uint168).max) {
revert SafeCastOverflowedUintDowncast(168, value);
}
return uint168(value);
}
/**
* @dev Returns the downcasted uint160 from uint256, reverting on
* overflow (when the input is greater than largest uint160).
*
* Counterpart to Solidity's `uint160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toUint160(uint256 value) internal pure returns (uint160) {
if (value > type(uint160).max) {
revert SafeCastOverflowedUintDowncast(160, value);
}
return uint160(value);
}
/**
* @dev Returns the downcasted uint152 from uint256, reverting on
* overflow (when the input is greater than largest uint152).
*
* Counterpart to Solidity's `uint152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toUint152(uint256 value) internal pure returns (uint152) {
if (value > type(uint152).max) {
revert SafeCastOverflowedUintDowncast(152, value);
}
return uint152(value);
}
/**
* @dev Returns the downcasted uint144 from uint256, reverting on
* overflow (when the input is greater than largest uint144).
*
* Counterpart to Solidity's `uint144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toUint144(uint256 value) internal pure returns (uint144) {
if (value > type(uint144).max) {
revert SafeCastOverflowedUintDowncast(144, value);
}
return uint144(value);
}
/**
* @dev Returns the downcasted uint136 from uint256, reverting on
* overflow (when the input is greater than largest uint136).
*
* Counterpart to Solidity's `uint136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toUint136(uint256 value) internal pure returns (uint136) {
if (value > type(uint136).max) {
revert SafeCastOverflowedUintDowncast(136, value);
}
return uint136(value);
}
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toUint128(uint256 value) internal pure returns (uint128) {
if (value > type(uint128).max) {
revert SafeCastOverflowedUintDowncast(128, value);
}
return uint128(value);
}
/**
* @dev Returns the downcasted uint120 from uint256, reverting on
* overflow (when the input is greater than largest uint120).
*
* Counterpart to Solidity's `uint120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toUint120(uint256 value) internal pure returns (uint120) {
if (value > type(uint120).max) {
revert SafeCastOverflowedUintDowncast(120, value);
}
return uint120(value);
}
/**
* @dev Returns the downcasted uint112 from uint256, reverting on
* overflow (when the input is greater than largest uint112).
*
* Counterpart to Solidity's `uint112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toUint112(uint256 value) internal pure returns (uint112) {
if (value > type(uint112).max) {
revert SafeCastOverflowedUintDowncast(112, value);
}
return uint112(value);
}
/**
* @dev Returns the downcasted uint104 from uint256, reverting on
* overflow (when the input is greater than largest uint104).
*
* Counterpart to Solidity's `uint104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toUint104(uint256 value) internal pure returns (uint104) {
if (value > type(uint104).max) {
revert SafeCastOverflowedUintDowncast(104, value);
}
return uint104(value);
}
/**
* @dev Returns the downcasted uint96 from uint256, reverting on
* overflow (when the input is greater than largest uint96).
*
* Counterpart to Solidity's `uint96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toUint96(uint256 value) internal pure returns (uint96) {
if (value > type(uint96).max) {
revert SafeCastOverflowedUintDowncast(96, value);
}
return uint96(value);
}
/**
* @dev Returns the downcasted uint88 from uint256, reverting on
* overflow (when the input is greater than largest uint88).
*
* Counterpart to Solidity's `uint88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toUint88(uint256 value) internal pure returns (uint88) {
if (value > type(uint88).max) {
revert SafeCastOverflowedUintDowncast(88, value);
}
return uint88(value);
}
/**
* @dev Returns the downcasted uint80 from uint256, reverting on
* overflow (when the input is greater than largest uint80).
*
* Counterpart to Solidity's `uint80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toUint80(uint256 value) internal pure returns (uint80) {
if (value > type(uint80).max) {
revert SafeCastOverflowedUintDowncast(80, value);
}
return uint80(value);
}
/**
* @dev Returns the downcasted uint72 from uint256, reverting on
* overflow (when the input is greater than largest uint72).
*
* Counterpart to Solidity's `uint72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toUint72(uint256 value) internal pure returns (uint72) {
if (value > type(uint72).max) {
revert SafeCastOverflowedUintDowncast(72, value);
}
return uint72(value);
}
/**
* @dev Returns the downcasted uint64 from uint256, reverting on
* overflow (when the input is greater than largest uint64).
*
* Counterpart to Solidity's `uint64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toUint64(uint256 value) internal pure returns (uint64) {
if (value > type(uint64).max) {
revert SafeCastOverflowedUintDowncast(64, value);
}
return uint64(value);
}
/**
* @dev Returns the downcasted uint56 from uint256, reverting on
* overflow (when the input is greater than largest uint56).
*
* Counterpart to Solidity's `uint56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toUint56(uint256 value) internal pure returns (uint56) {
if (value > type(uint56).max) {
revert SafeCastOverflowedUintDowncast(56, value);
}
return uint56(value);
}
/**
* @dev Returns the downcasted uint48 from uint256, reverting on
* overflow (when the input is greater than largest uint48).
*
* Counterpart to Solidity's `uint48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toUint48(uint256 value) internal pure returns (uint48) {
if (value > type(uint48).max) {
revert SafeCastOverflowedUintDowncast(48, value);
}
return uint48(value);
}
/**
* @dev Returns the downcasted uint40 from uint256, reverting on
* overflow (when the input is greater than largest uint40).
*
* Counterpart to Solidity's `uint40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toUint40(uint256 value) internal pure returns (uint40) {
if (value > type(uint40).max) {
revert SafeCastOverflowedUintDowncast(40, value);
}
return uint40(value);
}
/**
* @dev Returns the downcasted uint32 from uint256, reverting on
* overflow (when the input is greater than largest uint32).
*
* Counterpart to Solidity's `uint32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toUint32(uint256 value) internal pure returns (uint32) {
if (value > type(uint32).max) {
revert SafeCastOverflowedUintDowncast(32, value);
}
return uint32(value);
}
/**
* @dev Returns the downcasted uint24 from uint256, reverting on
* overflow (when the input is greater than largest uint24).
*
* Counterpart to Solidity's `uint24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toUint24(uint256 value) internal pure returns (uint24) {
if (value > type(uint24).max) {
revert SafeCastOverflowedUintDowncast(24, value);
}
return uint24(value);
}
/**
* @dev Returns the downcasted uint16 from uint256, reverting on
* overflow (when the input is greater than largest uint16).
*
* Counterpart to Solidity's `uint16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toUint16(uint256 value) internal pure returns (uint16) {
if (value > type(uint16).max) {
revert SafeCastOverflowedUintDowncast(16, value);
}
return uint16(value);
}
/**
* @dev Returns the downcasted uint8 from uint256, reverting on
* overflow (when the input is greater than largest uint8).
*
* Counterpart to Solidity's `uint8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toUint8(uint256 value) internal pure returns (uint8) {
if (value > type(uint8).max) {
revert SafeCastOverflowedUintDowncast(8, value);
}
return uint8(value);
}
/**
* @dev Converts a signed int256 into an unsigned uint256.
*
* Requirements:
*
* - input must be greater than or equal to 0.
*/
function toUint256(int256 value) internal pure returns (uint256) {
if (value < 0) {
revert SafeCastOverflowedIntToUint(value);
}
return uint256(value);
}
/**
* @dev Returns the downcasted int248 from int256, reverting on
* overflow (when the input is less than smallest int248 or
* greater than largest int248).
*
* Counterpart to Solidity's `int248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toInt248(int256 value) internal pure returns (int248 downcasted) {
downcasted = int248(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(248, value);
}
}
/**
* @dev Returns the downcasted int240 from int256, reverting on
* overflow (when the input is less than smallest int240 or
* greater than largest int240).
*
* Counterpart to Solidity's `int240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toInt240(int256 value) internal pure returns (int240 downcasted) {
downcasted = int240(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(240, value);
}
}
/**
* @dev Returns the downcasted int232 from int256, reverting on
* overflow (when the input is less than smallest int232 or
* greater than largest int232).
*
* Counterpart to Solidity's `int232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toInt232(int256 value) internal pure returns (int232 downcasted) {
downcasted = int232(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(232, value);
}
}
/**
* @dev Returns the downcasted int224 from int256, reverting on
* overflow (when the input is less than smallest int224 or
* greater than largest int224).
*
* Counterpart to Solidity's `int224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toInt224(int256 value) internal pure returns (int224 downcasted) {
downcasted = int224(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(224, value);
}
}
/**
* @dev Returns the downcasted int216 from int256, reverting on
* overflow (when the input is less than smallest int216 or
* greater than largest int216).
*
* Counterpart to Solidity's `int216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toInt216(int256 value) internal pure returns (int216 downcasted) {
downcasted = int216(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(216, value);
}
}
/**
* @dev Returns the downcasted int208 from int256, reverting on
* overflow (when the input is less than smallest int208 or
* greater than largest int208).
*
* Counterpart to Solidity's `int208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toInt208(int256 value) internal pure returns (int208 downcasted) {
downcasted = int208(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(208, value);
}
}
/**
* @dev Returns the downcasted int200 from int256, reverting on
* overflow (when the input is less than smallest int200 or
* greater than largest int200).
*
* Counterpart to Solidity's `int200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toInt200(int256 value) internal pure returns (int200 downcasted) {
downcasted = int200(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(200, value);
}
}
/**
* @dev Returns the downcasted int192 from int256, reverting on
* overflow (when the input is less than smallest int192 or
* greater than largest int192).
*
* Counterpart to Solidity's `int192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toInt192(int256 value) internal pure returns (int192 downcasted) {
downcasted = int192(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(192, value);
}
}
/**
* @dev Returns the downcasted int184 from int256, reverting on
* overflow (when the input is less than smallest int184 or
* greater than largest int184).
*
* Counterpart to Solidity's `int184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toInt184(int256 value) internal pure returns (int184 downcasted) {
downcasted = int184(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(184, value);
}
}
/**
* @dev Returns the downcasted int176 from int256, reverting on
* overflow (when the input is less than smallest int176 or
* greater than largest int176).
*
* Counterpart to Solidity's `int176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toInt176(int256 value) internal pure returns (int176 downcasted) {
downcasted = int176(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(176, value);
}
}
/**
* @dev Returns the downcasted int168 from int256, reverting on
* overflow (when the input is less than smallest int168 or
* greater than largest int168).
*
* Counterpart to Solidity's `int168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toInt168(int256 value) internal pure returns (int168 downcasted) {
downcasted = int168(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(168, value);
}
}
/**
* @dev Returns the downcasted int160 from int256, reverting on
* overflow (when the input is less than smallest int160 or
* greater than largest int160).
*
* Counterpart to Solidity's `int160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toInt160(int256 value) internal pure returns (int160 downcasted) {
downcasted = int160(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(160, value);
}
}
/**
* @dev Returns the downcasted int152 from int256, reverting on
* overflow (when the input is less than smallest int152 or
* greater than largest int152).
*
* Counterpart to Solidity's `int152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toInt152(int256 value) internal pure returns (int152 downcasted) {
downcasted = int152(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(152, value);
}
}
/**
* @dev Returns the downcasted int144 from int256, reverting on
* overflow (when the input is less than smallest int144 or
* greater than largest int144).
*
* Counterpart to Solidity's `int144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toInt144(int256 value) internal pure returns (int144 downcasted) {
downcasted = int144(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(144, value);
}
}
/**
* @dev Returns the downcasted int136 from int256, reverting on
* overflow (when the input is less than smallest int136 or
* greater than largest int136).
*
* Counterpart to Solidity's `int136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toInt136(int256 value) internal pure returns (int136 downcasted) {
downcasted = int136(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(136, value);
}
}
/**
* @dev Returns the downcasted int128 from int256, reverting on
* overflow (when the input is less than smallest int128 or
* greater than largest int128).
*
* Counterpart to Solidity's `int128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toInt128(int256 value) internal pure returns (int128 downcasted) {
downcasted = int128(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(128, value);
}
}
/**
* @dev Returns the downcasted int120 from int256, reverting on
* overflow (when the input is less than smallest int120 or
* greater than largest int120).
*
* Counterpart to Solidity's `int120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toInt120(int256 value) internal pure returns (int120 downcasted) {
downcasted = int120(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(120, value);
}
}
/**
* @dev Returns the downcasted int112 from int256, reverting on
* overflow (when the input is less than smallest int112 or
* greater than largest int112).
*
* Counterpart to Solidity's `int112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toInt112(int256 value) internal pure returns (int112 downcasted) {
downcasted = int112(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(112, value);
}
}
/**
* @dev Returns the downcasted int104 from int256, reverting on
* overflow (when the input is less than smallest int104 or
* greater than largest int104).
*
* Counterpart to Solidity's `int104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toInt104(int256 value) internal pure returns (int104 downcasted) {
downcasted = int104(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(104, value);
}
}
/**
* @dev Returns the downcasted int96 from int256, reverting on
* overflow (when the input is less than smallest int96 or
* greater than largest int96).
*
* Counterpart to Solidity's `int96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toInt96(int256 value) internal pure returns (int96 downcasted) {
downcasted = int96(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(96, value);
}
}
/**
* @dev Returns the downcasted int88 from int256, reverting on
* overflow (when the input is less than smallest int88 or
* greater than largest int88).
*
* Counterpart to Solidity's `int88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toInt88(int256 value) internal pure returns (int88 downcasted) {
downcasted = int88(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(88, value);
}
}
/**
* @dev Returns the downcasted int80 from int256, reverting on
* overflow (when the input is less than smallest int80 or
* greater than largest int80).
*
* Counterpart to Solidity's `int80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toInt80(int256 value) internal pure returns (int80 downcasted) {
downcasted = int80(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(80, value);
}
}
/**
* @dev Returns the downcasted int72 from int256, reverting on
* overflow (when the input is less than smallest int72 or
* greater than largest int72).
*
* Counterpart to Solidity's `int72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toInt72(int256 value) internal pure returns (int72 downcasted) {
downcasted = int72(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(72, value);
}
}
/**
* @dev Returns the downcasted int64 from int256, reverting on
* overflow (when the input is less than smallest int64 or
* greater than largest int64).
*
* Counterpart to Solidity's `int64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toInt64(int256 value) internal pure returns (int64 downcasted) {
downcasted = int64(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(64, value);
}
}
/**
* @dev Returns the downcasted int56 from int256, reverting on
* overflow (when the input is less than smallest int56 or
* greater than largest int56).
*
* Counterpart to Solidity's `int56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toInt56(int256 value) internal pure returns (int56 downcasted) {
downcasted = int56(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(56, value);
}
}
/**
* @dev Returns the downcasted int48 from int256, reverting on
* overflow (when the input is less than smallest int48 or
* greater than largest int48).
*
* Counterpart to Solidity's `int48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toInt48(int256 value) internal pure returns (int48 downcasted) {
downcasted = int48(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(48, value);
}
}
/**
* @dev Returns the downcasted int40 from int256, reverting on
* overflow (when the input is less than smallest int40 or
* greater than largest int40).
*
* Counterpart to Solidity's `int40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toInt40(int256 value) internal pure returns (int40 downcasted) {
downcasted = int40(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(40, value);
}
}
/**
* @dev Returns the downcasted int32 from int256, reverting on
* overflow (when the input is less than smallest int32 or
* greater than largest int32).
*
* Counterpart to Solidity's `int32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toInt32(int256 value) internal pure returns (int32 downcasted) {
downcasted = int32(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(32, value);
}
}
/**
* @dev Returns the downcasted int24 from int256, reverting on
* overflow (when the input is less than smallest int24 or
* greater than largest int24).
*
* Counterpart to Solidity's `int24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toInt24(int256 value) internal pure returns (int24 downcasted) {
downcasted = int24(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(24, value);
}
}
/**
* @dev Returns the downcasted int16 from int256, reverting on
* overflow (when the input is less than smallest int16 or
* greater than largest int16).
*
* Counterpart to Solidity's `int16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toInt16(int256 value) internal pure returns (int16 downcasted) {
downcasted = int16(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(16, value);
}
}
/**
* @dev Returns the downcasted int8 from int256, reverting on
* overflow (when the input is less than smallest int8 or
* greater than largest int8).
*
* Counterpart to Solidity's `int8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toInt8(int256 value) internal pure returns (int8 downcasted) {
downcasted = int8(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(8, value);
}
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
// Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
if (value > uint256(type(int256).max)) {
revert SafeCastOverflowedUintToInt(value);
}
return int256(value);
}
/**
* @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
*/
function toUint(bool b) internal pure returns (uint256 u) {
assembly ("memory-safe") {
u := iszero(iszero(b))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/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.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/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(buffer, add(32, 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(buffer, add(0x20, offset)))
}
}
}pragma solidity >=0.5.0;
interface IUniswapV2Factory {
event PairCreated(address indexed token0, address indexed token1, address pair, uint);
function feeTo() external view returns (address);
function feeToSetter() external view returns (address);
function getPair(address tokenA, address tokenB) external view returns (address pair);
function allPairs(uint) external view returns (address pair);
function allPairsLength() external view returns (uint);
function createPair(address tokenA, address tokenB) external returns (address pair);
function setFeeTo(address) external;
function setFeeToSetter(address) external;
}pragma solidity >=0.5.0;
interface IUniswapV2Pair {
event Approval(address indexed owner, address indexed spender, uint value);
event Transfer(address indexed from, address indexed to, uint value);
function name() external pure returns (string memory);
function symbol() external pure returns (string memory);
function decimals() external pure returns (uint8);
function totalSupply() external view returns (uint);
function balanceOf(address owner) external view returns (uint);
function allowance(address owner, address spender) external view returns (uint);
function approve(address spender, uint value) external returns (bool);
function transfer(address to, uint value) external returns (bool);
function transferFrom(address from, address to, uint value) external returns (bool);
function DOMAIN_SEPARATOR() external view returns (bytes32);
function PERMIT_TYPEHASH() external pure returns (bytes32);
function nonces(address owner) external view returns (uint);
function permit(address owner, address spender, uint value, uint deadline, uint8 v, bytes32 r, bytes32 s) external;
event Mint(address indexed sender, uint amount0, uint amount1);
event Burn(address indexed sender, uint amount0, uint amount1, address indexed to);
event Swap(
address indexed sender,
uint amount0In,
uint amount1In,
uint amount0Out,
uint amount1Out,
address indexed to
);
event Sync(uint112 reserve0, uint112 reserve1);
function MINIMUM_LIQUIDITY() external pure returns (uint);
function factory() external view returns (address);
function token0() external view returns (address);
function token1() external view returns (address);
function getReserves() external view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast);
function price0CumulativeLast() external view returns (uint);
function price1CumulativeLast() external view returns (uint);
function kLast() external view returns (uint);
function mint(address to) external returns (uint liquidity);
function burn(address to) external returns (uint amount0, uint amount1);
function swap(uint amount0Out, uint amount1Out, address to, bytes calldata data) external;
function skim(address to) external;
function sync() external;
function initialize(address, address) external;
}pragma solidity >=0.6.2;
interface IUniswapV2Router01 {
function factory() external pure returns (address);
function WETH() external pure returns (address);
function addLiquidity(
address tokenA,
address tokenB,
uint amountADesired,
uint amountBDesired,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB, uint liquidity);
function addLiquidityETH(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountETH, uint liquidity);
function removeLiquidity(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB);
function removeLiquidityETH(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountToken, uint amountETH);
function removeLiquidityWithPermit(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountA, uint amountB);
function removeLiquidityETHWithPermit(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountToken, uint amountETH);
function swapExactTokensForTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
function swapTokensForExactTokens(
uint amountOut,
uint amountInMax,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
function swapExactETHForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function swapTokensForExactETH(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapExactTokensForETH(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapETHForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function quote(uint amountA, uint reserveA, uint reserveB) external pure returns (uint amountB);
function getAmountOut(uint amountIn, uint reserveIn, uint reserveOut) external pure returns (uint amountOut);
function getAmountIn(uint amountOut, uint reserveIn, uint reserveOut) external pure returns (uint amountIn);
function getAmountsOut(uint amountIn, address[] calldata path) external view returns (uint[] memory amounts);
function getAmountsIn(uint amountOut, address[] calldata path) external view returns (uint[] memory amounts);
}pragma solidity >=0.6.2;
import './IUniswapV2Router01.sol';
interface IUniswapV2Router02 is IUniswapV2Router01 {
function removeLiquidityETHSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountETH);
function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountETH);
function swapExactTokensForTokensSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
function swapExactETHForTokensSupportingFeeOnTransferTokens(
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external payable;
function swapExactTokensForETHSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@openzeppelin/contracts/utils/Strings.sol";
/**
* @title SVGGenerator
* @dev Library for generating SVG visuals for XBURN NFTs
* - Optimized SVG generation with modular components
* - Improved string handling for better gas efficiency
* - Enhanced visualization with consistent styling
*/
library SVGGenerator {
using Strings for uint256;
/**
* @dev Main function to generate the complete SVG
* Assumes input strings are already correctly formatted for display.
* @param contractAddress The address of the contract
* @param burnId The ID of the burn
* @param xenBurnedNumeric Amount of XEN burned (formatted string, e.g., "1.23T" or "500K")
* @param baseMint Base mint amount (formatted string, e.g., "1,234")
* @param amplifier Current amplifier value (string)
* @param termDays Term in days (string)
* @param maturityDate Maturity date string (formatted YYYY-MM-DD)
* @param totalReward Total reward amount (formatted string, e.g., "2,468")
* @return Complete SVG as a string
*/
function generateSVG(
string memory contractAddress,
string memory burnId,
string memory xenBurnedNumeric, // Already formatted by caller
string memory baseMint, // Already formatted by caller
string memory amplifier,
string memory termDays,
string memory maturityDate,
string memory totalReward // Already formatted by caller
) internal pure returns (string memory) {
return string(
abi.encodePacked(
'<svg xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMin meet" viewBox="0 0 350 566">',
_generateDefs(),
_generateBackground(),
_generateBurnEffect(),
_generateLogo(),
_generateHeader(contractAddress),
_generateContent(burnId, xenBurnedNumeric, baseMint), // Pass formatted strings directly
_generateAttributes(amplifier, termDays, maturityDate),
_generateWarning(totalReward), // Pass formatted string directly
'</svg>'
)
);
}
/**
* @dev Generates SVG definitions (gradients and styles)
*/
function _generateDefs() private pure returns (string memory) {
return string(
abi.encodePacked(
'<defs>',
_generateGradients(),
_generateStyles(),
'</defs>'
)
);
}
/**
* @dev Generates contract information header
*/
function _generateHeader(string memory contractAddress) private pure returns (string memory) {
return string(
abi.encodePacked(
'<text x="50%" y="5%" class="base small" dominant-baseline="middle" text-anchor="middle">',
contractAddress,
'</text>'
)
);
}
/**
* @dev Generates background for the SVG
*/
function _generateBackground() private pure returns (string memory) {
return string(
abi.encodePacked(
'<g>',
'<rect width="100%" height="100%" fill="url(#g0)" rx="10px" ry="10px" stroke-linejoin="round"/>',
'<rect width="94%" height="96%" fill="transparent" rx="10px" ry="10px" ',
'stroke-linejoin="round" x="3%" y="2%" stroke-dasharray="1,6" stroke="white"/>',
'</g>'
)
);
}
/**
* @dev Generates flame effect for the SVG
*/
function _generateBurnEffect() private pure returns (string memory) {
return string(
abi.encodePacked(
'<g>',
'<path stroke="none" fill="url(#g1)" ',
'transform="translate(170,536), scale(1.7)" ',
'd="M -14 0 c -13 -13 -18 -26 -13 -37 c 8 -17 15 -24 11 -45 c 0 0 15 -2 27 28 c 0 0 10 -1 8 -18 c 3 -1 35 43 1 72 z"/>',
'<path stroke="none" fill="url(#g1)" ',
'transform="translate(170,536), scale(1.4)" ',
'd="M -10 0 c -13 -13 -18 -26 -9 -39 c 8 -17 14 -20 9 -34 c 10 6 13 13 19 31 c 9 -2 13 -7 14 -17 c 3 -1 15 37 -7 59 z"/>',
'</g>'
)
);
}
/**
* @dev Generates the XBURN logo
*/
function _generateLogo() private pure returns (string memory) {
return string(
abi.encodePacked(
'<g transform="translate(175,160)">',
'<line x1="-65" y1="-65" x2="65" y2="65" stroke="#ededed" stroke-width="5"/>',
'<line x1="-65" y1="65" x2="65" y2="-65" stroke="#ededed" stroke-width="5"/>',
'</g>'
)
);
}
/**
* @dev Generates the main content section
* Uses pre-formatted input strings directly.
*/
function _generateContent(
string memory burnId,
string memory xenBurnedNumeric, // Already formatted
string memory baseMint // Already formatted
) private pure returns (string memory) {
// Removed redundant comma formatting
return string(
abi.encodePacked(
'<text x="50%" y="50%" class="base token-name" dominant-baseline="middle" text-anchor="middle">$XBURN</text>',
'<text x="50%" y="56%" class="base burn" text-anchor="middle" dominant-baseline="middle">',
xenBurnedNumeric, ' XEN BURNED</text>',
'<text x="18%" y="62%" class="base meta" dominant-baseline="middle">#', burnId, '</text>',
'<text x="82%" y="62%" class="base meta series" dominant-baseline="middle" text-anchor="end">BURN</text>',
'<text x="18%" y="68%" class="base meta" dominant-baseline="middle">Base Mint</text>',
'<text x="82%" y="68%" class="base meta" dominant-baseline="middle" text-anchor="end">',
baseMint, ' $XBURN</text>' // Use baseMint directly
)
);
}
/**
* @dev Generates the attributes section
*/
function _generateAttributes(
string memory amplifier,
string memory termDays,
string memory maturityDate
) private pure returns (string memory) {
// Proper grammar handling for day/days
string memory daysText = _isTermEqualsOne(termDays) ? "DAY" : "DAYS";
return string(
abi.encodePacked(
'<text x="18%" y="74%" class="base meta" dominant-baseline="middle">AMP</text>',
'<text x="82%" y="74%" class="base meta" dominant-baseline="middle" text-anchor="end">',
amplifier,
'</text>',
'<text x="18%" y="80%" class="base meta" dominant-baseline="middle">Term</text>',
'<text x="82%" y="80%" class="base meta" dominant-baseline="middle" text-anchor="end">',
termDays, ' ', daysText, '</text>',
'<text x="18%" y="86%" class="base meta" dominant-baseline="middle">Maturity</text>',
'<text x="82%" y="86%" class="base meta" dominant-baseline="middle" text-anchor="end">',
maturityDate,
'</text>'
)
);
}
/**
* @dev Generates the warning text at the bottom
* Uses pre-formatted input string directly.
*/
function _generateWarning(string memory totalReward) private pure returns (string memory) {
// Removed redundant comma formatting
return string(
abi.encodePacked(
'<text x="50%" y="94%" class="base warning" text-anchor="middle" fill="#FFD700">',
totalReward, ' $XBURN LOCKED UNTIL MATURITY</text>' // Use totalReward directly
)
);
}
/**
* @dev Generates gradient definitions
*/
function _generateGradients() private pure returns (string memory) {
return string(
abi.encodePacked(
'<linearGradient id="g0" x1="50%" y1="0%" x2="50%" y2="100%">',
'<stop stop-color="hsl(1, 30%, 5%)" stop-opacity="1" offset="0%"/>',
'<stop stop-color="hsl(1, 45%, 12%)" stop-opacity="1" offset="50%"/>',
'<stop stop-color="hsl(1, 60%, 36%)" stop-opacity="1" offset="100%"/>',
'</linearGradient>',
'<linearGradient id="g1" x1="50%" y1="0%" x2="50%" y2="100%">',
'<stop stop-color="hsl(1, 100%, 50%)" stop-opacity="1" offset="20%"/>',
'<stop stop-color="hsl(35, 100%, 50%)" stop-opacity="0.6" offset="60%"/>',
'<stop stop-color="hsl(60, 100%, 50%)" stop-opacity="0.05" offset="90%"/>',
'</linearGradient>'
)
);
}
function _generateStyles() private pure returns (string memory) {
return string(
abi.encodePacked(
'<style>',
'.base {fill: #ededed; font-family: Montserrat, arial, sans-serif; font-size: 30px; font-weight: 400; }',
'.token-name {font-size: 36px; font-weight: 500; }',
'.series {text-transform: uppercase}',
'.meta {font-size: 16px; }',
'.small {font-size: 12px; }',
'.burn {font-weight: 500; font-size: 20px; }',
'.warning {font-size: 14px; font-weight: 500; }',
'</style>'
)
);
}
/**
* @dev Checks if term days is exactly "1" for proper grammar
* @param term The term in days as a string
* @return true if term is "1", false otherwise
*/
function _isTermEqualsOne(string memory term) private pure returns (bool) {
bytes memory termBytes = bytes(term);
return termBytes.length == 1 && termBytes[0] == '1';
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title XBurnMetadata
* @dev Library for handling on-chain SVG/JSON construction for XBurn NFTs.
* Handles metadata and token URI generation for the NFT contract.
*/
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/utils/Base64.sol";
import "./SVGGenerator.sol";
library XBurnMetadata {
using Strings for uint256;
using Strings for address;
using SVGGenerator for *;
/**
* @dev BurnLock structure containing all lock-related information
*/
struct BurnLock {
uint256 xenAmount; // Amount of XEN tokens burned
uint256 maturityTs; // Timestamp when the lock matures
uint256 ampSnapshot; // Amplifier snapshot at lock creation
uint256 termDays; // Lock term in days
address owner; // Owner of the lock
bool claimed; // Whether rewards have been claimed
uint256 rewardAmount; // Total reward amount (base + bonus)
uint256 baseMint; // Base mint amount without amplifier bonus
}
/**
* @dev TokenData structure for holding formatted data for visualization
*/
struct TokenData {
string burnId; // Token ID as string
string xenBurnedNumeric; // Amount of XEN burned, numeric string
string baseMint; // Base XBURN mint amount
string totalReward; // Total reward amount
string amplifier; // Amplifier percentage
string termDays; // Term in days
string maturityDate; // Formatted maturity date
string status; // Current status (Locked/Ready/Claimed)
bool isLocked; // Whether token is still locked
}
function formatLargeNumber(uint256 number) private pure returns (string memory) {
if (number >= 1e12) {
uint256 trillions = number / 1e12;
uint256 decimal = (number % 1e12) / 1e10;
return string(abi.encodePacked(
trillions.toString(),
decimal > 0 ? string(abi.encodePacked(".", decimal < 10 ? "0" : "", decimal.toString())) : "",
"T"
));
} else if (number >= 1e9) {
uint256 billions = number / 1e9;
uint256 decimal = (number % 1e9) / 1e7;
return string(abi.encodePacked(
billions.toString(),
decimal > 0 ? string(abi.encodePacked(".", decimal < 10 ? "0" : "", decimal.toString())) : "",
"B"
));
} else if (number >= 1e6) {
uint256 millions = number / 1e6;
uint256 decimal = (number % 1e6) / 1e4;
return string(abi.encodePacked(
millions.toString(),
decimal > 0 ? string(abi.encodePacked(".", decimal < 10 ? "0" : "", decimal.toString())) : "",
"M"
));
}
return number.toString();
}
/**
* @dev Formats a string number with commas (e.g., "1000000" becomes "1,000,000")
* Added based on SVGGenerator's implementation, moved here for central formatting.
* @param numberStr The number as a string (should not contain decimals or suffixes)
* @return The formatted number string with commas
*/
function _formatWithCommas(string memory numberStr) private pure returns (string memory) {
bytes memory numberBytes = bytes(numberStr);
uint256 len = numberBytes.length;
if (len <= 3) {
return numberStr;
}
uint256 commaCount = (len - 1) / 3;
bytes memory result = new bytes(len + commaCount);
uint256 resultIdx = result.length - 1;
uint256 sourceIdx = len - 1;
uint256 count = 0;
while (true) {
result[resultIdx] = numberBytes[sourceIdx];
count++;
if (sourceIdx == 0) break;
if (count == 3 && commaCount > 0) {
resultIdx--;
result[resultIdx] = ',';
commaCount--;
count = 0;
}
resultIdx--;
sourceIdx--;
}
return string(result);
}
/**
* @dev Main entry point for tokenURI creation
* @param tokenId The NFT token ID
* @param lock The BurnLock data for this token
* @param currentTime Current block timestamp
* @param contractAddress The NFT contract address
* @return Complete tokenURI with Base64 encoded JSON data
*/
function constructTokenURI(
uint256 tokenId,
BurnLock memory lock,
uint256 currentTime,
address contractAddress
) internal pure returns (string memory) {
TokenData memory data = _prepareData(tokenId, lock, currentTime);
string memory svg = _generateSVG(data, contractAddress);
string memory json = _generateJSON(data, svg);
return string(
abi.encodePacked(
"data:application/json;base64,",
Base64.encode(bytes(json))
)
);
}
/**
* @dev Prepares and formats data for token display
* @param tokenId The NFT token ID
* @param lock The BurnLock data for this token
* @param currentTime Current block timestamp
* @return Formatted TokenData structure
*/
function _prepareData(
uint256 tokenId,
BurnLock memory lock,
uint256 currentTime
) private pure returns (TokenData memory) {
// Basic token data
string memory burnId = tokenId.toString();
string memory xenBurnedNumeric = formatLargeNumber(lock.xenAmount / 1e18);
string memory baseMint = _formatWithCommas((lock.baseMint / 1e18).toString());
string memory totalReward = _formatWithCommas((lock.rewardAmount / 1e18).toString());
// Set amplifier to raw value
string memory amplifier = lock.ampSnapshot.toString();
// Term days
string memory termDays = lock.termDays.toString();
// Format maturity date
(uint256 year, uint256 month, uint256 day) = _parseTimestamp(lock.maturityTs);
string memory maturityDate = string(
abi.encodePacked(
year.toString(),
"-",
_padZero(month),
"-",
_padZero(day)
)
);
// Determine lock status
bool isLocked = (currentTime < lock.maturityTs && !lock.claimed);
string memory status = isLocked
? "Locked"
: (lock.claimed ? "Claimed" : "Ready");
return TokenData({
burnId: burnId,
xenBurnedNumeric: xenBurnedNumeric,
baseMint: baseMint,
totalReward: totalReward,
amplifier: amplifier,
termDays: termDays,
maturityDate: maturityDate,
status: status,
isLocked: isLocked
});
}
/**
* @dev Generates SVG for the token
* @param data Prepared token data
* @param contractAddress The NFT contract address
* @return SVG string
*/
function _generateSVG(
TokenData memory data,
address contractAddress
) private pure returns (string memory) {
// Convert contract address to string
string memory fullAddress = addressToString(contractAddress);
return SVGGenerator.generateSVG(
fullAddress,
data.burnId,
data.xenBurnedNumeric,
data.baseMint,
data.amplifier,
data.termDays,
data.maturityDate,
data.totalReward
);
}
/**
* @dev Generates JSON metadata for the token
* @param data Prepared token data
* @param svg SVG data string
* @return JSON metadata string
*/
function _generateJSON(
TokenData memory data,
string memory svg
) private pure returns (string memory) {
return string(
abi.encodePacked(
'{',
'"name":"XBURN Lock Position #', data.burnId, '",',
'"description":"This NFT represents a locked XBURN position created by burning XEN. ',
'It contains all data on-chain including the SVG image and is redeemable for XBURN tokens at maturity.",',
'"image":"data:image/svg+xml;base64,', Base64.encode(bytes(svg)), '",',
'"attributes":[',
'{"trait_type":"XEN Burned","value":"', data.xenBurnedNumeric, '"},',
'{"trait_type":"Base Mint","value":"', data.baseMint, '"},',
'{"trait_type":"Amplifier","value":"', data.amplifier, '"},',
'{"trait_type":"Term Days","value":"', data.termDays, '"},',
'{"trait_type":"Maturity","value":"', data.maturityDate, '"},',
'{"trait_type":"Total Reward","value":"', data.totalReward, '"},',
'{"trait_type":"Status","value":"', data.status, '"}',
']',
'}'
)
);
}
/**
* @dev Converts an address to a hex string
* @param addr The address to convert
* @return The address as a hex string
*/
function addressToString(address addr) private pure returns (string memory) {
return addr.toHexString();
}
/**
* @dev Parses a timestamp into year, month, and day
* @param timestamp The timestamp to parse
* @return year The year component
* @return month The month component
* @return day The day component
*/
function _parseTimestamp(uint256 timestamp)
private
pure
returns (uint256 year, uint256 month, uint256 day)
{
// Accurate date calculation algorithm
uint256 secs = timestamp;
uint256 z = (secs / 86400) + 719468;
uint256 era = (z >= 0 ? z : z - 146096) / 146097;
uint256 doe = z - era * 146097;
uint256 yoe = (doe - doe/1460 + doe/36524 - doe/146096) / 365;
uint256 y = yoe + era * 400;
uint256 doy = doe - (365*yoe + yoe/4 - yoe/100 + yoe/400);
uint256 mp = (5*doy + 2)/153;
uint256 d = doy - (153*mp+2)/5 + 1;
uint256 m;
if (mp < 10) {
m = mp + 3;
} else {
m = mp - 9;
}
y = y + (m <= 2 ? 1 : 0);
return (y, m, d);
}
/**
* @dev Pads a number with a leading zero if less than 10
* @param num The number to pad
* @return The padded number as a string
*/
function _padZero(uint256 num) private pure returns (string memory) {
return num < 10
? string(abi.encodePacked("0", num.toString()))
: num.toString();
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title XBurnNFT
* @dev ERC721 contract representing locked XBURN positions.
* Each NFT represents a position where XEN tokens were burned in exchange for XBURN rewards.
* The NFT contains all the details of the burn and matures after a set time period.
* Implements EIP-2981 for royalties and OpenSea contract metadata.
*/
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
import "@openzeppelin/contracts/token/common/ERC2981.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/Base64.sol";
import "./SVGGenerator.sol";
import "./XBurnMetadata.sol";
using Strings for uint256;
contract XBurnNFT is ERC721, ERC721Enumerable, ERC2981, Ownable {
// ------------------------------------------------
// ================ Constants =====================
// ------------------------------------------------
uint256 public constant MAX_TERM_DAYS = 3650; // ~10 years
uint256 public constant MAX_BATCH_SIZE = 100; // Maximum batch size for loop protection
uint256 public constant BASE_RATIO = 1_000_000;
// ------------------------------------------------
// ================ State Variables ==============
// ------------------------------------------------
// Address variables
address public minter;
// Counter variables
uint256 private _tokenIdCounter;
// Contract metadata URI for OpenSea, etc.
string private _contractURI;
// BurnLock struct for storing lock details
struct BurnLock {
uint256 xenAmount; // Amount of XEN tokens burned
uint256 maturityTs; // Timestamp when the lock matures
uint256 ampSnapshot; // Amplifier snapshot at lock creation
uint256 termDays; // Lock term in days
address owner; // Owner of the lock
bool claimed; // Whether rewards have been claimed
uint256 rewardAmount; // Total reward amount (base + bonus)
uint256 baseMint; // Base mint amount without amplifier bonus
}
// tokenId => BurnLock details
mapping(uint256 => BurnLock) public burnLocks;
// ------------------------------------------------
// ================ Custom Errors ================
// ------------------------------------------------
error OnlyMinter(address caller, address minter);
error AlreadyClaimed(uint256 tokenId);
error NonexistentToken(uint256 tokenId);
error LockedToken(uint256 tokenId);
error InvalidTermDays(uint256 providedDays, uint256 maxDays);
error ZeroAddressNotAllowed();
error NotAuthorized(address caller);
error BatchSizeTooLarge(uint256 provided, uint256 maximum);
error RoyaltyTooHigh(uint256 provided, uint256 maximum);
// ------------------------------------------------
// ================= Events ======================
// ------------------------------------------------
event BurnLockCreated(
uint256 indexed tokenId,
address indexed user,
uint256 amount,
uint256 termDays,
uint256 maturityTimestamp
);
event MinterChanged(address indexed oldMinter, address indexed newMinter);
event LockClaimed(uint256 indexed tokenId);
event LockBurned(uint256 indexed tokenId);
event ContractURIUpdated(string newURI);
event RoyaltyInfoUpdated(address receiver, uint96 feeNumerator);
// ------------------------------------------------
// ================ Modifiers ====================
// ------------------------------------------------
/**
* @dev Restricts function access to only the minter address
*/
modifier onlyMinter() {
if (msg.sender != minter) revert OnlyMinter(msg.sender, minter);
_;
}
// ------------------------------------------------
// ================ Constructor =================
// ------------------------------------------------
constructor()
ERC721("XEN Burn Lock", "XLOCK")
Ownable(msg.sender)
{
// Set default royalty to 2.5% to contract owner
_setDefaultRoyalty(msg.sender, 250);
// Set default contract URI
_contractURI = "data:application/json;base64,eyJuYW1lIjoiWEVOIEJ1cm4gTG9jayIsImRlc2NyaXB0aW9uIjoiQSBjb2xsZWN0aW9uIG9mIExvY2tlZCBYQlVSTiBwb3NpdGlvbnMgY3JlYXRlZCBieSBidXJuaW5nIFhFTiB0b2tlbnMuIEVhY2ggTkZUIHJlcHJlc2VudHMgYSBsb2NrZWQgcG9zaXRpb24gd2l0aCBldmVyeSBkZXRhaWwgc3RvcmVkIG9uLWNoYWluLiIsImltYWdlIjoiZGF0YTppbWFnZS9zdmcreG1sO2Jhc2U2NCxQSE4yWnlCamJHRnpjejBpWW1GelpTQjBlWEJsTWlJZ1ptbHNiRDBpSTJWa1pXUmxaQ0lnZUcxc2JuTTlJbWgwZEhBNkx5OTNkM2N1ZHpNdWIzSm5Mekl3TURFdmMzWm5JajQ4YzJWamRYSnBkSGtqYzI1c1lYUmxaRDA0Y0hjOEwzTmxZM1Z5YVhSNVBqeHpkSEp2YTJVdGJXbDBaWEp2YVdRK1BDOXpkSEp2YTJVdGJXbDBaWEp2YVdRK1BHRWdjRGtpYzNCc2FYUmxjam93TGpVaVBqeG5JRzltWm5ObGREMGlibTl1WlNJK1BHUnBZV2MrUEd4cGJtViBlREE6ZVRBZ2VESTJORFk6ZVRJMk5EWWlJSE4wZVd4bFBTSjNhV1IwYUhNNk9Dd2liM0JoWTJsMGVUb3hJaUF2UGp4c2FXNWXJER0xPSIsImV4dGVybmFsX2xpbmsiOiJodHRwczovL3hibHVybi5jb20iLCJzZWxsZXJfZmVlX2Jhc2lzX3BvaW50cyI6MjUwLCJmZWVfcmVjaXBpZW50IjoiMHgwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIn0=";
}
// ------------------------------------------------
// =============== NFT Minting ===================
// ------------------------------------------------
/**
* @dev Internal function to create a lock
* @param tokenId The NFT token ID
* @param to The address that will own the NFT
* @param xenAmount Amount of XEN burned
* @param termDays Lock duration in days
* @param ampSnapshot Amplifier value at lock creation
* @param rewardAmount Total reward amount including bonuses
*/
function _createLock(
uint256 tokenId,
address to,
uint256 xenAmount,
uint256 termDays,
uint256 ampSnapshot,
uint256 rewardAmount
) internal {
// Calculate the base mint amount using the updated constant
uint256 baseMint = xenAmount / BASE_RATIO;
// Set maturity timestamp
uint256 maturityTs;
if (termDays == 0) {
// Immediately claimable if term is 0
maturityTs = block.timestamp;
} else {
// Otherwise, add the exact number of days
maturityTs = block.timestamp + (termDays * 1 days);
}
// Create the lock
burnLocks[tokenId] = BurnLock({
xenAmount: xenAmount,
maturityTs: maturityTs,
ampSnapshot: ampSnapshot,
termDays: termDays,
owner: to,
claimed: false,
rewardAmount: rewardAmount,
baseMint: baseMint
});
}
/**
* @dev Mints a new XBURN lock NFT
* @param to Address that will own the NFT
* @param xenAmount Amount of XEN burned
* @param termDays Lock duration in days
* @param ampSnapshot Amplifier value at lock creation
* @param rewardAmount Total reward amount including bonuses
* @return tokenId The newly created token ID
*/
function mint(
address to,
uint256 xenAmount,
uint256 termDays,
uint256 ampSnapshot,
uint256 rewardAmount
) external onlyMinter returns (uint256) {
// Validate inputs
if (termDays > MAX_TERM_DAYS) revert InvalidTermDays(termDays, MAX_TERM_DAYS);
if (to == address(0)) revert ZeroAddressNotAllowed();
// Create new token ID
uint256 tokenId = _tokenIdCounter++;
// Create the lock
_createLock(tokenId, to, xenAmount, termDays, ampSnapshot, rewardAmount);
// Calculate maturity timestamp for the event
uint256 maturityTs = termDays == 0
? block.timestamp
: block.timestamp + (termDays * 1 days);
// Emit event for indexing and tracking
emit BurnLockCreated(tokenId, to, xenAmount, termDays, maturityTs);
// Mint the NFT
_safeMint(to, tokenId);
return tokenId;
}
// ------------------------------------------------
// ============= Lock Management =================
// ------------------------------------------------
/**
* @dev Marks a lock as claimed
* @param tokenId The token ID to update
*/
function setClaimed(uint256 tokenId) external onlyMinter {
if (_ownerOf(tokenId) == address(0)) revert NonexistentToken(tokenId);
if (burnLocks[tokenId].claimed) revert AlreadyClaimed(tokenId);
burnLocks[tokenId].claimed = true;
emit LockClaimed(tokenId);
}
/**
* @dev Burns an NFT (typically after claiming)
* @param tokenId The token ID to burn
*/
function burn(uint256 tokenId) external onlyMinter {
if (_ownerOf(tokenId) == address(0)) revert NonexistentToken(tokenId);
_burn(tokenId);
emit LockBurned(tokenId);
}
// ------------------------------------------------
// ================ Views ========================
// ------------------------------------------------
/**
* @dev Gets all details for a specific lock
* @param tokenId The token ID to query
* @return xenAmount Amount of XEN burned
* @return maturityTs Maturity timestamp
* @return ampSnapshot Amplifier snapshot
* @return termDays Lock term in days
* @return claimed Whether rewards have been claimed
* @return rewardAmount Total reward amount
* @return baseMint Base mint amount
* @return owner Owner of the lock
*/
function getLockDetails(uint256 tokenId)
external
view
returns (
uint256 xenAmount,
uint256 maturityTs,
uint256 ampSnapshot,
uint256 termDays,
bool claimed,
uint256 rewardAmount,
uint256 baseMint,
address owner
)
{
if (_ownerOf(tokenId) == address(0)) revert NonexistentToken(tokenId);
BurnLock storage lock = burnLocks[tokenId];
return (
lock.xenAmount,
lock.maturityTs,
lock.ampSnapshot,
lock.termDays,
lock.claimed,
lock.rewardAmount,
lock.baseMint,
lock.owner
);
}
/**
* @dev Gets all lock token IDs owned by a specific user with pagination
* @param user Address to query
* @param page Page number (0-indexed)
* @param pageSize Number of items per page
* @return tokenIds Array of token IDs
* @return totalPages Total number of pages available
*/
function getAllUserLocks(address user, uint256 page, uint256 pageSize)
external
view
returns (uint256[] memory tokenIds, uint256 totalPages)
{
// Protect against excessively large page sizes
if (pageSize > MAX_BATCH_SIZE) revert BatchSizeTooLarge(pageSize, MAX_BATCH_SIZE);
uint256 balance = balanceOf(user);
// Calculate total pages with ceiling division
totalPages = (balance + pageSize - 1) / pageSize;
// Handle out of bounds pages
if (page >= totalPages || balance == 0) {
return (new uint256[](0), totalPages);
}
// Calculate actual page boundaries
uint256 startIndex = page * pageSize;
uint256 endIndex = startIndex + pageSize;
if (endIndex > balance) {
endIndex = balance;
}
// Create result array
tokenIds = new uint256[](endIndex - startIndex);
// Fill array with token IDs
for (uint256 i = startIndex; i < endIndex; ++i) {
tokenIds[i - startIndex] = tokenOfOwnerByIndex(user, i);
}
return (tokenIds, totalPages);
}
/**
* @dev Returns metadata URI for a token
* Uses the XBurnMetadata library to construct the URI.
* @param tokenId The token ID to query
* @return URI string with embedded metadata
*/
function tokenURI(uint256 tokenId)
public
view
override(ERC721) // Only override ERC721
returns (string memory)
{
if (_ownerOf(tokenId) == address(0)) revert NonexistentToken(tokenId);
// Get lock data directly
BurnLock storage lock = burnLocks[tokenId];
// Use the library to construct the full token URI
// Note: Mapping the internal BurnLock struct to the library's version
return XBurnMetadata.constructTokenURI(
tokenId,
XBurnMetadata.BurnLock({
xenAmount: lock.xenAmount,
maturityTs: lock.maturityTs,
ampSnapshot: lock.ampSnapshot,
termDays: lock.termDays,
owner: _ownerOf(tokenId), // Use _ownerOf for current owner safety
claimed: lock.claimed,
rewardAmount: lock.rewardAmount,
baseMint: lock.baseMint
}),
block.timestamp,
address(this)
);
}
// ------------------------------------------------
// ================ Royalty Support ==============
// ------------------------------------------------
/**
* @dev Returns the contract-level metadata URI for marketplaces (OpenSea, etc.)
* @return Contract URI string
*/
function contractURI() public view returns (string memory) {
return _contractURI;
}
/**
* @dev Sets the contract-level metadata URI
* @param newURI New contract URI
*/
function setContractURI(string memory newURI) external onlyOwner {
_contractURI = newURI;
emit ContractURIUpdated(newURI);
}
/**
* @dev Sets a new royalty receiver and fee
* @param receiver Address to receive royalties
* @param feeNumerator Fee in basis points (e.g., 250 = 2.5%)
*/
function setDefaultRoyalty(address receiver, uint96 feeNumerator) external onlyOwner {
if (feeNumerator > 1000) revert RoyaltyTooHigh(feeNumerator, 1000); // Max 10%
_setDefaultRoyalty(receiver, feeNumerator);
emit RoyaltyInfoUpdated(receiver, feeNumerator);
}
/**
* @dev Removes the default royalty configuration
*/
function deleteDefaultRoyalty() external onlyOwner {
_deleteDefaultRoyalty();
emit RoyaltyInfoUpdated(address(0), 0);
}
// ------------------------------------------------
// ================ Admin Functions ==============
// ------------------------------------------------
/**
* @dev Sets the minter address
* @param newMinter The new minter address
*/
function setMinter(address newMinter) public {
if (msg.sender != minter && msg.sender != owner() && minter != address(0)) {
revert NotAuthorized(msg.sender);
}
if (newMinter == address(0)) revert ZeroAddressNotAllowed();
address oldMinter = minter;
minter = newMinter;
emit MinterChanged(oldMinter, newMinter);
}
// ------------------------------------------------
// ============ Internal Overrides ===============
// ------------------------------------------------
/**
* @dev Update hook from ERC721
* Updates owner in burnLocks when token is transferred
* @param to Address receiving the token
* @param tokenId Token ID being transferred
* @param auth Address authorized to make the transfer
* @return from Address that previously owned the token
*/
function _update(
address to,
uint256 tokenId,
address auth
) internal virtual override(ERC721, ERC721Enumerable) returns (address) {
address from = super._update(to, tokenId, auth);
// Update owner in burnLocks when transferring
if (from != address(0) && to != address(0)) {
// Prevent transfer of claimed tokens
if (burnLocks[tokenId].claimed) revert LockedToken(tokenId);
// Update ownership record in the lock struct itself
burnLocks[tokenId].owner = to;
}
return from;
}
/**
* @dev Required override for ERC721Enumerable
* @param account Address to increase balance for
* @param value Amount to increase balance by
*/
function _increaseBalance(
address account,
uint128 value
) internal virtual override(ERC721, ERC721Enumerable) {
super._increaseBalance(account, value);
}
/**
* @dev Required override for interface support including EIP-2981
* @param interfaceId Interface identifier
* @return bool True if supported
*/
function supportsInterface(
bytes4 interfaceId
) public view virtual override(ERC721, ERC721Enumerable, ERC2981) returns (bool) {
// Use super call for cleaner inheritance check
return super.supportsInterface(interfaceId);
}
}{
"optimizer": {
"enabled": true,
"runs": 200
},
"viaIR": true,
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"libraries": {}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"_xen","type":"address"},{"internalType":"address","name":"_router","type":"address"},{"internalType":"address","name":"_nft","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"allowance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientAllowance","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"balance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientBalance","type":"error"},{"inputs":[{"internalType":"address","name":"approver","type":"address"}],"name":"ERC20InvalidApprover","type":"error"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"ERC20InvalidReceiver","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"ERC20InvalidSender","type":"error"},{"inputs":[{"internalType":"address","name":"spender","type":"address"}],"name":"ERC20InvalidSpender","type":"error"},{"inputs":[{"internalType":"uint256","name":"required","type":"uint256"},{"internalType":"uint256","name":"provided","type":"uint256"}],"name":"InsufficientXen","type":"error"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"InvalidAmount","type":"error"},{"inputs":[{"internalType":"uint256","name":"providedDays","type":"uint256"},{"internalType":"uint256","name":"maxDays","type":"uint256"}],"name":"InvalidTerm","type":"error"},{"inputs":[],"name":"LiquidityAlreadyInitialized","type":"error"},{"inputs":[],"name":"LiquidityNotInitialized","type":"error"},{"inputs":[],"name":"LiquidityPairNotSet","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"address","name":"provided","type":"address"},{"internalType":"address","name":"actual","type":"address"}],"name":"NotTokenOwner","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[{"internalType":"uint256","name":"current","type":"uint256"},{"internalType":"uint256","name":"required","type":"uint256"}],"name":"PendingXenTooLow","type":"error"},{"inputs":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[{"internalType":"string","name":"reason","type":"string"}],"name":"SwapFailedError","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"TokenAlreadyClaimed","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"TokenNotClaimable","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"maturityTs","type":"uint256"},{"internalType":"uint256","name":"currentTime","type":"uint256"}],"name":"TokenNotMatured","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"address","name":"expected","type":"address"}],"name":"UnauthorizedCallback","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"xenAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"termDays","type":"uint256"}],"name":"BurnNFTMinted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"caller","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"CallerRewarded","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"baseAmount","type":"uint256"}],"name":"EmergencyEnd","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"totalXenBurned","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"totalXburnMinted","type":"uint256"}],"name":"GlobalStatsUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"amountXBURN","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amountXEN","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"liquidity","type":"uint256"}],"name":"LiquidityInitialized","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":"string","name":"reason","type":"string"},{"indexed":false,"internalType":"string","name":"message","type":"string"},{"indexed":false,"internalType":"uint256","name":"xenAmount","type":"uint256"}],"name":"SwapFailed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"XBURNBurned","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"baseAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"bonusAmount","type":"uint256"}],"name":"XBURNClaimed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"XENBurned","type":"event"},{"inputs":[],"name":"AMP_END","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"AMP_START","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"BASE_RATIO","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"CALLER_REWARD_PERCENTAGE","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"INITIAL_SUPPLY","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"LAUNCH_TS","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_BATCH_SIZE","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_DEADLINE","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_TERM","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MINIMUM_LIQUIDITY","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MIN_TERM","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SWAP_THRESHOLD","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"XEN","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"uint256","name":"termDays","type":"uint256"}],"name":"burnXEN","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"burnXburn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"claimLockedXBURN","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"emergencyEnd","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getAccumulationProgress","outputs":[{"internalType":"uint256","name":"accumulated","type":"uint256"},{"internalType":"uint256","name":"threshold","type":"uint256"},{"internalType":"uint256","name":"percentage","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getGlobalStats","outputs":[{"internalType":"uint256","name":"currentAMP","type":"uint256"},{"internalType":"uint256","name":"daysSinceLaunch","type":"uint256"},{"internalType":"uint256","name":"totalBurnedXEN","type":"uint256"},{"internalType":"uint256","name":"totalMintedXBURN","type":"uint256"},{"internalType":"uint256","name":"ampDecayDaysLeft","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"getStats","outputs":[{"internalType":"uint256","name":"userXenBurnedAmount","type":"uint256"},{"internalType":"uint256","name":"userXburnBurnedAmount","type":"uint256"},{"internalType":"uint256","name":"userXburnBalance","type":"uint256"},{"internalType":"uint256","name":"userBurnPercentage","type":"uint256"},{"internalType":"uint256","name":"globalXenBurned","type":"uint256"},{"internalType":"uint256","name":"globalXburnBurned","type":"uint256"},{"internalType":"uint256","name":"totalXburnSupply","type":"uint256"},{"internalType":"uint256","name":"globalBurnPercentage","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getTokenStats","outputs":[{"internalType":"uint256","name":"xenAmount","type":"uint256"},{"internalType":"uint256","name":"baseMint","type":"uint256"},{"internalType":"uint256","name":"rewardAmount","type":"uint256"},{"internalType":"uint256","name":"maturityTs","type":"uint256"},{"internalType":"bool","name":"isClaimable","type":"bool"},{"internalType":"bool","name":"isClaimed","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"},{"internalType":"uint256","name":"page","type":"uint256"},{"internalType":"uint256","name":"pageSize","type":"uint256"}],"name":"getUserLocks","outputs":[{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"},{"internalType":"uint256","name":"totalPages","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"getUserLocks","outputs":[{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"getUserStats","outputs":[{"internalType":"uint256","name":"xenBurned","type":"uint256"},{"internalType":"uint256","name":"xburnBalance","type":"uint256"},{"internalType":"uint256","name":"totalTokens","type":"uint256"},{"internalType":"uint256","name":"claimableTokens","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"globalBurnRank","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"xenAmount","type":"uint256"}],"name":"initializeLiquidity","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"liquidityInitialized","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"liquidityPair","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"nftContract","outputs":[{"internalType":"contract XBurnNFT","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"onTokenBurned","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingXen","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"uint256","name":"minXburnReceived","type":"uint256"}],"name":"swapXenForXburn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalXburnBurned","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalXburnMinted","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalXenBurned","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"uniswapRouter","outputs":[{"internalType":"contract IUniswapV2Router02","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"userXburnBurned","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"userXburnMinted","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"userXenBurned","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"validatePairTokens","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"daysFromLaunch","type":"uint256"}],"name":"verifyAmpCalculation","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]Contract Creation Code
61010034620004f657601f19620035dd38819003601f8181018416850194909290916001600160401b039183871083881117620003f5578160609285926040998a52833981010312620004f6576200005782620004fb565b9060209362000075876200006d878701620004fb565b9501620004fb565b916200008062000510565b916200008b62000510565b90835191838311620003f55760039283546001968782811c92168015620004eb575b8c831014620004d5578b82868594116200047c575b50508b9085831160011462000417576000926200040b575b505060001982861b1c191690861b1783555b8051938411620003f5576004998a548681811c91168015620003ea575b8b821014620003d55790818487969594931162000379575b508a92851160011462000311575060009362000305575b505082841b92600019911b1c19161786555b3315620002ee5760058054336001600160a01b0319821681179092558851956001600160a01b039586949193859391929184167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a3806006554260e052600755166080521660c0521660a0523015620002d95750600254690a968163f0a57b40000092838201809211620002c457506000917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9160025530835282815284832084815401905584519384523093a35161309a908162000543823960805181818161066c015281816111f9015281816114fd015281816117e10152818161203301528181612ef50152612f3b015260a05181818161040c0152818161048a0152818161071a01528181610a700152818161132c0152818161159c01528181611f5901526125ca015260c051818181610f12015281816118a10152612089015260e0518181816109f3015281816110500152612fea0152f35b601190634e487b7160e01b6000525260246000fd5b63ec442f0560e01b8152600083820152602490fd5b8651631e4fbdf760e01b8152600081880152602490fd5b01519150388062000138565b86959392919316928b6000528a6000209360005b8c82821062000362575050851162000347575b50505050811b0186556200014a565b01519060f884600019921b161c191690553880808062000338565b838501518755899890960195938401930162000325565b9091929394508b6000528a6000208480880160051c8201928d8910620003cb575b918991899897969594930160051c01915b828110620003bb57505062000121565b60008155889750899101620003ab565b925081926200039a565b60228c634e487b7160e01b6000525260246000fd5b90607f169062000109565b634e487b7160e01b600052604160045260246000fd5b015190503880620000da565b908c918e8a95168860005283600020936000905b8282106200046457505084116200044b575b505050811b018355620000ec565b015160001983881b60f8161c191690553880806200043d565b8385015186558c979095019493840193018f6200042b565b909192508660005285826000209181860160051c8301938610620004cb575b918a91869594930160051c01915b828110620004bb57508d9150620000c2565b600081558594508a9101620004a9565b925081926200049b565b634e487b7160e01b600052602260045260246000fd5b91607f1691620000ad565b600080fd5b51906001600160a01b0382168203620004f657565b60408051919082016001600160401b03811183821017620003f55760405260058252642c212aa92760d91b602083015256fe6080604081815260048036101561001557600080fd5b600092833560e01c90816301ffc9a71461281e57508063058aafe3146127f757806306fdde0314612702578063095ea7b3146126595780630c5e3d1e1461256957806318160ddd1461254a57806318186c1a146125125780632298e8d314611fc957806323a35de914611f0857806323b872dd14611e155780632f2d11ff14610ef85780632ff2e9dc14611df0578063313ce56714611dd4578063316c3a1214611db557806335fd141414611d8e578063372c89371461174157806348093dd1146117225780634e43603a1461155d578063543746b1146114e1578063579436fc146114c257806358c1cb221461117d5780636186b02514611156578063626c4e5d146110d45780636b4169c31461102b5780636f0e530f1461100e5780636ffc02af14610fd657806370a0823114610f9f578063715018a614610f41578063735de9f714610efd5780637597a9c214610ef8578063808a545714610ecf5780638da5cb5b14610ea65780639023c9d414610e0957806391699d8914610dd157806395d89b4114610cb6578063965b51ee14610a355780639886bf6314610a16578063a7886343146109db578063a9059cbb146109aa578063b42367c4146106df578063ba9a7a56146106ba578063bb502c281461069b578063c003598a14610657578063c23f85d61461054b578063c582951414610457578063cfdbf2541461043b578063d56d229d146103f7578063d9a1ff3a146103d1578063dd1dc325146103b3578063dd62ed3e14610365578063e7c1dbaa14610346578063f060482914610328578063f2a5ffbd146103085763f2fde38b1461027557600080fd5b346103045760203660031901126103045761028e6128b2565b9061029761292e565b6001600160a01b039182169283156102ee575050600554826bffffffffffffffffffffffff60a01b821617600555167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a380f35b51631e4fbdf760e01b8152908101849052602490fd5b8280fd5b5050346103245781600319360112610324576020905160058152f35b5080fd5b50503461032457816003193601126103245760209051620151808152f35b505034610324578160031936011261032457602090600a549051908152f35b5050346103245780600319360112610324576020916103826128b2565b8261038b6128c8565b6001600160a01b03928316845260018652922091166000908152908352819020549051908152f35b50503461032457816003193601126103245760209051620f42408152f35b5050346103245781600319360112610324576020906103ee612e70565b90519015158152f35b505034610324578160031936011261032457517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b5050346103245781600319360112610324576020905160328152f35b509034610304576020366003190112610304578051635b15bfd960e01b81528235928101929092526101009182816024817f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03165afa908115610541578460c09594819282918395610504575b505015938493846104f8575b815196875260208701528501526060840152151560808301521560a0820152f35b935082421015936104d7565b93509350505061052a929350803d1061053a575b6105228183612984565b810190612d9b565b50959695949350915038806104cb565b503d610518565b82513d86823e3d90fd5b5091346106545760209081600319360112610654576001600160a01b036105706128b2565b168152600d82528281205492600f83528082205491808452818120549060085491600a54936002549584151560001461064e57600d8852818420546127109081810291818304149015171561063b57856105c991612bad565b935b8715610630576127109081880291888304148815171561061d57506101009a50876105f591612bad565b975b8251998a528901528701526060860152608085015260a084015260c083015260e0820152f35b634e487b7160e01b815260118c52602490fd5b6101009a50976105f7565b634e487b7160e01b855260118b52602485fd5b836105cb565b80fd5b505034610324578160031936011261032457517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b5050346103245781600319360112610324576020906009549051908152f35b5050346103245781600319360112610324576020905169152d02c7e14af68000008152f35b509034610304576020806003193601126108bd578235926106fe612b77565b82516331a9108f60e11b81528181018590526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811691908482602481865afa91821561092f57889261096f575b5033908216036109395750835191635b15bfd960e01b83528581840152610100958684602481865afa93841561092f57889789918a918b97610900575b50501590816108f5575b50156108df57908792916107ae8533612de1565b6107ba85600954612a84565b600955338452600e86528684206107d2868254612a84565b9055823b156108bd57865163e7aa0bd760e01b8152828101829052848160248183885af180156108d5579085916108c1575b5050823b156108bd57602484928389519586948593630852cd8d60e31b85528401525af180156108b35761089b575b5050610854620f424060008051602061304583398151915295048092612be1565b8351918252828201527f0e322ecaa09d8958bd44f46d5ccc9356b4ea8b37ab7646e54a8cb95215c90577833392a260085490600954908351928352820152a1600160065580f35b6108a49061295a565b6108af578438610833565b8480fd5b85513d84823e3d90fd5b8380fd5b6108ca9061295a565b6108bd578338610804565b88513d87823e3d90fd5b8551631780a04f60e31b81529182015260249150fd5b90504210153861079a565b92509298505061091d929450803d1061053a576105228183612984565b50509694915091509791903880610790565b86513d8a823e3d90fd5b845163d1344c4560e01b81528084018781523360208201526001600160a01b0390921660408301529081906060010390fd5b0390fd5b9091508481813d83116109a3575b6109878183612984565b8101031261099f5761099890612bcd565b9038610753565b8780fd5b503d61097d565b5050346103245780600319360112610324576020906109d46109ca6128b2565b60243590336129a6565b5160018152f35b505034610324578160031936011261032457602090517f00000000000000000000000000000000000000000000000000000000000000008152f35b505034610324578160031936011261032457602090516312cc03008152f35b509034610304576020806003193601126108bd57823592610a54612b77565b82516331a9108f60e11b81528181018590526001600160a01b037f000000000000000000000000000000000000000000000000000000000000000081169291908482602481875afa91821561092f578892610c7f575b503390821603610c4e57508351635b15bfd960e01b8152818101869052946101008087602481875afa96871561092f5788918998610c23575b5050610c0d5790869291610af78733612de1565b610b0387600954612a84565b600955338452600e8552858420610b1b888254612a84565b9055823b156108bd57855163e7aa0bd760e01b8152828101829052848160248183885af18015610c0357908591610bef575b5050823b156108bd57602484928388519586948593630852cd8d60e31b85528401525af18015610be557610bd1575b50506000805160206130458339815191529282519081527f5004ce3f5d960788b0fa52de1cf6796cb4788fc978a91f242f4453ec573cdcf2823392a260085490600954908351928352820152a1600160065580f35b610bda9061295a565b6108bd578338610b7c565b84513d84823e3d90fd5b610bf89061295a565b6108bd578338610b4d565b87513d87823e3d90fd5b8451631780a04f60e31b81529182015260249150fd5b610c3e93985080919250903d1061053a576105228183612984565b509a955050925050503880610ae3565b845163d1344c4560e01b81529182018681523360208201526001600160a01b03909116604082015281906060010390fd5b9091508481813d8311610caf575b610c978183612984565b8101031261099f57610ca890612bcd565b9038610aaa565b503d610c8d565b50913461065457806003193601126106545781519181845492600184811c91818616958615610dc7575b6020968785108114610db4579087899a92868b999a9b529182600014610d8a575050600114610d2f575b8588610d2b89610d1c848a0385612984565b51928284938452830190612872565b0390f35b815286935091907f8a35acfbc15ff81a39ae7d344fd709f28e8600b4aa8c65c6b64bfe7fe36bd19b5b828410610d725750505082010181610d1c610d2b38610d0a565b8054848a018601528895508794909301928101610d58565b60ff19168882015294151560051b87019094019450859350610d1c9250610d2b9150389050610d0a565b634e487b7160e01b835260228a52602483fd5b92607f1692610ce0565b5050346103245760203660031901126103245760209181906001600160a01b03610df96128b2565b168152600d845220549051908152f35b50903461030457602036600319011261030457813591610e27612b77565b8215610e915750610e388233612ced565b610e4482600a54612a84565b600a55338352600f602052808320610e5d838254612a84565b9055519081527f8ec35b69bbf72c30727ea669e861e76d30ee4f53f6261ebc93eb4e0dda31494360203392a2600160065580f35b826024925191633728b83d60e01b8352820152fd5b50503461032457816003193601126103245760055490516001600160a01b039091168152602090f35b505034610324578160031936011261032457600c5490516001600160a01b039091168152602090f35b612912565b505034610324578160031936011261032457517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b8334610654578060031936011261065457610f5a61292e565b600580546001600160a01b031981169091556000906001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b5050346103245760203660031901126103245760209181906001600160a01b03610fc76128b2565b16815280845220549051908152f35b5050346103245760203660031901126103245760209181906001600160a01b03610ffe6128b2565b168152600e845220549051908152f35b505034610324578160031936011261032457602090516103848152f35b50919034610324578160031936011261032457611046612fe1565b91620151806110757f000000000000000000000000000000000000000000000000000000000000000042612be1565b04916008549060095492600186116000146110ca576000198601908682116110b7575060a09650935b8151958652602086015284015260608301526080820152f35b634e487b7160e01b815260118852602490fd5b60a096509361109e565b50919034610324578160031936011261032457600b54918215908161114a5761271091828502928584041417156111375750606093506b019d971e4fe8401e740000009004905b80519283526b019d971e4fe8401e740000006020840152820152f35b634e487b7160e01b815260118552602490fd5b9050606093509061111b565b505034610324578160031936011261032457602090516b019d971e4fe8401e740000008152f35b5090346103045780600319360112610304578135916024928335936111a0612b77565b69d3c21bcecceda100000082106114b057620151809283860286159487820414851715611482576312cc03001061149457601483028381046014148415171561148257606480910490886111f48387612be1565b61122d7f00000000000000000000000000000000000000000000000000000000000000009461122581303389612ab4565b600b54612a84565b600b556001600160a01b0393841690813b15610304578951632770a7eb60e21b81523387820190815260208101929092529291839182908490829060400103925af1801561147857611465575b5061128785600854612a84565b600855338952602095600d8752878a206112a2878254612a84565b9055620f424086046112b2612fe1565b91838b02908b820485141715611453578383029083820485148415171561144157938996936113028e946127106112fb8d9c9a966112f6610e4260a49c0485612b9a565b612b9a565b0490612a84565b918c519a8b988997637c9441d160e11b895233908901528701528d604487015285015260848401527f0000000000000000000000000000000000000000000000000000000000000000165af19182156114375786926113f5575b50600080516020613045833981519152947f15e99197c3eb538357bdfd3038a6a3c001c5446cbb9e11b29a29ef3588d92c089161139a600754612d8c565b60075585518181527fc1b094bd7ee87737194f9ad87e8702d670596561587b51246966bdbfc1784f4f863392a28551938452602084015260408301523391606090a260085490600954908351928352820152a1600160065580f35b9091508281813d8311611430575b61140d8183612984565b8101031261142b57519060008051602061304583398151915261135c565b600080fd5b503d611403565b84513d88823e3d90fd5b634e487b7160e01b8d5260118752878dfd5b634e487b7160e01b8c5260118652868cfd5b6114719099919961295a565b973861127a565b88513d8c823e3d90fd5b50634e487b7160e01b87526011905285fd5b610e4260449287875193633534c47760e21b8552840152820152fd5b9251633728b83d60e01b815291820152fd5b5050346103245781600319360112610324576020906008549051908152f35b50346103045781600319360112610304576114fa6128b2565b507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169133839003611532578380f35b516375287b7b60e01b8152339181019182526001600160a01b03909216602082015281906040010390fd5b50903461030457602091826003193601126108bd576001600160a01b0391826115846128b2565b1692838652600d8552818620549486815282872054917f00000000000000000000000000000000000000000000000000000000000000001693835195637731a78f60e01b875281870152602497808988015260329182604489015281886064818a5afa9788156117185782986116f3575b5087519682988489116000146116ec57845b845b86811061162a5760808d8d8d8d8d8d82519586528501528301526060820152f35b82518110156116db578d888260051b850101518b51918291635b15bfd960e01b83528883015261010092839181895afa9081156116d157889289926116a8575b505015908161169d575b50611688575b61168390612d8c565b611609565b9a61169561168391612d8c565b9b905061167a565b905042101538611674565b6116c2935080919250903d1061053a576105228183612984565b5050509350505090388061166a565b8c513d8a823e3d90fd5b634e487b7160e01b86528185528d86fd5b8894611607565b6117109198503d8084833e6117088183612984565b810190612e3f565b5096386115f5565b86513d84823e3d90fd5b5050346103245781600319360112610324576020906007549051908152f35b50823461065457602092836003193601126103245761175e612b77565b600c549060ff8260a01c1615611d7f576001600160a01b0391821615611d7057600b54926b019d971e4fe8401e74000000808510611d54575080600b556005840284810460051485151715611d415760649004926117bc8486612be1565b835163a9059cbb60e01b898201523360248083019190915260448083018890528252957f00000000000000000000000000000000000000000000000000000000000000009161181690611810606482612984565b83612b0f565b85519081527faac43248a49ce7ac3056cca2199ed9ac94d3b38b7981d36979273d8aaca272798a3392a284519267ffffffffffffffff926060850184811186821017611d2f578752600285528a85019287368537828116865115611d1d5790816118e08e879695948f98523061188b8b612bee565b528b51636eb1769f60e11b8152309881019889527f000000000000000000000000000000000000000000000000000000000000000087166001600160a01b03811660208b015298909283918291604090910190565b0381855afa908115611d13578f9192888d8f938e979689918991611ccb575b5061194a989261191488959361195893612a84565b905163095ea7b360e01b8682018181526001600160a01b0390951698820198895260208901929092529990968a91604090910190565b03601f1981018a5289612984565b87519082885af1903d8d519083611cac575b50505015611c56575b50505050610384420191824211611c4457918794928c94928e8c998c519a8b986338ed173960e01b8a5260a48a0194818b0152359089015260a060448901525180925260c48701949288915b838310611c1c5750505050508380928692336064840152608483015203925af19182918493611be1575b5050611b8057508060033d11611b70575b506308c379a014611acb575b7f666b4c8a15b59a26f75400d41fda7fa486f21ec3c2a6ef36f1adfceb8b25361b61096b938251809160608252611a8f611a6860608401604090601781527614ddd85c081d1c985b9cd858dd1a5bdb8819985a5b1959604a1b60208201520190565b8381038b850152600d81526c2ab735b737bbb71032b93937b960991b602082015260400190565b90858301520390a1519384936331f2047d60e01b85528401528201604090600d81526c2ab735b737bbb71032b93937b960991b60208201520190565b611ad3612c7b565b80611ade5750611a06565b91907f666b4c8a15b59a26f75400d41fda7fa486f21ec3c2a6ef36f1adfceb8b25361b61096b948251809160608252611b4f611b4260608401604090601781527614ddd85c081d1c985b9cd858dd1a5bdb8819985a5b1959604a1b60208201520190565b8381038c85015288612872565b90858301520390a1519485946331f2047d60e01b8652850152830190612872565b90508481803e5160e01c866119fa565b7f8ec35b69bbf72c30727ea669e861e76d30ee4f53f6261ebc93eb4e0dda31494387611bac8593612bee565b5192611bb98430336129a6565b611bc38430612ced565b611bcf84600a54612a84565b600a55519283523092a2600160065580f35b909192503d8085843e611bf48184612984565b82019189818403126108af5780519182116108af57611c14929101612c14565b9088806119e9565b919496985092965080600192958489511681520196019201928895938f928b989694936119bf565b634e487b7160e01b885260118c528988fd5b8b5191820152868c820152896044820152604481526080810181811089821117611c9a57611c91939291611c8c918d5282612b0f565b612b0f565b8c808d81611973565b634e487b7160e01b8b5260418f528c8bfd5b91925090611cc157503b15155b38808061196a565b6001915014611cb9565b9695505050505092935081813d8311611d0c575b611ce98183612984565b81010312611d0857518992918f918d919089908e90889061194a6118ff565b8980fd5b503d611cdf565b8b513d8c823e3d90fd5b634e487b7160e01b885260328c528988fd5b634e487b7160e01b875260418b528887fd5b634e487b7160e01b825260118652602482fd5b8560449186855192635e95573b60e11b84528301526024820152fd5b5163fc5df7ed60e01b81528390fd5b51632c73914160e21b81528390fd5b5091346106545760203660031901126106545750611dae6020923561302d565b9051908152f35b505034610324578160031936011261032457602090600b549051908152f35b5050346103245781600319360112610324576020905160128152f35b50503461032457816003193601126103245760209051690a968163f0a57b4000008152f35b50823461065457606036600319011261065457611e306128b2565b611e386128c8565b916044359360018060a01b038316808352600160205286832033845260205286832054916000198310611e74575b6020886109d48989896129a6565b868310611edc578115611ec5573315611eae575082526001602090815286832033845281529186902090859003905582906109d487611e66565b8751634a1406b160e11b8152908101849052602490fd5b875163e602df0560e01b8152908101849052602490fd5b8751637dc7a0d960e11b8152339181019182526020820193909352604081018790528291506060010390fd5b5090346103045760203660031901126103045782611f246128b2565b8251637731a78f60e01b81526001600160a01b039182169481019490945260248401829052600a6044850152839060649082907f0000000000000000000000000000000000000000000000000000000000000000165afa918215611fbf5783610d2b9493611fa1575b5050519182916020835260208301906128de565b611fb69293503d8091833e6117088183612984565b50903880611f8d565b81513d85823e3d90fd5b508234610654576020918260031936011261032457803593611fe961292e565b611ff1612b77565b60ff600c5460a01c166125055769152d02c7e14af6800000918286106124ea5781516370a0823160e01b80825233838301526024966001600160a01b039290917f00000000000000000000000000000000000000000000000000000000000000008481169290919084818c81875afa90811561147857908c918b916124b9575b50106124365750896120869130903390612ab4565b827f000000000000000000000000000000000000000000000000000000000000000016301561242057801561240a57308852600183528588208189528352690a968163f0a57b400000998a878a20558187518c81527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925863092a3865163095ea7b360e01b81526001600160a01b03831687820190815260208101839052909b9085908d90819060400103818d885af18015611478576123d0575b8a9b50605f829b9a9b02828104605f14831517156123be576103844201918242116123ac57895162e8e33760e81b8152308a8201529b8c0186905260448c015260648b8101849052690a0efaebbe36ceb0000060848d0152900460a48b01523360c48b015260e48a0152606089610104818d865af19a8b156123a2578a988b9a8c9d61235f575b508c15612344575050509082859287519384809263c45a015560e01b82525afa91821561233a5791839185938b926122f8575b50875163e6a4390560e01b8152308882019081526001600160a01b0390921660208301529384929183919082906040015b0392165afa9182156122ee5788926122b4575b505016600c549181156122a65750600160a01b6001600160a81b0319929092161717600c555190815260208101919091526040810192909252907ff3e32527b19e8ae25fb37a06bfd139366d29d0b6a0d83d92597f233ab91173ba90606090a1600160065580f35b835163fc5df7ed60e01b8152fd5b90809250813d83116122e7575b6122cb8183612984565b810103126122e3576122dc90612bcd565b888061223e565b8680fd5b503d6122c1565b85513d8a823e3d90fd5b92839194508092503d8311612333575b6123128183612984565b8101031261232f5761222b84926123298593612bcd565b916121fa565b8880fd5b503d612308565b86513d8b823e3d90fd5b9187916044938a5193635821a6bb60e11b8552840152820152fd5b99509b5098506060883d821161239a575b8161237d60609383612984565b81010312611d085787519887858a01519901519998999b8d6121c7565b3d9150612370565b87513d8c823e3d90fd5b634e487b7160e01b8d52601189528b8dfd5b634e487b7160e01b8c52601188528a8cfd5b848c813d8311612403575b6123e58183612984565b81010312611d08576123fa8b9c9b9a9b612aa7565b50999899612140565b503d6123db565b8551634a1406b160e11b81528086018990528990fd5b855163e602df0560e01b81528086018990528990fd5b85848b8d8a87848f97858451809481938252338b8301525afa9485156124af578795612477575b505051635821a6bb60e11b81529384015282015260449150fd5b9080929550813d83116124a8575b61248f8183612984565b810103126124a457604495505192868061245d565b8580fd5b503d612485565b82513d89823e3d90fd5b809250868092503d83116124e3575b6124d28183612984565b81010312611d08578b90518d612071565b503d6124c8565b85836044935192635821a6bb60e11b84528301526024820152fd5b51631aaf59ff60e11b8152fd5b5050346103245760203660031901126103245760209181906001600160a01b0361253a6128b2565b168152600f845220549051908152f35b5050346103245781600319360112610324576020906002549051908152f35b503461030457606036600319011261030457826125846128b2565b916044359260328411612650575b8451637731a78f60e01b81526001600160a01b03909116918101918252602435602083015260408201939093528290819060600103817f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03165afa90811561264457838092612622575b505061261882519383859485528401906128de565b9060208301520390f35b90915061263a9293503d8091833e6117088183612984565b9190913880612603565b505051903d90823e3d90fd5b60329350612592565b50346103045781600319360112610304576126726128b2565b6024359033156126eb576001600160a01b03169182156126d457508083602095338152600187528181208582528752205582519081527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925843392a35160018152f35b8351634a1406b160e11b8152908101859052602490fd5b835163e602df0560e01b8152808401869052602490fd5b5091346106545780600319360112610654578151918160035492600184811c918186169586156127ed575b6020968785108114610db4578899509688969785829a5291826000146127c657505060011461276a575b505050610d2b9291610d1c910385612984565b9190869350600383527fc2575a0e9e593c00f959f8c92f12db2869c3395a3b0502d05e2516446f71f85b5b8284106127ae5750505082010181610d1c610d2b612757565b8054848a018601528895508794909301928101612795565b60ff19168782015293151560051b86019093019350849250610d1c9150610d2b9050612757565b92607f169261272d565b50503461032457816003193601126103245760209060ff600c5460a01c1690519015158152f35b92505034610304576020366003190112610304573563ffffffff60e01b8116809103610304576020925063543746b160e01b8114908115612861575b5015158152f35b6301ffc9a760e01b1490503861285a565b919082519283825260005b84811061289e575050826000602080949584010152601f8019910116010190565b60208183018101518483018201520161287d565b600435906001600160a01b038216820361142b57565b602435906001600160a01b038216820361142b57565b90815180825260208080930193019160005b8281106128fe575050505090565b8351855293810193928101926001016128f0565b3461142b57600036600319011261142b57602060405160018152f35b6005546001600160a01b0316330361294257565b60405163118cdaa760e01b8152336004820152602490fd5b67ffffffffffffffff811161296e57604052565b634e487b7160e01b600052604160045260246000fd5b90601f8019910116810190811067ffffffffffffffff82111761296e57604052565b916001600160a01b03808416928315612a6b5716928315612a525760009083825281602052604082205490838210612a20575091604082827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef958760209652828652038282205586815220818154019055604051908152a3565b60405163391434e360e21b81526001600160a01b03919091166004820152602481019190915260448101839052606490fd5b60405163ec442f0560e01b815260006004820152602490fd5b604051634b637e8f60e11b815260006004820152602490fd5b91908201809211612a9157565b634e487b7160e01b600052601160045260246000fd5b5190811515820361142b57565b6040516323b872dd60e01b60208201526001600160a01b03928316602482015292909116604483015260648083019390935291815260a081019181831067ffffffffffffffff84111761296e57612b0d92604052612b0f565b565b906000602091828151910182855af115612b6b576000513d612b6257506001600160a01b0381163b155b612b405750565b604051635274afe760e01b81526001600160a01b039091166004820152602490fd5b60011415612b39565b6040513d6000823e3d90fd5b600260065414612b88576002600655565b604051633ee5aeb560e01b8152600490fd5b81810292918115918404141715612a9157565b8115612bb7570490565b634e487b7160e01b600052601260045260246000fd5b51906001600160a01b038216820361142b57565b91908203918211612a9157565b805160011015612bfe5760400190565b634e487b7160e01b600052603260045260246000fd5b9080601f8301121561142b5781519067ffffffffffffffff821161296e578160051b60405193602093612c4985840187612984565b8552838086019282010192831161142b578301905b828210612c6c575050505090565b81518152908301908301612c5e565b600060443d10612cd957604051600319913d83016004833e815167ffffffffffffffff918282113d602484011117612cdc57818401948551938411612ce4573d85010160208487010111612cdc5750612cd992910160200190612984565b90565b949350505050565b50949350505050565b906001600160a01b038216908115612a6b5760009282845283602052604084205490828210612d5a5750817fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef926020928587528684520360408620558060025403600255604051908152a3565b60405163391434e360e21b81526001600160a01b03919091166004820152602481019190915260448101829052606490fd5b6000198114612a915760010190565b91908261010091031261142b57815191602081015191604082015191606081015191612dc960808301612aa7565b9160a081015191612cd960e060c08401519301612bcd565b6001600160a01b0316908115612a52577fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef602082612e23600094600254612a84565b60025584845283825260408420818154019055604051908152a3565b919060408382031261142b57825167ffffffffffffffff811161142b57602091612e6a918501612c14565b92015190565b600c546001600160a01b03908116908115612fda57604051630dfe168160e01b8152602092908381600481855afa918215612b6b578491600093612f9e575b5060405163d21220a760e01b81529190829060049082905afa938415612b6b57600094612f64575b50508116913083149283612f36575b8315612ef3575b50505090565b7f000000000000000000000000000000000000000000000000000000000000000083161492509082612f2a575b5050388080612eed565b16301490503880612f20565b8183167f00000000000000000000000000000000000000000000000000000000000000008416149350612ee6565b8181959293953d8311612f97575b612f7c8183612984565b810103126106545750612f8f8291612bcd565b929038612ed7565b503d612f72565b9182819492943d8311612fd3575b612fb68183612984565b81010312610654575083612fcb600492612bcd565b929091612eaf565b503d612fac565b5050600090565b6201518061300f7f000000000000000000000000000000000000000000000000000000000000000042612be1565b0460018110156130275760010360018111612a915790565b50600190565b60018110156130275760010360018111612a91579056fe17d726ad382ea92487e2c4d01469c94fa17bef35e71d3f4b5414159695c038d2a2646970667358221220d86867bd4b3562791367b90350054a1e1b6db5839df042e23d0df18ad5fd2d9664736f6c63430008140033000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c80000000000000000000000004a7b5da61326a6379179b40d00f57e5bbdc962c2000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc723
Deployed Bytecode
0x6080604081815260048036101561001557600080fd5b600092833560e01c90816301ffc9a71461281e57508063058aafe3146127f757806306fdde0314612702578063095ea7b3146126595780630c5e3d1e1461256957806318160ddd1461254a57806318186c1a146125125780632298e8d314611fc957806323a35de914611f0857806323b872dd14611e155780632f2d11ff14610ef85780632ff2e9dc14611df0578063313ce56714611dd4578063316c3a1214611db557806335fd141414611d8e578063372c89371461174157806348093dd1146117225780634e43603a1461155d578063543746b1146114e1578063579436fc146114c257806358c1cb221461117d5780636186b02514611156578063626c4e5d146110d45780636b4169c31461102b5780636f0e530f1461100e5780636ffc02af14610fd657806370a0823114610f9f578063715018a614610f41578063735de9f714610efd5780637597a9c214610ef8578063808a545714610ecf5780638da5cb5b14610ea65780639023c9d414610e0957806391699d8914610dd157806395d89b4114610cb6578063965b51ee14610a355780639886bf6314610a16578063a7886343146109db578063a9059cbb146109aa578063b42367c4146106df578063ba9a7a56146106ba578063bb502c281461069b578063c003598a14610657578063c23f85d61461054b578063c582951414610457578063cfdbf2541461043b578063d56d229d146103f7578063d9a1ff3a146103d1578063dd1dc325146103b3578063dd62ed3e14610365578063e7c1dbaa14610346578063f060482914610328578063f2a5ffbd146103085763f2fde38b1461027557600080fd5b346103045760203660031901126103045761028e6128b2565b9061029761292e565b6001600160a01b039182169283156102ee575050600554826bffffffffffffffffffffffff60a01b821617600555167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a380f35b51631e4fbdf760e01b8152908101849052602490fd5b8280fd5b5050346103245781600319360112610324576020905160058152f35b5080fd5b50503461032457816003193601126103245760209051620151808152f35b505034610324578160031936011261032457602090600a549051908152f35b5050346103245780600319360112610324576020916103826128b2565b8261038b6128c8565b6001600160a01b03928316845260018652922091166000908152908352819020549051908152f35b50503461032457816003193601126103245760209051620f42408152f35b5050346103245781600319360112610324576020906103ee612e70565b90519015158152f35b505034610324578160031936011261032457517f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc7236001600160a01b03168152602090f35b5050346103245781600319360112610324576020905160328152f35b509034610304576020366003190112610304578051635b15bfd960e01b81528235928101929092526101009182816024817f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc7236001600160a01b03165afa908115610541578460c09594819282918395610504575b505015938493846104f8575b815196875260208701528501526060840152151560808301521560a0820152f35b935082421015936104d7565b93509350505061052a929350803d1061053a575b6105228183612984565b810190612d9b565b50959695949350915038806104cb565b503d610518565b82513d86823e3d90fd5b5091346106545760209081600319360112610654576001600160a01b036105706128b2565b168152600d82528281205492600f83528082205491808452818120549060085491600a54936002549584151560001461064e57600d8852818420546127109081810291818304149015171561063b57856105c991612bad565b935b8715610630576127109081880291888304148815171561061d57506101009a50876105f591612bad565b975b8251998a528901528701526060860152608085015260a084015260c083015260e0820152f35b634e487b7160e01b815260118c52602490fd5b6101009a50976105f7565b634e487b7160e01b855260118b52602485fd5b836105cb565b80fd5b505034610324578160031936011261032457517f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c86001600160a01b03168152602090f35b5050346103245781600319360112610324576020906009549051908152f35b5050346103245781600319360112610324576020905169152d02c7e14af68000008152f35b509034610304576020806003193601126108bd578235926106fe612b77565b82516331a9108f60e11b81528181018590526001600160a01b037f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc723811691908482602481865afa91821561092f57889261096f575b5033908216036109395750835191635b15bfd960e01b83528581840152610100958684602481865afa93841561092f57889789918a918b97610900575b50501590816108f5575b50156108df57908792916107ae8533612de1565b6107ba85600954612a84565b600955338452600e86528684206107d2868254612a84565b9055823b156108bd57865163e7aa0bd760e01b8152828101829052848160248183885af180156108d5579085916108c1575b5050823b156108bd57602484928389519586948593630852cd8d60e31b85528401525af180156108b35761089b575b5050610854620f424060008051602061304583398151915295048092612be1565b8351918252828201527f0e322ecaa09d8958bd44f46d5ccc9356b4ea8b37ab7646e54a8cb95215c90577833392a260085490600954908351928352820152a1600160065580f35b6108a49061295a565b6108af578438610833565b8480fd5b85513d84823e3d90fd5b8380fd5b6108ca9061295a565b6108bd578338610804565b88513d87823e3d90fd5b8551631780a04f60e31b81529182015260249150fd5b90504210153861079a565b92509298505061091d929450803d1061053a576105228183612984565b50509694915091509791903880610790565b86513d8a823e3d90fd5b845163d1344c4560e01b81528084018781523360208201526001600160a01b0390921660408301529081906060010390fd5b0390fd5b9091508481813d83116109a3575b6109878183612984565b8101031261099f5761099890612bcd565b9038610753565b8780fd5b503d61097d565b5050346103245780600319360112610324576020906109d46109ca6128b2565b60243590336129a6565b5160018152f35b505034610324578160031936011261032457602090517f00000000000000000000000000000000000000000000000000000000680e158d8152f35b505034610324578160031936011261032457602090516312cc03008152f35b509034610304576020806003193601126108bd57823592610a54612b77565b82516331a9108f60e11b81528181018590526001600160a01b037f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc72381169291908482602481875afa91821561092f578892610c7f575b503390821603610c4e57508351635b15bfd960e01b8152818101869052946101008087602481875afa96871561092f5788918998610c23575b5050610c0d5790869291610af78733612de1565b610b0387600954612a84565b600955338452600e8552858420610b1b888254612a84565b9055823b156108bd57855163e7aa0bd760e01b8152828101829052848160248183885af18015610c0357908591610bef575b5050823b156108bd57602484928388519586948593630852cd8d60e31b85528401525af18015610be557610bd1575b50506000805160206130458339815191529282519081527f5004ce3f5d960788b0fa52de1cf6796cb4788fc978a91f242f4453ec573cdcf2823392a260085490600954908351928352820152a1600160065580f35b610bda9061295a565b6108bd578338610b7c565b84513d84823e3d90fd5b610bf89061295a565b6108bd578338610b4d565b87513d87823e3d90fd5b8451631780a04f60e31b81529182015260249150fd5b610c3e93985080919250903d1061053a576105228183612984565b509a955050925050503880610ae3565b845163d1344c4560e01b81529182018681523360208201526001600160a01b03909116604082015281906060010390fd5b9091508481813d8311610caf575b610c978183612984565b8101031261099f57610ca890612bcd565b9038610aaa565b503d610c8d565b50913461065457806003193601126106545781519181845492600184811c91818616958615610dc7575b6020968785108114610db4579087899a92868b999a9b529182600014610d8a575050600114610d2f575b8588610d2b89610d1c848a0385612984565b51928284938452830190612872565b0390f35b815286935091907f8a35acfbc15ff81a39ae7d344fd709f28e8600b4aa8c65c6b64bfe7fe36bd19b5b828410610d725750505082010181610d1c610d2b38610d0a565b8054848a018601528895508794909301928101610d58565b60ff19168882015294151560051b87019094019450859350610d1c9250610d2b9150389050610d0a565b634e487b7160e01b835260228a52602483fd5b92607f1692610ce0565b5050346103245760203660031901126103245760209181906001600160a01b03610df96128b2565b168152600d845220549051908152f35b50903461030457602036600319011261030457813591610e27612b77565b8215610e915750610e388233612ced565b610e4482600a54612a84565b600a55338352600f602052808320610e5d838254612a84565b9055519081527f8ec35b69bbf72c30727ea669e861e76d30ee4f53f6261ebc93eb4e0dda31494360203392a2600160065580f35b826024925191633728b83d60e01b8352820152fd5b50503461032457816003193601126103245760055490516001600160a01b039091168152602090f35b505034610324578160031936011261032457600c5490516001600160a01b039091168152602090f35b612912565b505034610324578160031936011261032457517f0000000000000000000000004a7b5da61326a6379179b40d00f57e5bbdc962c26001600160a01b03168152602090f35b8334610654578060031936011261065457610f5a61292e565b600580546001600160a01b031981169091556000906001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b5050346103245760203660031901126103245760209181906001600160a01b03610fc76128b2565b16815280845220549051908152f35b5050346103245760203660031901126103245760209181906001600160a01b03610ffe6128b2565b168152600e845220549051908152f35b505034610324578160031936011261032457602090516103848152f35b50919034610324578160031936011261032457611046612fe1565b91620151806110757f00000000000000000000000000000000000000000000000000000000680e158d42612be1565b04916008549060095492600186116000146110ca576000198601908682116110b7575060a09650935b8151958652602086015284015260608301526080820152f35b634e487b7160e01b815260118852602490fd5b60a096509361109e565b50919034610324578160031936011261032457600b54918215908161114a5761271091828502928584041417156111375750606093506b019d971e4fe8401e740000009004905b80519283526b019d971e4fe8401e740000006020840152820152f35b634e487b7160e01b815260118552602490fd5b9050606093509061111b565b505034610324578160031936011261032457602090516b019d971e4fe8401e740000008152f35b5090346103045780600319360112610304578135916024928335936111a0612b77565b69d3c21bcecceda100000082106114b057620151809283860286159487820414851715611482576312cc03001061149457601483028381046014148415171561148257606480910490886111f48387612be1565b61122d7f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c89461122581303389612ab4565b600b54612a84565b600b556001600160a01b0393841690813b15610304578951632770a7eb60e21b81523387820190815260208101929092529291839182908490829060400103925af1801561147857611465575b5061128785600854612a84565b600855338952602095600d8752878a206112a2878254612a84565b9055620f424086046112b2612fe1565b91838b02908b820485141715611453578383029083820485148415171561144157938996936113028e946127106112fb8d9c9a966112f6610e4260a49c0485612b9a565b612b9a565b0490612a84565b918c519a8b988997637c9441d160e11b895233908901528701528d604487015285015260848401527f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc723165af19182156114375786926113f5575b50600080516020613045833981519152947f15e99197c3eb538357bdfd3038a6a3c001c5446cbb9e11b29a29ef3588d92c089161139a600754612d8c565b60075585518181527fc1b094bd7ee87737194f9ad87e8702d670596561587b51246966bdbfc1784f4f863392a28551938452602084015260408301523391606090a260085490600954908351928352820152a1600160065580f35b9091508281813d8311611430575b61140d8183612984565b8101031261142b57519060008051602061304583398151915261135c565b600080fd5b503d611403565b84513d88823e3d90fd5b634e487b7160e01b8d5260118752878dfd5b634e487b7160e01b8c5260118652868cfd5b6114719099919961295a565b973861127a565b88513d8c823e3d90fd5b50634e487b7160e01b87526011905285fd5b610e4260449287875193633534c47760e21b8552840152820152fd5b9251633728b83d60e01b815291820152fd5b5050346103245781600319360112610324576020906008549051908152f35b50346103045781600319360112610304576114fa6128b2565b507f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c86001600160a01b03169133839003611532578380f35b516375287b7b60e01b8152339181019182526001600160a01b03909216602082015281906040010390fd5b50903461030457602091826003193601126108bd576001600160a01b0391826115846128b2565b1692838652600d8552818620549486815282872054917f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc7231693835195637731a78f60e01b875281870152602497808988015260329182604489015281886064818a5afa9788156117185782986116f3575b5087519682988489116000146116ec57845b845b86811061162a5760808d8d8d8d8d8d82519586528501528301526060820152f35b82518110156116db578d888260051b850101518b51918291635b15bfd960e01b83528883015261010092839181895afa9081156116d157889289926116a8575b505015908161169d575b50611688575b61168390612d8c565b611609565b9a61169561168391612d8c565b9b905061167a565b905042101538611674565b6116c2935080919250903d1061053a576105228183612984565b5050509350505090388061166a565b8c513d8a823e3d90fd5b634e487b7160e01b86528185528d86fd5b8894611607565b6117109198503d8084833e6117088183612984565b810190612e3f565b5096386115f5565b86513d84823e3d90fd5b5050346103245781600319360112610324576020906007549051908152f35b50823461065457602092836003193601126103245761175e612b77565b600c549060ff8260a01c1615611d7f576001600160a01b0391821615611d7057600b54926b019d971e4fe8401e74000000808510611d54575080600b556005840284810460051485151715611d415760649004926117bc8486612be1565b835163a9059cbb60e01b898201523360248083019190915260448083018890528252957f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c89161181690611810606482612984565b83612b0f565b85519081527faac43248a49ce7ac3056cca2199ed9ac94d3b38b7981d36979273d8aaca272798a3392a284519267ffffffffffffffff926060850184811186821017611d2f578752600285528a85019287368537828116865115611d1d5790816118e08e879695948f98523061188b8b612bee565b528b51636eb1769f60e11b8152309881019889527f0000000000000000000000004a7b5da61326a6379179b40d00f57e5bbdc962c287166001600160a01b03811660208b015298909283918291604090910190565b0381855afa908115611d13578f9192888d8f938e979689918991611ccb575b5061194a989261191488959361195893612a84565b905163095ea7b360e01b8682018181526001600160a01b0390951698820198895260208901929092529990968a91604090910190565b03601f1981018a5289612984565b87519082885af1903d8d519083611cac575b50505015611c56575b50505050610384420191824211611c4457918794928c94928e8c998c519a8b986338ed173960e01b8a5260a48a0194818b0152359089015260a060448901525180925260c48701949288915b838310611c1c5750505050508380928692336064840152608483015203925af19182918493611be1575b5050611b8057508060033d11611b70575b506308c379a014611acb575b7f666b4c8a15b59a26f75400d41fda7fa486f21ec3c2a6ef36f1adfceb8b25361b61096b938251809160608252611a8f611a6860608401604090601781527614ddd85c081d1c985b9cd858dd1a5bdb8819985a5b1959604a1b60208201520190565b8381038b850152600d81526c2ab735b737bbb71032b93937b960991b602082015260400190565b90858301520390a1519384936331f2047d60e01b85528401528201604090600d81526c2ab735b737bbb71032b93937b960991b60208201520190565b611ad3612c7b565b80611ade5750611a06565b91907f666b4c8a15b59a26f75400d41fda7fa486f21ec3c2a6ef36f1adfceb8b25361b61096b948251809160608252611b4f611b4260608401604090601781527614ddd85c081d1c985b9cd858dd1a5bdb8819985a5b1959604a1b60208201520190565b8381038c85015288612872565b90858301520390a1519485946331f2047d60e01b8652850152830190612872565b90508481803e5160e01c866119fa565b7f8ec35b69bbf72c30727ea669e861e76d30ee4f53f6261ebc93eb4e0dda31494387611bac8593612bee565b5192611bb98430336129a6565b611bc38430612ced565b611bcf84600a54612a84565b600a55519283523092a2600160065580f35b909192503d8085843e611bf48184612984565b82019189818403126108af5780519182116108af57611c14929101612c14565b9088806119e9565b919496985092965080600192958489511681520196019201928895938f928b989694936119bf565b634e487b7160e01b885260118c528988fd5b8b5191820152868c820152896044820152604481526080810181811089821117611c9a57611c91939291611c8c918d5282612b0f565b612b0f565b8c808d81611973565b634e487b7160e01b8b5260418f528c8bfd5b91925090611cc157503b15155b38808061196a565b6001915014611cb9565b9695505050505092935081813d8311611d0c575b611ce98183612984565b81010312611d0857518992918f918d919089908e90889061194a6118ff565b8980fd5b503d611cdf565b8b513d8c823e3d90fd5b634e487b7160e01b885260328c528988fd5b634e487b7160e01b875260418b528887fd5b634e487b7160e01b825260118652602482fd5b8560449186855192635e95573b60e11b84528301526024820152fd5b5163fc5df7ed60e01b81528390fd5b51632c73914160e21b81528390fd5b5091346106545760203660031901126106545750611dae6020923561302d565b9051908152f35b505034610324578160031936011261032457602090600b549051908152f35b5050346103245781600319360112610324576020905160128152f35b50503461032457816003193601126103245760209051690a968163f0a57b4000008152f35b50823461065457606036600319011261065457611e306128b2565b611e386128c8565b916044359360018060a01b038316808352600160205286832033845260205286832054916000198310611e74575b6020886109d48989896129a6565b868310611edc578115611ec5573315611eae575082526001602090815286832033845281529186902090859003905582906109d487611e66565b8751634a1406b160e11b8152908101849052602490fd5b875163e602df0560e01b8152908101849052602490fd5b8751637dc7a0d960e11b8152339181019182526020820193909352604081018790528291506060010390fd5b5090346103045760203660031901126103045782611f246128b2565b8251637731a78f60e01b81526001600160a01b039182169481019490945260248401829052600a6044850152839060649082907f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc723165afa918215611fbf5783610d2b9493611fa1575b5050519182916020835260208301906128de565b611fb69293503d8091833e6117088183612984565b50903880611f8d565b81513d85823e3d90fd5b508234610654576020918260031936011261032457803593611fe961292e565b611ff1612b77565b60ff600c5460a01c166125055769152d02c7e14af6800000918286106124ea5781516370a0823160e01b80825233838301526024966001600160a01b039290917f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c88481169290919084818c81875afa90811561147857908c918b916124b9575b50106124365750896120869130903390612ab4565b827f0000000000000000000000004a7b5da61326a6379179b40d00f57e5bbdc962c216301561242057801561240a57308852600183528588208189528352690a968163f0a57b400000998a878a20558187518c81527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925863092a3865163095ea7b360e01b81526001600160a01b03831687820190815260208101839052909b9085908d90819060400103818d885af18015611478576123d0575b8a9b50605f829b9a9b02828104605f14831517156123be576103844201918242116123ac57895162e8e33760e81b8152308a8201529b8c0186905260448c015260648b8101849052690a0efaebbe36ceb0000060848d0152900460a48b01523360c48b015260e48a0152606089610104818d865af19a8b156123a2578a988b9a8c9d61235f575b508c15612344575050509082859287519384809263c45a015560e01b82525afa91821561233a5791839185938b926122f8575b50875163e6a4390560e01b8152308882019081526001600160a01b0390921660208301529384929183919082906040015b0392165afa9182156122ee5788926122b4575b505016600c549181156122a65750600160a01b6001600160a81b0319929092161717600c555190815260208101919091526040810192909252907ff3e32527b19e8ae25fb37a06bfd139366d29d0b6a0d83d92597f233ab91173ba90606090a1600160065580f35b835163fc5df7ed60e01b8152fd5b90809250813d83116122e7575b6122cb8183612984565b810103126122e3576122dc90612bcd565b888061223e565b8680fd5b503d6122c1565b85513d8a823e3d90fd5b92839194508092503d8311612333575b6123128183612984565b8101031261232f5761222b84926123298593612bcd565b916121fa565b8880fd5b503d612308565b86513d8b823e3d90fd5b9187916044938a5193635821a6bb60e11b8552840152820152fd5b99509b5098506060883d821161239a575b8161237d60609383612984565b81010312611d085787519887858a01519901519998999b8d6121c7565b3d9150612370565b87513d8c823e3d90fd5b634e487b7160e01b8d52601189528b8dfd5b634e487b7160e01b8c52601188528a8cfd5b848c813d8311612403575b6123e58183612984565b81010312611d08576123fa8b9c9b9a9b612aa7565b50999899612140565b503d6123db565b8551634a1406b160e11b81528086018990528990fd5b855163e602df0560e01b81528086018990528990fd5b85848b8d8a87848f97858451809481938252338b8301525afa9485156124af578795612477575b505051635821a6bb60e11b81529384015282015260449150fd5b9080929550813d83116124a8575b61248f8183612984565b810103126124a457604495505192868061245d565b8580fd5b503d612485565b82513d89823e3d90fd5b809250868092503d83116124e3575b6124d28183612984565b81010312611d08578b90518d612071565b503d6124c8565b85836044935192635821a6bb60e11b84528301526024820152fd5b51631aaf59ff60e11b8152fd5b5050346103245760203660031901126103245760209181906001600160a01b0361253a6128b2565b168152600f845220549051908152f35b5050346103245781600319360112610324576020906002549051908152f35b503461030457606036600319011261030457826125846128b2565b916044359260328411612650575b8451637731a78f60e01b81526001600160a01b03909116918101918252602435602083015260408201939093528290819060600103817f000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc7236001600160a01b03165afa90811561264457838092612622575b505061261882519383859485528401906128de565b9060208301520390f35b90915061263a9293503d8091833e6117088183612984565b9190913880612603565b505051903d90823e3d90fd5b60329350612592565b50346103045781600319360112610304576126726128b2565b6024359033156126eb576001600160a01b03169182156126d457508083602095338152600187528181208582528752205582519081527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925843392a35160018152f35b8351634a1406b160e11b8152908101859052602490fd5b835163e602df0560e01b8152808401869052602490fd5b5091346106545780600319360112610654578151918160035492600184811c918186169586156127ed575b6020968785108114610db4578899509688969785829a5291826000146127c657505060011461276a575b505050610d2b9291610d1c910385612984565b9190869350600383527fc2575a0e9e593c00f959f8c92f12db2869c3395a3b0502d05e2516446f71f85b5b8284106127ae5750505082010181610d1c610d2b612757565b8054848a018601528895508794909301928101612795565b60ff19168782015293151560051b86019093019350849250610d1c9150610d2b9050612757565b92607f169261272d565b50503461032457816003193601126103245760209060ff600c5460a01c1690519015158152f35b92505034610304576020366003190112610304573563ffffffff60e01b8116809103610304576020925063543746b160e01b8114908115612861575b5015158152f35b6301ffc9a760e01b1490503861285a565b919082519283825260005b84811061289e575050826000602080949584010152601f8019910116010190565b60208183018101518483018201520161287d565b600435906001600160a01b038216820361142b57565b602435906001600160a01b038216820361142b57565b90815180825260208080930193019160005b8281106128fe575050505090565b8351855293810193928101926001016128f0565b3461142b57600036600319011261142b57602060405160018152f35b6005546001600160a01b0316330361294257565b60405163118cdaa760e01b8152336004820152602490fd5b67ffffffffffffffff811161296e57604052565b634e487b7160e01b600052604160045260246000fd5b90601f8019910116810190811067ffffffffffffffff82111761296e57604052565b916001600160a01b03808416928315612a6b5716928315612a525760009083825281602052604082205490838210612a20575091604082827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef958760209652828652038282205586815220818154019055604051908152a3565b60405163391434e360e21b81526001600160a01b03919091166004820152602481019190915260448101839052606490fd5b60405163ec442f0560e01b815260006004820152602490fd5b604051634b637e8f60e11b815260006004820152602490fd5b91908201809211612a9157565b634e487b7160e01b600052601160045260246000fd5b5190811515820361142b57565b6040516323b872dd60e01b60208201526001600160a01b03928316602482015292909116604483015260648083019390935291815260a081019181831067ffffffffffffffff84111761296e57612b0d92604052612b0f565b565b906000602091828151910182855af115612b6b576000513d612b6257506001600160a01b0381163b155b612b405750565b604051635274afe760e01b81526001600160a01b039091166004820152602490fd5b60011415612b39565b6040513d6000823e3d90fd5b600260065414612b88576002600655565b604051633ee5aeb560e01b8152600490fd5b81810292918115918404141715612a9157565b8115612bb7570490565b634e487b7160e01b600052601260045260246000fd5b51906001600160a01b038216820361142b57565b91908203918211612a9157565b805160011015612bfe5760400190565b634e487b7160e01b600052603260045260246000fd5b9080601f8301121561142b5781519067ffffffffffffffff821161296e578160051b60405193602093612c4985840187612984565b8552838086019282010192831161142b578301905b828210612c6c575050505090565b81518152908301908301612c5e565b600060443d10612cd957604051600319913d83016004833e815167ffffffffffffffff918282113d602484011117612cdc57818401948551938411612ce4573d85010160208487010111612cdc5750612cd992910160200190612984565b90565b949350505050565b50949350505050565b906001600160a01b038216908115612a6b5760009282845283602052604084205490828210612d5a5750817fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef926020928587528684520360408620558060025403600255604051908152a3565b60405163391434e360e21b81526001600160a01b03919091166004820152602481019190915260448101829052606490fd5b6000198114612a915760010190565b91908261010091031261142b57815191602081015191604082015191606081015191612dc960808301612aa7565b9160a081015191612cd960e060c08401519301612bcd565b6001600160a01b0316908115612a52577fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef602082612e23600094600254612a84565b60025584845283825260408420818154019055604051908152a3565b919060408382031261142b57825167ffffffffffffffff811161142b57602091612e6a918501612c14565b92015190565b600c546001600160a01b03908116908115612fda57604051630dfe168160e01b8152602092908381600481855afa918215612b6b578491600093612f9e575b5060405163d21220a760e01b81529190829060049082905afa938415612b6b57600094612f64575b50508116913083149283612f36575b8315612ef3575b50505090565b7f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c883161492509082612f2a575b5050388080612eed565b16301490503880612f20565b8183167f000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c88416149350612ee6565b8181959293953d8311612f97575b612f7c8183612984565b810103126106545750612f8f8291612bcd565b929038612ed7565b503d612f72565b9182819492943d8311612fd3575b612fb68183612984565b81010312610654575083612fcb600492612bcd565b929091612eaf565b503d612fac565b5050600090565b6201518061300f7f00000000000000000000000000000000000000000000000000000000680e158d42612be1565b0460018110156130275760010360018111612a915790565b50600190565b60018110156130275760010360018111612a91579056fe17d726ad382ea92487e2c4d01469c94fa17bef35e71d3f4b5414159695c038d2a2646970667358221220d86867bd4b3562791367b90350054a1e1b6db5839df042e23d0df18ad5fd2d9664736f6c63430008140033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c80000000000000000000000004a7b5da61326a6379179b40d00f57e5bbdc962c2000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc723
-----Decoded View---------------
Arg [0] : _xen (address): 0xeB585163DEbB1E637c6D617de3bEF99347cd75c8
Arg [1] : _router (address): 0x4A7b5Da61326A6379179b40d00F57E5bbDC962c2
Arg [2] : _nft (address): 0xD7DD1997Ed8d5b836099e5D28FeD1A9d8e9Cc723
-----Encoded View---------------
3 Constructor Arguments found :
Arg [0] : 000000000000000000000000eb585163debb1e637c6d617de3bef99347cd75c8
Arg [1] : 0000000000000000000000004a7b5da61326a6379179b40d00f57e5bbdc962c2
Arg [2] : 000000000000000000000000d7dd1997ed8d5b836099e5d28fed1a9d8e9cc723
Loading...
Loading
[ Download: CSV Export ]
[ Download: CSV Export ]
A token is a representation of an on-chain or off-chain asset. The token page shows information such as price, total supply, holders, transfers and social links. Learn more about this page in our Knowledge Base.
Add Token to MetaMask (Web3)