// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
/// @title Nyro Token
/// @notice ERC-20 reward token distributed only by the Nyro NFT contract.
contract NyroToken is ERC20, Ownable {
uint256 public constant MAX_SUPPLY = 10_000_000 ether;
address public minter;
bool public minterLocked;
error ZeroAddress();
error InvalidAmount();
error UnauthorizedMinter();
error MinterAlreadyLocked();
error MaxSupplyExceeded();
event MinterConfigured(address indexed minter);
constructor(address initialOwner) ERC20("Nyro", "NYRO") Ownable(initialOwner) {}
/// @notice Permanently assigns the sole token minter. This can only be executed once.
function setMinter(address minter_) external onlyOwner {
if (minterLocked) revert MinterAlreadyLocked();
if (minter_ == address(0)) revert ZeroAddress();
minter = minter_;
minterLocked = true;
emit MinterConfigured(minter_);
}
/// @notice Mints NYRO rewards. Only the permanently configured Nyro NFT contract may call this.
function mintReward(address to, uint256 amount) external {
if (msg.sender != minter) revert UnauthorizedMinter();
if (to == address(0)) revert ZeroAddress();
if (amount == 0) revert InvalidAmount();
if (totalSupply() + amount > MAX_SUPPLY) revert MaxSupplyExceeded();
_mint(to, amount);
}
}
imports29 files
@openzeppelin/contracts/utils/Panic.sol
// 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)
}
}
}
@openzeppelin/contracts/utils/ReentrancyGuard.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
import {StorageSlot} from "./StorageSlot.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*
* IMPORTANT: Deprecated. This storage-based reentrancy guard will be removed and replaced
* by the {ReentrancyGuardTransient} variant in v6.0.
*
* @custom:stateless
*/
abstract contract ReentrancyGuard {
using StorageSlot for bytes32;
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant REENTRANCY_GUARD_STORAGE =
0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
constructor() {
_reentrancyGuardStorageSlot().getUint256Slot().value = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
/**
* @dev A `view` only version of {nonReentrant}. Use to block view functions
* from being called, preventing reading from inconsistent contract state.
*
* CAUTION: This is a "view" modifier and does not change the reentrancy
* status. Use it only on view functions. For payable or non-payable functions,
* use the standard {nonReentrant} modifier instead.
*/
modifier nonReentrantView() {
_nonReentrantBeforeView();
_;
}
function _nonReentrantBeforeView() private view {
if (_reentrancyGuardEntered()) {
revert ReentrancyGuardReentrantCall();
}
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be NOT_ENTERED
_nonReentrantBeforeView();
// Any calls to nonReentrant after this point will fail
_reentrancyGuardStorageSlot().getUint256Slot().value = ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_reentrancyGuardStorageSlot().getUint256Slot().value = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _reentrancyGuardStorageSlot().getUint256Slot().value == ENTERED;
}
function _reentrancyGuardStorageSlot() internal pure virtual returns (bytes32) {
return REENTRANCY_GUARD_STORAGE;
}
}
@openzeppelin/contracts/access/Ownable.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
@openzeppelin/contracts/access/Ownable2Step.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.20;
import {Ownable} from "./Ownable.sol";
/**
* @dev Contract module which provides access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* This extension of the {Ownable} contract includes a two-step mechanism to transfer
* ownership, where the new owner must call {acceptOwnership} in order to replace the
* old one. This can help prevent common mistakes, such as transfers of ownership to
* incorrect accounts, or to contracts that are unable to interact with the
* permission system.
*
* The initial owner is specified at deployment time in the constructor for `Ownable`. This
* can later be changed with {transferOwnership} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2Step is Ownable {
address private _pendingOwner;
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*
* Setting `newOwner` to the zero address is allowed; this can be used to cancel an initiated ownership transfer.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
if (pendingOwner() != sender) {
revert OwnableUnauthorizedAccount(sender);
}
_transferOwnership(sender);
}
}
@openzeppelin/contracts/interfaces/draft-IERC6093.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (interfaces/draft-IERC6093.sol)
pragma solidity >=0.8.4;
/**
* @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-721.
* 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);
}
@openzeppelin/contracts/token/ERC20/ERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* Both values are immutable: they can only be set once during construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/// @inheritdoc IERC20
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/// @inheritdoc IERC20
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/// @inheritdoc IERC20
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation sets the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the `transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner`'s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}
@openzeppelin/contracts/token/ERC20/IERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/IERC20.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity >=0.6.2;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
@openzeppelin/contracts/token/ERC721/ERC721.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.24;
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_;
}
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
super.supportsInterface(interfaceId);
}
/// @inheritdoc IERC721
function balanceOf(address owner) public view virtual returns (uint256) {
if (owner == address(0)) {
revert ERC721InvalidOwner(address(0));
}
return _balances[owner];
}
/// @inheritdoc IERC721
function ownerOf(uint256 tokenId) public view virtual returns (address) {
return _requireOwned(tokenId);
}
/// @inheritdoc IERC721Metadata
function name() public view virtual returns (string memory) {
return _name;
}
/// @inheritdoc IERC721Metadata
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/// @inheritdoc IERC721Metadata
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 "";
}
/// @inheritdoc IERC721
function approve(address to, uint256 tokenId) public virtual {
_approve(to, tokenId, _msgSender());
}
/// @inheritdoc IERC721
function getApproved(uint256 tokenId) public view virtual returns (address) {
_requireOwned(tokenId);
return _getApproved(tokenId);
}
/// @inheritdoc IERC721
function setApprovalForAll(address operator, bool approved) public virtual {
_setApprovalForAll(_msgSender(), operator, approved);
}
/// @inheritdoc IERC721
function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
return _operatorApprovals[owner][operator];
}
/// @inheritdoc IERC721
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);
}
}
/// @inheritdoc IERC721
function safeTransferFrom(address from, address to, uint256 tokenId) public {
safeTransferFrom(from, to, tokenId, "");
}
/// @inheritdoc IERC721
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 (owner == address(0)) {
revert ERC721InvalidApprover(address(0));
}
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;
}
}
@openzeppelin/contracts/token/ERC721/IERC721.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721.sol)
pragma solidity >=0.6.2;
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);
}
@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721Receiver.sol)
pragma solidity >=0.5.0;
/**
* @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);
}
@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (token/ERC721/extensions/ERC721Enumerable.sol)
pragma solidity ^0.8.24;
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();
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721) returns (bool) {
return interfaceId == type(IERC721Enumerable).interfaceId || super.supportsInterface(interfaceId);
}
/// @inheritdoc IERC721Enumerable
function tokenOfOwnerByIndex(address owner, uint256 index) public view virtual returns (uint256) {
if (index >= balanceOf(owner)) {
revert ERC721OutOfBoundsIndex(owner, index);
}
return _ownedTokens[owner][index];
}
/// @inheritdoc IERC721Enumerable
function totalSupply() public view virtual returns (uint256) {
return _allTokens.length;
}
/// @inheritdoc IERC721Enumerable
function tokenByIndex(uint256 index) public view virtual returns (uint256) {
if (index >= totalSupply()) {
revert ERC721OutOfBoundsIndex(address(0), index);
}
return _allTokens[index];
}
/// @inheritdoc ERC721
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 to forbid batch minting because the enumeration
* extension does not support it.
*/
function _increaseBalance(address account, uint128 amount) internal virtual override {
if (amount > 0) {
revert ERC721EnumerableForbiddenBatchMint();
}
super._increaseBalance(account, amount);
}
}
@openzeppelin/contracts/token/ERC721/extensions/IERC721Enumerable.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/extensions/IERC721Enumerable.sol)
pragma solidity >=0.6.2;
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);
}
@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity >=0.6.2;
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);
}
@openzeppelin/contracts/token/ERC721/utils/ERC721Utils.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.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 provides 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(reason, 0x20), mload(reason))
}
}
}
}
}
}
@openzeppelin/contracts/utils/Base64.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (utils/Base64.sol)
pragma solidity ^0.8.20;
import {SafeCast} from "./math/SafeCast.sol";
/**
* @dev Provides a set of functions to operate with Base64 strings.
*/
library Base64 {
using SafeCast for bool;
error InvalidBase64Char(bytes1);
/**
* @dev Converts a `bytes` to its Base64 `string` representation.
*/
function encode(bytes memory data) internal pure returns (string memory) {
return string(_encode(data, false));
}
/**
* @dev Converts a `bytes` to its Base64Url `string` representation.
* Output is not padded with `=` as specified in https://www.rfc-editor.org/rfc/rfc4648[rfc4648].
*/
function encodeURL(bytes memory data) internal pure returns (string memory) {
return string(_encode(data, true));
}
/**
* @dev Converts a Base64 `string` to the `bytes` it represents.
*
* * Supports padded and unpadded inputs.
* * Supports both encoding ({encode} and {encodeURL}) seamlessly.
* * Reverts with {InvalidBase64Char} if the input contains an invalid character.
*/
function decode(string memory data) internal pure returns (bytes memory) {
return _decode(bytes(data));
}
/**
* @dev Internal table-agnostic encoding
*
* Padding is enabled when using the Base64 table, and disabled when using the Base64Url table.
* See sections 4 and 5 of https://datatracker.ietf.org/doc/html/rfc4648
*/
function _encode(bytes memory data, bool urlAndFilenameSafe) private pure returns (bytes memory result) {
/**
* Inspired by Brecht Devos (Brechtpd) implementation - MIT license
* https://github.com/Brechtpd/base64/blob/e78d9fd951e7b0977ddca77d92dc85183770daf4/base64.sol
*/
if (data.length == 0) return "";
// Padding is enabled by default, but disabled when the "urlAndFilenameSafe" alphabet is used
//
// If padding is enabled, the final length should be `bytes` data length divided by 3 rounded up and then
// multiplied by 4 so that it leaves room for padding the last chunk
// - `data.length + 2` -> Prepare for division rounding up
// - `/ 3` -> Number of 3-bytes chunks (rounded up)
// - `4 *` -> 4 characters for each chunk
// This is equivalent to: 4 * Math.ceil(data.length / 3)
//
// If padding is disabled, the final length should be `bytes` data length multiplied by 4/3 rounded up as
// opposed to when padding is required to fill the last chunk.
// - `4 * data.length` -> 4 characters for each chunk
// - ` + 2` -> Prepare for division rounding up
// - `/ 3` -> Number of 3-bytes chunks (rounded up)
// This is equivalent to: Math.ceil((4 * data.length) / 3)
uint256 resultLength = urlAndFilenameSafe ? (4 * data.length + 2) / 3 : 4 * ((data.length + 2) / 3);
assembly ("memory-safe") {
result := mload(0x40)
// Store the encoding table in the scratch space (and fmp ptr) to avoid memory allocation
//
// Base64 (ascii) A B C D E F G H I J K L M N O P Q R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z 0 1 2 3 4 5 6 7 8 9 + /
// Base64 (hex) 4142434445464748494a4b4c4d4e4f505152535455565758595a6162636465666768696a6b6c6d6e6f707172737475767778797a303132333435363738392b2f
// Base64Url (ascii) A B C D E F G H I J K L M N O P Q R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z 0 1 2 3 4 5 6 7 8 9 - _
// Base64Url (hex) 4142434445464748494a4b4c4d4e4f505152535455565758595a6162636465666768696a6b6c6d6e6f707172737475767778797a303132333435363738392d5f
// xor (hex) 00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000670
mstore(0x1f, "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef")
mstore(0x3f, xor("ghijklmnopqrstuvwxyz0123456789+/", mul(urlAndFilenameSafe, 0x670)))
// Prepare result pointer, jump over length
let resultPtr := add(result, 0x20)
let resultEnd := add(resultPtr, resultLength)
let dataPtr := data
let endPtr := add(data, mload(data))
// In some cases, the last iteration will read bytes after the end of the data. We cache the value, and
// set it to zero to make sure no dirty bytes are read in that section.
let afterPtr := add(endPtr, 0x20)
let afterCache := mload(afterPtr)
mstore(afterPtr, 0x00)
// Run over the input, 3 bytes at a time
for {} lt(dataPtr, endPtr) {} {
// Advance 3 bytes
dataPtr := add(dataPtr, 3)
let input := mload(dataPtr)
// To write each character, shift the 3 byte (24 bits) chunk
// 4 times in blocks of 6 bits for each character (18, 12, 6, 0)
// and apply logical AND with 0x3F to bitmask the least significant 6 bits.
// Use this as an index into the lookup table, mload an entire word
// so the desired character is in the least significant byte, and
// mstore8 this least significant byte into the result and continue.
mstore8(resultPtr, mload(and(shr(18, input), 0x3F)))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(and(shr(12, input), 0x3F)))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(and(shr(6, input), 0x3F)))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(and(input, 0x3F)))
resultPtr := add(resultPtr, 1) // Advance
}
// Reset the value that was cached
mstore(afterPtr, afterCache)
if iszero(urlAndFilenameSafe) {
// When data `bytes` is not exactly 3 bytes long
// it is padded with `=` characters at the end
switch mod(mload(data), 3)
case 1 {
mstore8(sub(resultPtr, 1), 0x3d)
mstore8(sub(resultPtr, 2), 0x3d)
}
case 2 {
mstore8(sub(resultPtr, 1), 0x3d)
}
}
// Store result length and update FMP to reserve allocated space
mstore(result, resultLength)
mstore(0x40, resultEnd)
}
}
/**
* @dev Internal decoding
*/
function _decode(bytes memory data) private pure returns (bytes memory result) {
bytes4 errorSelector = InvalidBase64Char.selector;
uint256 dataLength = data.length;
if (dataLength == 0) return "";
uint256 resultLength = (dataLength / 4) * 3;
if (dataLength % 4 == 0) {
resultLength -= (data[dataLength - 1] == "=").toUint() + (data[dataLength - 2] == "=").toUint();
} else {
resultLength += (dataLength % 4) - 1;
}
assembly ("memory-safe") {
result := mload(0x40)
// Temporarily store the reverse lookup table between in memory. This spans from 0x00 to 0x50, Using:
// - all 64bytes of scratch space
// - part of the FMP (at location 0x40)
mstore(0x30, 0x2425262728292a2b2c2d2e2f30313233)
mstore(0x20, 0x0a0b0c0d0e0f10111213141516171819ffffffff3fff1a1b1c1d1e1f20212223)
mstore(0x00, 0x3eff3eff3f3435363738393a3b3c3dffffff00ffffff00010203040506070809)
// Prepare result pointer, jump over length
let dataPtr := data
let resultPtr := add(result, 0x20)
let endPtr := add(resultPtr, resultLength)
// In some cases, the last iteration will read bytes after the end of the data. We cache the value, and
// set it to "==" (fake padding) to make sure no dirty bytes are read in that section.
let afterPtr := add(add(data, 0x20), dataLength)
let afterCache := mload(afterPtr)
mstore(afterPtr, shl(240, 0x3d3d))
// loop while not everything is decoded
for {} lt(resultPtr, endPtr) {} {
dataPtr := add(dataPtr, 4)
// Read a 4 bytes chunk of data
let input := mload(dataPtr)
// Decode each byte in the chunk as a 6 bit block, and align them to form a block of 3 bytes
let a := sub(byte(28, input), 43)
// slither-disable-next-line incorrect-shift
if iszero(and(shl(a, 1), 0xffffffd0ffffffc47ff5)) {
mstore(0, errorSelector)
mstore(4, shl(248, add(a, 43)))
revert(0, 0x24)
}
let b := sub(byte(29, input), 43)
// slither-disable-next-line incorrect-shift
if iszero(and(shl(b, 1), 0xffffffd0ffffffc47ff5)) {
mstore(0, errorSelector)
mstore(4, shl(248, add(b, 43)))
revert(0, 0x24)
}
let c := sub(byte(30, input), 43)
// slither-disable-next-line incorrect-shift
if iszero(and(shl(c, 1), 0xffffffd0ffffffc47ff5)) {
mstore(0, errorSelector)
mstore(4, shl(248, add(c, 43)))
revert(0, 0x24)
}
let d := sub(byte(31, input), 43)
// slither-disable-next-line incorrect-shift
if iszero(and(shl(d, 1), 0xffffffd0ffffffc47ff5)) {
mstore(0, errorSelector)
mstore(4, shl(248, add(d, 43)))
revert(0, 0x24)
}
mstore(
resultPtr,
or(
or(shl(250, byte(0, mload(a))), shl(244, byte(0, mload(b)))),
or(shl(238, byte(0, mload(c))), shl(232, byte(0, mload(d))))
)
)
resultPtr := add(resultPtr, 3)
}
// Reset the value that was cached
mstore(afterPtr, afterCache)
// Store result length and update FMP to reserve allocated space
mstore(result, resultLength)
mstore(0x40, endPtr)
}
}
}
@openzeppelin/contracts/utils/Bytes.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (utils/Bytes.sol)
pragma solidity ^0.8.24;
import {Math} from "./math/Math.sol";
/**
* @dev Bytes operations.
*/
library Bytes {
/**
* @dev Forward search for `s` in `buffer`
* * If `s` is present in the buffer, returns the index of the first instance
* * If `s` is not present in the buffer, returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf[Javascript's `Array.indexOf`]
*/
function indexOf(bytes memory buffer, bytes1 s) internal pure returns (uint256) {
return indexOf(buffer, s, 0);
}
/**
* @dev Forward search for `s` in `buffer` starting at position `pos`
* * If `s` is present in the buffer (at or after `pos`), returns the index of the next instance
* * If `s` is not present in the buffer (at or after `pos`), returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf[Javascript's `Array.indexOf`]
*/
function indexOf(bytes memory buffer, bytes1 s, uint256 pos) internal pure returns (uint256) {
uint256 length = buffer.length;
for (uint256 i = pos; i < length; ++i) {
if (bytes1(_unsafeReadBytesOffset(buffer, i)) == s) {
return i;
}
}
return type(uint256).max;
}
/**
* @dev Backward search for `s` in `buffer`
* * If `s` is present in the buffer, returns the index of the last instance
* * If `s` is not present in the buffer, returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf[Javascript's `Array.lastIndexOf`]
*/
function lastIndexOf(bytes memory buffer, bytes1 s) internal pure returns (uint256) {
return lastIndexOf(buffer, s, type(uint256).max);
}
/**
* @dev Backward search for `s` in `buffer` starting at position `pos`
* * If `s` is present in the buffer (at or before `pos`), returns the index of the previous instance
* * If `s` is not present in the buffer (at or before `pos`), returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf[Javascript's `Array.lastIndexOf`]
*/
function lastIndexOf(bytes memory buffer, bytes1 s, uint256 pos) internal pure returns (uint256) {
unchecked {
uint256 length = buffer.length;
for (uint256 i = Math.min(Math.saturatingAdd(pos, 1), length); i > 0; --i) {
if (bytes1(_unsafeReadBytesOffset(buffer, i - 1)) == s) {
return i - 1;
}
}
return type(uint256).max;
}
}
/**
* @dev Copies the content of `buffer`, from `start` (included) to the end of `buffer` into a new bytes object in
* memory.
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice[Javascript's `Array.slice`]
*/
function slice(bytes memory buffer, uint256 start) internal pure returns (bytes memory) {
return slice(buffer, start, buffer.length);
}
/**
* @dev Copies the content of `buffer`, from `start` (included) to `end` (excluded) into a new bytes object in
* memory. The `end` argument is truncated to the length of the `buffer`.
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice[Javascript's `Array.slice`]
*/
function slice(bytes memory buffer, uint256 start, uint256 end) internal pure returns (bytes memory) {
// sanitize
end = Math.min(end, buffer.length);
start = Math.min(start, end);
// allocate and copy
bytes memory result = new bytes(end - start);
assembly ("memory-safe") {
mcopy(add(result, 0x20), add(add(buffer, 0x20), start), sub(end, start))
}
return result;
}
/**
* @dev Moves the content of `buffer`, from `start` (included) to the end of `buffer` to the start of that buffer,
* and shrinks the buffer length accordingly, effectively overriding the content of buffer with buffer[start:].
*
* NOTE: This function modifies the provided buffer in place. If you need to preserve the original buffer, use {slice} instead
*/
function splice(bytes memory buffer, uint256 start) internal pure returns (bytes memory) {
return splice(buffer, start, buffer.length);
}
/**
* @dev Moves the content of `buffer`, from `start` (included) to `end` (excluded) to the start of that buffer,
* and shrinks the buffer length accordingly, effectively overriding the content of buffer with buffer[start:end].
* The `end` argument is truncated to the length of the `buffer`.
*
* NOTE: This function modifies the provided buffer in place. If you need to preserve the original buffer, use {slice} instead
*/
function splice(bytes memory buffer, uint256 start, uint256 end) internal pure returns (bytes memory) {
// sanitize
end = Math.min(end, buffer.length);
start = Math.min(start, end);
// move and resize
assembly ("memory-safe") {
mcopy(add(buffer, 0x20), add(add(buffer, 0x20), start), sub(end, start))
mstore(buffer, sub(end, start))
}
return buffer;
}
/**
* @dev Replaces bytes in `buffer` starting at `pos` with all bytes from `replacement`.
*
* Parameters are clamped to valid ranges (i.e. `pos` is clamped to `[0, buffer.length]`).
* If `pos >= buffer.length`, no replacement occurs and the buffer is returned unchanged.
*
* NOTE: This function modifies the provided buffer in place.
*/
function replace(bytes memory buffer, uint256 pos, bytes memory replacement) internal pure returns (bytes memory) {
return replace(buffer, pos, replacement, 0, replacement.length);
}
/**
* @dev Replaces bytes in `buffer` starting at `pos` with bytes from `replacement` starting at `offset`.
* Copies at most `length` bytes from `replacement` to `buffer`.
*
* Parameters are clamped to valid ranges (i.e. `pos` is clamped to `[0, buffer.length]`, `offset` is
* clamped to `[0, replacement.length]`, and `length` is clamped to `min(length, replacement.length - offset,
* buffer.length - pos))`. If `pos >= buffer.length` or `offset >= replacement.length`, no replacement occurs
* and the buffer is returned unchanged.
*
* NOTE: This function modifies the provided buffer in place.
*/
function replace(
bytes memory buffer,
uint256 pos,
bytes memory replacement,
uint256 offset,
uint256 length
) internal pure returns (bytes memory) {
// sanitize
pos = Math.min(pos, buffer.length);
offset = Math.min(offset, replacement.length);
length = Math.min(length, Math.min(replacement.length - offset, buffer.length - pos));
// replace
assembly ("memory-safe") {
mcopy(add(add(buffer, 0x20), pos), add(add(replacement, 0x20), offset), length)
}
return buffer;
}
/**
* @dev Concatenate an array of bytes into a single bytes object.
*
* For fixed bytes types, we recommend using the solidity built-in `bytes.concat` or (equivalent)
* `abi.encodePacked`.
*
* NOTE: this could be done in assembly with a single loop that expands starting at the FMP, but that would be
* significantly less readable. It might be worth benchmarking the savings of the full-assembly approach.
*/
function concat(bytes[] memory buffers) internal pure returns (bytes memory) {
uint256 length = 0;
for (uint256 i = 0; i < buffers.length; ++i) {
length += buffers[i].length;
}
bytes memory result = new bytes(length);
uint256 offset = 0x20;
for (uint256 i = 0; i < buffers.length; ++i) {
bytes memory input = buffers[i];
assembly ("memory-safe") {
mcopy(add(result, offset), add(input, 0x20), mload(input))
}
unchecked {
offset += input.length;
}
}
return result;
}
/**
* @dev Split each byte in `input` into two nibbles (4 bits each)
*
* Example: hex"01234567" → hex"0001020304050607"
*/
function toNibbles(bytes memory input) internal pure returns (bytes memory output) {
assembly ("memory-safe") {
let length := mload(input)
output := mload(0x40)
mstore(0x40, add(add(output, 0x20), mul(length, 2)))
mstore(output, mul(length, 2))
for {
let i := 0
} lt(i, length) {
i := add(i, 0x10)
} {
let chunk := shr(128, mload(add(add(input, 0x20), i)))
chunk := and(
0x0000000000000000ffffffffffffffff0000000000000000ffffffffffffffff,
or(shl(64, chunk), chunk)
)
chunk := and(
0x00000000ffffffff00000000ffffffff00000000ffffffff00000000ffffffff,
or(shl(32, chunk), chunk)
)
chunk := and(
0x0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff,
or(shl(16, chunk), chunk)
)
chunk := and(
0x00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff,
or(shl(8, chunk), chunk)
)
chunk := and(
0x0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f,
or(shl(4, chunk), chunk)
)
mstore(add(add(output, 0x20), mul(i, 2)), chunk)
}
}
}
/**
* @dev Returns true if the two byte buffers are equal.
*/
function equal(bytes memory a, bytes memory b) internal pure returns (bool) {
return a.length == b.length && keccak256(a) == keccak256(b);
}
/**
* @dev Reverses the byte order of a bytes32 value, converting between little-endian and big-endian.
* Inspired by https://graphics.stanford.edu/~seander/bithacks.html#ReverseParallel[Reverse Parallel]
*/
function reverseBytes32(bytes32 value) internal pure returns (bytes32) {
value = // swap bytes
((value >> 8) & 0x00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF) |
((value & 0x00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF) << 8);
value = // swap 2-byte long pairs
((value >> 16) & 0x0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF) |
((value & 0x0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF) << 16);
value = // swap 4-byte long pairs
((value >> 32) & 0x00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF) |
((value & 0x00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF) << 32);
value = // swap 8-byte long pairs
((value >> 64) & 0x0000000000000000FFFFFFFFFFFFFFFF0000000000000000FFFFFFFFFFFFFFFF) |
((value & 0x0000000000000000FFFFFFFFFFFFFFFF0000000000000000FFFFFFFFFFFFFFFF) << 64);
return (value >> 128) | (value << 128); // swap 16-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 128-bit values.
function reverseBytes16(bytes16 value) internal pure returns (bytes16) {
value = // swap bytes
((value & 0xFF00FF00FF00FF00FF00FF00FF00FF00) >> 8) |
((value & 0x00FF00FF00FF00FF00FF00FF00FF00FF) << 8);
value = // swap 2-byte long pairs
((value & 0xFFFF0000FFFF0000FFFF0000FFFF0000) >> 16) |
((value & 0x0000FFFF0000FFFF0000FFFF0000FFFF) << 16);
value = // swap 4-byte long pairs
((value & 0xFFFFFFFF00000000FFFFFFFF00000000) >> 32) |
((value & 0x00000000FFFFFFFF00000000FFFFFFFF) << 32);
return (value >> 64) | (value << 64); // swap 8-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 64-bit values.
function reverseBytes8(bytes8 value) internal pure returns (bytes8) {
value = ((value & 0xFF00FF00FF00FF00) >> 8) | ((value & 0x00FF00FF00FF00FF) << 8); // swap bytes
value = ((value & 0xFFFF0000FFFF0000) >> 16) | ((value & 0x0000FFFF0000FFFF) << 16); // swap 2-byte long pairs
return (value >> 32) | (value << 32); // swap 4-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 32-bit values.
function reverseBytes4(bytes4 value) internal pure returns (bytes4) {
value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8); // swap bytes
return (value >> 16) | (value << 16); // swap 2-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 16-bit values.
function reverseBytes2(bytes2 value) internal pure returns (bytes2) {
return (value >> 8) | (value << 8);
}
/**
* @dev Counts the number of leading zero bits a bytes array. Returns `8 * buffer.length`
* if the buffer is all zeros.
*/
function clz(bytes memory buffer) internal pure returns (uint256) {
for (uint256 i = 0; i < buffer.length; i += 0x20) {
bytes32 chunk = _unsafeReadBytesOffset(buffer, i);
if (chunk != bytes32(0)) {
return Math.min(8 * i + Math.clz(uint256(chunk)), 8 * buffer.length);
}
}
return 8 * buffer.length;
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(add(buffer, 0x20), offset))
}
}
}
@openzeppelin/contracts/utils/Context.sol
// 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;
}
}
@openzeppelin/contracts/utils/StorageSlot.sol
// 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
}
}
}
@openzeppelin/contracts/utils/Strings.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (utils/Strings.sol)
pragma solidity ^0.8.24;
import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";
import {Bytes} from "./Bytes.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 =
0xffffffff | // first 32 bits corresponding to the control characters (U+0000 to U+001F)
(1 << 0x22) | // double quote
(1 << 0x5c); // backslash
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @dev The string being parsed contains characters that are not in scope of the given base.
*/
error StringsInvalidChar();
/**
* @dev The string being parsed is not a properly formatted address.
*/
error StringsInvalidAddressFormat();
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
assembly ("memory-safe") {
ptr := add(add(buffer, 0x20), length)
}
while (true) {
ptr--;
assembly ("memory-safe") {
mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
uint256 localValue = value;
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
* representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
* representation, according to EIP-55.
*/
function toChecksumHexString(address addr) internal pure returns (string memory) {
bytes memory buffer = bytes(toHexString(addr));
// hash the hex part of buffer (skip length + 2 bytes, length 40)
uint256 hashValue;
assembly ("memory-safe") {
hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
}
for (uint256 i = 41; i > 1; --i) {
// possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
// case shift by xoring with 0x20
buffer[i] ^= 0x20;
}
hashValue >>= 4;
}
return string(buffer);
}
/**
* @dev Converts a `bytes` buffer to its ASCII `string` hexadecimal representation.
*/
function toHexString(bytes memory input) internal pure returns (string memory) {
unchecked {
bytes memory buffer = new bytes(2 * input.length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 0; i < input.length; ++i) {
uint8 v = uint8(input[i]);
buffer[2 * i + 2] = HEX_DIGITS[v >> 4];
buffer[2 * i + 3] = HEX_DIGITS[v & 0xf];
}
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.equal(bytes(a), 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 backslashes (including those in \uXXXX sequences) and the characters in ranges
* defined in section 2.5 of RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). All control characters in U+0000
* to U+001F are escaped (\b, \t, \n, \f, \r use short form; others use \u00XX). 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);
// Put output at the FMP. Memory will be reserved later when we figure out the actual length of the escaped
// string. All write are done using _unsafeWriteBytesOffset, which avoid the (expensive) length checks for
// each character written.
bytes memory output;
assembly ("memory-safe") {
output := mload(0x40)
}
uint256 outputLength = 0;
for (uint256 i = 0; i < buffer.length; ++i) {
uint8 char = uint8(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (((SPECIAL_CHARS_LOOKUP & (1 << char)) != 0)) {
_unsafeWriteBytesOffset(output, outputLength++, "\\");
if (char == 0x08) _unsafeWriteBytesOffset(output, outputLength++, "b");
else if (char == 0x09) _unsafeWriteBytesOffset(output, outputLength++, "t");
else if (char == 0x0a) _unsafeWriteBytesOffset(output, outputLength++, "n");
else if (char == 0x0c) _unsafeWriteBytesOffset(output, outputLength++, "f");
else if (char == 0x0d) _unsafeWriteBytesOffset(output, outputLength++, "r");
else if (char == 0x5c) _unsafeWriteBytesOffset(output, outputLength++, "\\");
else if (char == 0x22) {
// solhint-disable-next-line quotes
_unsafeWriteBytesOffset(output, outputLength++, '"');
} else {
// U+0000 to U+001F without short form: output \u00XX
_unsafeWriteBytesOffset(output, outputLength++, "u");
_unsafeWriteBytesOffset(output, outputLength++, "0");
_unsafeWriteBytesOffset(output, outputLength++, "0");
_unsafeWriteBytesOffset(output, outputLength++, HEX_DIGITS[char >> 4]);
_unsafeWriteBytesOffset(output, outputLength++, HEX_DIGITS[char & 0x0f]);
}
} else {
_unsafeWriteBytesOffset(output, outputLength++, bytes1(char));
}
}
// write the actual length and reserve memory
assembly ("memory-safe") {
mstore(output, outputLength)
mstore(0x40, add(output, add(outputLength, 0x20)))
}
return string(output);
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(add(buffer, 0x20), offset))
}
}
/**
* @dev Write a bytes1 to 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 _unsafeWriteBytesOffset(bytes memory buffer, uint256 offset, bytes1 value) private pure {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
mstore8(add(add(buffer, 0x20), offset), shr(248, value))
}
}
}
@openzeppelin/contracts/utils/introspection/ERC165.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.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 {
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}
@openzeppelin/contracts/utils/introspection/IERC165.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
@openzeppelin/contracts/utils/math/Math.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.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 `condition ? a : b`. 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. `condition ? a : b`) 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) {
unchecked {
// (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 buffer) private pure returns (bool) {
uint256 chunk;
for (uint256 i = 0; i < buffer.length; i += 0x20) {
// See _unsafeReadBytesOffset from utils/Bytes.sol
assembly ("memory-safe") {
chunk := mload(add(add(buffer, 0x20), i))
}
if (chunk >> (8 * saturatingSub(i + 0x20, buffer.length)) != 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 first 16 bytes (most significant half).
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;
}
/**
* @dev Counts the number of leading zero bits in a uint256.
*/
function clz(uint256 x) internal pure returns (uint256) {
return ternary(x == 0, 256, 255 - log2(x));
}
}
@openzeppelin/contracts/utils/math/SafeCast.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.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 a uint of `bits` size.
*/
error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
/**
* @dev An int value doesn't fit in a 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 A 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))
}
}
}
@openzeppelin/contracts/utils/math/SignedMath.sol
// 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);
}
}
}
contracts/NyroArtData.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @title Nyro Locked Master Art Data
/// @notice Stores the approved 128×128 lime-green-on-black portrait bitmap fully onchain.
contract NyroArtData {
function masterPortrait() external pure returns (string memory) {
return string.concat(
"<path d='M64 5h4v1h-4zM63 6h2v1h-2zM66 6h3v1h-3zM54 7h4v1h-4zM63 7h1v1h-1zM67 7h1v1h-1zM78 7h2v1h-2zM53 8h2v1h-2zM56 8h4v1h-4zM63 8h3v1h-3zM79 8h2v1h-2zM44 9h4v1h-4zM53 9h2v1h-2zM57 9h3v1h-3zM62 9h2v1h-2zM70 9h2v1h-2zM74 9h7v1h-7zM44 10h4v1h-4zM54 10h3v1h-3zM58 10h6v1h-6zM70 10h2v1h-2zM73 10h7v1h-7zM44 11h1v1h-1zM48 11h5v1h-5zM55 11h2v1h-2zM59 11h5v1h-5zM70 11h7v1h-7zM82 11h2v1h-2zM39 12h1v1h-1zM44 12h4v1h-4zM50 12h5v1h-5zM63 12h2v1h-2zM67 12h1v1h-1zM72 12h2v1h-2zM75 12h10v1h-10zM37 13h3v1h-3zM44 13h4v1h-4zM52 13h3v1h-3zM56 13h2v1h-2zM62 13h1v1h-1zM64 13h1v1h-1zM66 13h3v1h-3zM71 13h3v1h-3zM75 13h7v1h-7zM83 13h3v1h-3zM36 14h5v1h-5zM45 14h2v1h-2zM50 14h1v1h-1zM52 14h5v1h-5zM62 14h1v1h-1zM64 14h3v1h-3zM78 14h3v1h-3zM83 14h4v1h-4zM89 14h3v1h-3zM35 15h3v1h-3zM40 15h5v1h-5zM50 15h1v1h-1zM52 15h1v1h-1zM54 15h2v1h-2zM60 15h1v1h-1zM62 15h1v1h-1zM64 15h5v1h-5zM71 15h3v1h-3zM75 15h1v1h-1zM77 15h3v1h-3zM82 15h4v1h-4zM89 15h3v1h-3zM36 16h2v1h-2zM40 16h5v1h-5zM50 16h1v1h-1zM52 16h5v1h-5zM60 16h1v1h-1zM62 16h1v1h-1zM64 16h1v1h-1zM68 16h1v1h-1zM78 16h4v1h-4zM83 16h2v1h-2zM89 16h3v1h-3zM36 17h2v1h-2zM42 17h2v1h-2zM60 17h1v1h-1zM62 17h1v1h-1zM64 17h1v1h-1zM66 17h3v1h-3zM71 17h3v1h-3zM75 17h1v1h-1zM77 17h1v1h-1zM82 17h10v1h-10zM41 18h1v1h-1zM53 18h3v1h-3zM60 18h1v1h-1zM62 18h1v1h-1zM64 18h1v1h-1zM66 18h3v1h-3zM82 18h9v1h-9zM41 19h1v1h-1zM43 19h1v1h-1zM45 19h1v1h-1zM50 19h1v1h-1zM52 19h3v1h-3zM60 19h3v1h-3zM64 19h1v1h-1zM66 19h3v1h-3zM73 19h1v1h-1zM75 19h1v1h-1zM78 19h8v1h-8zM88 19h3v1h-3zM36 20h4v1h-4zM41 20h3v1h-3zM45 20h1v1h-1zM49 20h2v1h-2zM52 20h3v1h-3zM58 20h3v1h-3zM62 20h1v1h-1zM64 20h1v1h-1zM79 20h6v1h-6zM88 20h3v1h-3zM34 21h3v1h-3zM38 21h2v1h-2zM41 21h3v1h-3zM45 21h1v1h-1zM49 21h2v1h-2zM52 21h2v1h-2zM60 21h3v1h-3zM69 21h1v1h-1zM71 21h1v1h-1zM73 21h1v1h-1zM80 21h6v1h-6zM89 21h2v1h-2zM34 22h2v1h-2zM39 22h3v1h-3zM43 22h1v1h-1zM45 22h1v1h-1zM52 22h1v1h-1zM89 22h6v1h-6zM34 23h2v1h-2zM40 23h4v1h-4zM45 23h1v1h-1zM50 23h3v1h-3zM57 23h1v1h-1zM59 23h1v1h-1zM68 23h2v1h-2zM71 23h1v1h-1zM73 23h1v1h-1zM75 23h1v1h-1zM77 23h3v1h-3zM90 23h5v1h-5zM34 24h1v1h-1zM41 24h3v1h-3zM45 24h1v1h-1zM50 24h2v1h-2zM92 24h2v1h-2zM32 25h3v1h-3zM43 25h2v1h-2zM49 25h2v1h-2zM55 25h1v1h-1zM57 25h1v1h-1zM59 25h1v1h-1zM64 25h3v1h-3zM68 25h4v1h-4zM73 25h1v1h-1zM75 25h1v1h-1zM77 25h3v1h-3zM92 25h2v1h-2zM30 26h5v1h-5zM43 26h2v1h-2zM49 26h1v1h-1zM55 26h1v1h-1zM57 26h1v1h-1zM59 26h1v1h-1zM64 26h1v1h-1zM66 26h1v1h-1zM68 26h2v1h-2zM71 26h1v1h-1zM73 26h1v1h-1zM75 26h1v1h-1zM77 26h1v1h-1zM79 26h1v1h-1zM84 26h1v1h-1zM92 26h2v1h-2zM30 27h2v1h-2zM39 27h6v1h-6zM49 27h1v1h-1zM55 27h1v1h-1zM57 27h1v1h-1zM59 27h1v1h-1zM64 27h3v1h-3zM68 27h4v1h-4zM73 27h1v1h-1zM75 27h1v1h-1zM77 27h3v1h-3zM82 27h4v1h-4zM91 27h2v1h-2zM30 28h2v1h-2zM39 28h2v1h-2zM42 28h3v1h-3zM55 28h1v1h-1zM57 28h1v1h-1zM59 28h1v1h-1zM64 28h1v1h-1zM66 28h1v1h-1zM68 28h1v1h-1zM70 28h2v1h-2zM73 28h1v1h-1zM77 28h1v1h-1zM86 28h1v1h-1zM88 28h1v1h-1zM92 28h4v1h-4zM30 29h2v1h-2zM33 29h1v1h-1zM37 29h2v1h-2zM40 29h1v1h-1zM42 29h2v1h-2zM55 29h1v1h-1zM57 29h1v1h-1zM59 29h1v1h-1zM64 29h3v1h-3zM68 29h1v1h-1zM71 29h1v1h-1zM73 29h1v1h-1zM77 29h1v1h-1zM86 29h1v1h-1zM88 29h1v1h-1zM93 29h3v1h-3zM30 30h4v1h-4zM41 30h7v1h-7zM55 30h3v1h-3zM64 30h1v1h-1zM66 30h1v1h-1zM68 30h1v1h-1zM71 30h1v1h-1zM73 30h1v1h-1zM78 30h6v1h-6zM86 30h1v1h-1zM88 30h1v1h-1zM90 30h1v1h-1zM94 30h4v1h-4zM30 31h2v1h-2zM41 31h1v1h-1zM43 31h3v1h-3zM55 31h3v1h-3zM64 31h3v1h-3zM68 31h1v1h-1zM71 31h1v1h-1zM73 31h1v1h-1zM78 31h7v1h-7zM86 31h1v1h-1zM88 31h1v1h-1zM90 31h1v1h-1zM92 31h1v1h-1zM94 31h5v1h-5z' fill='#C8FF00'/>",
"<path d='M30 32h2v1h-2zM39 32h1v1h-1zM41 32h1v1h-1zM43 32h1v1h-1zM45 32h1v1h-1zM55 32h3v1h-3zM64 32h1v1h-1zM66 32h1v1h-1zM73 32h1v1h-1zM78 32h7v1h-7zM86 32h1v1h-1zM88 32h1v1h-1zM90 32h1v1h-1zM97 32h3v1h-3zM30 33h2v1h-2zM39 33h1v1h-1zM41 33h3v1h-3zM45 33h1v1h-1zM55 33h3v1h-3zM64 33h3v1h-3zM73 33h1v1h-1zM78 33h9v1h-9zM88 33h1v1h-1zM90 33h1v1h-1zM98 33h2v1h-2zM27 34h2v1h-2zM31 34h2v1h-2zM35 34h1v1h-1zM37 34h1v1h-1zM39 34h1v1h-1zM41 34h2v1h-2zM44 34h2v1h-2zM55 34h3v1h-3zM62 34h8v1h-8zM80 34h6v1h-6zM94 34h2v1h-2zM98 34h5v1h-5zM26 35h4v1h-4zM31 35h5v1h-5zM37 35h1v1h-1zM39 35h3v1h-3zM44 35h2v1h-2zM55 35h3v1h-3zM62 35h8v1h-8zM73 35h2v1h-2zM80 35h5v1h-5zM94 35h3v1h-3zM101 35h2v1h-2zM26 36h2v1h-2zM29 36h3v1h-3zM35 36h3v1h-3zM39 36h2v1h-2zM43 36h1v1h-1zM55 36h1v1h-1zM62 36h8v1h-8zM73 36h2v1h-2zM82 36h5v1h-5zM88 36h1v1h-1zM90 36h1v1h-1zM92 36h1v1h-1zM95 36h2v1h-2zM100 36h1v1h-1zM102 36h1v1h-1zM26 37h4v1h-4zM35 37h1v1h-1zM37 37h1v1h-1zM39 37h1v1h-1zM43 37h1v1h-1zM55 37h3v1h-3zM62 37h8v1h-8zM73 37h3v1h-3zM82 37h3v1h-3zM86 37h1v1h-1zM88 37h1v1h-1zM90 37h1v1h-1zM92 37h1v1h-1zM96 37h2v1h-2zM100 37h3v1h-3zM26 38h3v1h-3zM30 38h1v1h-1zM35 38h1v1h-1zM37 38h1v1h-1zM39 38h1v1h-1zM43 38h1v1h-1zM55 38h3v1h-3zM62 38h8v1h-8zM73 38h3v1h-3zM82 38h5v1h-5zM88 38h1v1h-1zM90 38h1v1h-1zM92 38h1v1h-1zM96 38h2v1h-2zM100 38h3v1h-3zM30 39h1v1h-1zM35 39h1v1h-1zM37 39h1v1h-1zM39 39h1v1h-1zM43 39h1v1h-1zM56 39h2v1h-2zM62 39h2v1h-2zM65 39h2v1h-2zM68 39h2v1h-2zM71 39h5v1h-5zM84 39h1v1h-1zM86 39h1v1h-1zM88 39h1v1h-1zM90 39h1v1h-1zM92 39h1v1h-1zM96 39h3v1h-3zM29 40h2v1h-2zM37 40h1v1h-1zM43 40h1v1h-1zM55 40h3v1h-3zM61 40h3v1h-3zM65 40h5v1h-5zM71 40h2v1h-2zM74 40h3v1h-3zM78 40h2v1h-2zM84 40h3v1h-3zM88 40h1v1h-1zM90 40h1v1h-1zM92 40h1v1h-1zM94 40h1v1h-1zM96 40h3v1h-3zM29 41h1v1h-1zM41 41h1v1h-1zM55 41h3v1h-3zM61 41h3v1h-3zM70 41h7v1h-7zM78 41h2v1h-2zM84 41h1v1h-1zM96 41h3v1h-3zM29 42h2v1h-2zM41 42h1v1h-1zM55 42h3v1h-3zM63 42h14v1h-14zM78 42h4v1h-4zM84 42h1v1h-1zM96 42h3v1h-3zM29 43h2v1h-2zM35 43h1v1h-1zM37 43h1v1h-1zM39 43h1v1h-1zM55 43h3v1h-3zM63 43h8v1h-8zM73 43h4v1h-4zM79 43h8v1h-8zM91 43h4v1h-4zM96 43h2v1h-2zM27 44h3v1h-3zM35 44h3v1h-3zM39 44h1v1h-1zM55 44h5v1h-5zM62 44h15v1h-15zM79 44h6v1h-6zM86 44h1v1h-1zM92 44h3v1h-3zM96 44h3v1h-3zM27 45h3v1h-3zM37 45h1v1h-1zM39 45h1v1h-1zM55 45h5v1h-5zM62 45h16v1h-16zM79 45h3v1h-3zM84 45h3v1h-3zM93 45h8v1h-8zM25 46h4v1h-4zM53 46h1v1h-1zM55 46h7v1h-7zM63 46h8v1h-8zM72 46h6v1h-6zM79 46h3v1h-3zM84 46h1v1h-1zM86 46h1v1h-1zM97 46h5v1h-5zM25 47h2v1h-2zM39 47h1v1h-1zM53 47h1v1h-1zM55 47h7v1h-7zM63 47h19v1h-19zM94 47h1v1h-1zM100 47h2v1h-2zM25 48h2v1h-2zM28 48h3v1h-3zM39 48h1v1h-1zM53 48h1v1h-1zM55 48h7v1h-7zM63 48h18v1h-18zM82 48h2v1h-2zM93 48h2v1h-2zM99 48h2v1h-2zM26 49h5v1h-5zM39 49h1v1h-1zM53 49h1v1h-1zM55 49h24v1h-24zM80 49h1v1h-1zM82 49h2v1h-2zM94 49h3v1h-3zM99 49h2v1h-2zM26 50h2v1h-2zM29 50h2v1h-2zM39 50h1v1h-1zM58 50h11v1h-11zM81 50h3v1h-3zM94 50h6v1h-6zM28 51h3v1h-3zM38 51h2v1h-2zM60 51h4v1h-4zM65 51h3v1h-3zM81 51h3v1h-3zM95 51h2v1h-2zM98 51h2v1h-2zM28 52h2v1h-2zM39 52h1v1h-1zM60 52h7v1h-7zM73 52h6v1h-6zM83 52h2v1h-2zM89 52h2v1h-2zM95 52h5v1h-5zM28 53h2v1h-2zM37 53h1v1h-1zM50 53h6v1h-6zM60 53h4v1h-4zM65 53h2v1h-2zM70 53h9v1h-9zM81 53h1v1h-1zM83 53h2v1h-2zM88 53h3v1h-3zM96 53h2v1h-2zM28 54h2v1h-2zM37 54h3v1h-3zM50 54h6v1h-6zM62 54h2v1h-2zM65 54h1v1h-1zM70 54h3v1h-3zM80 54h5v1h-5zM86 54h3v1h-3zM29 55h2v1h-2zM39 55h2v1h-2zM62 55h5v1h-5zM80 55h5v1h-5zM86 55h5v1h-5zM93 55h2v1h-2zM27 56h3v1h-3zM37 56h4v1h-4zM45 56h2v1h-2zM52 56h4v1h-4zM62 56h6v1h-6zM73 56h1v1h-1zM75 56h1v1h-1zM79 56h6v1h-6zM87 56h4v1h-4zM93 56h3v1h-3zM27 57h2v1h-2zM36 57h3v1h-3zM46 57h2v1h-2zM52 57h3v1h-3zM56 57h1v1h-1zM62 57h9v1h-9zM73 57h1v1h-1zM75 57h1v1h-1zM77 57h14v1h-14zM94 57h3v1h-3zM27 58h2v1h-2zM32 58h1v1h-1zM36 58h2v1h-2zM39 58h3v1h-3zM47 58h1v1h-1zM49 58h1v1h-1zM56 58h1v1h-1zM60 58h1v1h-1zM62 58h12v1h-12zM75 58h13v1h-13zM89 58h2v1h-2zM95 58h3v1h-3zM27 59h2v1h-2zM31 59h3v1h-3zM36 59h2v1h-2zM41 59h1v1h-1zM47 59h1v1h-1zM49 59h1v1h-1zM52 59h3v1h-3zM59 59h2v1h-2zM62 59h22v1h-22zM85 59h3v1h-3zM89 59h2v1h-2zM96 59h2v1h-2zM30 60h2v1h-2zM37 60h1v1h-1zM40 60h2v1h-2zM45 60h3v1h-3zM49 60h5v1h-5zM56 60h1v1h-1zM58 60h1v1h-1zM62 60h22v1h-22zM86 60h1v1h-1zM89 60h2v1h-2zM94 60h3v1h-3zM30 61h2v1h-2zM34 61h1v1h-1zM37 61h2v1h-2zM47 61h1v1h-1zM49 61h1v1h-1zM51 61h4v1h-4zM56 61h1v1h-1zM58 61h3v1h-3zM62 61h22v1h-22zM88 61h3v1h-3zM93 61h3v1h-3zM31 62h4v1h-4zM37 62h3v1h-3zM47 62h1v1h-1zM49 62h6v1h-6zM56 62h1v1h-1zM58 62h1v1h-1zM60 62h1v1h-1zM62 62h22v1h-22zM87 62h3v1h-3zM93 62h2v1h-2zM32 63h2v1h-2zM38 63h2v1h-2zM45 63h3v1h-3zM49 63h6v1h-6zM56 63h1v1h-1zM58 63h1v1h-1zM62 63h22v1h-22zM85 63h5v1h-5zM93 63h3v1h-3z' fill='#C8FF00'/>",
"<path d='M31 64h2v1h-2zM35 64h1v1h-1zM39 64h3v1h-3zM46 64h2v1h-2zM49 64h6v1h-6zM56 64h1v1h-1zM58 64h1v1h-1zM62 64h27v1h-27zM94 64h2v1h-2zM31 65h5v1h-5zM40 65h4v1h-4zM47 65h1v1h-1zM49 65h6v1h-6zM56 65h1v1h-1zM58 65h1v1h-1zM62 65h26v1h-26zM91 65h4v1h-4zM33 66h3v1h-3zM41 66h3v1h-3zM47 66h1v1h-1zM49 66h6v1h-6zM56 66h1v1h-1zM58 66h1v1h-1zM61 66h26v1h-26zM91 66h3v1h-3zM34 67h2v1h-2zM42 67h1v1h-1zM47 67h1v1h-1zM49 67h6v1h-6zM56 67h1v1h-1zM61 67h22v1h-22zM84 67h2v1h-2zM91 67h2v1h-2zM35 68h2v1h-2zM47 68h1v1h-1zM49 68h6v1h-6zM56 68h1v1h-1zM66 68h17v1h-17zM84 68h2v1h-2zM90 68h3v1h-3zM36 69h1v1h-1zM41 69h2v1h-2zM45 69h3v1h-3zM49 69h6v1h-6zM56 69h1v1h-1zM58 69h1v1h-1zM66 69h16v1h-16zM83 69h4v1h-4zM42 70h1v1h-1zM49 70h6v1h-6zM56 70h1v1h-1zM58 70h1v1h-1zM64 70h18v1h-18zM83 70h2v1h-2zM86 70h1v1h-1zM42 71h1v1h-1zM49 71h6v1h-6zM56 71h1v1h-1zM58 71h3v1h-3zM63 71h19v1h-19zM83 71h2v1h-2zM86 71h1v1h-1zM40 72h4v1h-4zM49 72h6v1h-6zM56 72h1v1h-1zM58 72h3v1h-3zM62 72h19v1h-19zM83 72h2v1h-2zM86 72h1v1h-1zM40 73h2v1h-2zM43 73h1v1h-1zM49 73h6v1h-6zM56 73h1v1h-1zM58 73h3v1h-3zM62 73h19v1h-19zM83 73h2v1h-2zM86 73h1v1h-1zM40 74h4v1h-4zM50 74h5v1h-5zM56 74h1v1h-1zM58 74h1v1h-1zM60 74h1v1h-1zM62 74h19v1h-19zM84 74h3v1h-3zM42 75h1v1h-1zM50 75h5v1h-5zM56 75h1v1h-1zM67 75h13v1h-13zM85 75h1v1h-1zM51 76h4v1h-4zM56 76h1v1h-1zM62 76h17v1h-17zM85 76h1v1h-1zM52 77h3v1h-3zM56 77h1v1h-1zM58 77h1v1h-1zM60 77h1v1h-1zM62 77h16v1h-16zM85 77h1v1h-1zM53 78h2v1h-2zM56 78h1v1h-1zM58 78h3v1h-3zM62 78h15v1h-15zM54 79h1v1h-1zM56 79h1v1h-1zM58 79h3v1h-3zM66 79h10v1h-10zM77 79h1v1h-1zM54 80h1v1h-1zM56 80h1v1h-1zM58 80h3v1h-3zM62 80h13v1h-13zM76 80h2v1h-2zM46 81h2v1h-2zM56 81h1v1h-1zM58 81h3v1h-3zM62 81h12v1h-12zM76 81h2v1h-2zM79 81h3v1h-3zM45 82h1v1h-1zM58 82h3v1h-3zM62 82h11v1h-11zM75 82h3v1h-3zM81 82h2v1h-2zM44 83h2v1h-2zM58 83h3v1h-3zM62 83h10v1h-10zM74 83h4v1h-4zM82 83h1v1h-1zM44 84h4v1h-4zM59 84h2v1h-2zM62 84h8v1h-8zM74 84h4v1h-4zM80 84h3v1h-3zM44 85h4v1h-4zM60 85h1v1h-1zM62 85h7v1h-7zM74 85h4v1h-4zM79 85h2v1h-2zM82 85h1v1h-1zM44 86h2v1h-2zM47 86h2v1h-2zM62 86h6v1h-6zM72 86h1v1h-1zM74 86h3v1h-3zM78 86h2v1h-2zM82 86h1v1h-1zM44 87h2v1h-2zM48 87h2v1h-2zM72 87h4v1h-4zM77 87h2v1h-2zM82 87h1v1h-1zM44 88h2v1h-2zM49 88h3v1h-3zM72 88h7v1h-7zM82 88h1v1h-1zM44 89h2v1h-2zM50 89h3v1h-3zM72 89h1v1h-1zM74 89h3v1h-3zM82 89h1v1h-1zM44 90h2v1h-2zM52 90h5v1h-5zM69 90h6v1h-6zM82 90h1v1h-1zM44 91h2v1h-2zM54 91h8v1h-8zM65 91h8v1h-8zM82 91h1v1h-1zM44 92h2v1h-2zM57 92h6v1h-6zM64 92h5v1h-5zM82 92h1v1h-1zM44 93h2v1h-2zM62 93h1v1h-1zM64 93h1v1h-1zM82 93h1v1h-1zM44 94h2v1h-2zM62 94h1v1h-1zM64 94h1v1h-1zM80 94h4v1h-4zM43 95h3v1h-3zM62 95h1v1h-1zM64 95h1v1h-1zM80 95h4v1h-4z' fill='#C8FF00'/>",
"<path d='M43 96h2v1h-2zM46 96h2v1h-2zM62 96h1v1h-1zM64 96h1v1h-1zM79 96h2v1h-2zM83 96h3v1h-3zM41 97h3v1h-3zM48 97h1v1h-1zM62 97h1v1h-1zM64 97h1v1h-1zM77 97h2v1h-2zM84 97h4v1h-4zM39 98h4v1h-4zM61 98h5v1h-5zM83 98h1v1h-1zM86 98h4v1h-4zM37 99h4v1h-4zM42 99h2v1h-2zM60 99h7v1h-7zM83 99h2v1h-2zM87 99h4v1h-4zM36 100h3v1h-3zM43 100h2v1h-2zM60 100h2v1h-2zM64 100h3v1h-3zM82 100h1v1h-1zM87 100h1v1h-1zM89 100h4v1h-4zM34 101h3v1h-3zM39 101h2v1h-2zM43 101h2v1h-2zM60 101h7v1h-7zM82 101h1v1h-1zM87 101h1v1h-1zM91 101h4v1h-4zM31 102h5v1h-5zM38 102h1v1h-1zM40 102h5v1h-5zM60 102h7v1h-7zM82 102h1v1h-1zM85 102h1v1h-1zM87 102h2v1h-2zM93 102h5v1h-5zM29 103h4v1h-4zM38 103h2v1h-2zM43 103h2v1h-2zM60 103h7v1h-7zM82 103h1v1h-1zM85 103h1v1h-1zM87 103h1v1h-1zM95 103h4v1h-4zM26 104h5v1h-5zM39 104h3v1h-3zM43 104h1v1h-1zM46 104h2v1h-2zM79 104h1v1h-1zM82 104h1v1h-1zM84 104h3v1h-3zM97 104h5v1h-5zM24 105h4v1h-4zM41 105h3v1h-3zM46 105h2v1h-2zM62 105h1v1h-1zM64 105h1v1h-1zM78 105h2v1h-2zM82 105h4v1h-4zM101 105h3v1h-3zM23 106h4v1h-4zM42 106h2v1h-2zM45 106h1v1h-1zM62 106h1v1h-1zM64 106h1v1h-1zM78 106h7v1h-7zM100 106h2v1h-2zM103 106h2v1h-2zM22 107h2v1h-2zM43 107h1v1h-1zM45 107h1v1h-1zM62 107h1v1h-1zM64 107h1v1h-1zM78 107h5v1h-5zM84 107h1v1h-1zM104 107h3v1h-3zM19 108h4v1h-4zM45 108h1v1h-1zM62 108h1v1h-1zM64 108h1v1h-1zM78 108h4v1h-4zM105 108h4v1h-4zM17 109h4v1h-4zM45 109h1v1h-1zM62 109h1v1h-1zM64 109h1v1h-1zM78 109h4v1h-4zM107 109h4v1h-4zM16 110h3v1h-3zM62 110h1v1h-1zM64 110h1v1h-1zM109 110h3v1h-3zM14 111h3v1h-3zM62 111h1v1h-1zM64 111h1v1h-1zM111 111h3v1h-3zM13 112h3v1h-3zM62 112h1v1h-1zM64 112h1v1h-1zM112 112h3v1h-3zM13 113h2v1h-2zM62 113h1v1h-1zM64 113h1v1h-1zM114 113h2v1h-2zM12 114h2v1h-2zM64 114h2v1h-2zM114 114h2v1h-2zM64 115h2v1h-2zM64 116h2v1h-2zM64 117h2v1h-2zM64 118h2v1h-2zM64 119h2v1h-2z' fill='#C8FF00'/>"
);
}
}
contracts/NyroFeatureData.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
/// @title Nyro Primary Feature Data
/// @notice Large structural portrait layers stored separately so every renderer contract remains below EIP-170.
/// @dev Every function returns strict 1-bit SVG fragments using only #000 and #C8FF00.
contract NyroFeatureData {
using Strings for uint256;
function hairLayer(uint8 id) external pure returns (string memory) {
string memory erase = "<path d='M18 0h94v44H18zM18 22h27v54H18zM88 22h24v54H88z' fill='#000'/>";
if (id == 0) return string.concat(erase, "<path d='M27 43V28l7-2-3-7 9 2-1-9 10 5 4-12 8 8 6-12 7 12 10-7 2 11 10-4-2 10 9 1-5 9 6 6-7 8M25 48l-5 9 7 4-5 10M103 47l7 9-7 5 4 10' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M34 29h2M42 24h2M50 20h2M60 17h2M70 18h2M80 21h2M90 27h2M31 37h2M43 34h2M54 30h2M67 29h2M79 32h2M93 36h2' stroke='#C8FF00' stroke-width='2'/>");
if (id == 1) return string.concat(erase, "<path d='M37 44V28l7-13 10-7h20l11 7 7 13v16M42 32h45M47 23h35' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M45 17h3M53 12h3M62 10h3M72 11h3M81 17h3' stroke='#C8FF00' stroke-width='2'/>");
if (id == 2) return string.concat(erase, "<path d='M27 43l4-17 7 3 1-13 10 6 4-18 10 12 8-15 5 17 12-10-1 16 11-3 3 18M24 48l-4 9 8 3M104 47l6 9-8 4' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M36 35h4M47 29h3M59 24h4M72 24h3M84 29h4M95 35h3' stroke='#C8FF00' stroke-width='1'/>");
if (id == 3) return string.concat(erase, "<path d='M46 43V22h7l2-12 7 7 3-16 6 16 7-8 1 13h5v21M37 28h10M84 28h9M38 35h8M85 35h7' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M55 22h23M58 27h17M61 32h11' stroke='#C8FF00' stroke-width='1'/>");
if (id == 4) return string.concat(erase, "<path d='M29 42V25l9-9 15-7h23l15 7 8 9v17M33 31h62M38 22h52M35 39v28M42 37v35M49 36v30M91 39v29M84 37v36M77 36v31' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M35 68h3M40 73h4M47 67h3M89 69h3M82 74h4M76 68h3' stroke='#C8FF00' stroke-width='1'/>");
if (id == 5) return string.concat(erase, "<path d='M31 43V20l10-9h45l11 9v23M35 19h58M35 31h58M28 47h14M86 47h15M31 53h12M85 53h16' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M42 14v25M51 11v29M77 11v29M86 14v25' fill='none' stroke='#C8FF00' stroke-width='1'/>");
if (id == 6) return string.concat(erase, "<path d='M28 43l4-18 8 5 3-17 8 9 6-20 7 17 8-18 6 21 9-12 1 19 9-6 3 20M24 49l7 6-8 8 7 7M104 49l-7 6 8 8-7 7' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M43 29l5-8M56 25l5-11M70 25l4-12M83 29l5-10' stroke='#C8FF00' stroke-width='1'/>");
if (id == 7) return string.concat(erase, "<path d='M32 42V24l9-10 14-5h19l14 5 9 10v18M37 25h54M42 17h44M34 43v25M40 43v33M46 43v27M94 43v25M88 43v33M82 43v27' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M31 68h6v5h-6zM37 75h6v5h-6zM91 68h6v5h-6zM85 75h6v5h-6z' fill='none' stroke='#C8FF00' stroke-width='1'/>");
if (id == 8) return string.concat(erase, "<path d='M25 42l6-17 10-9 19-8h34l9 9-18 4-8 6-13 4-9 9-8 18-9-8-9 3M92 26l7 9 3 15M24 50l-5 8 7 5-4 9' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M39 25l40-9M35 31l36-8M32 37l29-7' stroke='#C8FF00' stroke-width='1'/>");
if (id == 9) return string.concat(erase, "<path d='M31 42V25l8-9 13-6h24l13 6 8 9v17M38 18L31 8M48 12l-2-11M58 10l3-9M70 10l-1-9M81 13l4-11M91 19l8-10M31 8h4M44 1h4M59 1h4M68 1h4M84 2h4M97 9h4' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M39 28h50M43 34h42' stroke='#C8FF00' stroke-width='1'/>");
if (id == 10) return string.concat(erase, "<path d='M26 43V27l7-4-2-8 9 3 1-10 10 7 3-12 9 10v30M65 43V18l10-8h13l9 10v23M23 49l7 5-7 8 6 8M98 48l8 6-6 8 4 7' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M34 30h3M43 24h3M52 20h3M73 18h16M73 24h20M73 30h22' stroke='#C8FF00' stroke-width='1'/>");
return string.concat(erase, "<path d='M23 43l9-8-7-7 13-2-3-10 13 5 2-14 12 9L67 1l8 15 10-10 2 15 14-5-4 12 11 2-8 9 6 8-13 3M24 51l-5 9 10 2-6 10M103 51l7 9-10 2 5 10' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M39 34h4M49 28h4M60 23h4M72 23h4M83 28h4M93 35h4' stroke='#C8FF00' stroke-width='1'/>");
}
function faceLayer(uint8 id) external pure returns (string memory) {
if (id == 0) return "";
if (id == 1) return "<path d='M38 57l2 25 13 15h23l15-15 1-25M43 91l10 10h24l10-10' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M39 72h3M89 72h3' stroke='#C8FF00' stroke-width='2'/>";
if (id == 2) return "<path d='M43 55v29l10 19h23l10-19V55M54 101l10 9 11-9' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M47 88h4M80 88h4' stroke='#C8FF00' stroke-width='1'/>";
if (id == 3) return "<path d='M40 57l4 29 12 13h17l14-13 3-29M48 92l9 9h16l10-9' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M42 68h3M87 68h3' stroke='#C8FF00' stroke-width='1'/>";
if (id == 4) return "<path d='M41 57l5 27 18 19 19-19 6-27M48 86l16 20 17-20' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M44 74h4M84 74h4' stroke='#C8FF00' stroke-width='1'/>";
if (id == 5) return "<path d='M66 42h23v48l-8 10H66M70 46h15v8H70M83 58h6M72 92h10' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M86 63h4v4h-4zM70 73h3v3h-3zM80 82h5v3h-5z' fill='#C8FF00'/>";
if (id == 6) return "<path d='M43 48h43v43L75 103H55L43 91z' fill='#000'/><path d='M46 51h37v37L73 99H57L46 88zM51 57h10v8H51M69 57h10v8H69M60 70h10v7H60M53 83h24' fill='none' stroke='#C8FF00' stroke-width='1'/>";
return "<path d='M64 42v62M40 58h24v36H51l-11-12z' fill='#000'/><path d='M64 44v58M44 61h16M46 68h13M48 76h11M51 85h8M69 96h13' fill='none' stroke='#C8FF00' stroke-width='1'/>";
}
function eyeLayer(uint8 id) external pure returns (string memory) {
string memory erase = "<rect x='39' y='44' width='51' height='15' fill='#000'/>";
if (id == 0) return string.concat(erase, "<path d='M43 50h17M69 50h17M47 53h9M73 53h9' stroke='#C8FF00' stroke-width='1'/>");
if (id == 1) return string.concat(erase, "<path d='M42 52l8-5h10l-4 8H46zM69 47h10l8 5-4 3H73z' fill='none' stroke='#C8FF00' stroke-width='1'/>");
if (id == 2) return string.concat(erase, "<path d='M55 47h19v10H55zM59 50h11v4H59z' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='63' y='51' width='3' height='3' fill='#C8FF00'/>");
if (id == 3) return string.concat(erase, "<path d='M42 49h12v8H42M58 47h12v10H58M74 49h12v8H74' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M46 53h4M62 52h4M78 53h4' stroke='#C8FF00' stroke-width='1'/>");
if (id == 4) return string.concat(erase, "<path d='M42 47h18v11H42zM69 47h18v11H69z' fill='#C8FF00'/><path d='M47 50h8v5h-8zM74 50h8v5h-8z' fill='#000'/><rect x='50' y='52' width='2' height='2' fill='#C8FF00'/><rect x='77' y='52' width='2' height='2' fill='#C8FF00'/>");
if (id == 5) return string.concat(erase, "<path d='M43 47l16 10M59 47L43 57M70 47l16 10M86 47L70 57' stroke='#C8FF00' stroke-width='1'/>");
if (id == 6) return string.concat(erase, "<path d='M40 47h49v11H40zM44 51h12M72 51h12M61 47v11' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M57 52h4M67 52h4' stroke='#C8FF00' stroke-width='1'/>");
if (id == 7) return string.concat(erase, "<path d='M43 54h17M69 54h17M47 51h9M73 51h9' stroke='#C8FF00' stroke-width='1'/><rect x='52' y='53' width='2' height='2' fill='#C8FF00'/><rect x='78' y='53' width='2' height='2' fill='#C8FF00'/>");
if (id == 8) return string.concat(erase, "<circle cx='51' cy='52' r='6' fill='none' stroke='#C8FF00' stroke-width='1'/><circle cx='78' cy='52' r='6' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='49' y='50' width='4' height='4' fill='#C8FF00'/><rect x='76' y='50' width='4' height='4' fill='#C8FF00'/>");
return string.concat(erase, "<path d='M42 48h18v9H42zM69 48h18v9H69z' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M45 51h3M51 54h3M56 50h2M72 54h3M78 50h3M83 53h2' stroke='#C8FF00' stroke-width='1'/>");
}
function mouthLayer(uint8 id) external pure returns (string memory) {
string memory erase = "<rect x='47' y='67' width='40' height='23' fill='#000'/>";
if (id == 0) return string.concat(erase, "<path d='M54 79h27M59 82h17' stroke='#C8FF00' stroke-width='1'/>");
if (id == 1) return string.concat(erase, "<path d='M51 75h32v10H51zM54 78h26M57 78v6M63 78v6M69 78v6M75 78v6' fill='none' stroke='#C8FF00' stroke-width='1'/>");
if (id == 2) return string.concat(erase, "<path d='M52 73h30v14H52zM56 76v8M62 75v10M68 75v10M74 76v8M79 77v6' fill='none' stroke='#C8FF00' stroke-width='1'/>");
if (id == 3) return string.concat(erase, "<path d='M50 72h34l3 5-3 10H50l-3-10z' fill='none' stroke='#C8FF00' stroke-width='1'/><path d='M54 76h26M56 80h22M60 84h14' stroke='#C8FF00' stroke-width='1'/>");
if (id == 4) return string.concat(erase, "<path d='M53 76l6 7h16l7-7M58 83h18' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='64' y='80' width='5' height='2' fill='#C8FF00'/>");
if (id == 5) return string.concat(erase, "<path d='M53 80h29M56 76l4 8M64 76l4 8M72 76l4 8M80 76l3 6' stroke='#C8FF00' stroke-width='1'/>");
if (id == 6) return string.concat(erase, "<ellipse cx='66' cy='79' rx='15' ry='9' fill='#000' stroke='#C8FF00' stroke-width='1'/><path d='M56 76h20M58 82h16' stroke='#C8FF00' stroke-width='1'/>");
if (id == 7) return string.concat(erase, "<path d='M52 74h30v13H52z' fill='#C8FF00'/><path d='M56 77h5v7h-5zM64 77h5v7h-5zM72 77h5v7h-5z' fill='#000'/>");
if (id == 8) return string.concat(erase, "<path d='M54 75v12l7-7M79 75v12l-7-7M60 82h14' fill='none' stroke='#C8FF00' stroke-width='1'/>");
return string.concat(erase, "<path d='M53 78h29M57 74h4M64 73h5M72 74h4M59 84h19' stroke='#C8FF00' stroke-width='1'/><rect x='65' y='78' width='5' height='4' fill='#C8FF00'/>");
}
function formLayer(uint8 id) external pure returns (string memory) {
if (id == 0) return "";
if (id == 1) return "<path d='M45 61l9 7-7 9M83 61l-9 7 7 9' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (id == 2) return "<path d='M63 36h4v4h-4zM61 38h8M65 34v8' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (id == 3) return "<path d='M47 58l5 4-4 5 6 5-4 6M82 58l-5 4 4 5-6 5 4 6' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (id == 4) return "<path d='M38 65h6M40 69h8M86 65h6M82 69h8' stroke='#C8FF00' stroke-width='1'/>";
if (id == 5) return "<path d='M44 60h4v4h-4zM82 60h4v4h-4zM42 66h3v3h-3zM86 66h3v3h-3z' fill='#C8FF00'/>";
if (id == 6) return "<path d='M60 61h9M58 64h13M61 67h7' stroke='#C8FF00' stroke-width='1'/>";
return "<path d='M46 62l3 3-3 3 3 3-3 3M84 62l-3 3 3 3-3 3 3 3' fill='none' stroke='#C8FF00' stroke-width='1'/>";
}
/// @dev Seven visibly distinct front-facing character bases. Black shapes erase parts of the locked
/// master portrait while lime-green shapes rebuild type-specific anatomy and silhouettes.
function characterTypeLayer(uint8 characterType) external pure returns (string memory) {
if (characterType == 0) {
return "<path d='M42 63h3M86 63h3' stroke='#C8FF00' stroke-width='1'/>";
}
if (characterType == 1) {
return string.concat(
"<path d='M35 55L20 47v17l15 5M93 55l15-8v17l-15 5' fill='none' stroke='#C8FF00' stroke-width='1'/>",
"<path d='M52 18L46 5M76 18l6-13M46 5h4M79 5h4M60 94l5 7 6-7' fill='none' stroke='#C8FF00' stroke-width='1'/>"
);
}
if (characterType == 2) {
return string.concat(
"<path d='M36 57L20 51v18l16 4M92 57l16-6v18l-16 4M41 88l10 10h27l10-10' fill='none' stroke='#C8FF00' stroke-width='1'/>",
"<path d='M55 78v10l6-6M77 78v10l-6-6' fill='none' stroke='#C8FF00' stroke-width='1'/>"
);
}
if (characterType == 3) {
return string.concat(
"<path d='M36 53L14 42l9 22 13 4M92 53l22-11-9 22-13 4M54 94l11 12 11-12' fill='none' stroke='#C8FF00' stroke-width='1'/>",
"<path d='M20 48h9M99 48h9' stroke='#C8FF00' stroke-width='1'/>"
);
}
if (characterType == 4) {
return string.concat(
"<path d='M25 34h49v3H25zM56 47h52v3H56zM28 61h42v3H28zM61 75h43v3H61zM37 91h48v3H37z' fill='#000'/>",
"<path d='M30 35h49M51 48h52M34 62h42M57 76h43M43 92h48' stroke='#C8FF00' stroke-width='1'/>",
"<rect x='20' y='46' width='8' height='2' fill='#C8FF00'/><rect x='101' y='66' width='9' height='2' fill='#C8FF00'/><rect x='43' y='81' width='10' height='2' fill='#C8FF00'/>"
);
}
if (characterType == 5) {
return string.concat(
"<path d='M20 78V41l9-20 16-12h38l16 12 9 20v37M27 75V45l8-17 14-11h30l14 11 8 17v30' fill='none' stroke='#C8FF00' stroke-width='1'/>",
"<path d='M29 79l15 15M99 79L84 94M44 94h40' fill='none' stroke='#C8FF00' stroke-width='1'/>"
);
}
return string.concat(
"<path d='M35 102L15 120M93 102l20 18M35 102h15M93 102H78' fill='none' stroke='#C8FF00' stroke-width='1'/>",
"<path d='M64 37l5 6-5 6-5-6zM64 105l6 8-6 9-6-9z' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='63' y='110' width='2' height='6' fill='#C8FF00'/>"
);
}
function maskLayer(uint8 mask) external pure returns (string memory) {
if (mask == 0) return "";
if (mask == 1) return "<path d='M41 47h46v9H41z' fill='#000'/><path d='M45 51h12M71 51h12' stroke='#C8FF00' stroke-width='1'/>";
if (mask == 2) return "<path d='M64 39v47' stroke='#000' stroke-width='1'/><rect x='68' y='43' width='1' height='1' fill='#000'/><rect x='71' y='47' width='1' height='1' fill='#000'/>";
if (mask == 3) return "<path d='M48 70h34v15H48z' fill='#000'/><path d='M53 74v7M59 74v7M65 74v7M71 74v7M77 74v7' stroke='#C8FF00' stroke-width='1'/>";
if (mask == 4) return "<path d='M50 67h29l5 5v13l-5 5H50l-5-5V72z' fill='#000'/><path d='M52 73v10M58 72v12M64 72v12M70 73v10M76 74v8' stroke='#C8FF00' stroke-width='1'/>";
if (mask == 5) return "<path d='M42 44h44v41H42z' fill='#000'/><path d='M46 49h12v7H46M70 49h12v7H70M62 59v9M52 75h4v5M62 75h4v5M72 75h4v5' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (mask == 6) return "<path d='M69 47h18v10H69z' fill='#000'/><path d='M72 52h11M87 53h7' stroke='#C8FF00' stroke-width='1'/>";
if (mask == 7) return "<path d='M40 48h48v7H40z' fill='#000'/><path d='M45 51h12M71 51h12M40 48l-7-4M88 48l7-4' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (mask == 8) return "<path d='M52 77h5M59 74h4M67 78h7M77 74h4M57 84h4M70 84h5' stroke='#000' stroke-width='1'/>";
return "<path d='M65 40h22v45h-5v5H65z' fill='#000'/><path d='M72 50h11M72 64h4M79 69h5M70 79h7' stroke='#C8FF00' stroke-width='1'/>";
}
function suitLayer(uint8 suit) external pure returns (string memory) {
if (suit == 0) return "";
if (suit == 1) return "<path d='M44 104l12 10M84 104l-12 10M56 114h16' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (suit == 2) return "<path d='M40 106h10l6 7M88 106H78l-6 7M50 106v12M78 106v12' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (suit == 3) return "<path d='M42 103l9 15M86 103l-9 15M51 118h26' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='63' y='116' width='2' height='2' fill='#C8FF00'/>";
if (suit == 4) return "<path d='M36 108h12v7H36M92 108H80v7h12M48 111h32' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (suit == 5) return "<path d='M43 104v18M85 104v18M48 109h5M75 109h5' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='47' y='116' width='1' height='1' fill='#C8FF00'/><rect x='80' y='116' width='1' height='1' fill='#C8FF00'/>";
if (suit == 6) return "<path d='M34 110l10-7 12 11M94 110l-10-7-12 11M56 114v13M72 114v13' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (suit == 7) return "<path d='M38 105h12l6 6M90 105H78l-6 6M50 105l3 18M78 105l-3 18' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (suit == 8) return "<path d='M42 104l10 6-4 13M86 104l-10 6 4 13M52 110h24' fill='none' stroke='#C8FF00' stroke-width='1'/>";
return "<path d='M32 116h16M96 116H80M41 110v13M87 110v13M56 116h16' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='37' y='120' width='1' height='1' fill='#C8FF00'/><rect x='90' y='120' width='1' height='1' fill='#C8FF00'/>";
}
function hatLayer(uint8 hat) external pure returns (string memory) {
if (hat == 0) return "";
if (hat == 1) return "<path d='M41 18v-8h6V6h34v4h7v9M35 20h59' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 2) return "<path d='M38 21v-9h9V8h34v4h9v10M46 14h35M80 21h19' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 3) return "<path d='M46 18V2h36v16M38 20h53M51 7h26' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 4) return "<path d='M40 19l7-16 9 11 8-14 9 14 10-11 6 16M40 21h49' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 5) return "<path d='M57 18V4h5V0h6v4h5v14M52 20h26' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 6) return "<path d='M45 7h38M40 10h48' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 7) return "<path d='M52 16V3h-6V0h11v3M76 16V2h6V0H71v2' fill='none' stroke='#C8FF00' stroke-width='1'/><rect x='52' y='8' width='1' height='1' fill='#C8FF00'/><rect x='76' y='8' width='1' height='1' fill='#C8FF00'/>";
if (hat == 8) return "<path d='M25 72V39l8-16 13-10h36l13 10 8 16v33M32 71V43l7-14 11-8h28l11 8 7 14v28' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 9) return "<path d='M41 19V5h5v11h11V8h14v8h11V5h5v14M41 21h46' fill='none' stroke='#C8FF00' stroke-width='1'/>";
if (hat == 10) return "<path d='M39 20l7-10 7 6 7-15 7 13 8-13 6 15 8-6 5 10M39 22h55' fill='none' stroke='#C8FF00' stroke-width='1'/>";
return "<rect x='39' y='18' width='2' height='1' fill='#C8FF00'/><rect x='46' y='12' width='2' height='1' fill='#C8FF00'/><rect x='54' y='7' width='1' height='2' fill='#C8FF00'/><rect x='64' y='4' width='1' height='2' fill='#C8FF00'/><rect x='74' y='7' width='1' height='2' fill='#C8FF00'/><rect x='82' y='12' width='2' height='1' fill='#C8FF00'/><rect x='90' y='18' width='2' height='1' fill='#C8FF00'/>";
}
}
contracts/NyroNFT.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {ERC721} from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import {ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {Base64} from "@openzeppelin/contracts/utils/Base64.sol";
import {NyroRenderer} from "./NyroRenderer.sol";
import {NyroToken} from "./NyroToken.sol";
/// @title Nyro
/// @notice 10,000 fully onchain, instant-reveal, black-and-lime pixel portraits on Robinhood Chain.
contract NyroNFT is ERC721Enumerable, Ownable2Step, ReentrancyGuard {
uint256 public constant HARD_MAX_SUPPLY = 10_000;
uint256 public constant DEFAULT_MINT_PRICE = 0.0001 ether;
uint256 public constant MAX_PER_TX = 10;
uint256 public constant TOKEN_REWARD_PER_NFT = 1_000 ether;
NyroRenderer public immutable renderer;
NyroToken public immutable rewardToken;
bytes32 public immutable collectionSeed;
uint256 public MAX_SUPPLY;
uint256 public mintPrice;
bool public mintOpen;
/// @notice Cumulative mint statistics only. This counter never limits future mints.
mapping(address account => uint256 quantity) public mintedByWallet;
error MintClosed();
error InvalidQuantity();
error IncorrectPayment();
error SoldOut();
error ZeroAddress();
error InvalidAmount();
error InvalidSupply();
error TransferFailed();
event Minted(address indexed minter, uint256 indexed firstTokenId, uint256 quantity, uint256 paid);
event OwnerMinted(address indexed to, uint256 indexed firstTokenId, uint256 quantity);
event MintStatusChanged(bool isOpen);
event MintPriceChanged(uint256 oldPrice, uint256 newPrice);
event MaxSupplyChanged(uint256 oldSupply, uint256 newSupply);
event FundsWithdrawn(address indexed to, uint256 amount);
event TokenRewardDistributed(address indexed recipient, uint256 nftQuantity, uint256 tokenAmount);
constructor(
address initialOwner,
NyroRenderer renderer_,
NyroToken rewardToken_,
bytes32 collectionSeed_,
uint256 initialMaxSupply,
uint256 initialMintPrice
)
ERC721("Nyro", "NYRO")
Ownable(initialOwner)
{
if (initialOwner == address(0) || address(renderer_) == address(0) || address(rewardToken_) == address(0)) revert ZeroAddress();
if (initialMaxSupply == 0 || initialMaxSupply > HARD_MAX_SUPPLY) revert InvalidSupply();
renderer = renderer_;
rewardToken = rewardToken_;
collectionSeed = collectionSeed_;
MAX_SUPPLY = initialMaxSupply;
mintPrice = initialMintPrice;
}
function mint(uint256 quantity) external payable nonReentrant {
if (!mintOpen) revert MintClosed();
_validateMint(quantity);
if (msg.value != mintPrice * quantity) revert IncorrectPayment();
uint256 firstTokenId = totalSupply() + 1;
_mintBatch(msg.sender, quantity);
emit Minted(msg.sender, firstTokenId, quantity, msg.value);
}
/// @notice Owner airdrop/reserve mint. Maximum 10 NFTs per transaction; no recipient wallet cap.
function ownerMint(address to, uint256 quantity) external onlyOwner nonReentrant {
if (to == address(0)) revert ZeroAddress();
_validateMint(quantity);
uint256 firstTokenId = totalSupply() + 1;
_mintBatch(to, quantity);
emit OwnerMinted(to, firstTokenId, quantity);
}
function setMintOpen(bool isOpen) external onlyOwner {
mintOpen = isOpen;
emit MintStatusChanged(isOpen);
}
function setMintPrice(uint256 newPrice) external onlyOwner {
uint256 oldPrice = mintPrice;
mintPrice = newPrice;
emit MintPriceChanged(oldPrice, newPrice);
}
/// @notice Changes the active collection cap without ever exceeding the audited 10,000 hard cap.
/// @dev The new cap cannot be lower than the number of NFTs already minted.
function setMaxSupply(uint256 newMaxSupply) external onlyOwner {
if (newMaxSupply == 0 || newMaxSupply > HARD_MAX_SUPPLY || newMaxSupply < totalSupply()) revert InvalidSupply();
uint256 oldSupply = MAX_SUPPLY;
MAX_SUPPLY = newMaxSupply;
emit MaxSupplyChanged(oldSupply, newMaxSupply);
}
function withdraw() external onlyOwner nonReentrant {
_withdrawTo(payable(owner()), address(this).balance);
}
function withdrawTo(address payable to, uint256 amount) external onlyOwner nonReentrant {
_withdrawTo(to, amount);
}
function tokenURI(uint256 tokenId) public view override returns (string memory) {
_requireOwned(tokenId);
return renderer.tokenURI(tokenId, seedOf(tokenId));
}
function tokenSVG(uint256 tokenId) external view returns (string memory) {
_requireOwned(tokenId);
return renderer.svg(tokenId, seedOf(tokenId));
}
function seedOf(uint256 tokenId) public view returns (bytes32) {
return keccak256(abi.encodePacked(collectionSeed, tokenId, address(this), block.chainid));
}
function totalMinted() external view returns (uint256) {
return totalSupply();
}
function remainingSupply() external view returns (uint256) {
return MAX_SUPPLY - totalSupply();
}
function mintCost(uint256 quantity) external view returns (uint256) {
return mintPrice * quantity;
}
function tokenRewardFor(uint256 quantity) external pure returns (uint256) {
return TOKEN_REWARD_PER_NFT * quantity;
}
function walletOfOwner(address account) external view returns (uint256[] memory tokenIds) {
uint256 count = balanceOf(account);
tokenIds = new uint256[](count);
for (uint256 i; i < count; ++i) {
tokenIds[i] = tokenOfOwnerByIndex(account, i);
}
}
function contractURI() external view returns (string memory) {
bytes32 previewSeed = keccak256("NYRO_COLLECTION_PREVIEW");
string memory image = string.concat(
"data:image/svg+xml;base64,",
Base64.encode(bytes(renderer.svg(1, previewSeed)))
);
bytes memory json = abi.encodePacked(
'{"name":"Nyro","description":"Fully onchain, instant-reveal, black-and-lime pixel portraits on Robinhood Chain.",',
'"image":"', image, '"}'
);
return string.concat("data:application/json;base64,", Base64.encode(json));
}
function _mintBatch(address to, uint256 quantity) internal {
mintedByWallet[to] += quantity;
uint256 start = totalSupply() + 1;
for (uint256 i; i < quantity; ++i) {
_safeMint(to, start + i);
}
uint256 tokenAmount = TOKEN_REWARD_PER_NFT * quantity;
rewardToken.mintReward(to, tokenAmount);
emit TokenRewardDistributed(to, quantity, tokenAmount);
}
function _validateMint(uint256 quantity) internal view {
if (quantity == 0 || quantity > MAX_PER_TX) revert InvalidQuantity();
if (totalSupply() + quantity > MAX_SUPPLY) revert SoldOut();
}
function _withdrawTo(address payable to, uint256 amount) internal {
if (to == address(0)) revert ZeroAddress();
if (amount == 0 || amount > address(this).balance) revert InvalidAmount();
(bool ok,) = to.call{value: amount}("");
if (!ok) revert TransferFailed();
emit FundsWithdrawn(to, amount);
}
function _increaseBalance(address account, uint128 value)
internal
override(ERC721Enumerable)
{
super._increaseBalance(account, value);
}
}
contracts/NyroRenderer.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {Base64} from "@openzeppelin/contracts/utils/Base64.sol";
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
import {NyroArtData} from "./NyroArtData.sol";
import {NyroFeatureData} from "./NyroFeatureData.sol";
/// @title Nyro Fully Onchain Thin-Line 1-Bit Renderer
/// @notice Renders front-facing lime-green pixel portraits on black entirely inside the EVM.
/// @dev The locked 128×128 master portrait was converted into horizontal pixel runs and is returned directly as SVG.
contract NyroRenderer {
using Strings for uint256;
struct Traits {
uint8 race;
uint8 hair;
uint8 eyes;
uint8 mouth;
uint8 face;
uint8 form;
uint8 hat;
uint8 suit;
uint8 mask;
uint8 texture;
}
NyroArtData public immutable artData;
NyroFeatureData public immutable featureData;
error ZeroDataContract();
constructor(NyroArtData artData_, NyroFeatureData featureData_) {
if (address(artData_) == address(0) || address(featureData_) == address(0)) revert ZeroDataContract();
artData = artData_;
featureData = featureData_;
}
function tokenURI(uint256 tokenId, bytes32 seed) external view returns (string memory) {
Traits memory t = traits(tokenId, seed);
string memory image = string.concat("data:image/svg+xml;base64,", Base64.encode(bytes(svg(tokenId, seed))));
bytes memory json = abi.encodePacked(
'{"name":"Nyro #', tokenId.toString(),
'","description":"A fully onchain, instant-reveal 1-bit portrait on Robinhood Chain. Lime-green artwork on black.",',
'"image":"', image, '","attributes":[',
attribute("Character Type", raceName(t.race)), ",",
attribute("Hair Form", hairName(t.hair)), ",",
attribute("Eye Form", eyeName(t.eyes)), ",",
attribute("Mouth Form", mouthName(t.mouth)), ",",
attribute("Face Structure", faceName(t.face)), ",",
attribute("Form", formName(t.form)), ",",
attribute("Hat", hatName(t.hat)), ",",
attribute("Suit", suitName(t.suit)), ",",
attribute("Mask", maskName(t.mask)), ",",
attribute("Texture", textureName(t.texture)), ",",
'{"trait_type":"Identity Code","display_type":"number","value":', tokenId.toString(), "}]}"
);
return string.concat("data:application/json;base64,", Base64.encode(json));
}
function svg(uint256 tokenId, bytes32 seed) public view returns (string memory) {
Traits memory t = traits(tokenId, seed);
return string.concat(
"<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 128 128' shape-rendering='crispEdges'>",
"<path d='M0 0h128v128H0z' fill='#000'/><g>",
artData.masterPortrait(),
featureData.hairLayer(t.hair),
featureData.faceLayer(t.face),
featureData.eyeLayer(t.eyes),
featureData.mouthLayer(t.mouth),
featureData.formLayer(t.form),
featureData.characterTypeLayer(t.race),
featureData.maskLayer(t.mask),
featureData.suitLayer(t.suit),
featureData.hatLayer(t.hat),
textureLayer(t.texture, seed),
identityLayer(tokenId),
"</g></svg>"
);
}
/// @notice Returns deterministic traits. IDs 1..10,000 use a bijective permutation before mixed-radix decomposition.
/// The race+hair+eyes+mouth+face genotype is unique for every collection token.
function traits(uint256 tokenId, bytes32 seed) public pure returns (Traits memory t) {
uint256 raw = tokenId == 0 ? 0 : tokenId - 1;
uint256 code = (raw * 7919 + 1049) % 10_000;
t.race = uint8(code % 7);
code /= 7;
t.hair = uint8(code % 12);
code /= 12;
t.eyes = uint8(code % 10);
code /= 10;
t.mouth = uint8(code % 10);
code /= 10;
uint256 n = uint256(seed);
// Codes 0..8,399 use even face variants; codes 8,400..9,999 use odd variants.
// This keeps repeated four-trait bases visually distinct while using all eight face structures.
t.face = uint8(code + 2 * ((n >> 8) % 4));
t.form = uint8((n >> 16) % 8);
t.hat = uint8((n >> 24) % 12);
t.suit = uint8((n >> 48) % 10);
t.mask = uint8((n >> 72) % 10);
t.texture = uint8((n >> 96) % 8);
// Readability rules only affect secondary overlays; the non-repeating primary genotype is untouched.
if (t.race == 1 && (t.hat == 5 || t.hat == 7)) t.hat = 0;
if (t.race == 5) t.hat = 0;
if (t.race == 4 && t.mask == 5) t.mask = 8;
if (t.hat == 2 && t.mask == 7) t.mask = 1;
if (t.hat == 8 && t.mask == 5) t.mask = 9;
}
function textureLayer(uint8 texture, bytes32 seed) internal pure returns (string memory) {
uint256 n = uint256(seed);
string memory p = string.concat(
pixelIf(n, 0, 35, 31), pixelIf(n, 1, 40, 25), pixelIf(n, 2, 46, 20),
pixelIf(n, 3, 53, 16), pixelIf(n, 4, 61, 14), pixelIf(n, 5, 69, 15),
pixelIf(n, 6, 77, 18), pixelIf(n, 7, 84, 23), pixelIf(n, 8, 91, 30),
pixelIf(n, 9, 97, 38), pixelIf(n, 10, 30, 44), pixelIf(n, 11, 100, 48)
);
if (texture == 0) return string.concat(p, dotGrid(39, 27), dotGrid(82, 30));
if (texture == 1) return string.concat(p, dotGrid(45, 20), dotGrid(76, 24));
if (texture == 2) return string.concat(p, dotGrid(35, 35), dotGrid(86, 36));
if (texture == 3) return string.concat(p, dotGrid(50, 18), dotGrid(91, 31));
if (texture == 4) return string.concat(p, dotGrid(32, 39), dotGrid(79, 20));
if (texture == 5) return string.concat(p, dotGrid(42, 24), dotGrid(94, 40));
if (texture == 6) return string.concat(p, dotGrid(55, 16), dotGrid(83, 27));
return string.concat(p, dotGrid(36, 29), dotGrid(73, 18));
}
function dotGrid(uint8 x, uint8 y) internal pure returns (string memory) {
return string.concat(
"<rect x='", uint256(x).toString(), "' y='", uint256(y).toString(), "' width='1' height='1' fill='#C8FF00'/>",
"<rect x='", uint256(x + 4).toString(), "' y='", uint256(y).toString(), "' width='1' height='1' fill='#C8FF00'/>",
"<rect x='", uint256(x).toString(), "' y='", uint256(y + 4).toString(), "' width='1' height='1' fill='#C8FF00'/>",
"<rect x='", uint256(x + 4).toString(), "' y='", uint256(y + 4).toString(), "' width='1' height='1' fill='#C8FF00'/>"
);
}
function pixelIf(uint256 n, uint8 bitIndex, uint8 x, uint8 y) internal pure returns (string memory) {
if ((n & (uint256(1) << bitIndex)) == 0) return "";
return string.concat("<rect x='", uint256(x).toString(), "' y='", uint256(y).toString(), "' width='1' height='1' fill='#C8FF00'/>");
}
/// @dev A visible 14-bit shoulder constellation directly encodes token IDs 1..10,000 without collisions.
function identityLayer(uint256 tokenId) internal pure returns (string memory) {
uint256 glyph = tokenId;
return string.concat(
identityBit(glyph, 0, 39, 116), identityBit(glyph, 1, 43, 118), identityBit(glyph, 2, 47, 120),
identityBit(glyph, 3, 51, 122), identityBit(glyph, 4, 55, 124), identityBit(glyph, 5, 59, 121),
identityBit(glyph, 6, 63, 123), identityBit(glyph, 7, 69, 121), identityBit(glyph, 8, 73, 124),
identityBit(glyph, 9, 77, 122), identityBit(glyph, 10, 81, 120), identityBit(glyph, 11, 85, 118),
identityBit(glyph, 12, 89, 116), identityBit(glyph, 13, 93, 114)
);
}
function identityBit(uint256 glyph, uint8 bitIndex, uint8 x, uint8 y) internal pure returns (string memory) {
if ((glyph & (uint256(1) << bitIndex)) == 0) return "";
return string.concat("<rect x='", uint256(x).toString(), "' y='", uint256(y).toString(), "' width='2' height='2' fill='#C8FF00'/>");
}
function attribute(string memory key, string memory value) internal pure returns (string memory) {
return string.concat('{"trait_type":"', key, '","value":"', value, '"}');
}
function raceName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Human";
if (id == 1) return "Alien";
if (id == 2) return "Orc";
if (id == 3) return "Goblin";
if (id == 4) return "Glitch";
if (id == 5) return "Hoodie";
return "Hero";
}
function hairName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Curl Halo";
if (id == 1) return "Shaved Arc";
if (id == 2) return "Razor Spikes";
if (id == 3) return "Signal Mohawk";
if (id == 4) return "Long Dreads";
if (id == 5) return "Angular Bob";
if (id == 6) return "Flame Crown";
if (id == 7) return "Pixel Braids";
if (id == 8) return "Asymmetric Sweep";
if (id == 9) return "Cable Crown";
if (id == 10) return "Split Cut";
return "Void Bloom";
}
function eyeName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Classic";
if (id == 1) return "Narrow";
if (id == 2) return "Cyclops";
if (id == 3) return "Triple";
if (id == 4) return "Hollow";
if (id == 5) return "Crossed";
if (id == 6) return "Visor";
if (id == 7) return "Sleep";
if (id == 8) return "Ring";
return "Pixel Array";
}
function mouthName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Neutral";
if (id == 1) return "Teeth";
if (id == 2) return "Grill";
if (id == 3) return "Respirator";
if (id == 4) return "Smirk";
if (id == 5) return "Stitched";
if (id == 6) return "Void";
if (id == 7) return "Bone Grid";
if (id == 8) return "Tusks";
return "Core";
}
function faceName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Classic";
if (id == 1) return "Wide";
if (id == 2) return "Long";
if (id == 3) return "Round";
if (id == 4) return "Diamond";
if (id == 5) return "Mechanical";
if (id == 6) return "Hollow";
return "Split";
}
function formName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Clean";
if (id == 1) return "Chevrons";
if (id == 2) return "Third Signal";
if (id == 3) return "Cracked";
if (id == 4) return "Temple Lines";
if (id == 5) return "Node Marks";
if (id == 6) return "Nose Grid";
return "Wave Marks";
}
function hatName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Wild Curls";
if (id == 1) return "Thin Beanie";
if (id == 2) return "Low Pixel Cap";
if (id == 3) return "Void Top Hat";
if (id == 4) return "Broken Crown";
if (id == 5) return "Signal Mohawk";
if (id == 6) return "Halo Line";
if (id == 7) return "Lab Antennas";
if (id == 8) return "Deep Hood";
if (id == 9) return "Horn Crown";
if (id == 10) return "Static Crown";
return "Fracture Pins";
}
function suitName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Void Collar";
if (id == 1) return "Split Lapel";
if (id == 2) return "Lab Harness";
if (id == 3) return "Chain Formal";
if (id == 4) return "Utility Frame";
if (id == 5) return "Signal Jacket";
if (id == 6) return "Arc Mantle";
if (id == 7) return "Noir Vest";
if (id == 8) return "Broken Blazer";
return "NPC Uniform";
}
function maskName(uint8 id) public pure returns (string memory) {
if (id == 0) return "None";
if (id == 1) return "Eye Bar";
if (id == 2) return "Split Face";
if (id == 3) return "Line Grill";
if (id == 4) return "Respirator";
if (id == 5) return "Skull Grid";
if (id == 6) return "Mono Lens";
if (id == 7) return "Blindfold";
if (id == 8) return "Glitch Mouth";
return "Half Void";
}
function textureName(uint8 id) public pure returns (string memory) {
if (id == 0) return "Fine Static";
if (id == 1) return "Soft Dither";
if (id == 2) return "Broken Scan";
if (id == 3) return "Chain Noise";
if (id == 4) return "Sparse Dust";
if (id == 5) return "Lab Grain";
if (id == 6) return "Void Flecks";
return "Signal Rain";
}
}
