Contract Name:
CollectionRegistry
Contract Source Code:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "./interfaces/ICollectionRegistry.sol";
import "./libraries/StatValidation.sol";
/// @title CollectionRegistry
/// @notice Manages whitelisted NFT collections and their base stats
contract CollectionRegistry is ICollectionRegistry, Ownable {
// ------------------------- State variables -------------------------
// Mapping from collection address to its stats
mapping(address => CollectionStats) private collectionStats;
// Array to keep track of all whitelisted collections
address[] private whitelistedCollections;
// ------------------------- Constructor -------------------------
constructor() Ownable(msg.sender) {}
// ------------------------- External functions - Admin -------------------------
/// @notice Whitelist a new NFT collection with base stats
/// @param collection Address of the NFT collection
/// @param baseVitality Initial vitality for NFTs from this collection
/// @param baseStrength Initial strength for NFTs from this collection
/// @param baseAgility Initial agility for NFTs from this collection
/// @param baseDefense Initial defense for NFTs from this collection
/// @param classType Class archetype for this collection
/// @param complexity Gas complexity tier (1-3)
function whitelistCollection(
address collection,
uint64 baseVitality,
uint64 baseStrength,
uint64 baseAgility,
uint64 baseDefense,
ClassArchetype classType,
uint8 complexity
) external onlyOwner {
require(
!collectionStats[collection].isWhitelisted,
"Already whitelisted"
);
_validateERC721(collection);
// Validate stats for class type
uint64[4] memory stats = [
baseVitality,
baseStrength,
baseAgility,
baseDefense
];
StatValidation.validateClassStats(uint8(classType), stats);
// Store collection stats
collectionStats[collection] = CollectionStats({
baseVitality: baseVitality,
baseStrength: baseStrength,
baseAgility: baseAgility,
baseDefense: baseDefense,
classType: uint8(classType),
complexity: complexity,
isWhitelisted: true
});
whitelistedCollections.push(collection);
emit CollectionWhitelisted(
collection,
baseVitality,
baseStrength,
baseAgility,
baseDefense,
classType,
complexity
);
}
/// @notice Update base stats for a whitelisted collection
/// @param collection Address of the NFT collection
/// @param baseVitality New base vitality
/// @param baseStrength New base strength
/// @param baseAgility New base agility
/// @param baseDefense New base defense
/// @param classType New class archetype
/// @param complexity New complexity tier
function updateCollectionStats(
address collection,
uint64 baseVitality,
uint64 baseStrength,
uint64 baseAgility,
uint64 baseDefense,
ClassArchetype classType,
uint8 complexity
) external onlyOwner {
require(collectionStats[collection].isWhitelisted, "Not whitelisted");
// Validate stats for class type
uint64[4] memory stats = [
baseVitality,
baseStrength,
baseAgility,
baseDefense
];
StatValidation.validateClassStats(uint8(classType), stats);
// Update collection stats
collectionStats[collection] = CollectionStats({
baseVitality: baseVitality,
baseStrength: baseStrength,
baseAgility: baseAgility,
baseDefense: baseDefense,
classType: uint8(classType),
complexity: complexity,
isWhitelisted: true
});
emit CollectionStatsUpdated(
collection,
baseVitality,
baseStrength,
baseAgility,
baseDefense,
classType,
complexity
);
}
/// @notice Remove a collection from the whitelist
/// @param collection Address of the NFT collection to remove
function removeCollection(address collection) external onlyOwner {
require(collectionStats[collection].isWhitelisted, "Not whitelisted");
delete collectionStats[collection];
// Remove from whitelisted collections array
for (uint256 i = 0; i < whitelistedCollections.length; i++) {
if (whitelistedCollections[i] == collection) {
whitelistedCollections[i] = whitelistedCollections[
whitelistedCollections.length - 1
];
whitelistedCollections.pop();
break;
}
}
emit CollectionRemoved(collection);
}
// ------------------------- External view functions -------------------------
/// @notice Check if a collection is whitelisted
/// @param collection Address of the NFT collection to check
/// @return bool True if collection is whitelisted
function isWhitelisted(address collection) external view returns (bool) {
return collectionStats[collection].isWhitelisted;
}
/// @notice Get base stats for a collection
/// @param collection Address of the NFT collection
/// @return CollectionStats struct containing base stats
function getCollectionStats(
address collection
) external view returns (CollectionStats memory) {
return collectionStats[collection];
}
/// @notice Get all whitelisted collections
/// @return address[] Array of whitelisted collection addresses
function getWhitelistedCollections()
external
view
returns (address[] memory)
{
return whitelistedCollections;
}
// ------------------------- Internal functions -------------------------
/// @notice Validate that an address is an ERC721 contract
/// @param collection Address to validate
function _validateERC721(address collection) internal view {
require(collection.code.length > 0, "Collection must be a contract");
try IERC721(collection).supportsInterface(0x80ac58cd) returns (
bool isERC721
) {
require(isERC721, "Collection must support ERC721 interface");
} catch {
revert("Collection must support ERC721 interface");
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC-721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
* {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/// @title ICollectionRegistry
/// @notice Interface for managing whitelisted NFT collections and their base stats
interface ICollectionRegistry {
// ------------------------- Type definitions -------------------------
/// @notice Enum for different class archetypes
enum ClassArchetype {
WARRIOR, // High strength/defense
ROGUE, // High agility/critical
PALADIN, // Balanced with healing
BERSERKER // High damage/risk
}
/// @notice Stats structure for NFT collections
struct CollectionStats {
uint64 baseVitality;
uint64 baseStrength;
uint64 baseAgility;
uint64 baseDefense;
uint8 classType; // ClassArchetype
uint8 complexity; // For gas limit determination
bool isWhitelisted;
}
// ------------------------- Events -------------------------
/// @notice Event emitted when a collection is whitelisted
event CollectionWhitelisted(
address indexed collection,
uint64 baseVitality,
uint64 baseStrength,
uint64 baseAgility,
uint64 baseDefense,
ClassArchetype classType,
uint8 complexity
);
/// @notice Event emitted when a collection's stats are updated
event CollectionStatsUpdated(
address indexed collection,
uint64 baseVitality,
uint64 baseStrength,
uint64 baseAgility,
uint64 baseDefense,
ClassArchetype classType,
uint8 complexity
);
/// @notice Event emitted when a collection is removed from whitelist
event CollectionRemoved(address indexed collection);
// ------------------------- Admin functions -------------------------
/// @notice Whitelist a new NFT collection with base stats
/// @param collection Address of the NFT collection
/// @param baseVitality Initial vitality for NFTs from this collection
/// @param baseStrength Initial strength for NFTs from this collection
/// @param baseAgility Initial agility for NFTs from this collection
/// @param baseDefense Initial defense for NFTs from this collection
/// @param classType Class archetype for this collection
/// @param complexity Gas complexity tier (1-3)
function whitelistCollection(
address collection,
uint64 baseVitality,
uint64 baseStrength,
uint64 baseAgility,
uint64 baseDefense,
ClassArchetype classType,
uint8 complexity
) external;
/// @notice Update base stats for a whitelisted collection
/// @param collection Address of the NFT collection
/// @param baseVitality New base vitality
/// @param baseStrength New base strength
/// @param baseAgility New base agility
/// @param baseDefense New base defense
/// @param classType New class archetype
/// @param complexity New complexity tier
function updateCollectionStats(
address collection,
uint64 baseVitality,
uint64 baseStrength,
uint64 baseAgility,
uint64 baseDefense,
ClassArchetype classType,
uint8 complexity
) external;
/// @notice Remove a collection from the whitelist
/// @param collection Address of the NFT collection to remove
function removeCollection(address collection) external;
// ------------------------- View functions -------------------------
/// @notice Check if a collection is whitelisted
/// @param collection Address of the NFT collection to check
/// @return bool True if collection is whitelisted
function isWhitelisted(address collection) external view returns (bool);
/// @notice Get base stats for a collection
/// @param collection Address of the NFT collection
/// @return CollectionStats struct containing base stats
function getCollectionStats(
address collection
) external view returns (CollectionStats memory);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "../interfaces/ICollectionRegistry.sol";
/// @title StatValidation
/// @notice Library for validating stat ranges and class-specific requirements
library StatValidation {
// ------------------------- Constants -------------------------
uint64 private constant MIN_STAT_VALUE = 50;
uint64 private constant MAX_STAT_VALUE = 200;
uint64 private constant MAX_STAT_INCREASE = 50;
uint8 private constant MAX_COMPLEXITY = 3;
// Gas limits by complexity tier
uint256 private constant TIER1_GAS_LIMIT = 30000;
uint256 private constant TIER2_GAS_LIMIT = 50000;
uint256 private constant TIER3_GAS_LIMIT = 80000;
// ------------------------- Errors -------------------------
error InvalidStatRange(uint64 value, uint64 min, uint64 max);
error InvalidStatIncrease(
uint64 oldValue,
uint64 newValue,
uint64 maxIncrease
);
error InvalidClassStats(uint8 classType, string reason);
error InvalidComplexity(uint8 complexity, uint256 gasUsed);
// ------------------------- Core validation -------------------------
/// @notice Validate a stat value is within acceptable range
/// @param value Stat value to check
/// @param min Minimum allowed value
/// @param max Maximum allowed value
function validateStatRange(
uint64 value,
uint64 min,
uint64 max
) public pure {
if (value < min || value > max) {
revert InvalidStatRange(value, min, max);
}
}
/// @notice Validate a stat increase is within acceptable range
/// @param oldValue Previous stat value
/// @param newValue New stat value
/// @param maxIncrease Maximum allowed increase
function validateStatIncrease(
uint64 oldValue,
uint64 newValue,
uint64 maxIncrease
) public pure {
if (newValue < oldValue || newValue > oldValue + maxIncrease) {
revert InvalidStatIncrease(oldValue, newValue, maxIncrease);
}
}
// ------------------------- Class validation -------------------------
/// @notice Validate stats are appropriate for class type
/// @param classType The class archetype
/// @param stats Array of stats [vitality, strength, agility, defense]
function validateClassStats(
uint8 classType,
uint64[4] memory stats
) public pure {
ICollectionRegistry.ClassArchetype archetype = ICollectionRegistry
.ClassArchetype(classType);
// Validate base requirements for each class
if (archetype == ICollectionRegistry.ClassArchetype.WARRIOR) {
if (stats[1] < 80 || stats[3] < 80) {
// strength and defense
revert InvalidClassStats(
classType,
"Warrior requires high strength and defense"
);
}
} else if (archetype == ICollectionRegistry.ClassArchetype.ROGUE) {
if (stats[2] < 80) {
// agility
revert InvalidClassStats(
classType,
"Rogue requires high agility"
);
}
} else if (archetype == ICollectionRegistry.ClassArchetype.PALADIN) {
if (stats[0] < 80 || stats[3] < 70) {
// vitality and defense
revert InvalidClassStats(
classType,
"Paladin requires high vitality and defense"
);
}
} else if (archetype == ICollectionRegistry.ClassArchetype.BERSERKER) {
if (stats[1] < 90) {
// strength
revert InvalidClassStats(
classType,
"Berserker requires very high strength"
);
}
}
// Validate all stats are within global range
for (uint256 i = 0; i < 4; i++) {
validateStatRange(stats[i], MIN_STAT_VALUE, MAX_STAT_VALUE);
}
}
// ------------------------- Complexity validation -------------------------
/// @notice Validate gas usage against complexity tier
/// @param complexity Complexity tier (1-3)
/// @param gasUsed Amount of gas used
function validateComplexityRequirements(
uint8 complexity,
uint256 gasUsed
) public pure {
if (complexity == 0 || complexity > MAX_COMPLEXITY) {
revert InvalidComplexity(complexity, gasUsed);
}
uint256 gasLimit = complexity == 1
? TIER1_GAS_LIMIT
: complexity == 2
? TIER2_GAS_LIMIT
: TIER3_GAS_LIMIT;
if (gasUsed > gasLimit) {
revert InvalidComplexity(complexity, gasUsed);
}
}
// ------------------------- Utility functions -------------------------
/// @notice Get the gas limit for a complexity tier
/// @param complexity Complexity tier (1-3)
/// @return uint256 Gas limit for the tier
function getGasLimitForComplexity(
uint8 complexity
) public pure returns (uint256) {
return
complexity == 1
? TIER1_GAS_LIMIT
: complexity == 2
? TIER2_GAS_LIMIT
: complexity == 3
? TIER3_GAS_LIMIT
: 0;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}