Latest 25 from a total of 2,343 transactions
| Transaction Hash |
|
Block
|
From
|
To
|
|||||
|---|---|---|---|---|---|---|---|---|---|
| Fight | 38434854 | 39 hrs ago | IN | 0 ETH | 0.00000012 | ||||
| Fight | 38434809 | 39 hrs ago | IN | 0 ETH | 0.00000013 | ||||
| Fight | 38243466 | 3 days ago | IN | 0 ETH | 0.00000012 | ||||
| Fight | 38243440 | 3 days ago | IN | 0 ETH | 0.00000012 | ||||
| Fight | 38243340 | 3 days ago | IN | 0 ETH | 0.00000012 | ||||
| Fight | 38172996 | 4 days ago | IN | 0 ETH | 0.00000009 | ||||
| Fight | 38172898 | 4 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 38092327 | 5 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 38092272 | 5 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37999910 | 6 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37999808 | 6 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37999789 | 6 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37913294 | 7 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37838656 | 8 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37838466 | 8 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37838365 | 8 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37838339 | 8 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37838306 | 8 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37653825 | 10 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37653774 | 10 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37575415 | 11 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37575384 | 11 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37575337 | 11 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37393520 | 13 days ago | IN | 0 ETH | 0.00000008 | ||||
| Fight | 37393430 | 13 days ago | IN | 0 ETH | 0.00000008 |
View more zero value Internal Transactions in Advanced View mode
Cross-Chain Transactions
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity 0.8.26;
import {UnimonV2} from "./UnimonV2.sol";
import {UnimonEquipment} from "./UnimonEquipment.sol";
/**
* @title UnimonSlayer
* @notice Super simple contract to fight monsters in the wild.
* @dev Fully on-chain, no external randomness. Randomness uses block contextual values and is not secure.
*
* Features:
* - fight(tokenId, monsterId): rolls a biased-random outcome based on token's power vs monster difficulty
* - msg.sender must own tokenId
* - 5 predefined monsters with names and difficulty levels
* - Tracks total fights and wins per token
* - On-chain queries: get single or multiple monster records by ID
*/
contract UnimonSlayer {
UnimonV2 public immutable unimon;
UnimonEquipment public immutable equipment;
address public owner;
struct Monster {
string name; // Monster display name
uint8 difficulty; // 1-20 scale (Unimon power is attack+defense; max 20)
bool active; // Whether the monster can be fought
}
Monster[] public monsters;
/// @notice Per-token fight stats
mapping(uint256 => uint256) public totalFightsForToken;
mapping(uint256 => uint256) public totalWinsForToken;
/// @notice Emitted after each fight
/// @param user The fighter (must own tokenId)
/// @param tokenId The Unimon used to fight
/// @param monsterId The monster being fought
/// @param won True if the roll succeeded
/// @param power Current Unimon power (attack+defense)
/// @param difficulty Monster difficulty used for the roll
event MonsterFought(
address indexed user,
uint256 indexed tokenId,
uint256 indexed monsterId,
bool won,
uint256 power,
uint8 difficulty
);
constructor(address _equipment) {
equipment = UnimonEquipment(_equipment);
unimon = equipment.unimonV2();
owner = msg.sender;
// Preconfigure 5 monsters with increasing difficulty (max power is 20)
monsters.push(Monster({name: "Impling", difficulty: 2, active: true}));
monsters.push(Monster({name: "Slime", difficulty: 5, active: true}));
monsters.push(Monster({name: "Swarm", difficulty: 8, active: true}));
monsters.push(Monster({name: "Ogre", difficulty: 12, active: true}));
monsters.push(Monster({name: "Dragon", difficulty: 16, active: true}));
}
modifier onlyOwner() {
require(msg.sender == owner, "Not owner");
_;
}
function transferOwnership(address newOwner) external onlyOwner {
require(newOwner != address(0), "Zero owner");
owner = newOwner;
}
/**
* @notice Returns total number of configured monsters
*/
function monsterCount() external view returns (uint256) {
return monsters.length;
}
/**
* @notice Get a monster by ID
* @param monsterId The monster ID to fetch
* @return name The monster name
* @return difficulty The monster difficulty (1-20)
* @return active Whether the monster is active
*/
function getMonster(
uint256 monsterId
) external view returns (string memory name, uint8 difficulty, bool active) {
require(monsterId < monsters.length, "Invalid monster");
Monster memory m = monsters[monsterId];
return (m.name, m.difficulty, m.active);
}
/**
* @notice Batch fetch monsters by IDs
* @param ids Array of monster IDs to fetch
* @return out Array of Monster records (name, difficulty, active)
*/
function getMonstersByIds(uint256[] calldata ids) external view returns (Monster[] memory out) {
out = new Monster[](ids.length);
for (uint256 i = 0; i < ids.length; i++) {
require(ids[i] < monsters.length, "Invalid monster");
out[i] = monsters[ids[i]];
}
}
function addMonster(string calldata name, uint8 difficulty, bool active) external onlyOwner returns (uint256 monsterId) {
require(bytes(name).length > 0, "Name empty");
require(difficulty > 0 && difficulty <= 20, "Bad diff");
monsterId = monsters.length;
monsters.push(Monster({name: name, difficulty: difficulty, active: active}));
}
function updateMonster(uint256 monsterId, string calldata name, uint8 difficulty, bool active) external onlyOwner {
require(monsterId < monsters.length, "Invalid monster");
require(bytes(name).length > 0, "Name empty");
require(difficulty > 0 && difficulty <= 20, "Bad diff");
monsters[monsterId] = Monster({name: name, difficulty: difficulty, active: active});
}
function setMonsterActive(uint256 monsterId, bool active) external onlyOwner {
require(monsterId < monsters.length, "Invalid monster");
monsters[monsterId].active = active;
}
function removeMonster(uint256 monsterId) external onlyOwner {
require(monsterId < monsters.length, "Invalid monster");
monsters[monsterId].name = "";
monsters[monsterId].difficulty = 0;
monsters[monsterId].active = false;
}
/**
* @notice Returns current Unimon power as attack+defense.
* @dev Reads stats from UnimonV2.
*/
function getUnimonPower(uint256 tokenId) public view returns (uint256) {
(int256 attackLevel, int256 defenseLevel, ) = equipment.getModifiedStats(tokenId);
uint256 atk = attackLevel <= 0 ? 1 : uint256(attackLevel);
uint256 def = defenseLevel <= 0 ? 1 : uint256(defenseLevel);
return atk + def;
}
/**
* @notice Fight a monster. Fully random outcome biased slightly by (power - difficulty).
* - Win probability p = clamp(50 + 3*(power - difficulty), 10..90)%
* This gives ~3% per point advantage/disadvantage, capped at 10%-90%.
* @param tokenId Unimon token to fight with (must be owned by msg.sender)
* @param monsterId Monster to fight
* @return won True if fight succeeded
*/
function fight(uint256 tokenId, uint256 monsterId) external returns (bool won) {
require(unimon.ownerOf(tokenId) == msg.sender, "Not token owner");
require(monsterId < monsters.length && monsters[monsterId].active, "Invalid monster");
uint256 power = getUnimonPower(tokenId);
uint8 difficulty = monsters[monsterId].difficulty;
// Compute probability in percent (0-100) with slight slope and equipment overall percent bonus
( , , int256 overallPercent) = equipment.getModifiedStats(tokenId);
int256 diff = int256(power) - int256(uint256(difficulty));
int256 p = 50 + (diff * 3) + overallPercent; // add overall % directly
if (p < 10) p = 10;
if (p > 90) p = 90;
uint256 chance = uint256(int256(p));
uint256 rand = _random(tokenId) % 100; // 0-99
won = rand < chance;
totalFightsForToken[tokenId] += 1;
if (won) totalWinsForToken[tokenId] += 1;
emit MonsterFought(msg.sender, tokenId, monsterId, won, power, difficulty);
return won;
}
/**
* @notice Pseudo-random generator; DO NOT use for security-critical randomness.
* @dev Uses block.prevrandao and other contextual data to vary results between calls.
*/
function _random(uint256 tokenId) internal view returns (uint256) {
// NOTE: Not secure randomness; adequate for gamey mechanics.
// Uses changing inputs to avoid trivial predictability.
return
uint256(
keccak256(
abi.encodePacked(
block.prevrandao,
block.timestamp,
msg.sender,
tokenId,
totalFightsForToken[tokenId]
)
)
);
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.26;
import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";
import {ERC721} from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import {ERC721Burnable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Burnable.sol";
import {ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
import {UnimonItems} from "./UnimonItems.sol";
/**
* @title UnimonV2
* @author Unimon Team
* @notice ERC721 NFT contract for Unimon characters with evolution mechanics
* @dev This contract implements the core Unimon NFT functionality
*
* Key features:
* - ERC721 standard with enumeration and burnable extensions
* - Evolution system using energy tokens
* - Customizable names for each Unimon
* - Attack and defense stats with random evolution bonuses
* - Supply management with configurable max supply
* - Role-based access control for minting
*
* @custom:security This contract uses OpenZeppelin's AccessControl, ERC721Burnable, and ERC721Enumerable
*/
contract UnimonV2 is ERC721, ERC721Enumerable, AccessControl, ERC721Burnable {
/// @notice Role for entities that can mint new Unimon NFTs
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
/// @notice Reference to the UnimonItems contract for energy consumption
UnimonItems public unimonItems;
/// @notice Next token ID to be minted
uint256 private _nextTokenId;
/// @notice Maximum supply of Unimon NFTs
uint256 public maxSupply = 10000;
/// @notice Whether evolution functionality is currently enabled
bool public evolutionsEnabled = true;
/// @notice Mapping of token ID to Unimon stats
mapping(uint256 => UnimonStats) public unimonStats;
/// @notice Structure containing Unimon character statistics
/// @param attackLevel Current attack level (1-10)
/// @param defenseLevel Current defense level (1-10)
/// @param evolved Whether this Unimon has been evolved
/// @param name Custom name given to this Unimon
struct UnimonStats {
uint256 attackLevel;
uint256 defenseLevel;
bool evolved;
string name;
}
/// @notice Emitted when a Unimon is evolved
/// @param tokenId ID of the evolved Unimon
/// @param energyAmount Amount of energy used for evolution
/// @param newAttackLevel New attack level after evolution
/// @param newDefenseLevel New defense level after evolution
event UnimonEvolved(uint256 indexed tokenId, uint256 energyAmount, uint256 newAttackLevel, uint256 newDefenseLevel);
/// @notice Emitted when a Unimon's name is set
/// @param tokenId ID of the Unimon
/// @param name New name for the Unimon
event UnimonNameSet(uint256 indexed tokenId, string name);
/// @notice Emitted when max supply is updated
/// @param oldMaxSupply Previous max supply value
/// @param newMaxSupply New max supply value
event MaxSupplyUpdated(uint256 oldMaxSupply, uint256 newMaxSupply);
/// @notice Emitted when evolution functionality is toggled
/// @param enabled Whether evolutions are now enabled or disabled
event EvolutionsToggled(bool enabled);
/**
* @notice Constructor for UnimonV2 contract
* @param _unimonItems Address of the UnimonItems contract
*/
constructor(address _unimonItems) ERC721("UnimonV2", "UNIMON") {
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
unimonItems = UnimonItems(_unimonItems);
}
/*
VIEW FUNCTIONS
*/
/**
* @notice Get the base URI for token metadata
* @return Base URI string for token metadata
* @dev Override of ERC721 _baseURI function
*/
function _baseURI() internal pure override returns (string memory) {
return "https://v2.unimon.app/unimon/";
}
/**
* @notice Mint a new Unimon NFT to an address
* @param to Address to mint the NFT to
* @return tokenId ID of the newly minted NFT
* @dev Only callable by MINTER_ROLE
* @dev Creates default stats (attack: 1, defense: 1, evolved: false)
* @dev Assigns default name "Unimon #[tokenId]"
*/
function safeMint(address to) public onlyRole(MINTER_ROLE) returns (uint256) {
require(_nextTokenId < maxSupply, "Hard cap reached");
uint256 tokenId = _nextTokenId++;
_safeMint(to, tokenId);
string memory defaultName = string(abi.encodePacked("Unimon #", Strings.toString(tokenId)));
unimonStats[tokenId] = UnimonStats({attackLevel: 1, defenseLevel: 1, evolved: false, name: defaultName});
return tokenId;
}
/**
* @notice Get the stats for a specific Unimon
* @param tokenId ID of the Unimon to get stats for
* @return attackLevel Current attack level
* @return defenseLevel Current defense level
* @return evolved Whether the Unimon has been evolved
* @return name Custom name of the Unimon
* @dev Reverts if token does not exist
*/
function getUnimonStats(
uint256 tokenId
) external view returns (uint256 attackLevel, uint256 defenseLevel, bool evolved, string memory name) {
require(_ownerOf(tokenId) != address(0), "Token does not exist");
UnimonStats memory stats = unimonStats[tokenId];
return (stats.attackLevel, stats.defenseLevel, stats.evolved, stats.name);
}
/**
* @notice Get the name of a specific Unimon
* @param tokenId ID of the Unimon to get name for
* @return name Custom name of the Unimon
* @dev Reverts if token does not exist
*/
function getUnimonName(uint256 tokenId) external view returns (string memory) {
require(_ownerOf(tokenId) != address(0), "Token does not exist");
return unimonStats[tokenId].name;
}
/**
* @notice Get all Unimon owned by an address with their stats
* @param owner Address to get Unimon for
* @return tokenIds Array of token IDs owned by the address
* @return attackLevels Array of attack levels for each Unimon
* @return defenseLevels Array of defense levels for each Unimon
* @return evolvedStates Array of evolution states for each Unimon
* @return names Array of names for each Unimon
*/
function getAllUnimonForAddress(
address owner
)
external
view
returns (
uint256[] memory tokenIds,
uint256[] memory attackLevels,
uint256[] memory defenseLevels,
bool[] memory evolvedStates,
string[] memory names
)
{
uint256 balance = balanceOf(owner);
tokenIds = new uint256[](balance);
attackLevels = new uint256[](balance);
defenseLevels = new uint256[](balance);
evolvedStates = new bool[](balance);
names = new string[](balance);
for (uint256 i = 0; i < balance; i++) {
uint256 tokenId = tokenOfOwnerByIndex(owner, i);
tokenIds[i] = tokenId;
UnimonStats memory stats = unimonStats[tokenId];
attackLevels[i] = stats.attackLevel;
defenseLevels[i] = stats.defenseLevel;
evolvedStates[i] = stats.evolved;
names[i] = stats.name;
}
}
/**
* @notice Set the maximum supply of Unimon NFTs
* @param _maxSupply New maximum supply value
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @dev Cannot be set below current supply
*/
function setMaxSupply(uint256 _maxSupply) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(_maxSupply >= _nextTokenId, "Cannot set max supply below current supply");
uint256 oldMaxSupply = maxSupply;
maxSupply = _maxSupply;
emit MaxSupplyUpdated(oldMaxSupply, _maxSupply);
}
/**
* @notice Get the current number of minted Unimon
* @return Current supply count
*/
function getCurrentSupply() external view returns (uint256) {
return _nextTokenId;
}
/**
* @notice Get the remaining number of Unimon that can be minted
* @return Remaining supply available for minting
*/
function getRemainingSupply() external view returns (uint256) {
return maxSupply - _nextTokenId;
}
/*
INTERNAL FUNCTIONS
*/
/**
* @notice Calculate evolution stat bonuses based on energy amount
* @param energyAmount Amount of energy used for evolution (1-10)
* @param tokenId ID of the Unimon being evolved
* @return attackBonus Bonus attack points to add
* @return defenseBonus Bonus defense points to add
* @dev Uses deterministic randomness based on tokenId, timestamp, sender, and energy amount
* @dev Total stats range from energyAmount to 2x energyAmount (capped at 18)
* @dev Each stat is capped at 9 bonus points (total stat max 10)
* @dev Higher energy amounts have 40% chance to reduce total stats by 1
*/
function _calculateEvolutionStats(
uint256 energyAmount,
uint256 tokenId
) internal view returns (uint256 attackBonus, uint256 defenseBonus) {
bytes32 seed = keccak256(abi.encodePacked(tokenId, block.timestamp, msg.sender, energyAmount));
uint256 hash = uint256(seed);
// Choose total stats between energyAmount and 2x energy amount
uint256 minStats = energyAmount;
uint256 maxStats = energyAmount * 2;
uint256 totalStats = minStats + (hash % (maxStats - minStats + 1));
// Cap totalStats at 18 (max possible with 9+9)
if (totalStats > 18) {
totalStats = 18;
}
if (energyAmount >= 9) {
// 40% chance to reduce totalStats by 1
uint256 biasSeed = uint256(keccak256(abi.encodePacked(seed, "bias")));
if (biasSeed % 100 < 40) {
if (totalStats > minStats + 1) {
totalStats -= 1;
}
}
}
// Randomly distribute between attack and defense
uint256 attackSeed = uint256(keccak256(abi.encodePacked(seed, "attack")));
attackBonus = attackSeed % (totalStats + 1); // 0 to totalStats
defenseBonus = totalStats - attackBonus;
// Cap each skill at 9 bonus (since base is 1, total will be 10)
// Redistribute excess to ensure no stats are lost
if (attackBonus > 9) {
uint256 excess = attackBonus - 9;
attackBonus = 9;
defenseBonus = defenseBonus + excess;
}
if (defenseBonus > 9) {
uint256 excess = defenseBonus - 9;
defenseBonus = 9;
attackBonus = attackBonus + excess > 9 ? 9 : attackBonus + excess;
}
return (attackBonus, defenseBonus);
}
/*
USER WRITE FUNCTIONS
*/
/**
* @notice Evolve a Unimon using energy tokens
* @param tokenId ID of the Unimon to evolve
* @param energyAmount Amount of energy to use for evolution (1-10)
* @dev This function:
* - Verifies ownership of the Unimon
* - Validates energy amount and availability
* - Consumes energy tokens
* - Calculates random stat bonuses
* - Updates Unimon stats and marks as evolved
* - Emits UnimonEvolved event
*/
function evolve(uint256 tokenId, uint256 energyAmount) external {
require(ownerOf(tokenId) == msg.sender, "You don't own this Unimon");
require(energyAmount >= 1 && energyAmount <= 10, "Energy amount must be 1-10");
require(!unimonStats[tokenId].evolved, "Unimon already evolved");
require(evolutionsEnabled, "Evolutions are currently disabled");
uint256 energyId = unimonItems.ENERGY_ID();
require(unimonItems.balanceOf(msg.sender, energyId) > 0, "Insufficient energy");
unimonItems.spendItem(msg.sender, energyId, energyAmount);
(uint256 attackBonus, uint256 defenseBonus) = _calculateEvolutionStats(energyAmount, tokenId);
uint256 newAttackLevel = unimonStats[tokenId].attackLevel + attackBonus;
uint256 newDefenseLevel = unimonStats[tokenId].defenseLevel + defenseBonus;
unimonStats[tokenId].attackLevel = newAttackLevel;
unimonStats[tokenId].defenseLevel = newDefenseLevel;
unimonStats[tokenId].evolved = true;
emit UnimonEvolved(tokenId, energyAmount, newAttackLevel, newDefenseLevel);
}
/**
* @notice Set a custom name for a Unimon
* @param tokenId ID of the Unimon to name
* @param name New name for the Unimon (1-24 characters)
* @dev Only the owner of the Unimon can set its name
* @dev Name cannot be empty or longer than 24 characters
*/
function setUnimonName(uint256 tokenId, string calldata name) external {
require(ownerOf(tokenId) == msg.sender, "You don't own this Unimon");
require(bytes(name).length > 0, "Name cannot be empty");
require(bytes(name).length <= 24, "Name too long");
unimonStats[tokenId].name = name;
emit UnimonNameSet(tokenId, name);
}
/**
* @notice Toggle whether evolution functionality is enabled
* @param _enabled Whether to enable or disable evolutions
* @dev Only callable by DEFAULT_ADMIN_ROLE
*/
function toggleEvolutions(bool _enabled) external onlyRole(DEFAULT_ADMIN_ROLE) {
evolutionsEnabled = _enabled;
emit EvolutionsToggled(_enabled);
}
/*
OVERRIDES
*/
/**
* @dev Override to support both ERC721 and ERC721Enumerable
*/
function _update(
address to,
uint256 tokenId,
address auth
) internal override(ERC721, ERC721Enumerable) returns (address) {
return super._update(to, tokenId, auth);
}
/**
* @dev Override to support both ERC721 and ERC721Enumerable
*/
function _increaseBalance(address account, uint128 value) internal override(ERC721, ERC721Enumerable) {
super._increaseBalance(account, value);
}
/**
* @dev Override to support ERC721, ERC721Enumerable, and AccessControl interfaces
*/
function supportsInterface(
bytes4 interfaceId
) public view override(ERC721, ERC721Enumerable, AccessControl) returns (bool) {
return super.supportsInterface(interfaceId);
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.26;
import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";
import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import {UnimonV2} from "./UnimonV2.sol";
import {UnimonItems} from "./UnimonItems.sol";
/**
* @title UnimonEquipment
* @author Unimon Team
* @notice Manages equipment system for Unimon NFTs, allowing players to equip items that modify their stats
* @dev This contract handles the equipping/unequipping of items and tracks equipment configurations.
* Items are stored as ERC1155 tokens and can provide stat modifiers to Unimon NFTs.
* Only configured items can be equipped, and the contract supports both permanent and consumable equipment.
*/
contract UnimonEquipment is AccessControl {
bytes32 public constant EQUIPMENT_MANAGER_ROLE = keccak256("EQUIPMENT_MANAGER_ROLE");
UnimonV2 public immutable unimonV2;
UnimonItems public immutable unimonItems;
mapping(uint256 => uint256) public equippedItems;
mapping(uint256 => EquipmentStats) public equipmentStats;
/**
* @notice Equipment statistics and configuration for items
* @param attackModifier Flat attack modifier (can be positive or negative)
* @param defenseModifier Flat defense modifier (can be positive or negative)
* @param overallPercent Percentage modifier (100 = +100%, -50 = -50%)
* @param isConsumable Whether this is a consumable item (vs permanent equipment)
* @param isConfigured Whether this item can be equipped (must be true to equip)
*/
struct EquipmentStats {
int256 attackModifier; // Can be positive or negative
int256 defenseModifier; // Can be positive or negative
int256 overallPercent; // Percentage modifier (100 = +100%, -50 = -50%)
bool isConsumable; // Whether this is a consumable item (vs permanent equipment)
bool isConfigured; // Whether this item can be equipped
}
/**
* @notice Emitted when an item is equipped to a Unimon
* @param tokenId The Unimon token ID
* @param itemId The item ID that was equipped
* @param owner The owner of the Unimon
*/
event ItemEquipped(uint256 indexed tokenId, uint256 indexed itemId, address indexed owner);
/**
* @notice Emitted when an item is unequipped from a Unimon
* @param tokenId The Unimon token ID
* @param itemId The item ID that was unequipped
* @param owner The owner of the Unimon
*/
event ItemUnequipped(uint256 indexed tokenId, uint256 indexed itemId, address indexed owner);
/**
* @notice Emitted when equipment configuration is set for an item
* @param itemId The item ID being configured
* @param attackModifier The attack modifier value
* @param defenseModifier The defense modifier value
* @param overallPercent The overall percentage modifier
* @param isConsumable Whether the item is consumable
*/
event EquipmentConfigured(
uint256 indexed itemId,
int256 attackModifier,
int256 defenseModifier,
int256 overallPercent,
bool isConsumable
);
/**
* @notice Constructor to initialize the equipment system
* @param _unimonV2 Address of the UnimonV2 NFT contract
* @param _unimonItems Address of the UnimonItems ERC1155 contract
* @dev Grants DEFAULT_ADMIN_ROLE and EQUIPMENT_MANAGER_ROLE to the deployer.
* SPENDER_ROLE should be granted to this contract separately for burning consumable items.
*/
constructor(address _unimonV2, address _unimonItems) {
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(EQUIPMENT_MANAGER_ROLE, msg.sender);
unimonV2 = UnimonV2(_unimonV2);
unimonItems = UnimonItems(_unimonItems);
}
/*
VIEW FUNCTIONS
*/
/**
* @notice Get the currently equipped item ID for a Unimon
* @param tokenId The Unimon token ID
* @return The equipped item ID (0 if no item is equipped)
*/
function getEquippedItem(uint256 tokenId) external view returns (uint256) {
return equippedItems[tokenId];
}
/**
* @notice Get the modified stats for a Unimon including equipment bonuses
* @param tokenId The Unimon token ID
* @return attackLevel The modified attack level (base + equipment modifier)
* @return defenseLevel The modified defense level (base + equipment modifier)
* @return overallPercent The overall percentage modifier from equipment
* @dev Returns base stats if no item is equipped or if the equipped item is not configured
*/
function getModifiedStats(
uint256 tokenId
) external view returns (int256 attackLevel, int256 defenseLevel, int256 overallPercent) {
(uint256 baseAttack, uint256 baseDefense, , ) = unimonV2.getUnimonStats(tokenId);
uint256 equippedItemId = equippedItems[tokenId];
if (equippedItemId == 0) {
return (int256(baseAttack), int256(baseDefense), 0);
}
EquipmentStats memory equipment = equipmentStats[equippedItemId];
if (!equipment.isConfigured) {
return (int256(baseAttack), int256(baseDefense), 0);
}
// Apply flat modifiers only - can be negative
attackLevel = int256(baseAttack) + equipment.attackModifier;
defenseLevel = int256(baseDefense) + equipment.defenseModifier;
// Return percentage modifier separately
overallPercent = equipment.overallPercent;
}
/**
* @notice Check if an item is configured as equipment
* @param itemId The item ID to check
* @return True if the item is configured as equipment
*/
function isEquipmentConfigured(uint256 itemId) external view returns (bool) {
return equipmentStats[itemId].isConfigured;
}
/**
* @notice Check if an item is consumable
* @param itemId The item ID to check
* @return True if the item is consumable
*/
function isConsumableItem(uint256 itemId) external view returns (bool) {
return equipmentStats[itemId].isConsumable;
}
/**
* @notice Check if a Unimon has a consumable item equipped
* @param tokenId The Unimon token ID to check
* @return True if the Unimon has a consumable item equipped
*/
function hasConsumableEquipped(uint256 tokenId) public view returns (bool) {
uint256 equippedItemId = equippedItems[tokenId];
if (equippedItemId == 0) {
return false;
}
return equipmentStats[equippedItemId].isConsumable;
}
/**
* @notice Get modified stats for all Unimon owned by a user with pagination
* @param user The user address to get stats for
* @param offset The starting index for pagination
* @param limit The maximum number of results to return
* @return tokenIds Array of Unimon token IDs
* @return attackLevels Array of modified attack levels
* @return defenseLevels Array of modified defense levels
* @return overallPercents Array of overall percentage modifiers
* @return equippedItemIds Array of equipped item IDs (0 if none equipped)
* @return totalOwned Total number of Unimon owned by the user
* @dev Returns empty arrays if user owns no Unimon or limit is 0
*/
function getAllModifiedStatsForUser(
address user,
uint256 offset,
uint256 limit
)
external
view
returns (
uint256[] memory tokenIds,
int256[] memory attackLevels,
int256[] memory defenseLevels,
int256[] memory overallPercents,
uint256[] memory equippedItemIds,
uint256 totalOwned
)
{
totalOwned = unimonV2.balanceOf(user);
require(offset < totalOwned || totalOwned == 0, "Offset exceeds total owned");
if (totalOwned == 0 || limit == 0) {
return (new uint256[](0), new int256[](0), new int256[](0), new int256[](0), new uint256[](0), totalOwned);
}
uint256 end = offset + limit;
if (end > totalOwned) {
end = totalOwned;
}
uint256 resultLength = end - offset;
tokenIds = new uint256[](resultLength);
attackLevels = new int256[](resultLength);
defenseLevels = new int256[](resultLength);
overallPercents = new int256[](resultLength);
equippedItemIds = new uint256[](resultLength);
for (uint256 i = 0; i < resultLength; i++) {
uint256 tokenId = unimonV2.tokenOfOwnerByIndex(user, offset + i);
tokenIds[i] = tokenId;
(int256 attack, int256 defense, int256 percent) = this.getModifiedStats(tokenId);
attackLevels[i] = attack;
defenseLevels[i] = defense;
overallPercents[i] = percent;
equippedItemIds[i] = equippedItems[tokenId];
}
}
/*
USER FUNCTIONS
*/
/**
* @notice Equip an item to a Unimon
* @param tokenId The Unimon token ID to equip the item to
* @param itemId The item ID to equip
* @dev Automatically unequips any currently equipped item before equipping the new one.
* Transfers the item from the user to this contract. Requires the user to own both
* the Unimon and the item, and the item must be configured as equipment.
*/
function equipItem(uint256 tokenId, uint256 itemId) external {
require(unimonV2.ownerOf(tokenId) == msg.sender, "You don't own this Unimon");
require(equipmentStats[itemId].isConfigured, "Item is not configurable as equipment");
require(unimonItems.balanceOf(msg.sender, itemId) > 0, "You don't own this item");
// Auto-unequip current item if one is equipped
if (equippedItems[tokenId] != 0) {
_unequipItem(tokenId, msg.sender);
}
// Transfer item from user to this contract (no approval needed - equipment role)
unimonItems.whitelistTransfer(msg.sender, address(this), itemId, 1);
// Equip the item
equippedItems[tokenId] = itemId;
emit ItemEquipped(tokenId, itemId, msg.sender);
}
/**
* @notice Unequip the currently equipped item from a Unimon
* @param tokenId The Unimon token ID to unequip the item from
* @dev Returns the item to the Unimon owner. Requires the user to own the Unimon
* and have an item currently equipped.
*/
function unequipItem(uint256 tokenId) external {
require(unimonV2.ownerOf(tokenId) == msg.sender, "You don't own this Unimon");
require(equippedItems[tokenId] != 0, "No item equipped");
_unequipItem(tokenId, msg.sender);
}
/*
INTERNAL FUNCTIONS
*/
/**
* @notice Internal function to unequip an item from a Unimon
* @param tokenId The Unimon token ID
* @param owner The owner of the Unimon
* @dev Clears the equipped item mapping and transfers the item back to the owner
*/
function _unequipItem(uint256 tokenId, address owner) internal {
uint256 equippedItemId = equippedItems[tokenId];
equippedItems[tokenId] = 0;
unimonItems.whitelistTransfer(address(this), owner, equippedItemId, 1);
emit ItemUnequipped(tokenId, equippedItemId, owner);
}
/*
ADMIN FUNCTIONS
*/
/**
* @notice Configure an item as equipment with stat modifiers
* @param itemId The item ID to configure
* @param attackModifier The attack modifier value (can be negative)
* @param defenseModifier The defense modifier value (can be negative)
* @param overallPercent The overall percentage modifier (100 = +100%, -50 = -50%)
* @param isConsumable Whether the item is consumable
* @dev Only callable by accounts with EQUIPMENT_MANAGER_ROLE
*/
function configureEquipment(
uint256 itemId,
int256 attackModifier,
int256 defenseModifier,
int256 overallPercent,
bool isConsumable
) external onlyRole(EQUIPMENT_MANAGER_ROLE) {
equipmentStats[itemId] = EquipmentStats({
attackModifier: attackModifier,
defenseModifier: defenseModifier,
overallPercent: overallPercent,
isConsumable: isConsumable,
isConfigured: true
});
emit EquipmentConfigured(itemId, attackModifier, defenseModifier, overallPercent, isConsumable);
}
/**
* @notice Configure multiple items as equipment in a single transaction
* @param itemIds Array of item IDs to configure
* @param attackModifiers Array of attack modifier values
* @param defenseModifiers Array of defense modifier values
* @param overallPercents Array of overall percentage modifiers
* @param isConsumables Array of consumable flags
* @dev Only callable by accounts with EQUIPMENT_MANAGER_ROLE. All arrays must have the same length.
*/
function configureBulkEquipment(
uint256[] memory itemIds,
int256[] memory attackModifiers,
int256[] memory defenseModifiers,
int256[] memory overallPercents,
bool[] memory isConsumables
) external onlyRole(EQUIPMENT_MANAGER_ROLE) {
require(
itemIds.length == attackModifiers.length &&
itemIds.length == defenseModifiers.length &&
itemIds.length == overallPercents.length &&
itemIds.length == isConsumables.length,
"Array lengths must match"
);
for (uint256 i = 0; i < itemIds.length; i++) {
equipmentStats[itemIds[i]] = EquipmentStats({
attackModifier: attackModifiers[i],
defenseModifier: defenseModifiers[i],
overallPercent: overallPercents[i],
isConsumable: isConsumables[i],
isConfigured: true
});
emit EquipmentConfigured(itemIds[i], attackModifiers[i], defenseModifiers[i], overallPercents[i], isConsumables[i]);
}
}
/**
* @notice Remove equipment configuration for an item
* @param itemId The item ID to remove configuration for
* @dev Only callable by accounts with EQUIPMENT_MANAGER_ROLE. This will prevent the item from being equipped.
*/
function removeEquipmentConfig(uint256 itemId) external onlyRole(EQUIPMENT_MANAGER_ROLE) {
delete equipmentStats[itemId];
}
/**
* @notice Emergency unequip function for admin use
* @param tokenId The Unimon token ID to unequip
* @dev Only callable by accounts with DEFAULT_ADMIN_ROLE. Returns the equipped item to the Unimon owner.
*/
function emergencyUnequip(uint256 tokenId) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(equippedItems[tokenId] != 0, "No item equipped");
address owner = unimonV2.ownerOf(tokenId);
_unequipItem(tokenId, owner);
}
/**
* @notice Remove equipment from a Unimon with option to burn the item
* @param tokenId The Unimon token ID to remove equipment from
* @param burnItem Whether to burn the item (true) or return it to the owner (false)
* @dev Only callable by accounts with EQUIPMENT_MANAGER_ROLE. If burnItem is true, the item is transferred
* to the zero address, effectively burning it.
*/
function removeEquipment(uint256 tokenId, bool burnItem) external onlyRole(EQUIPMENT_MANAGER_ROLE) {
require(equippedItems[tokenId] != 0, "No item equipped");
uint256 equippedItemId = equippedItems[tokenId];
address owner = unimonV2.ownerOf(tokenId);
// Clear the equipped item
equippedItems[tokenId] = 0;
if (burnItem) {
// Burn the item by transferring to zero address
unimonItems.whitelistTransfer(address(this), address(0), equippedItemId, 1);
} else {
// Return item to owner
unimonItems.whitelistTransfer(address(this), owner, equippedItemId, 1);
}
emit ItemUnequipped(tokenId, equippedItemId, owner);
}
/**
* @notice Consume and burn the equipped item from a Unimon after battle
* @param tokenId The Unimon token ID to consume equipment from
* @dev Only callable by accounts with EQUIPMENT_MANAGER_ROLE. This function is designed to be called
* after battles to consume consumable equipment. The item is burned and the Unimon is left with
* no equipment equipped.
*/
function consumeUponBattle(uint256 tokenId) external onlyRole(EQUIPMENT_MANAGER_ROLE) {
require(equippedItems[tokenId] != 0, "No item equipped");
require(hasConsumableEquipped(tokenId), "Equipped item is not consumable");
uint256 equippedItemId = equippedItems[tokenId];
address owner = unimonV2.ownerOf(tokenId);
// Clear the equipped item
equippedItems[tokenId] = 0;
// Burn the item using the proper burn function
unimonItems.spendItem(address(this), equippedItemId, 1);
emit ItemUnequipped(tokenId, equippedItemId, owner);
}
/*
ERC1155 RECEIVER
*/
/**
* @notice ERC1155 receiver function to accept item transfers
* @return The function selector to confirm receipt
* @dev Required for the contract to receive ERC1155 tokens (items)
*/
function onERC1155Received(address, address, uint256, uint256, bytes memory) public pure returns (bytes4) {
return this.onERC1155Received.selector;
}
/**
* @notice ERC1155 batch receiver function to accept multiple item transfers
* @return The function selector to confirm receipt
* @dev Required for the contract to receive batch ERC1155 token transfers
*/
function onERC1155BatchReceived(
address,
address,
uint256[] memory,
uint256[] memory,
bytes memory
) public pure returns (bytes4) {
return this.onERC1155BatchReceived.selector;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "./IAccessControl.sol";
import {Context} from "../utils/Context.sol";
import {ERC165} from "../utils/introspection/ERC165.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControl is Context, IAccessControl, ERC165 {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
mapping(bytes32 role => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
return _roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
bytes32 previousAdminRole = getRoleAdmin(role);
_roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
if (!hasRole(role, account)) {
_roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` from `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
if (hasRole(role, account)) {
_roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// 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/ERC721Burnable.sol)
pragma solidity ^0.8.20;
import {ERC721} from "../ERC721.sol";
import {Context} from "../../../utils/Context.sol";
/**
* @title ERC-721 Burnable Token
* @dev ERC-721 Token that can be burned (destroyed).
*/
abstract contract ERC721Burnable is Context, ERC721 {
/**
* @dev Burns `tokenId`. See {ERC721-_burn}.
*
* Requirements:
*
* - The caller must own `tokenId` or be an approved operator.
*/
function burn(uint256 tokenId) public virtual {
// 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.
_update(address(0), tokenId, _msgSender());
}
}// 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.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)))
}
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.26;
import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";
import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol";
import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol";
/**
* @title UnimonItems
* @author Unimon Team
* @notice ERC1155 token contract for Unimon game items including energy, keys, and mint coupons
* @dev This contract manages all fungible items in the Unimon ecosystem
*
* Key features:
* - ERC1155 multi-token standard for efficient item management
* - Role-based access control for minting and spending
* - Supply tracking for all tokens
* - Airdrop functionality for v1 users
* - Equipment transfer whitelisting
*
* @custom:security This contract uses OpenZeppelin's AccessControl, ERC1155Burnable, and ERC1155Supply
*/
contract UnimonItems is ERC1155, AccessControl, ERC1155Burnable, ERC1155Supply {
/// @notice Role for entities that can mint new items
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
/// @notice Role for entities that can spend/burn items from users
bytes32 public constant SPENDER_ROLE = keccak256("SPENDER_ROLE");
/// @notice Role for equipment contracts that can transfer items
bytes32 public constant EQUIPMENT_ROLE = keccak256("EQUIPMENT_ROLE");
/// @notice Token ID for energy items (used for evolution)
uint256 public constant ENERGY_ID = 0;
/// @notice Token ID for UNIKEY items (used for gacha pulls)
uint256 public constant UNIKEY_ID = 1;
/// @notice Token ID for mint coupons (reduces mint cost by 50%)
uint256 public constant MINT_COUPON_ID = 2;
/// @notice Whether the v1 airdrop has been executed
bool public airdropExecuted;
/// @notice Emitted when items are minted
/// @param to Address receiving the items
/// @param id Token ID of the minted item
/// @param amount Amount minted
event ItemMinted(address indexed to, uint256 indexed id, uint256 amount);
/// @notice Emitted when items are burned/spent
/// @param from Address losing the items
/// @param id Token ID of the burned item
/// @param amount Amount burned
event ItemBurned(address indexed from, uint256 indexed id, uint256 amount);
/**
* @notice Constructor for UnimonItems contract
* @param _admin Address that will receive admin and minter roles
*/
constructor(address _admin) ERC1155("https://v2.unimon.app/items/{id}") {
_grantRole(DEFAULT_ADMIN_ROLE, _admin);
_grantRole(MINTER_ROLE, _admin);
_grantRole(SPENDER_ROLE, _admin);
}
/*
VIEW FUNCTIONS
*/
/**
* @notice Get balances for multiple token IDs for a specific account
* @param account Address to check balances for
* @param ids Array of token IDs to check
* @return Array of balances corresponding to the token IDs
*/
function getBalances(address account, uint256[] memory ids) external view returns (uint256[] memory) {
uint256[] memory balances = new uint256[](ids.length);
for (uint256 i = 0; i < ids.length; i++) {
balances[i] = balanceOf(account, ids[i]);
}
return balances;
}
/*
PERMISSIONED FUNCTIONS
*/
/**
* @notice Mint a single item to an address
* @param to Address to mint to
* @param id Token ID to mint
* @param amount Amount to mint
* @dev Only callable by MINTER_ROLE
*/
function mint(address to, uint256 id, uint256 amount) external onlyRole(MINTER_ROLE) {
_mint(to, id, amount, "");
emit ItemMinted(to, id, amount);
}
/**
* @notice Mint multiple items to an address in a single transaction
* @param to Address to mint to
* @param ids Array of token IDs to mint
* @param amounts Array of amounts to mint for each token ID
* @dev Only callable by MINTER_ROLE
* @dev Arrays must have the same length
*/
function mintBatch(address to, uint256[] memory ids, uint256[] memory amounts) external onlyRole(MINTER_ROLE) {
_mintBatch(to, ids, amounts, "");
for (uint256 i = 0; i < ids.length; i++) {
emit ItemMinted(to, ids[i], amounts[i]);
}
}
/**
* @notice Spend/burn a single item from an address
* @param from Address to burn from
* @param id Token ID to burn
* @param amount Amount to burn
* @dev Only callable by SPENDER_ROLE
*/
function spendItem(address from, uint256 id, uint256 amount) external onlyRole(SPENDER_ROLE) {
_burn(from, id, amount);
emit ItemBurned(from, id, amount);
}
/**
* @notice Burn/spend multiple items from an address
* @param from Address to burn from
* @param ids Array of token IDs to burn
* @param amounts Array of amounts to burn for each token ID
* @dev Only callable by SPENDER_ROLE
* @dev Arrays must have the same length
*/
function spendItemBatch(
address from,
uint256[] memory ids,
uint256[] memory amounts
) external onlyRole(SPENDER_ROLE) {
_burnBatch(from, ids, amounts);
for (uint256 i = 0; i < ids.length; i++) {
emit ItemBurned(from, ids[i], amounts[i]);
}
}
/*
ADMIN FUNCTIONS
*/
/**
* @notice Admin transfer of a single item between addresses
* @param from Address to transfer from
* @param to Address to transfer to
* @param id Token ID to transfer
* @param amount Amount to transfer
* @dev Only callable by DEFAULT_ADMIN_ROLE
*/
function adminTransfer(address from, address to, uint256 id, uint256 amount) external onlyRole(DEFAULT_ADMIN_ROLE) {
_safeTransferFrom(from, to, id, amount, "");
}
/**
* @notice Admin transfer of multiple items between addresses
* @param from Address to transfer from
* @param to Address to transfer to
* @param ids Array of token IDs to transfer
* @param amounts Array of amounts to transfer for each token ID
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @dev Arrays must have the same length
*/
function adminTransferBatch(
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts
) external onlyRole(DEFAULT_ADMIN_ROLE) {
_safeBatchTransferFrom(from, to, ids, amounts, "");
}
/**
* @notice Bulk airdrop function for v1 users - mints unikeys and mint coupons to multiple addresses
* @param recipients Array of recipient addresses
* @param amounts Array of amounts (both unikeys and coupons) for each recipient
* @dev Only callable by MINTER_ROLE
* @dev Can only be executed once
* @dev Arrays must have the same length
*/
function v1Airdrop(address[] memory recipients, uint256[] memory amounts) external onlyRole(MINTER_ROLE) {
require(!airdropExecuted, "Airdrop already executed");
require(recipients.length == amounts.length, "Arrays length mismatch");
airdropExecuted = true;
for (uint256 i = 0; i < recipients.length; i++) {
if (amounts[i] > 0) {
// Mint unikeys
_mint(recipients[i], UNIKEY_ID, amounts[i], "");
emit ItemMinted(recipients[i], UNIKEY_ID, amounts[i]);
// Mint coupons
_mint(recipients[i], MINT_COUPON_ID, amounts[i], "");
emit ItemMinted(recipients[i], MINT_COUPON_ID, amounts[i]);
}
}
}
/**
* @notice Set the base URI for token metadata
* @param newuri New base URI
* @dev Only callable by DEFAULT_ADMIN_ROLE
*/
function setURI(string memory newuri) external onlyRole(DEFAULT_ADMIN_ROLE) {
_setURI(newuri);
}
/**
* @notice Grant minter role to an address
* @param minter Address to grant minter role to
* @dev Only callable by DEFAULT_ADMIN_ROLE
*/
function grantMinterRole(address minter) external onlyRole(DEFAULT_ADMIN_ROLE) {
_grantRole(MINTER_ROLE, minter);
}
/**
* @notice Grant spender role to an address
* @param spender Address to grant spender role to
* @dev Only callable by DEFAULT_ADMIN_ROLE
*/
function grantSpenderRole(address spender) external onlyRole(DEFAULT_ADMIN_ROLE) {
_grantRole(SPENDER_ROLE, spender);
}
/**
* @notice Whitelisted transfer of a single item (for equipment contracts)
* @param from Address to transfer from
* @param to Address to transfer to
* @param id Token ID to transfer
* @param amount Amount to transfer
* @dev Only callable by EQUIPMENT_ROLE
*/
function whitelistTransfer(address from, address to, uint256 id, uint256 amount) external onlyRole(EQUIPMENT_ROLE) {
_safeTransferFrom(from, to, id, amount, "");
}
/**
* @notice Whitelisted transfer of multiple items (for equipment contracts)
* @param from Address to transfer from
* @param to Address to transfer to
* @param ids Array of token IDs to transfer
* @param amounts Array of amounts to transfer for each token ID
* @dev Only callable by EQUIPMENT_ROLE
* @dev Arrays must have the same length
*/
function whitelistBatchTransfer(
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts
) external onlyRole(EQUIPMENT_ROLE) {
_safeBatchTransferFrom(from, to, ids, amounts, "");
}
/*
Overrides
*/
/**
* @dev Override to track supply changes
*/
function _update(
address from,
address to,
uint256[] memory ids,
uint256[] memory values
) internal override(ERC1155, ERC1155Supply) {
super._update(from, to, ids, values);
}
/**
* @dev Override to support both ERC1155 and AccessControl interfaces
*/
function supportsInterface(bytes4 interfaceId) public view override(ERC1155, AccessControl) returns (bool) {
return super.supportsInterface(interfaceId);
}
}// 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.3.0) (access/IAccessControl.sol)
pragma solidity ^0.8.20;
/**
* @dev External interface of AccessControl declared to support ERC-165 detection.
*/
interface IAccessControl {
/**
* @dev The `account` is missing a role.
*/
error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);
/**
* @dev The caller of a function is not the expected one.
*
* NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
*/
error AccessControlBadConfirmation();
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted to signal this.
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call. This account bears the admin role (for the granted role).
* Expected in cases where the role was granted using the internal {AccessControl-_grantRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*/
function renounceRole(bytes32 role, address callerConfirmation) external;
}// 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.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.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) (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.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.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) (token/ERC1155/ERC1155.sol)
pragma solidity ^0.8.20;
import {IERC1155} from "./IERC1155.sol";
import {IERC1155MetadataURI} from "./extensions/IERC1155MetadataURI.sol";
import {ERC1155Utils} from "./utils/ERC1155Utils.sol";
import {Context} from "../../utils/Context.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {Arrays} from "../../utils/Arrays.sol";
import {IERC1155Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the basic standard multi-token.
* See https://eips.ethereum.org/EIPS/eip-1155
* Originally based on code by Enjin: https://github.com/enjin/erc-1155
*/
abstract contract ERC1155 is Context, ERC165, IERC1155, IERC1155MetadataURI, IERC1155Errors {
using Arrays for uint256[];
using Arrays for address[];
mapping(uint256 id => mapping(address account => uint256)) private _balances;
mapping(address account => mapping(address operator => bool)) private _operatorApprovals;
// Used as the URI for all token types by relying on ID substitution, e.g. https://token-cdn-domain/{id}.json
string private _uri;
/**
* @dev See {_setURI}.
*/
constructor(string memory uri_) {
_setURI(uri_);
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC1155).interfaceId ||
interfaceId == type(IERC1155MetadataURI).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC1155MetadataURI-uri}.
*
* This implementation returns the same URI for *all* token types. It relies
* on the token type ID substitution mechanism
* https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the ERC].
*
* Clients calling this function must replace the `\{id\}` substring with the
* actual token type ID.
*/
function uri(uint256 /* id */) public view virtual returns (string memory) {
return _uri;
}
/**
* @dev See {IERC1155-balanceOf}.
*/
function balanceOf(address account, uint256 id) public view virtual returns (uint256) {
return _balances[id][account];
}
/**
* @dev See {IERC1155-balanceOfBatch}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(
address[] memory accounts,
uint256[] memory ids
) public view virtual returns (uint256[] memory) {
if (accounts.length != ids.length) {
revert ERC1155InvalidArrayLength(ids.length, accounts.length);
}
uint256[] memory batchBalances = new uint256[](accounts.length);
for (uint256 i = 0; i < accounts.length; ++i) {
batchBalances[i] = balanceOf(accounts.unsafeMemoryAccess(i), ids.unsafeMemoryAccess(i));
}
return batchBalances;
}
/**
* @dev See {IERC1155-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved) public virtual {
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC1155-isApprovedForAll}.
*/
function isApprovedForAll(address account, address operator) public view virtual returns (bool) {
return _operatorApprovals[account][operator];
}
/**
* @dev See {IERC1155-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes memory data) public virtual {
address sender = _msgSender();
if (from != sender && !isApprovedForAll(from, sender)) {
revert ERC1155MissingApprovalForAll(sender, from);
}
_safeTransferFrom(from, to, id, value, data);
}
/**
* @dev See {IERC1155-safeBatchTransferFrom}.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] memory ids,
uint256[] memory values,
bytes memory data
) public virtual {
address sender = _msgSender();
if (from != sender && !isApprovedForAll(from, sender)) {
revert ERC1155MissingApprovalForAll(sender, from);
}
_safeBatchTransferFrom(from, to, ids, values, data);
}
/**
* @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`. Will mint (or burn) if `from`
* (or `to`) is the zero address.
*
* Emits a {TransferSingle} event if the arrays contain one element, and {TransferBatch} otherwise.
*
* Requirements:
*
* - If `to` refers to a smart contract, it must implement either {IERC1155Receiver-onERC1155Received}
* or {IERC1155Receiver-onERC1155BatchReceived} and return the acceptance magic value.
* - `ids` and `values` must have the same length.
*
* NOTE: The ERC-1155 acceptance check is not performed in this function. See {_updateWithAcceptanceCheck} instead.
*/
function _update(address from, address to, uint256[] memory ids, uint256[] memory values) internal virtual {
if (ids.length != values.length) {
revert ERC1155InvalidArrayLength(ids.length, values.length);
}
address operator = _msgSender();
for (uint256 i = 0; i < ids.length; ++i) {
uint256 id = ids.unsafeMemoryAccess(i);
uint256 value = values.unsafeMemoryAccess(i);
if (from != address(0)) {
uint256 fromBalance = _balances[id][from];
if (fromBalance < value) {
revert ERC1155InsufficientBalance(from, fromBalance, value, id);
}
unchecked {
// Overflow not possible: value <= fromBalance
_balances[id][from] = fromBalance - value;
}
}
if (to != address(0)) {
_balances[id][to] += value;
}
}
if (ids.length == 1) {
uint256 id = ids.unsafeMemoryAccess(0);
uint256 value = values.unsafeMemoryAccess(0);
emit TransferSingle(operator, from, to, id, value);
} else {
emit TransferBatch(operator, from, to, ids, values);
}
}
/**
* @dev Version of {_update} that performs the token acceptance check by calling
* {IERC1155Receiver-onERC1155Received} or {IERC1155Receiver-onERC1155BatchReceived} on the receiver address if it
* contains code (eg. is a smart contract at the moment of execution).
*
* IMPORTANT: Overriding this function is discouraged because it poses a reentrancy risk from the receiver. So any
* update to the contract state after this function would break the check-effect-interaction pattern. Consider
* overriding {_update} instead.
*/
function _updateWithAcceptanceCheck(
address from,
address to,
uint256[] memory ids,
uint256[] memory values,
bytes memory data
) internal virtual {
_update(from, to, ids, values);
if (to != address(0)) {
address operator = _msgSender();
if (ids.length == 1) {
uint256 id = ids.unsafeMemoryAccess(0);
uint256 value = values.unsafeMemoryAccess(0);
ERC1155Utils.checkOnERC1155Received(operator, from, to, id, value, data);
} else {
ERC1155Utils.checkOnERC1155BatchReceived(operator, from, to, ids, values, data);
}
}
}
/**
* @dev Transfers a `value` tokens of token type `id` from `from` to `to`.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `from` must have a balance of tokens of type `id` of at least `value` amount.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function _safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes memory data) internal {
if (to == address(0)) {
revert ERC1155InvalidReceiver(address(0));
}
if (from == address(0)) {
revert ERC1155InvalidSender(address(0));
}
(uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
_updateWithAcceptanceCheck(from, to, ids, values, data);
}
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
* - `ids` and `values` must have the same length.
*/
function _safeBatchTransferFrom(
address from,
address to,
uint256[] memory ids,
uint256[] memory values,
bytes memory data
) internal {
if (to == address(0)) {
revert ERC1155InvalidReceiver(address(0));
}
if (from == address(0)) {
revert ERC1155InvalidSender(address(0));
}
_updateWithAcceptanceCheck(from, to, ids, values, data);
}
/**
* @dev Sets a new URI for all token types, by relying on the token type ID
* substitution mechanism
* https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the ERC].
*
* By this mechanism, any occurrence of the `\{id\}` substring in either the
* URI or any of the values in the JSON file at said URI will be replaced by
* clients with the token type ID.
*
* For example, the `https://token-cdn-domain/\{id\}.json` URI would be
* interpreted by clients as
* `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
* for token type ID 0x4cce0.
*
* See {uri}.
*
* Because these URIs cannot be meaningfully represented by the {URI} event,
* this function emits no events.
*/
function _setURI(string memory newuri) internal virtual {
_uri = newuri;
}
/**
* @dev Creates a `value` amount of tokens of type `id`, and assigns them to `to`.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function _mint(address to, uint256 id, uint256 value, bytes memory data) internal {
if (to == address(0)) {
revert ERC1155InvalidReceiver(address(0));
}
(uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
_updateWithAcceptanceCheck(address(0), to, ids, values, data);
}
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - `ids` and `values` must have the same length.
* - `to` cannot be the zero address.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function _mintBatch(address to, uint256[] memory ids, uint256[] memory values, bytes memory data) internal {
if (to == address(0)) {
revert ERC1155InvalidReceiver(address(0));
}
_updateWithAcceptanceCheck(address(0), to, ids, values, data);
}
/**
* @dev Destroys a `value` amount of tokens of type `id` from `from`
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `from` must have at least `value` amount of tokens of type `id`.
*/
function _burn(address from, uint256 id, uint256 value) internal {
if (from == address(0)) {
revert ERC1155InvalidSender(address(0));
}
(uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
_updateWithAcceptanceCheck(from, address(0), ids, values, "");
}
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `from` must have at least `value` amount of tokens of type `id`.
* - `ids` and `values` must have the same length.
*/
function _burnBatch(address from, uint256[] memory ids, uint256[] memory values) internal {
if (from == address(0)) {
revert ERC1155InvalidSender(address(0));
}
_updateWithAcceptanceCheck(from, address(0), ids, values, "");
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the zero address.
*/
function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
if (operator == address(0)) {
revert ERC1155InvalidOperator(address(0));
}
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Creates an array in memory with only one value for each of the elements provided.
*/
function _asSingletonArrays(
uint256 element1,
uint256 element2
) private pure returns (uint256[] memory array1, uint256[] memory array2) {
assembly ("memory-safe") {
// Load the free memory pointer
array1 := mload(0x40)
// Set array length to 1
mstore(array1, 1)
// Store the single element at the next word after the length (where content starts)
mstore(add(array1, 0x20), element1)
// Repeat for next array locating it right after the first array
array2 := add(array1, 0x40)
mstore(array2, 1)
mstore(add(array2, 0x20), element2)
// Update the free memory pointer by pointing after the second array
mstore(0x40, add(array2, 0x40))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC1155/extensions/ERC1155Burnable.sol)
pragma solidity ^0.8.20;
import {ERC1155} from "../ERC1155.sol";
/**
* @dev Extension of {ERC1155} that allows token holders to destroy both their
* own tokens and those that they have been approved to use.
*/
abstract contract ERC1155Burnable is ERC1155 {
function burn(address account, uint256 id, uint256 value) public virtual {
if (account != _msgSender() && !isApprovedForAll(account, _msgSender())) {
revert ERC1155MissingApprovalForAll(_msgSender(), account);
}
_burn(account, id, value);
}
function burnBatch(address account, uint256[] memory ids, uint256[] memory values) public virtual {
if (account != _msgSender() && !isApprovedForAll(account, _msgSender())) {
revert ERC1155MissingApprovalForAll(_msgSender(), account);
}
_burnBatch(account, ids, values);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC1155/extensions/ERC1155Supply.sol)
pragma solidity ^0.8.20;
import {ERC1155} from "../ERC1155.sol";
import {Arrays} from "../../../utils/Arrays.sol";
/**
* @dev Extension of ERC-1155 that adds tracking of total supply per id.
*
* Useful for scenarios where Fungible and Non-fungible tokens have to be
* clearly identified. Note: While a totalSupply of 1 might mean the
* corresponding is an NFT, there is no guarantees that no other token with the
* same id are not going to be minted.
*
* NOTE: This contract implies a global limit of 2**256 - 1 to the number of tokens
* that can be minted.
*
* CAUTION: This extension should not be added in an upgrade to an already deployed contract.
*/
abstract contract ERC1155Supply is ERC1155 {
using Arrays for uint256[];
mapping(uint256 id => uint256) private _totalSupply;
uint256 private _totalSupplyAll;
/**
* @dev Total value of tokens in with a given id.
*/
function totalSupply(uint256 id) public view virtual returns (uint256) {
return _totalSupply[id];
}
/**
* @dev Total value of tokens.
*/
function totalSupply() public view virtual returns (uint256) {
return _totalSupplyAll;
}
/**
* @dev Indicates whether any token exist with a given id, or not.
*/
function exists(uint256 id) public view virtual returns (bool) {
return totalSupply(id) > 0;
}
/**
* @dev See {ERC1155-_update}.
*/
function _update(
address from,
address to,
uint256[] memory ids,
uint256[] memory values
) internal virtual override {
super._update(from, to, ids, values);
if (from == address(0)) {
uint256 totalMintValue = 0;
for (uint256 i = 0; i < ids.length; ++i) {
uint256 value = values.unsafeMemoryAccess(i);
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply[ids.unsafeMemoryAccess(i)] += value;
totalMintValue += value;
}
// Overflow check required: The rest of the code assumes that totalSupplyAll never overflows
_totalSupplyAll += totalMintValue;
}
if (to == address(0)) {
uint256 totalBurnValue = 0;
for (uint256 i = 0; i < ids.length; ++i) {
uint256 value = values.unsafeMemoryAccess(i);
unchecked {
// Overflow not possible: values[i] <= balanceOf(from, ids[i]) <= totalSupply(ids[i])
_totalSupply[ids.unsafeMemoryAccess(i)] -= value;
// Overflow not possible: sum_i(values[i]) <= sum_i(totalSupply(ids[i])) <= totalSupplyAll
totalBurnValue += value;
}
}
unchecked {
// Overflow not possible: totalBurnValue = sum_i(values[i]) <= sum_i(totalSupply(ids[i])) <= totalSupplyAll
_totalSupplyAll -= totalBurnValue;
}
}
}
}// 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.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.1.0) (utils/Panic.sol)
pragma solidity ^0.8.20;
/**
* @dev Helper library for emitting standardized panic codes.
*
* ```solidity
* contract Example {
* using Panic for uint256;
*
* // Use any of the declared internal constants
* function foo() { Panic.GENERIC.panic(); }
*
* // Alternatively
* function foo() { Panic.panic(Panic.GENERIC); }
* }
* ```
*
* Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
*
* _Available since v5.1._
*/
// slither-disable-next-line unused-state
library Panic {
/// @dev generic / unspecified error
uint256 internal constant GENERIC = 0x00;
/// @dev used by the assert() builtin
uint256 internal constant ASSERT = 0x01;
/// @dev arithmetic underflow or overflow
uint256 internal constant UNDER_OVERFLOW = 0x11;
/// @dev division or modulo by zero
uint256 internal constant DIVISION_BY_ZERO = 0x12;
/// @dev enum conversion error
uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
/// @dev invalid encoding in storage
uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
/// @dev empty array pop
uint256 internal constant EMPTY_ARRAY_POP = 0x31;
/// @dev array out of bounds access
uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
/// @dev resource error (too large allocation or too large array)
uint256 internal constant RESOURCE_ERROR = 0x41;
/// @dev calling invalid internal function
uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
/// @dev Reverts with a panic code. Recommended to use with
/// the internal constants with predefined codes.
function panic(uint256 code) internal pure {
assembly ("memory-safe") {
mstore(0x00, 0x4e487b71)
mstore(0x20, code)
revert(0x1c, 0x24)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC1155/IERC1155.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-1155 compliant contract, as defined in the
* https://eips.ethereum.org/EIPS/eip-1155[ERC].
*/
interface IERC1155 is IERC165 {
/**
* @dev Emitted when `value` amount of tokens of type `id` are transferred from `from` to `to` by `operator`.
*/
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
/**
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
* transfers.
*/
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
/**
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
* `approved`.
*/
event ApprovalForAll(address indexed account, address indexed operator, bool approved);
/**
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
*
* If an {URI} event was emitted for `id`, the standard
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
* returned by {IERC1155MetadataURI-uri}.
*/
event URI(string value, uint256 indexed id);
/**
* @dev Returns the value of tokens of token type `id` owned by `account`.
*/
function balanceOf(address account, uint256 id) external view returns (uint256);
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(
address[] calldata accounts,
uint256[] calldata ids
) external view returns (uint256[] memory);
/**
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the zero address.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
*
* See {setApprovalForAll}.
*/
function isApprovedForAll(address account, address operator) external view returns (bool);
/**
* @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {IERC1155Receiver-onERC1155Received} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
* - `from` must have a balance of tokens of type `id` of at least `value` amount.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes calldata data) external;
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {IERC1155Receiver-onERC1155BatchReceived} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits either a {TransferSingle} or a {TransferBatch} event, depending on the length of the array arguments.
*
* Requirements:
*
* - `ids` and `values` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC1155/extensions/IERC1155MetadataURI.sol)
pragma solidity ^0.8.20;
import {IERC1155} from "../IERC1155.sol";
/**
* @dev Interface of the optional ERC1155MetadataExtension interface, as defined
* in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[ERC].
*/
interface IERC1155MetadataURI is IERC1155 {
/**
* @dev Returns the URI for token type `id`.
*
* If the `\{id\}` substring is present in the URI, it must be replaced by
* clients with the actual token type ID.
*/
function uri(uint256 id) external view returns (string memory);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC1155/utils/ERC1155Utils.sol)
pragma solidity ^0.8.20;
import {IERC1155Receiver} from "../IERC1155Receiver.sol";
import {IERC1155Errors} from "../../../interfaces/draft-IERC6093.sol";
/**
* @dev Library that provide common ERC-1155 utility functions.
*
* See https://eips.ethereum.org/EIPS/eip-1155[ERC-1155].
*
* _Available since v5.1._
*/
library ERC1155Utils {
/**
* @dev Performs an acceptance check for the provided `operator` by calling {IERC1155Receiver-onERC1155Received}
* 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 {IERC1155Receiver-onERC1155Received} and return the acceptance magic value to accept
* the transfer.
*/
function checkOnERC1155Received(
address operator,
address from,
address to,
uint256 id,
uint256 value,
bytes memory data
) internal {
if (to.code.length > 0) {
try IERC1155Receiver(to).onERC1155Received(operator, from, id, value, data) returns (bytes4 response) {
if (response != IERC1155Receiver.onERC1155Received.selector) {
// Tokens rejected
revert IERC1155Errors.ERC1155InvalidReceiver(to);
}
} catch (bytes memory reason) {
if (reason.length == 0) {
// non-IERC1155Receiver implementer
revert IERC1155Errors.ERC1155InvalidReceiver(to);
} else {
assembly ("memory-safe") {
revert(add(32, reason), mload(reason))
}
}
}
}
}
/**
* @dev Performs a batch acceptance check for the provided `operator` by calling {IERC1155Receiver-onERC1155BatchReceived}
* 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 {IERC1155Receiver-onERC1155Received} and return the acceptance magic value to accept
* the transfer.
*/
function checkOnERC1155BatchReceived(
address operator,
address from,
address to,
uint256[] memory ids,
uint256[] memory values,
bytes memory data
) internal {
if (to.code.length > 0) {
try IERC1155Receiver(to).onERC1155BatchReceived(operator, from, ids, values, data) returns (
bytes4 response
) {
if (response != IERC1155Receiver.onERC1155BatchReceived.selector) {
// Tokens rejected
revert IERC1155Errors.ERC1155InvalidReceiver(to);
}
} catch (bytes memory reason) {
if (reason.length == 0) {
// non-IERC1155Receiver implementer
revert IERC1155Errors.ERC1155InvalidReceiver(to);
} else {
assembly ("memory-safe") {
revert(add(32, reason), mload(reason))
}
}
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/Arrays.sol)
// This file was procedurally generated from scripts/generate/templates/Arrays.js.
pragma solidity ^0.8.20;
import {Comparators} from "./Comparators.sol";
import {SlotDerivation} from "./SlotDerivation.sol";
import {StorageSlot} from "./StorageSlot.sol";
import {Math} from "./math/Math.sol";
/**
* @dev Collection of functions related to array types.
*/
library Arrays {
using SlotDerivation for bytes32;
using StorageSlot for bytes32;
/**
* @dev Sort an array of uint256 (in memory) following the provided comparator function.
*
* This function does the sorting "in place", meaning that it overrides the input. The object is returned for
* convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
*
* NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
* array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
* when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
* consume more gas than is available in a block, leading to potential DoS.
*
* IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
*/
function sort(
uint256[] memory array,
function(uint256, uint256) pure returns (bool) comp
) internal pure returns (uint256[] memory) {
_quickSort(_begin(array), _end(array), comp);
return array;
}
/**
* @dev Variant of {sort} that sorts an array of uint256 in increasing order.
*/
function sort(uint256[] memory array) internal pure returns (uint256[] memory) {
sort(array, Comparators.lt);
return array;
}
/**
* @dev Sort an array of address (in memory) following the provided comparator function.
*
* This function does the sorting "in place", meaning that it overrides the input. The object is returned for
* convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
*
* NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
* array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
* when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
* consume more gas than is available in a block, leading to potential DoS.
*
* IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
*/
function sort(
address[] memory array,
function(address, address) pure returns (bool) comp
) internal pure returns (address[] memory) {
sort(_castToUint256Array(array), _castToUint256Comp(comp));
return array;
}
/**
* @dev Variant of {sort} that sorts an array of address in increasing order.
*/
function sort(address[] memory array) internal pure returns (address[] memory) {
sort(_castToUint256Array(array), Comparators.lt);
return array;
}
/**
* @dev Sort an array of bytes32 (in memory) following the provided comparator function.
*
* This function does the sorting "in place", meaning that it overrides the input. The object is returned for
* convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
*
* NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
* array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
* when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
* consume more gas than is available in a block, leading to potential DoS.
*
* IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
*/
function sort(
bytes32[] memory array,
function(bytes32, bytes32) pure returns (bool) comp
) internal pure returns (bytes32[] memory) {
sort(_castToUint256Array(array), _castToUint256Comp(comp));
return array;
}
/**
* @dev Variant of {sort} that sorts an array of bytes32 in increasing order.
*/
function sort(bytes32[] memory array) internal pure returns (bytes32[] memory) {
sort(_castToUint256Array(array), Comparators.lt);
return array;
}
/**
* @dev Performs a quick sort of a segment of memory. The segment sorted starts at `begin` (inclusive), and stops
* at end (exclusive). Sorting follows the `comp` comparator.
*
* Invariant: `begin <= end`. This is the case when initially called by {sort} and is preserved in subcalls.
*
* IMPORTANT: Memory locations between `begin` and `end` are not validated/zeroed. This function should
* be used only if the limits are within a memory array.
*/
function _quickSort(uint256 begin, uint256 end, function(uint256, uint256) pure returns (bool) comp) private pure {
unchecked {
if (end - begin < 0x40) return;
// Use first element as pivot
uint256 pivot = _mload(begin);
// Position where the pivot should be at the end of the loop
uint256 pos = begin;
for (uint256 it = begin + 0x20; it < end; it += 0x20) {
if (comp(_mload(it), pivot)) {
// If the value stored at the iterator's position comes before the pivot, we increment the
// position of the pivot and move the value there.
pos += 0x20;
_swap(pos, it);
}
}
_swap(begin, pos); // Swap pivot into place
_quickSort(begin, pos, comp); // Sort the left side of the pivot
_quickSort(pos + 0x20, end, comp); // Sort the right side of the pivot
}
}
/**
* @dev Pointer to the memory location of the first element of `array`.
*/
function _begin(uint256[] memory array) private pure returns (uint256 ptr) {
assembly ("memory-safe") {
ptr := add(array, 0x20)
}
}
/**
* @dev Pointer to the memory location of the first memory word (32bytes) after `array`. This is the memory word
* that comes just after the last element of the array.
*/
function _end(uint256[] memory array) private pure returns (uint256 ptr) {
unchecked {
return _begin(array) + array.length * 0x20;
}
}
/**
* @dev Load memory word (as a uint256) at location `ptr`.
*/
function _mload(uint256 ptr) private pure returns (uint256 value) {
assembly {
value := mload(ptr)
}
}
/**
* @dev Swaps the elements memory location `ptr1` and `ptr2`.
*/
function _swap(uint256 ptr1, uint256 ptr2) private pure {
assembly {
let value1 := mload(ptr1)
let value2 := mload(ptr2)
mstore(ptr1, value2)
mstore(ptr2, value1)
}
}
/// @dev Helper: low level cast address memory array to uint256 memory array
function _castToUint256Array(address[] memory input) private pure returns (uint256[] memory output) {
assembly {
output := input
}
}
/// @dev Helper: low level cast bytes32 memory array to uint256 memory array
function _castToUint256Array(bytes32[] memory input) private pure returns (uint256[] memory output) {
assembly {
output := input
}
}
/// @dev Helper: low level cast address comp function to uint256 comp function
function _castToUint256Comp(
function(address, address) pure returns (bool) input
) private pure returns (function(uint256, uint256) pure returns (bool) output) {
assembly {
output := input
}
}
/// @dev Helper: low level cast bytes32 comp function to uint256 comp function
function _castToUint256Comp(
function(bytes32, bytes32) pure returns (bool) input
) private pure returns (function(uint256, uint256) pure returns (bool) output) {
assembly {
output := input
}
}
/**
* @dev Searches a sorted `array` and returns the first index that contains
* a value greater or equal to `element`. If no such index exists (i.e. all
* values in the array are strictly less than `element`), the array length is
* returned. Time complexity O(log n).
*
* NOTE: The `array` is expected to be sorted in ascending order, and to
* contain no repeated elements.
*
* IMPORTANT: Deprecated. This implementation behaves as {lowerBound} but lacks
* support for repeated elements in the array. The {lowerBound} function should
* be used instead.
*/
function findUpperBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeAccess(array, mid).value > element) {
high = mid;
} else {
low = mid + 1;
}
}
// At this point `low` is the exclusive upper bound. We will return the inclusive upper bound.
if (low > 0 && unsafeAccess(array, low - 1).value == element) {
return low - 1;
} else {
return low;
}
}
/**
* @dev Searches an `array` sorted in ascending order and returns the first
* index that contains a value greater or equal than `element`. If no such index
* exists (i.e. all values in the array are strictly less than `element`), the array
* length is returned. Time complexity O(log n).
*
* See C++'s https://en.cppreference.com/w/cpp/algorithm/lower_bound[lower_bound].
*/
function lowerBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeAccess(array, mid).value < element) {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
} else {
high = mid;
}
}
return low;
}
/**
* @dev Searches an `array` sorted in ascending order and returns the first
* index that contains a value strictly greater than `element`. If no such index
* exists (i.e. all values in the array are strictly less than `element`), the array
* length is returned. Time complexity O(log n).
*
* See C++'s https://en.cppreference.com/w/cpp/algorithm/upper_bound[upper_bound].
*/
function upperBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeAccess(array, mid).value > element) {
high = mid;
} else {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
}
}
return low;
}
/**
* @dev Same as {lowerBound}, but with an array in memory.
*/
function lowerBoundMemory(uint256[] memory array, uint256 element) internal pure returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeMemoryAccess(array, mid) < element) {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
} else {
high = mid;
}
}
return low;
}
/**
* @dev Same as {upperBound}, but with an array in memory.
*/
function upperBoundMemory(uint256[] memory array, uint256 element) internal pure returns (uint256) {
uint256 low = 0;
uint256 high = array.length;
if (high == 0) {
return 0;
}
while (low < high) {
uint256 mid = Math.average(low, high);
// Note that mid will always be strictly less than high (i.e. it will be a valid array index)
// because Math.average rounds towards zero (it does integer division with truncation).
if (unsafeMemoryAccess(array, mid) > element) {
high = mid;
} else {
// this cannot overflow because mid < high
unchecked {
low = mid + 1;
}
}
}
return low;
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeAccess(address[] storage arr, uint256 pos) internal pure returns (StorageSlot.AddressSlot storage) {
bytes32 slot;
assembly ("memory-safe") {
slot := arr.slot
}
return slot.deriveArray().offset(pos).getAddressSlot();
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeAccess(bytes32[] storage arr, uint256 pos) internal pure returns (StorageSlot.Bytes32Slot storage) {
bytes32 slot;
assembly ("memory-safe") {
slot := arr.slot
}
return slot.deriveArray().offset(pos).getBytes32Slot();
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeAccess(uint256[] storage arr, uint256 pos) internal pure returns (StorageSlot.Uint256Slot storage) {
bytes32 slot;
assembly ("memory-safe") {
slot := arr.slot
}
return slot.deriveArray().offset(pos).getUint256Slot();
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeMemoryAccess(address[] memory arr, uint256 pos) internal pure returns (address res) {
assembly {
res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
}
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeMemoryAccess(bytes32[] memory arr, uint256 pos) internal pure returns (bytes32 res) {
assembly {
res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
}
}
/**
* @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
*
* WARNING: Only use if you are certain `pos` is lower than the array length.
*/
function unsafeMemoryAccess(uint256[] memory arr, uint256 pos) internal pure returns (uint256 res) {
assembly {
res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
}
}
/**
* @dev Helper to set the length of a dynamic array. Directly writing to `.length` is forbidden.
*
* WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
*/
function unsafeSetLength(address[] storage array, uint256 len) internal {
assembly ("memory-safe") {
sstore(array.slot, len)
}
}
/**
* @dev Helper to set the length of a dynamic array. Directly writing to `.length` is forbidden.
*
* WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
*/
function unsafeSetLength(bytes32[] storage array, uint256 len) internal {
assembly ("memory-safe") {
sstore(array.slot, len)
}
}
/**
* @dev Helper to set the length of a dynamic array. Directly writing to `.length` is forbidden.
*
* WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
*/
function unsafeSetLength(uint256[] storage array, uint256 len) internal {
assembly ("memory-safe") {
sstore(array.slot, len)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC1155/IERC1155Receiver.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Interface that must be implemented by smart contracts in order to receive
* ERC-1155 token transfers.
*/
interface IERC1155Receiver is IERC165 {
/**
* @dev Handles the receipt of a single ERC-1155 token type. This function is
* called at the end of a `safeTransferFrom` after the balance has been updated.
*
* NOTE: To accept the transfer, this must return
* `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
* (i.e. 0xf23a6e61, or its own function selector).
*
* @param operator The address which initiated the transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param id The ID of the token being transferred
* @param value The amount of tokens being transferred
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
*/
function onERC1155Received(
address operator,
address from,
uint256 id,
uint256 value,
bytes calldata data
) external returns (bytes4);
/**
* @dev Handles the receipt of a multiple ERC-1155 token types. This function
* is called at the end of a `safeBatchTransferFrom` after the balances have
* been updated.
*
* NOTE: To accept the transfer(s), this must return
* `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
* (i.e. 0xbc197c81, or its own function selector).
*
* @param operator The address which initiated the batch transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param ids An array containing ids of each token being transferred (order and length must match values array)
* @param values An array containing amounts of each token being transferred (order and length must match ids array)
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
*/
function onERC1155BatchReceived(
address operator,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external returns (bytes4);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Comparators.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides a set of functions to compare values.
*
* _Available since v5.1._
*/
library Comparators {
function lt(uint256 a, uint256 b) internal pure returns (bool) {
return a < b;
}
function gt(uint256 a, uint256 b) internal pure returns (bool) {
return a > b;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/SlotDerivation.sol)
// This file was procedurally generated from scripts/generate/templates/SlotDerivation.js.
pragma solidity ^0.8.20;
/**
* @dev Library for computing storage (and transient storage) locations from namespaces and deriving slots
* corresponding to standard patterns. The derivation method for array and mapping matches the storage layout used by
* the solidity language / compiler.
*
* See https://docs.soliditylang.org/en/v0.8.20/internals/layout_in_storage.html#mappings-and-dynamic-arrays[Solidity docs for mappings and dynamic arrays.].
*
* Example usage:
* ```solidity
* contract Example {
* // Add the library methods
* using StorageSlot for bytes32;
* using SlotDerivation for bytes32;
*
* // Declare a namespace
* string private constant _NAMESPACE = "<namespace>"; // eg. OpenZeppelin.Slot
*
* function setValueInNamespace(uint256 key, address newValue) internal {
* _NAMESPACE.erc7201Slot().deriveMapping(key).getAddressSlot().value = newValue;
* }
*
* function getValueInNamespace(uint256 key) internal view returns (address) {
* return _NAMESPACE.erc7201Slot().deriveMapping(key).getAddressSlot().value;
* }
* }
* ```
*
* TIP: Consider using this library along with {StorageSlot}.
*
* NOTE: This library provides a way to manipulate storage locations in a non-standard way. Tooling for checking
* upgrade safety will ignore the slots accessed through this library.
*
* _Available since v5.1._
*/
library SlotDerivation {
/**
* @dev Derive an ERC-7201 slot from a string (namespace).
*/
function erc7201Slot(string memory namespace) internal pure returns (bytes32 slot) {
assembly ("memory-safe") {
mstore(0x00, sub(keccak256(add(namespace, 0x20), mload(namespace)), 1))
slot := and(keccak256(0x00, 0x20), not(0xff))
}
}
/**
* @dev Add an offset to a slot to get the n-th element of a structure or an array.
*/
function offset(bytes32 slot, uint256 pos) internal pure returns (bytes32 result) {
unchecked {
return bytes32(uint256(slot) + pos);
}
}
/**
* @dev Derive the location of the first element in an array from the slot where the length is stored.
*/
function deriveArray(bytes32 slot) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, slot)
result := keccak256(0x00, 0x20)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, address key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, and(key, shr(96, not(0))))
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, bool key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, iszero(iszero(key)))
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, bytes32 key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, key)
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, uint256 key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, key)
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, int256 key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
mstore(0x00, key)
mstore(0x20, slot)
result := keccak256(0x00, 0x40)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, string memory key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
let length := mload(key)
let begin := add(key, 0x20)
let end := add(begin, length)
let cache := mload(end)
mstore(end, slot)
result := keccak256(begin, add(length, 0x20))
mstore(end, cache)
}
}
/**
* @dev Derive the location of a mapping element from the key.
*/
function deriveMapping(bytes32 slot, bytes memory key) internal pure returns (bytes32 result) {
assembly ("memory-safe") {
let length := mload(key)
let begin := add(key, 0x20)
let end := add(begin, length)
let cache := mload(end)
mstore(end, slot)
result := keccak256(begin, add(length, 0x20))
mstore(end, cache)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.20;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC-1967 implementation slot:
* ```solidity
* contract ERC1967 {
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(newImplementation.code.length > 0);
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct Int256Slot {
int256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Int256Slot` with member `value` located at `slot`.
*/
function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
/**
* @dev Returns a `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
}{
"remappings": [
"@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/",
"@uniswap/v4-core/=node_modules/@uniswap/v4-core/",
"v4-core/=lib/v4-periphery/lib/v4-core/",
"v4-periphery/=lib/v4-periphery/",
"@ensdomains/=lib/v4-periphery/lib/v4-core/node_modules/@ensdomains/",
"ds-test/=node_modules/@uniswap/v4-core/lib/solmate/lib/ds-test/",
"erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/",
"eth-gas-reporter/=node_modules/eth-gas-reporter/",
"forge-gas-snapshot/=lib/v4-periphery/lib/permit2/lib/forge-gas-snapshot/src/",
"forge-std/=lib/forge-std/src/",
"halmos-cheatcodes/=lib/openzeppelin-contracts/lib/halmos-cheatcodes/src/",
"hardhat/=node_modules/hardhat/",
"openzeppelin-contracts/=lib/openzeppelin-contracts/",
"openzeppelin/=lib/uniswap-hooks/lib/v4-core/lib/openzeppelin-contracts/contracts/",
"permit2/=lib/v4-periphery/lib/permit2/",
"solmate/=node_modules/@uniswap/v4-core/lib/solmate/",
"uniswap-hooks/=lib/uniswap-hooks/src/"
],
"optimizer": {
"enabled": false,
"runs": 200
},
"metadata": {
"useLiteralContent": false,
"bytecodeHash": "ipfs",
"appendCBOR": true
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"evmVersion": "cancun",
"viaIR": false
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"_equipment","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"monsterId","type":"uint256"},{"indexed":false,"internalType":"bool","name":"won","type":"bool"},{"indexed":false,"internalType":"uint256","name":"power","type":"uint256"},{"indexed":false,"internalType":"uint8","name":"difficulty","type":"uint8"}],"name":"MonsterFought","type":"event"},{"inputs":[{"internalType":"string","name":"name","type":"string"},{"internalType":"uint8","name":"difficulty","type":"uint8"},{"internalType":"bool","name":"active","type":"bool"}],"name":"addMonster","outputs":[{"internalType":"uint256","name":"monsterId","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"equipment","outputs":[{"internalType":"contract UnimonEquipment","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"monsterId","type":"uint256"}],"name":"fight","outputs":[{"internalType":"bool","name":"won","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"monsterId","type":"uint256"}],"name":"getMonster","outputs":[{"internalType":"string","name":"name","type":"string"},{"internalType":"uint8","name":"difficulty","type":"uint8"},{"internalType":"bool","name":"active","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"getMonstersByIds","outputs":[{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"uint8","name":"difficulty","type":"uint8"},{"internalType":"bool","name":"active","type":"bool"}],"internalType":"struct UnimonSlayer.Monster[]","name":"out","type":"tuple[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getUnimonPower","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"monsterCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"monsters","outputs":[{"internalType":"string","name":"name","type":"string"},{"internalType":"uint8","name":"difficulty","type":"uint8"},{"internalType":"bool","name":"active","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"monsterId","type":"uint256"}],"name":"removeMonster","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"monsterId","type":"uint256"},{"internalType":"bool","name":"active","type":"bool"}],"name":"setMonsterActive","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"totalFightsForToken","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"totalWinsForToken","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unimon","outputs":[{"internalType":"contract UnimonV2","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"monsterId","type":"uint256"},{"internalType":"string","name":"name","type":"string"},{"internalType":"uint8","name":"difficulty","type":"uint8"},{"internalType":"bool","name":"active","type":"bool"}],"name":"updateMonster","outputs":[],"stateMutability":"nonpayable","type":"function"}]Contract Creation Code
60c060405234801561000f575f80fd5b50604051612f6a380380612f6a833981810160405281019061003191906105d3565b8073ffffffffffffffffffffffffffffffffffffffff1660a08173ffffffffffffffffffffffffffffffffffffffff168152505060a05173ffffffffffffffffffffffffffffffffffffffff166399ba7cf06040518163ffffffff1660e01b8152600401602060405180830381865afa1580156100b0573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906100d49190610639565b73ffffffffffffffffffffffffffffffffffffffff1660808173ffffffffffffffffffffffffffffffffffffffff1681525050335f806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550600160405180606001604052806040518060400160405280600781526020017f496d706c696e67000000000000000000000000000000000000000000000000008152508152602001600260ff16815260200160011515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f0190816101d8919061089e565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055505050600160405180606001604052806040518060400160405280600581526020017f536c696d650000000000000000000000000000000000000000000000000000008152508152602001600560ff16815260200160011515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f0190816102ad919061089e565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055505050600160405180606001604052806040518060400160405280600581526020017f537761726d0000000000000000000000000000000000000000000000000000008152508152602001600860ff16815260200160011515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f019081610382919061089e565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055505050600160405180606001604052806040518060400160405280600481526020017f4f677265000000000000000000000000000000000000000000000000000000008152508152602001600c60ff16815260200160011515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f019081610457919061089e565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055505050600160405180606001604052806040518060400160405280600681526020017f447261676f6e00000000000000000000000000000000000000000000000000008152508152602001601060ff16815260200160011515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f01908161052c919061089e565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff02191690831515021790555050505061096d565b5f80fd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f6105a282610579565b9050919050565b6105b281610598565b81146105bc575f80fd5b50565b5f815190506105cd816105a9565b92915050565b5f602082840312156105e8576105e7610575565b5b5f6105f5848285016105bf565b91505092915050565b5f61060882610598565b9050919050565b610618816105fe565b8114610622575f80fd5b50565b5f815190506106338161060f565b92915050565b5f6020828403121561064e5761064d610575565b5b5f61065b84828501610625565b91505092915050565b5f81519050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f60028204905060018216806106df57607f821691505b6020821081036106f2576106f161069b565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f600883026107547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82610719565b61075e8683610719565b95508019841693508086168417925050509392505050565b5f819050919050565b5f819050919050565b5f6107a261079d61079884610776565b61077f565b610776565b9050919050565b5f819050919050565b6107bb83610788565b6107cf6107c7826107a9565b848454610725565b825550505050565b5f90565b6107e36107d7565b6107ee8184846107b2565b505050565b5b81811015610811576108065f826107db565b6001810190506107f4565b5050565b601f82111561085657610827816106f8565b6108308461070a565b8101602085101561083f578190505b61085361084b8561070a565b8301826107f3565b50505b505050565b5f82821c905092915050565b5f6108765f198460080261085b565b1980831691505092915050565b5f61088e8383610867565b9150826002028217905092915050565b6108a782610664565b67ffffffffffffffff8111156108c0576108bf61066e565b5b6108ca82546106c8565b6108d5828285610815565b5f60209050601f831160018114610906575f84156108f4578287015190505b6108fe8582610883565b865550610965565b601f198416610914866106f8565b5f5b8281101561093b57848901518255600182019150602085019450602081019050610916565b868310156109585784890151610954601f891682610867565b8355505b6001600288020188555050505b505050505050565b60805160a0516125c76109a35f395f818161037301528181610a4c01526111f001525f81816108cd015261104201526125c75ff3fe608060405234801561000f575f80fd5b50600436106100fe575f3560e01c8063a86c0c0d11610095578063c39563b111610064578063c39563b1146102d6578063c48ad9ab14610306578063ca39e5ef14610322578063f2fde38b14610352576100fe565b8063a86c0c0d1461023a578063b17ad4be1461026a578063b693bff814610286578063c0576b73146102a4576100fe565b80632c73750f116100d15780632c73750f146101ae57806362fb6fe1146101cc57806374c9f2a3146101fe5780638da5cb5b1461021c576100fe565b806303b1cacd14610102578063064e8cb0146101325780631ce6f1a51461016257806329e5c6641461017e575b5f80fd5b61011c6004803603810190610117919061159e565b61036e565b60405161012991906115d8565b60405180910390f35b61014c6004803603810190610147919061159e565b61044d565b60405161015991906115d8565b60405180910390f35b61017c600480360381019061017791906116bd565b610462565b005b61019860048036038101906101939190611741565b6106b1565b6040516101a591906115d8565b60405180910390f35b6101b66108cb565b6040516101c3919061182c565b60405180910390f35b6101e660048036038101906101e1919061159e565b6108ef565b6040516101f5939291906118d3565b60405180910390f35b610206610a4a565b604051610213919061192f565b60405180910390f35b610224610a6e565b6040516102319190611968565b60405180910390f35b610254600480360381019061024f91906119d6565b610a91565b6040516102619190611b8f565b60405180910390f35b610284600480360381019061027f9190611baf565b610c95565b005b61028e610da8565b60405161029b91906115d8565b60405180910390f35b6102be60048036038101906102b9919061159e565b610db4565b6040516102cd939291906118d3565b60405180910390f35b6102f060048036038101906102eb919061159e565b610e88565b6040516102fd91906115d8565b60405180910390f35b610320600480360381019061031b919061159e565b610e9d565b005b61033c60048036038101906103379190611bed565b611028565b6040516103499190611c2b565b60405180910390f35b61036c60048036038101906103679190611c6e565b6113b8565b005b5f805f7f000000000000000000000000000000000000000000000000000000000000000073ffffffffffffffffffffffffffffffffffffffff16632ca13ba4856040518263ffffffff1660e01b81526004016103ca91906115d8565b606060405180830381865afa1580156103e5573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906104099190611ccc565b50915091505f8083131561041d5782610420565b60015b90505f808313156104315782610434565b60015b905080826104429190611d49565b945050505050919050565b6002602052805f5260405f205f915090505481565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16146104ef576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016104e690611dc6565b60405180910390fd5b6001805490508510610536576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161052d90611e2e565b60405180910390fd5b5f848490501161057b576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161057290611e96565b60405180910390fd5b5f8260ff16118015610591575060148260ff1611155b6105d0576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016105c790611efe565b60405180910390fd5b604051806060016040528085858080601f0160208091040260200160405190810160405280939291908181526020018383808284375f81840152601f19601f8201169050808301925050505050505081526020018360ff1681526020018215158152506001868154811061064757610646611f1c565b5b905f5260205f2090600202015f820151815f0190816106669190612167565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055509050505050505050565b5f805f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610740576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161073790611dc6565b60405180910390fd5b5f8585905011610785576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161077c90611e96565b60405180910390fd5b5f8360ff1611801561079b575060148360ff1611155b6107da576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107d190611efe565b60405180910390fd5b60018054905090506001604051806060016040528087878080601f0160208091040260200160405190810160405280939291908181526020018383808284375f81840152601f19601f8201169050808301925050505050505081526020018560ff168152602001841515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f0190816108809190612167565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055505050949350505050565b7f000000000000000000000000000000000000000000000000000000000000000081565b60605f80600180549050841061093a576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161093190611e2e565b60405180910390fd5b5f6001858154811061094f5761094e611f1c565b5b905f5260205f2090600202016040518060600160405290815f8201805461097590611fa3565b80601f01602080910402602001604051908101604052809291908181526020018280546109a190611fa3565b80156109ec5780601f106109c3576101008083540402835291602001916109ec565b820191905f5260205f20905b8154815290600101906020018083116109cf57829003601f168201915b50505050508152602001600182015f9054906101000a900460ff1660ff1660ff1681526020016001820160019054906101000a900460ff1615151515815250509050805f015181602001518260400151935093509350509193909250565b7f000000000000000000000000000000000000000000000000000000000000000081565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b60608282905067ffffffffffffffff811115610ab057610aaf611f49565b5b604051908082528060200260200182016040528015610ae957816020015b610ad661153f565b815260200190600190039081610ace5790505b5090505f5b83839050811015610c8e57600180549050848483818110610b1257610b11611f1c565b5b9050602002013510610b59576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610b5090611e2e565b60405180910390fd5b6001848483818110610b6e57610b6d611f1c565b5b9050602002013581548110610b8657610b85611f1c565b5b905f5260205f2090600202016040518060600160405290815f82018054610bac90611fa3565b80601f0160208091040260200160405190810160405280929190818152602001828054610bd890611fa3565b8015610c235780601f10610bfa57610100808354040283529160200191610c23565b820191905f5260205f20905b815481529060010190602001808311610c0657829003601f168201915b50505050508152602001600182015f9054906101000a900460ff1660ff1660ff1681526020016001820160019054906101000a900460ff161515151581525050828281518110610c7657610c75611f1c565b5b60200260200101819052508080600101915050610aee565b5092915050565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610d22576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610d1990611dc6565b60405180910390fd5b6001805490508210610d69576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610d6090611e2e565b60405180910390fd5b8060018381548110610d7e57610d7d611f1c565b5b905f5260205f20906002020160010160016101000a81548160ff0219169083151502179055505050565b5f600180549050905090565b60018181548110610dc3575f80fd5b905f5260205f2090600202015f91509050805f018054610de290611fa3565b80601f0160208091040260200160405190810160405280929190818152602001828054610e0e90611fa3565b8015610e595780601f10610e3057610100808354040283529160200191610e59565b820191905f5260205f20905b815481529060010190602001808311610e3c57829003601f168201915b505050505090806001015f9054906101000a900460ff16908060010160019054906101000a900460ff16905083565b6003602052805f5260405f205f915090505481565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610f2a576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610f2190611dc6565b60405180910390fd5b6001805490508110610f71576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610f6890611e2e565b60405180910390fd5b60405180602001604052805f81525060018281548110610f9457610f93611f1c565b5b905f5260205f2090600202015f019081610fae9190612167565b505f60018281548110610fc457610fc3611f1c565b5b905f5260205f2090600202016001015f6101000a81548160ff021916908360ff1602179055505f60018281548110610fff57610ffe611f1c565b5b905f5260205f20906002020160010160016101000a81548160ff02191690831515021790555050565b5f3373ffffffffffffffffffffffffffffffffffffffff167f000000000000000000000000000000000000000000000000000000000000000073ffffffffffffffffffffffffffffffffffffffff16636352211e856040518263ffffffff1660e01b815260040161109991906115d8565b602060405180830381865afa1580156110b4573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906110d8919061224a565b73ffffffffffffffffffffffffffffffffffffffff161461112e576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401611125906122bf565b60405180910390fd5b6001805490508210801561116f57506001828154811061115157611150611f1c565b5b905f5260205f20906002020160010160019054906101000a900460ff165b6111ae576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016111a590611e2e565b60405180910390fd5b5f6111b88461036e565b90505f600184815481106111cf576111ce611f1c565b5b905f5260205f2090600202016001015f9054906101000a900460ff1690505f7f000000000000000000000000000000000000000000000000000000000000000073ffffffffffffffffffffffffffffffffffffffff16632ca13ba4876040518263ffffffff1660e01b815260040161124791906115d8565b606060405180830381865afa158015611262573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906112869190611ccc565b925050505f8260ff168461129a91906122dd565b90505f826003836112ab919061231d565b60326112b79190612393565b6112c19190612393565b9050600a8112156112d157600a90505b605a8113156112df57605a90505b5f8190505f60646112ef8b6114f5565b6112f99190612401565b90508181109750600160025f8c81526020019081526020015f205f8282546113219190611d49565b92505081905550871561135757600160035f8c81526020019081526020015f205f82825461134f9190611d49565b925050819055505b888a3373ffffffffffffffffffffffffffffffffffffffff167fd610fbc161b5374a686883a3e2a444010d7b5b90bf8ade281573f7ff6d1eed598b8b8b6040516113a393929190612431565b60405180910390a45050505050505092915050565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614611445576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161143c90611dc6565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036114b3576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016114aa906124b0565b60405180910390fd5b805f806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b5f4442338460025f8781526020019081526020015f2054604051602001611520959493929190612533565b604051602081830303815290604052805190602001205f1c9050919050565b6040518060600160405280606081526020015f60ff1681526020015f151581525090565b5f80fd5b5f80fd5b5f819050919050565b61157d8161156b565b8114611587575f80fd5b50565b5f8135905061159881611574565b92915050565b5f602082840312156115b3576115b2611563565b5b5f6115c08482850161158a565b91505092915050565b6115d28161156b565b82525050565b5f6020820190506115eb5f8301846115c9565b92915050565b5f80fd5b5f80fd5b5f80fd5b5f8083601f840112611612576116116115f1565b5b8235905067ffffffffffffffff81111561162f5761162e6115f5565b5b60208301915083600182028301111561164b5761164a6115f9565b5b9250929050565b5f60ff82169050919050565b61166781611652565b8114611671575f80fd5b50565b5f813590506116828161165e565b92915050565b5f8115159050919050565b61169c81611688565b81146116a6575f80fd5b50565b5f813590506116b781611693565b92915050565b5f805f805f608086880312156116d6576116d5611563565b5b5f6116e38882890161158a565b955050602086013567ffffffffffffffff81111561170457611703611567565b5b611710888289016115fd565b9450945050604061172388828901611674565b9250506060611734888289016116a9565b9150509295509295909350565b5f805f806060858703121561175957611758611563565b5b5f85013567ffffffffffffffff81111561177657611775611567565b5b611782878288016115fd565b9450945050602061179587828801611674565b92505060406117a6878288016116a9565b91505092959194509250565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f819050919050565b5f6117f46117ef6117ea846117b2565b6117d1565b6117b2565b9050919050565b5f611805826117da565b9050919050565b5f611816826117fb565b9050919050565b6118268161180c565b82525050565b5f60208201905061183f5f83018461181d565b92915050565b5f81519050919050565b5f82825260208201905092915050565b8281835e5f83830152505050565b5f601f19601f8301169050919050565b5f61188782611845565b611891818561184f565b93506118a181856020860161185f565b6118aa8161186d565b840191505092915050565b6118be81611652565b82525050565b6118cd81611688565b82525050565b5f6060820190508181035f8301526118eb818661187d565b90506118fa60208301856118b5565b61190760408301846118c4565b949350505050565b5f611919826117fb565b9050919050565b6119298161190f565b82525050565b5f6020820190506119425f830184611920565b92915050565b5f611952826117b2565b9050919050565b61196281611948565b82525050565b5f60208201905061197b5f830184611959565b92915050565b5f8083601f840112611996576119956115f1565b5b8235905067ffffffffffffffff8111156119b3576119b26115f5565b5b6020830191508360208202830111156119cf576119ce6115f9565b5b9250929050565b5f80602083850312156119ec576119eb611563565b5b5f83013567ffffffffffffffff811115611a0957611a08611567565b5b611a1585828601611981565b92509250509250929050565b5f81519050919050565b5f82825260208201905092915050565b5f819050602082019050919050565b5f82825260208201905092915050565b5f611a6482611845565b611a6e8185611a4a565b9350611a7e81856020860161185f565b611a878161186d565b840191505092915050565b611a9b81611652565b82525050565b611aaa81611688565b82525050565b5f606083015f8301518482035f860152611aca8282611a5a565b9150506020830151611adf6020860182611a92565b506040830151611af26040860182611aa1565b508091505092915050565b5f611b088383611ab0565b905092915050565b5f602082019050919050565b5f611b2682611a21565b611b308185611a2b565b935083602082028501611b4285611a3b565b805f5b85811015611b7d5784840389528151611b5e8582611afd565b9450611b6983611b10565b925060208a01995050600181019050611b45565b50829750879550505050505092915050565b5f6020820190508181035f830152611ba78184611b1c565b905092915050565b5f8060408385031215611bc557611bc4611563565b5b5f611bd28582860161158a565b9250506020611be3858286016116a9565b9150509250929050565b5f8060408385031215611c0357611c02611563565b5b5f611c108582860161158a565b9250506020611c218582860161158a565b9150509250929050565b5f602082019050611c3e5f8301846118c4565b92915050565b611c4d81611948565b8114611c57575f80fd5b50565b5f81359050611c6881611c44565b92915050565b5f60208284031215611c8357611c82611563565b5b5f611c9084828501611c5a565b91505092915050565b5f819050919050565b611cab81611c99565b8114611cb5575f80fd5b50565b5f81519050611cc681611ca2565b92915050565b5f805f60608486031215611ce357611ce2611563565b5b5f611cf086828701611cb8565b9350506020611d0186828701611cb8565b9250506040611d1286828701611cb8565b9150509250925092565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f611d538261156b565b9150611d5e8361156b565b9250828201905080821115611d7657611d75611d1c565b5b92915050565b7f4e6f74206f776e657200000000000000000000000000000000000000000000005f82015250565b5f611db060098361184f565b9150611dbb82611d7c565b602082019050919050565b5f6020820190508181035f830152611ddd81611da4565b9050919050565b7f496e76616c6964206d6f6e7374657200000000000000000000000000000000005f82015250565b5f611e18600f8361184f565b9150611e2382611de4565b602082019050919050565b5f6020820190508181035f830152611e4581611e0c565b9050919050565b7f4e616d6520656d707479000000000000000000000000000000000000000000005f82015250565b5f611e80600a8361184f565b9150611e8b82611e4c565b602082019050919050565b5f6020820190508181035f830152611ead81611e74565b9050919050565b7f42616420646966660000000000000000000000000000000000000000000000005f82015250565b5f611ee860088361184f565b9150611ef382611eb4565b602082019050919050565b5f6020820190508181035f830152611f1581611edc565b9050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680611fba57607f821691505b602082108103611fcd57611fcc611f76565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f6008830261202f7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82611ff4565b6120398683611ff4565b95508019841693508086168417925050509392505050565b5f61206b6120666120618461156b565b6117d1565b61156b565b9050919050565b5f819050919050565b61208483612051565b61209861209082612072565b848454612000565b825550505050565b5f90565b6120ac6120a0565b6120b781848461207b565b505050565b5b818110156120da576120cf5f826120a4565b6001810190506120bd565b5050565b601f82111561211f576120f081611fd3565b6120f984611fe5565b81016020851015612108578190505b61211c61211485611fe5565b8301826120bc565b50505b505050565b5f82821c905092915050565b5f61213f5f1984600802612124565b1980831691505092915050565b5f6121578383612130565b9150826002028217905092915050565b61217082611845565b67ffffffffffffffff81111561218957612188611f49565b5b6121938254611fa3565b61219e8282856120de565b5f60209050601f8311600181146121cf575f84156121bd578287015190505b6121c7858261214c565b86555061222e565b601f1984166121dd86611fd3565b5f5b82811015612204578489015182556001820191506020850194506020810190506121df565b86831015612221578489015161221d601f891682612130565b8355505b6001600288020188555050505b505050505050565b5f8151905061224481611c44565b92915050565b5f6020828403121561225f5761225e611563565b5b5f61226c84828501612236565b91505092915050565b7f4e6f7420746f6b656e206f776e657200000000000000000000000000000000005f82015250565b5f6122a9600f8361184f565b91506122b482612275565b602082019050919050565b5f6020820190508181035f8301526122d68161229d565b9050919050565b5f6122e782611c99565b91506122f283611c99565b925082820390508181125f8412168282135f85121516171561231757612316611d1c565b5b92915050565b5f61232782611c99565b915061233283611c99565b925082820261234081611c99565b91507f800000000000000000000000000000000000000000000000000000000000000084145f8412161561237757612376611d1c565b5b828205841483151761238c5761238b611d1c565b5b5092915050565b5f61239d82611c99565b91506123a883611c99565b92508282019050828112155f8312168382125f8412151617156123ce576123cd611d1c565b5b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f61240b8261156b565b91506124168361156b565b925082612426576124256123d4565b5b828206905092915050565b5f6060820190506124445f8301866118c4565b61245160208301856115c9565b61245e60408301846118b5565b949350505050565b7f5a65726f206f776e6572000000000000000000000000000000000000000000005f82015250565b5f61249a600a8361184f565b91506124a582612466565b602082019050919050565b5f6020820190508181035f8301526124c78161248e565b9050919050565b5f819050919050565b6124e86124e38261156b565b6124ce565b82525050565b5f8160601b9050919050565b5f612504826124ee565b9050919050565b5f612515826124fa565b9050919050565b61252d61252882611948565b61250b565b82525050565b5f61253e82886124d7565b60208201915061254e82876124d7565b60208201915061255e828661251c565b60148201915061256e82856124d7565b60208201915061257e82846124d7565b602082019150819050969550505050505056fea264697066735822122092c2388926b35e6551e6c29849ff29f2227d9d6aa1a1e580e35a5fea9d27726e64736f6c634300081a003300000000000000000000000044afb9e951718fc7d9344cade16f5a6781e96190
Deployed Bytecode
0x608060405234801561000f575f80fd5b50600436106100fe575f3560e01c8063a86c0c0d11610095578063c39563b111610064578063c39563b1146102d6578063c48ad9ab14610306578063ca39e5ef14610322578063f2fde38b14610352576100fe565b8063a86c0c0d1461023a578063b17ad4be1461026a578063b693bff814610286578063c0576b73146102a4576100fe565b80632c73750f116100d15780632c73750f146101ae57806362fb6fe1146101cc57806374c9f2a3146101fe5780638da5cb5b1461021c576100fe565b806303b1cacd14610102578063064e8cb0146101325780631ce6f1a51461016257806329e5c6641461017e575b5f80fd5b61011c6004803603810190610117919061159e565b61036e565b60405161012991906115d8565b60405180910390f35b61014c6004803603810190610147919061159e565b61044d565b60405161015991906115d8565b60405180910390f35b61017c600480360381019061017791906116bd565b610462565b005b61019860048036038101906101939190611741565b6106b1565b6040516101a591906115d8565b60405180910390f35b6101b66108cb565b6040516101c3919061182c565b60405180910390f35b6101e660048036038101906101e1919061159e565b6108ef565b6040516101f5939291906118d3565b60405180910390f35b610206610a4a565b604051610213919061192f565b60405180910390f35b610224610a6e565b6040516102319190611968565b60405180910390f35b610254600480360381019061024f91906119d6565b610a91565b6040516102619190611b8f565b60405180910390f35b610284600480360381019061027f9190611baf565b610c95565b005b61028e610da8565b60405161029b91906115d8565b60405180910390f35b6102be60048036038101906102b9919061159e565b610db4565b6040516102cd939291906118d3565b60405180910390f35b6102f060048036038101906102eb919061159e565b610e88565b6040516102fd91906115d8565b60405180910390f35b610320600480360381019061031b919061159e565b610e9d565b005b61033c60048036038101906103379190611bed565b611028565b6040516103499190611c2b565b60405180910390f35b61036c60048036038101906103679190611c6e565b6113b8565b005b5f805f7f00000000000000000000000044afb9e951718fc7d9344cade16f5a6781e9619073ffffffffffffffffffffffffffffffffffffffff16632ca13ba4856040518263ffffffff1660e01b81526004016103ca91906115d8565b606060405180830381865afa1580156103e5573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906104099190611ccc565b50915091505f8083131561041d5782610420565b60015b90505f808313156104315782610434565b60015b905080826104429190611d49565b945050505050919050565b6002602052805f5260405f205f915090505481565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16146104ef576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016104e690611dc6565b60405180910390fd5b6001805490508510610536576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161052d90611e2e565b60405180910390fd5b5f848490501161057b576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161057290611e96565b60405180910390fd5b5f8260ff16118015610591575060148260ff1611155b6105d0576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016105c790611efe565b60405180910390fd5b604051806060016040528085858080601f0160208091040260200160405190810160405280939291908181526020018383808284375f81840152601f19601f8201169050808301925050505050505081526020018360ff1681526020018215158152506001868154811061064757610646611f1c565b5b905f5260205f2090600202015f820151815f0190816106669190612167565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055509050505050505050565b5f805f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610740576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161073790611dc6565b60405180910390fd5b5f8585905011610785576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161077c90611e96565b60405180910390fd5b5f8360ff1611801561079b575060148360ff1611155b6107da576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107d190611efe565b60405180910390fd5b60018054905090506001604051806060016040528087878080601f0160208091040260200160405190810160405280939291908181526020018383808284375f81840152601f19601f8201169050808301925050505050505081526020018560ff168152602001841515815250908060018154018082558091505060019003905f5260205f2090600202015f909190919091505f820151815f0190816108809190612167565b506020820151816001015f6101000a81548160ff021916908360ff16021790555060408201518160010160016101000a81548160ff0219169083151502179055505050949350505050565b7f0000000000000000000000008161169579cfc3c6aae09e182eb06cefcd2f68c781565b60605f80600180549050841061093a576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161093190611e2e565b60405180910390fd5b5f6001858154811061094f5761094e611f1c565b5b905f5260205f2090600202016040518060600160405290815f8201805461097590611fa3565b80601f01602080910402602001604051908101604052809291908181526020018280546109a190611fa3565b80156109ec5780601f106109c3576101008083540402835291602001916109ec565b820191905f5260205f20905b8154815290600101906020018083116109cf57829003601f168201915b50505050508152602001600182015f9054906101000a900460ff1660ff1660ff1681526020016001820160019054906101000a900460ff1615151515815250509050805f015181602001518260400151935093509350509193909250565b7f00000000000000000000000044afb9e951718fc7d9344cade16f5a6781e9619081565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b60608282905067ffffffffffffffff811115610ab057610aaf611f49565b5b604051908082528060200260200182016040528015610ae957816020015b610ad661153f565b815260200190600190039081610ace5790505b5090505f5b83839050811015610c8e57600180549050848483818110610b1257610b11611f1c565b5b9050602002013510610b59576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610b5090611e2e565b60405180910390fd5b6001848483818110610b6e57610b6d611f1c565b5b9050602002013581548110610b8657610b85611f1c565b5b905f5260205f2090600202016040518060600160405290815f82018054610bac90611fa3565b80601f0160208091040260200160405190810160405280929190818152602001828054610bd890611fa3565b8015610c235780601f10610bfa57610100808354040283529160200191610c23565b820191905f5260205f20905b815481529060010190602001808311610c0657829003601f168201915b50505050508152602001600182015f9054906101000a900460ff1660ff1660ff1681526020016001820160019054906101000a900460ff161515151581525050828281518110610c7657610c75611f1c565b5b60200260200101819052508080600101915050610aee565b5092915050565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610d22576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610d1990611dc6565b60405180910390fd5b6001805490508210610d69576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610d6090611e2e565b60405180910390fd5b8060018381548110610d7e57610d7d611f1c565b5b905f5260205f20906002020160010160016101000a81548160ff0219169083151502179055505050565b5f600180549050905090565b60018181548110610dc3575f80fd5b905f5260205f2090600202015f91509050805f018054610de290611fa3565b80601f0160208091040260200160405190810160405280929190818152602001828054610e0e90611fa3565b8015610e595780601f10610e3057610100808354040283529160200191610e59565b820191905f5260205f20905b815481529060010190602001808311610e3c57829003601f168201915b505050505090806001015f9054906101000a900460ff16908060010160019054906101000a900460ff16905083565b6003602052805f5260405f205f915090505481565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614610f2a576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610f2190611dc6565b60405180910390fd5b6001805490508110610f71576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610f6890611e2e565b60405180910390fd5b60405180602001604052805f81525060018281548110610f9457610f93611f1c565b5b905f5260205f2090600202015f019081610fae9190612167565b505f60018281548110610fc457610fc3611f1c565b5b905f5260205f2090600202016001015f6101000a81548160ff021916908360ff1602179055505f60018281548110610fff57610ffe611f1c565b5b905f5260205f20906002020160010160016101000a81548160ff02191690831515021790555050565b5f3373ffffffffffffffffffffffffffffffffffffffff167f0000000000000000000000008161169579cfc3c6aae09e182eb06cefcd2f68c773ffffffffffffffffffffffffffffffffffffffff16636352211e856040518263ffffffff1660e01b815260040161109991906115d8565b602060405180830381865afa1580156110b4573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906110d8919061224a565b73ffffffffffffffffffffffffffffffffffffffff161461112e576040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401611125906122bf565b60405180910390fd5b6001805490508210801561116f57506001828154811061115157611150611f1c565b5b905f5260205f20906002020160010160019054906101000a900460ff165b6111ae576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016111a590611e2e565b60405180910390fd5b5f6111b88461036e565b90505f600184815481106111cf576111ce611f1c565b5b905f5260205f2090600202016001015f9054906101000a900460ff1690505f7f00000000000000000000000044afb9e951718fc7d9344cade16f5a6781e9619073ffffffffffffffffffffffffffffffffffffffff16632ca13ba4876040518263ffffffff1660e01b815260040161124791906115d8565b606060405180830381865afa158015611262573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906112869190611ccc565b925050505f8260ff168461129a91906122dd565b90505f826003836112ab919061231d565b60326112b79190612393565b6112c19190612393565b9050600a8112156112d157600a90505b605a8113156112df57605a90505b5f8190505f60646112ef8b6114f5565b6112f99190612401565b90508181109750600160025f8c81526020019081526020015f205f8282546113219190611d49565b92505081905550871561135757600160035f8c81526020019081526020015f205f82825461134f9190611d49565b925050819055505b888a3373ffffffffffffffffffffffffffffffffffffffff167fd610fbc161b5374a686883a3e2a444010d7b5b90bf8ade281573f7ff6d1eed598b8b8b6040516113a393929190612431565b60405180910390a45050505050505092915050565b5f8054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614611445576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161143c90611dc6565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036114b3576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016114aa906124b0565b60405180910390fd5b805f806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b5f4442338460025f8781526020019081526020015f2054604051602001611520959493929190612533565b604051602081830303815290604052805190602001205f1c9050919050565b6040518060600160405280606081526020015f60ff1681526020015f151581525090565b5f80fd5b5f80fd5b5f819050919050565b61157d8161156b565b8114611587575f80fd5b50565b5f8135905061159881611574565b92915050565b5f602082840312156115b3576115b2611563565b5b5f6115c08482850161158a565b91505092915050565b6115d28161156b565b82525050565b5f6020820190506115eb5f8301846115c9565b92915050565b5f80fd5b5f80fd5b5f80fd5b5f8083601f840112611612576116116115f1565b5b8235905067ffffffffffffffff81111561162f5761162e6115f5565b5b60208301915083600182028301111561164b5761164a6115f9565b5b9250929050565b5f60ff82169050919050565b61166781611652565b8114611671575f80fd5b50565b5f813590506116828161165e565b92915050565b5f8115159050919050565b61169c81611688565b81146116a6575f80fd5b50565b5f813590506116b781611693565b92915050565b5f805f805f608086880312156116d6576116d5611563565b5b5f6116e38882890161158a565b955050602086013567ffffffffffffffff81111561170457611703611567565b5b611710888289016115fd565b9450945050604061172388828901611674565b9250506060611734888289016116a9565b9150509295509295909350565b5f805f806060858703121561175957611758611563565b5b5f85013567ffffffffffffffff81111561177657611775611567565b5b611782878288016115fd565b9450945050602061179587828801611674565b92505060406117a6878288016116a9565b91505092959194509250565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f819050919050565b5f6117f46117ef6117ea846117b2565b6117d1565b6117b2565b9050919050565b5f611805826117da565b9050919050565b5f611816826117fb565b9050919050565b6118268161180c565b82525050565b5f60208201905061183f5f83018461181d565b92915050565b5f81519050919050565b5f82825260208201905092915050565b8281835e5f83830152505050565b5f601f19601f8301169050919050565b5f61188782611845565b611891818561184f565b93506118a181856020860161185f565b6118aa8161186d565b840191505092915050565b6118be81611652565b82525050565b6118cd81611688565b82525050565b5f6060820190508181035f8301526118eb818661187d565b90506118fa60208301856118b5565b61190760408301846118c4565b949350505050565b5f611919826117fb565b9050919050565b6119298161190f565b82525050565b5f6020820190506119425f830184611920565b92915050565b5f611952826117b2565b9050919050565b61196281611948565b82525050565b5f60208201905061197b5f830184611959565b92915050565b5f8083601f840112611996576119956115f1565b5b8235905067ffffffffffffffff8111156119b3576119b26115f5565b5b6020830191508360208202830111156119cf576119ce6115f9565b5b9250929050565b5f80602083850312156119ec576119eb611563565b5b5f83013567ffffffffffffffff811115611a0957611a08611567565b5b611a1585828601611981565b92509250509250929050565b5f81519050919050565b5f82825260208201905092915050565b5f819050602082019050919050565b5f82825260208201905092915050565b5f611a6482611845565b611a6e8185611a4a565b9350611a7e81856020860161185f565b611a878161186d565b840191505092915050565b611a9b81611652565b82525050565b611aaa81611688565b82525050565b5f606083015f8301518482035f860152611aca8282611a5a565b9150506020830151611adf6020860182611a92565b506040830151611af26040860182611aa1565b508091505092915050565b5f611b088383611ab0565b905092915050565b5f602082019050919050565b5f611b2682611a21565b611b308185611a2b565b935083602082028501611b4285611a3b565b805f5b85811015611b7d5784840389528151611b5e8582611afd565b9450611b6983611b10565b925060208a01995050600181019050611b45565b50829750879550505050505092915050565b5f6020820190508181035f830152611ba78184611b1c565b905092915050565b5f8060408385031215611bc557611bc4611563565b5b5f611bd28582860161158a565b9250506020611be3858286016116a9565b9150509250929050565b5f8060408385031215611c0357611c02611563565b5b5f611c108582860161158a565b9250506020611c218582860161158a565b9150509250929050565b5f602082019050611c3e5f8301846118c4565b92915050565b611c4d81611948565b8114611c57575f80fd5b50565b5f81359050611c6881611c44565b92915050565b5f60208284031215611c8357611c82611563565b5b5f611c9084828501611c5a565b91505092915050565b5f819050919050565b611cab81611c99565b8114611cb5575f80fd5b50565b5f81519050611cc681611ca2565b92915050565b5f805f60608486031215611ce357611ce2611563565b5b5f611cf086828701611cb8565b9350506020611d0186828701611cb8565b9250506040611d1286828701611cb8565b9150509250925092565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f611d538261156b565b9150611d5e8361156b565b9250828201905080821115611d7657611d75611d1c565b5b92915050565b7f4e6f74206f776e657200000000000000000000000000000000000000000000005f82015250565b5f611db060098361184f565b9150611dbb82611d7c565b602082019050919050565b5f6020820190508181035f830152611ddd81611da4565b9050919050565b7f496e76616c6964206d6f6e7374657200000000000000000000000000000000005f82015250565b5f611e18600f8361184f565b9150611e2382611de4565b602082019050919050565b5f6020820190508181035f830152611e4581611e0c565b9050919050565b7f4e616d6520656d707479000000000000000000000000000000000000000000005f82015250565b5f611e80600a8361184f565b9150611e8b82611e4c565b602082019050919050565b5f6020820190508181035f830152611ead81611e74565b9050919050565b7f42616420646966660000000000000000000000000000000000000000000000005f82015250565b5f611ee860088361184f565b9150611ef382611eb4565b602082019050919050565b5f6020820190508181035f830152611f1581611edc565b9050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680611fba57607f821691505b602082108103611fcd57611fcc611f76565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f6008830261202f7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82611ff4565b6120398683611ff4565b95508019841693508086168417925050509392505050565b5f61206b6120666120618461156b565b6117d1565b61156b565b9050919050565b5f819050919050565b61208483612051565b61209861209082612072565b848454612000565b825550505050565b5f90565b6120ac6120a0565b6120b781848461207b565b505050565b5b818110156120da576120cf5f826120a4565b6001810190506120bd565b5050565b601f82111561211f576120f081611fd3565b6120f984611fe5565b81016020851015612108578190505b61211c61211485611fe5565b8301826120bc565b50505b505050565b5f82821c905092915050565b5f61213f5f1984600802612124565b1980831691505092915050565b5f6121578383612130565b9150826002028217905092915050565b61217082611845565b67ffffffffffffffff81111561218957612188611f49565b5b6121938254611fa3565b61219e8282856120de565b5f60209050601f8311600181146121cf575f84156121bd578287015190505b6121c7858261214c565b86555061222e565b601f1984166121dd86611fd3565b5f5b82811015612204578489015182556001820191506020850194506020810190506121df565b86831015612221578489015161221d601f891682612130565b8355505b6001600288020188555050505b505050505050565b5f8151905061224481611c44565b92915050565b5f6020828403121561225f5761225e611563565b5b5f61226c84828501612236565b91505092915050565b7f4e6f7420746f6b656e206f776e657200000000000000000000000000000000005f82015250565b5f6122a9600f8361184f565b91506122b482612275565b602082019050919050565b5f6020820190508181035f8301526122d68161229d565b9050919050565b5f6122e782611c99565b91506122f283611c99565b925082820390508181125f8412168282135f85121516171561231757612316611d1c565b5b92915050565b5f61232782611c99565b915061233283611c99565b925082820261234081611c99565b91507f800000000000000000000000000000000000000000000000000000000000000084145f8412161561237757612376611d1c565b5b828205841483151761238c5761238b611d1c565b5b5092915050565b5f61239d82611c99565b91506123a883611c99565b92508282019050828112155f8312168382125f8412151617156123ce576123cd611d1c565b5b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f61240b8261156b565b91506124168361156b565b925082612426576124256123d4565b5b828206905092915050565b5f6060820190506124445f8301866118c4565b61245160208301856115c9565b61245e60408301846118b5565b949350505050565b7f5a65726f206f776e6572000000000000000000000000000000000000000000005f82015250565b5f61249a600a8361184f565b91506124a582612466565b602082019050919050565b5f6020820190508181035f8301526124c78161248e565b9050919050565b5f819050919050565b6124e86124e38261156b565b6124ce565b82525050565b5f8160601b9050919050565b5f612504826124ee565b9050919050565b5f612515826124fa565b9050919050565b61252d61252882611948565b61250b565b82525050565b5f61253e82886124d7565b60208201915061254e82876124d7565b60208201915061255e828661251c565b60148201915061256e82856124d7565b60208201915061257e82846124d7565b602082019150819050969550505050505056fea264697066735822122092c2388926b35e6551e6c29849ff29f2227d9d6aa1a1e580e35a5fea9d27726e64736f6c634300081a0033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
00000000000000000000000044afb9e951718fc7d9344cade16f5a6781e96190
-----Decoded View---------------
Arg [0] : _equipment (address): 0x44afb9e951718FC7d9344cAdE16f5a6781E96190
-----Encoded View---------------
1 Constructor Arguments found :
Arg [0] : 00000000000000000000000044afb9e951718fc7d9344cade16f5a6781e96190
Net Worth in USD
Net Worth in ETH
Multichain Portfolio | 35 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.