Contract Source Code:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "./interfaces/IPrizePool.sol";
import "./interfaces/IDungeonEntry.sol";
import "./interfaces/IDungeonGame.sol";
/// @title PrizePool
/// @notice Manages entry fees and prize distribution for successful dungeon runs
contract PrizePool is IPrizePool, Ownable, ReentrancyGuard {
// State variables
uint256 private constant MIN_ENTRY_FEE = 0.01 ether;
uint256 private constant MAX_ENTRY_FEE = 1 ether;
uint256 private constant WINNER_SHARE = 80; // 80% of entry fees go to winners
uint256 private constant TREASURY_SHARE = 20; // 20% goes to treasury
uint256 private entryFee;
uint256 private totalEntryFees;
uint256 private totalPrizesPaid;
uint256 private currentRunPrizePool;
uint256 private treasuryBalance;
address private dungeonEntry;
address private dungeonGame;
bool private initialized;
// Mapping to track unclaimed prizes per NFT
mapping(address => mapping(uint256 => uint256)) private unclaimedPrizes;
// Mapping to track if an NFT has claimed its prize for the current run
mapping(address => mapping(uint256 => bool)) private hasClaimedCurrentRun;
// Events
event EntryFeeUpdated(uint256 newFee);
event PrizePoolUpdated(uint256 newPool);
event PrizeClaimed(address indexed collection, uint256 indexed tokenId, uint256 amount);
event TreasuryWithdrawn(uint256 amount);
event PrizePoolInitialized(address indexed dungeonEntry, address indexed dungeonGame);
constructor(
uint256 _entryFee,
uint256 _winnerShare
) Ownable() {
require(_entryFee >= MIN_ENTRY_FEE && _entryFee <= MAX_ENTRY_FEE, "Invalid entry fee");
entryFee = _entryFee;
}
/// @notice Initialize the PrizePool with required contract addresses
/// @param _dungeonEntry Address of the DungeonEntry contract
/// @param _dungeonGame Address of the DungeonGame contract
function initialize(
address _dungeonEntry,
address _dungeonGame
) external onlyOwner {
require(!initialized, "Already initialized");
require(_dungeonEntry != address(0), "Invalid DungeonEntry address");
require(_dungeonGame != address(0), "Invalid DungeonGame address");
dungeonEntry = _dungeonEntry;
dungeonGame = _dungeonGame;
initialized = true;
emit PrizePoolInitialized(_dungeonEntry, _dungeonGame);
}
/// @notice Updates the entry fee for dungeon runs
/// @param newFee The new entry fee in wei
function updateEntryFee(uint256 newFee) external onlyOwner {
require(newFee >= MIN_ENTRY_FEE && newFee <= MAX_ENTRY_FEE, "Invalid entry fee");
entryFee = newFee;
emit EntryFeeUpdated(newFee);
}
/// @notice Records entry fee payment
function depositEntryFee(address collection, uint256 tokenId) external payable {
require(initialized, "Not initialized");
require(msg.sender == dungeonEntry, "Only DungeonEntry can record fees");
require(msg.value == entryFee, "Incorrect entry fee");
currentRunPrizePool += msg.value;
totalEntryFees += msg.value;
// Calculate treasury share
uint256 treasuryShare = (msg.value * TREASURY_SHARE) / 100;
treasuryBalance += treasuryShare;
emit PrizePoolUpdated(currentRunPrizePool);
}
/// @notice Register a winner for prize distribution
function registerWinner(address collection, uint256 tokenId, uint256 amount) external {
require(initialized, "Not initialized");
require(msg.sender == dungeonGame, "Only DungeonGame can register winners");
require(!hasClaimedCurrentRun[collection][tokenId], "Already claimed for this run");
// Calculate prize share
uint256 prizeShare = (currentRunPrizePool * WINNER_SHARE) / 100;
unclaimedPrizes[collection][tokenId] += prizeShare;
hasClaimedCurrentRun[collection][tokenId] = true;
emit PrizePoolUpdated(currentRunPrizePool);
}
/// @notice Claims unclaimed prize for an NFT
/// @param collection The NFT collection address
/// @param tokenId The NFT token ID
function claimPrize(address collection, uint256 tokenId) external nonReentrant {
require(initialized, "Not initialized");
require(IERC721(collection).ownerOf(tokenId) == msg.sender, "Not NFT owner");
uint256 prize = unclaimedPrizes[collection][tokenId];
require(prize > 0, "No unclaimed prize");
unclaimedPrizes[collection][tokenId] = 0;
totalPrizesPaid += prize;
(bool success, ) = msg.sender.call{value: prize}("");
require(success, "Transfer failed");
emit PrizeClaimed(collection, tokenId, prize);
}
/// @notice Withdraws treasury balance to owner
function withdrawTreasury() external onlyOwner nonReentrant {
require(initialized, "Not initialized");
uint256 amount = treasuryBalance;
require(amount > 0, "No treasury balance");
treasuryBalance = 0;
(bool success, ) = msg.sender.call{value: amount}("");
require(success, "Transfer failed");
emit TreasuryWithdrawn(amount);
}
/// @notice Gets the current entry fee
function getEntryFee() external view returns (uint256) {
return entryFee;
}
/// @notice Gets the current prize pool amount
function getCurrentPrizePool() external view returns (uint256) {
return currentRunPrizePool;
}
/// @notice Gets total entry fees collected
function getTotalEntryFees() external view returns (uint256) {
return totalEntryFees;
}
/// @notice Gets total prizes paid out
function getTotalPrizesPaid() external view returns (uint256) {
return totalPrizesPaid;
}
/// @notice Gets current treasury balance
function getTreasuryBalance() external view returns (uint256) {
return treasuryBalance;
}
/// @notice Get the claimable prize amount for an NFT
function getClaimablePrize(address collection, uint256 tokenId) external view returns (uint256) {
return unclaimedPrizes[collection][tokenId];
}
/// @notice Check if an NFT has an unclaimed prize
function hasUnclaimedPrize(address collection, uint256 tokenId) external view returns (bool) {
return unclaimedPrizes[collection][tokenId] > 0;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../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.
*
* By default, the owner account will be the one that deploys the contract. 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;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @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 {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing 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 {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_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 v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @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 you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 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 ERC721 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 ERC721
* 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 caller.
*
* 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.19;
/// @title IPrizePool
/// @notice Interface for managing dungeon rewards and prize distribution
interface IPrizePool {
/// @notice Event emitted when entry fee is deposited
event EntryFeeDeposited(address indexed collection, uint256 indexed tokenId, uint256 amount);
/// @notice Event emitted when reward is claimed
event RewardClaimed(address indexed collection, uint256 indexed tokenId, address indexed recipient, uint256 amount);
/// @notice Event emitted when prize pool parameters are updated
event PrizePoolParametersUpdated(uint256 entryFee, uint256 winnerShare);
/// @notice Deposit entry fee for a dungeon run
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
function depositEntryFee(address collection, uint256 tokenId) external payable;
/// @notice Register a winner for prize claiming
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @param amount Amount to be claimed
function registerWinner(address collection, uint256 tokenId, uint256 amount) external;
/// @notice Claim prize for a winning NFT
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
function claimPrize(address collection, uint256 tokenId) external;
/// @notice Get claimable prize amount for a winning NFT
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @return uint256 Claimable amount
function getClaimablePrize(address collection, uint256 tokenId) external view returns (uint256);
/// @notice Get current prize pool balance
/// @return uint256 Current balance
function getCurrentPrizePool() external view returns (uint256);
/// @notice Check if an NFT has an unclaimed prize
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @return bool True if NFT has unclaimed prize
function hasUnclaimedPrize(address collection, uint256 tokenId) external view returns (bool);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
/// @title IDungeonEntry
/// @notice Interface for managing dungeon entry and run initialization
interface IDungeonEntry {
/// @notice Structure for active dungeon run state
struct DungeonRun {
uint256 currentHp;
uint256 currentAttack;
uint256 currentSpeed;
uint256 currentRoom;
uint256 startTime;
bool isActive;
}
/// @notice Event emitted when a dungeon run is started
event DungeonRunStarted(
address indexed collection,
uint256 indexed tokenId,
address indexed player,
uint256 entryFee
);
/// @notice Event emitted when a dungeon run is ended
event DungeonRunEnded(
address indexed collection,
uint256 indexed tokenId,
bool success
);
/// @notice Start a new dungeon run for an NFT
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
function startDungeonRun(address collection, uint256 tokenId) external payable;
/// @notice End an active dungeon run (called by DungeonGame)
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @param success Whether the run was successful
function endDungeonRun(address collection, uint256 tokenId, bool success) external;
/// @notice Get the current dungeon run state for an NFT
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @return DungeonRun struct containing current run state
function getCurrentRun(address collection, uint256 tokenId) external view returns (DungeonRun memory);
/// @notice Check if an NFT has an active dungeon run
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @return bool True if NFT has an active run
function hasActiveRun(address collection, uint256 tokenId) external view returns (bool);
/// @notice Get the current entry fee for dungeon runs
/// @return uint256 Current entry fee in wei
function getEntryFee() external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
/// @title IDungeonGame
/// @notice Interface for core dungeon game mechanics and progression
interface IDungeonGame {
/// @notice Structure for dungeon room state
struct RoomState {
address collection;
uint256 tokenId;
uint256 entryIndex; // Used for ordering characters
uint256 currentHp;
uint256 currentAttack;
uint256 currentSpeed;
bool isOccupied;
}
/// @notice Structure for encounter results
struct EncounterResult {
int256 hpChange;
int256 attackChange;
int256 speedChange;
uint256 xpGained;
bool survived;
string encounterDescription;
uint256 roomNumber;
}
/// @notice Event emitted when an encounter is completed
event EncounterCompleted(
address indexed collection,
uint256 indexed tokenId,
uint256 roomNumber,
uint256 xpGained,
bool survived,
string encounterDescription
);
/// @notice Event emitted when a dungeon run is completed
event DungeonCompleted(
address indexed collection,
uint256 indexed tokenId,
bool success,
uint256 roomsCleared,
uint256 totalXpGained,
uint256 reward
);
/// @notice Progress all characters in the dungeon by one room
/// @return EncounterResult[] Array of encounter results for each character that moved
function progressAllCharacters() external returns (EncounterResult[] memory);
/// @notice Add a new character to the dungeon queue
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
function addCharacterToDungeon(address collection, uint256 tokenId) external;
/// @notice Claim rewards for a successful dungeon run
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
function claimRewards(address collection, uint256 tokenId) external;
/// @notice Get the state of a specific room
/// @param roomNumber Room number to query
/// @return RoomState Current state of the room
function getRoomState(uint256 roomNumber) external view returns (RoomState memory);
/// @notice Get all active room states
/// @return RoomState[] Array of all room states
function getAllRoomStates() external view returns (RoomState[] memory);
/// @notice Get the room number where a character is located
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @return uint256 Room number, 0 if not in dungeon
function getCharacterRoom(address collection, uint256 tokenId) external view returns (uint256);
/// @notice Get the total number of rooms in the dungeon
/// @return uint256 Number of rooms (16)
function getTotalRooms() external pure returns (uint256);
/// @notice Check if a character has completed the dungeon
/// @param collection Address of the NFT collection
/// @param tokenId Token ID of the NFT
/// @return bool True if character has completed all rooms
function isDungeonCompleted(address collection, uint256 tokenId) external view returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @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;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* 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[EIP 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);
}