// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol)pragmasolidity ^0.8.1;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/functionisContract(address account) internalviewreturns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0// for contracts in construction, since the code is only stored at the end// of the constructor execution.return account.code.length>0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
require(address(this).balance>= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(address(this).balance>= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytesmemory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytesmemory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/functionverifyCallResult(bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalpurereturns (bytesmemory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assembly/// @solidity memory-safe-assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
Contract Source Code
File 2 of 19: AdventureERC721.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.9;import"./IQuestStaking.sol";
import"./AdventurePermissions.sol";
import"@openzeppelin/contracts/token/ERC721/ERC721.sol";
abstractcontractAdventureERC721isERC721, AdventurePermissions, IQuestStaking{
uint256publicconstant MAX_UINT32 =type(uint32).max;
uint256publicconstant MAX_CONCURRENT_QUESTS =100;
/// @dev Maps each token id to a mapping that can enumerate all active quests within an adventuremapping (uint256=>mapping (address=>uint32[])) public activeQuestList;
/// @dev Maps each token id to a mapping from adventure address to a mapping of quest ids to quest detailsmapping (uint256=>mapping (address=>mapping (uint32=> Quest))) public activeQuestLookup;
/// @dev Maps each token id to the number of blocking quests it is currently entered intomapping (uint256=>uint256) public blockingQuestCounts;
/// @dev ERC-165 interface supportfunctionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverride (ERC721, IERC165) returns (bool) {
return interfaceId ==type(IQuestStaking).interfaceId||super.supportsInterface(interfaceId);
}
/// @notice Allows an authorized game contract to transfer a player's token if they have opted infunctionadventureTransferFrom(addressfrom, address to, uint256 tokenId) externaloverrideonlyAdventure{
require(_isApprovedForAdventure(_msgSender(), tokenId), "Caller not approved for adventure");
_transfer(from, to, tokenId);
}
/// @notice Allows an authorized game contract to transfer a player's token if they have opted infunctionadventureSafeTransferFrom(addressfrom, address to, uint256 tokenId) externaloverrideonlyAdventure{
require(_isApprovedForAdventure(_msgSender(), tokenId), "Caller not approved for adventure");
_safeTransfer(from, to, tokenId, "");
}
/// @notice Allows an authorized game contract to burn a player's token if they have opted infunctionadventureBurn(uint256 tokenId) externaloverrideonlyAdventure{
require(_isApprovedForAdventure(_msgSender(), tokenId), "Caller not approved for adventure");
_burn(tokenId);
}
/// @notice Allows an authorized game contract to stake a player's token into a quest if they have opted infunctionenterQuest(uint256 tokenId, uint256 questId) externaloverrideonlyAdventure{
require(_isApprovedForAdventure(_msgSender(), tokenId), "Caller not approved for adventure");
_enterQuest(tokenId, _msgSender(), questId);
}
/// @notice Allows an authorized game contract to unstake a player's token from a quest if they have opted in/// For developers of adventure contracts that perform adventure burns, be aware that the adventure must exitQuest/// before the adventure burn occurs, as _exitQuest emits the owner of the token, which would revert after burning.functionexitQuest(uint256 tokenId, uint256 questId) externaloverrideonlyAdventure{
require(_isApprovedForAdventure(_msgSender(), tokenId), "Caller not approved for adventure");
_exitQuest(tokenId, _msgSender(), questId);
}
/// @notice Admin-only ability to boot a token from all quests on an adventure./// This ability is only unlocked in the event that an adventure has been unwhitelisted, as early exiting/// from quests can cause out of sync state between the ERC721 token contract and the adventure/quest.functionbootFromAllQuests(uint256 tokenId, address adventure) externalonlyOwneronlyWhenRemovedFromWhitelist(adventure) {
_exitAllQuests(tokenId, adventure, true);
}
/// @notice Gives the player the ability to exit a quest without interacting directly with the approved, whitelisted adventure/// This ability is only unlocked in the event that an adventure has been unwhitelisted, as early exiting/// from quests can cause out of sync state between the ERC721 token contract and the adventure/quest.functionuserExitQuest(uint256 tokenId, address adventure, uint256 questId) externalonlyWhenRemovedFromWhitelist(adventure) {
require(ownerOf(tokenId) == _msgSender(), "Only token owner may exit quest");
_exitQuest(tokenId, adventure, questId);
}
/// @notice Gives the player the ability to exit all quests on an adventure without interacting directly with the approved, whitelisted adventure/// This ability is only unlocked in the event that an adventure has been unwhitelisted, as early exiting/// from quests can cause out of sync state between the ERC721 token contract and the adventure/quest.functionuserExitAllQuests(uint256 tokenId, address adventure) externalonlyWhenRemovedFromWhitelist(adventure) {
require(ownerOf(tokenId) == _msgSender(), "Only token owner may exit quest");
_exitAllQuests(tokenId, adventure, false);
}
/// @notice Returns the number of quests a token is actively participating in for a specified adventurefunctiongetQuestCount(uint256 tokenId, address adventure) publicoverrideviewreturns (uint256) {
return activeQuestList[tokenId][adventure].length;
}
/// @notice Returns the amount of time a token has been participating in the specified questfunctiongetTimeOnQuest(uint256 tokenId, address adventure, uint256 questId) publicoverrideviewreturns (uint256) {
(bool participatingInQuest, uint256 startTimestamp,) = isParticipatingInQuest(tokenId, adventure, questId);
return participatingInQuest ? (block.timestamp- startTimestamp) : 0;
}
/// @notice Returns whether or not a token is currently participating in the specified quest as well as the time it was started and the quest indexfunctionisParticipatingInQuest(uint256 tokenId, address adventure, uint256 questId) publicoverrideviewreturns (bool participatingInQuest, uint256 startTimestamp, uint256 index) {
Quest memory quest = activeQuestLookup[tokenId][adventure][uint32(questId)];
participatingInQuest = quest.isActive;
startTimestamp = quest.startTimestamp;
index = quest.arrayIndex;
return (participatingInQuest, startTimestamp, index);
}
/// @notice Returns a list of all active quests for the specified token id and adventurefunctiongetActiveQuests(uint256 tokenId, address adventure) publicoverrideviewreturns (Quest[] memory activeQuests) {
uint256 questCount = getQuestCount(tokenId, adventure);
activeQuests =new Quest[](questCount);
uint32[] memory activeQuestIdList = activeQuestList[tokenId][adventure];
for(uint256 i =0; i < questCount; ++i) {
activeQuests[i] = activeQuestLookup[tokenId][adventure][activeQuestIdList[i]];
}
return activeQuests;
}
/// @notice Enters the specified quest for a token id./// Throws if the token is already participating in the specified quest./// Throws if the number of active quests exceeds the max allowable for the given adventure./// Emits a QuestUpdated event for off-chain processing.function_enterQuest(uint256 tokenId, address adventure, uint256 questId) internal{
require(questId <= MAX_UINT32, "questId out of range");
(bool participatingInQuest,,) = isParticipatingInQuest(tokenId, adventure, questId);
require(!participatingInQuest, "Already on quest");
uint256 currentQuestCount = getQuestCount(tokenId, adventure);
require(currentQuestCount < MAX_CONCURRENT_QUESTS, "Too many active quests");
uint32 castedQuestId =uint32(questId);
activeQuestList[tokenId][adventure].push(castedQuestId);
activeQuestLookup[tokenId][adventure][castedQuestId] = Quest({
isActive: true,
startTimestamp: uint64(block.timestamp),
questId: castedQuestId,
arrayIndex: uint32(currentQuestCount)
});
address ownerOfToken = ownerOf(tokenId);
emit QuestUpdated(tokenId, ownerOfToken, adventure, questId, true, false);
if(IAdventure(adventure).questsLockTokens()) {
unchecked {
++blockingQuestCounts[tokenId];
}
}
IAdventure(adventure).onQuestEntered(ownerOfToken, tokenId, questId);
}
/// @notice Exits the specified quest for a token id./// Throws if the token is not currently participating on the specified quest./// Emits a QuestUpdated event for off-chain processing.function_exitQuest(uint256 tokenId, address adventure, uint256 questId) internal{
require(questId <= MAX_UINT32, "questId out of range");
(bool participatingInQuest, uint256 startTimestamp, uint256 index) = isParticipatingInQuest(tokenId, adventure, questId);
require(participatingInQuest, "Not on quest");
uint32 castedQuestId =uint32(questId);
uint256 lastArrayIndex = getQuestCount(tokenId, adventure) -1;
activeQuestList[tokenId][adventure][index] = activeQuestList[tokenId][adventure][lastArrayIndex];
activeQuestLookup[tokenId][adventure][activeQuestList[tokenId][adventure][lastArrayIndex]].arrayIndex =uint32(index);
activeQuestList[tokenId][adventure].pop();
delete activeQuestLookup[tokenId][adventure][castedQuestId];
address ownerOfToken = ownerOf(tokenId);
emit QuestUpdated(tokenId, ownerOfToken, adventure, questId, false, false);
if(IAdventure(adventure).questsLockTokens()) {
--blockingQuestCounts[tokenId];
}
IAdventure(adventure).onQuestExited(ownerOfToken, tokenId, questId, startTimestamp);
}
/// @notice Removes the specified token id from all quests on the specified adventurefunction_exitAllQuests(uint256 tokenId, address adventure, bool booted) internal{
address tokenOwner = ownerOf(tokenId);
uint256 questCount = getQuestCount(tokenId, adventure);
if(IAdventure(adventure).questsLockTokens()) {
blockingQuestCounts[tokenId] -= questCount;
}
for(uint256 i =0; i < questCount; ++i) {
uint256 questId = activeQuestList[tokenId][adventure][i];
Quest memory quest = activeQuestLookup[tokenId][adventure][uint32(questId)];
uint256 startTimestamp = quest.startTimestamp;
emit QuestUpdated(tokenId, tokenOwner, adventure, questId, false, booted);
delete activeQuestLookup[tokenId][adventure][uint32(questId)];
IAdventure(adventure).onQuestExited(tokenOwner, tokenId, questId, startTimestamp);
}
delete activeQuestList[tokenId][adventure];
}
/// @dev By default, tokens that are participating in quests are transferrable. However, if a token is participating/// in a quest on an adventure that was designated as a token locker, the transfer will revert and keep the token/// locked.function_beforeTokenTransfer(address/*from*/, address/*to*/, uint256 tokenId) internalvirtualoverride{
require(blockingQuestCounts[tokenId] ==0, "An active quest is preventing transfers");
}
}
Contract Source Code
File 3 of 19: AdventurePermissions.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.9;import"./IAdventure.sol";
import"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/token/ERC721/IERC721.sol";
abstractcontractAdventurePermissionsisOwnable{
structAdventureDetails {
bool isWhitelisted;
uint128 arrayIndex;
}
/// @dev Emitted when the adventure whitelist is updatedeventAdventureWhitelistUpdated(addressindexed adventure, bool whitelisted);
/// @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets, for special in-game adventures.eventAdventureApprovalForAll(addressindexed tokenOwner, addressindexed operator, bool approved);
/// @dev Whitelist array for iterationaddress[] public whitelistedAdventureList;
/// @dev Whitelist mappingmapping (address=> AdventureDetails) public whitelistedAdventures;
/// @dev Mapping from owner to operator approvals for special gameplay behaviormapping (address=>mapping (address=>bool)) private _operatorAdventureApprovals;
modifieronlyAdventure() {
require(isAdventureWhitelisted(_msgSender()), "Not an adventure.");
_;
}
/// @notice This modifier is used to prevent early backdoor exiting from adventures,/// and action which can cause problems with data getting out of sync in the adventure.modifieronlyWhenRemovedFromWhitelist(address adventure) {
require(!isAdventureWhitelisted(adventure), "Adventure is still whitelisted");
_;
}
/// @notice Returns whether the specified account is a whitelisted adventurefunctionisAdventureWhitelisted(address account) publicviewreturns (bool) {
return whitelistedAdventures[account].isWhitelisted;
}
/// @notice Whitelists an adventure and specifies whether or not the quests in that adventure lock token transfersfunctionwhitelistAdventure(address adventure) externalonlyOwner{
require(!whitelistedAdventures[adventure].isWhitelisted, "Already whitelisted");
require(IERC165(adventure).supportsInterface(type(IAdventure).interfaceId), "Invalid adventure contract");
whitelistedAdventures[adventure].isWhitelisted =true;
whitelistedAdventures[adventure].arrayIndex =uint128(whitelistedAdventureList.length);
whitelistedAdventureList.push(adventure);
emit AdventureWhitelistUpdated(adventure, true);
}
/// @notice Removes an adventure from the whitelistfunctionunwhitelistAdventure(address adventure) externalonlyOwner{
require(whitelistedAdventures[adventure].isWhitelisted, "Not whitelisted");
uint128 itemPositionToDelete = whitelistedAdventures[adventure].arrayIndex;
whitelistedAdventureList[itemPositionToDelete] = whitelistedAdventureList[whitelistedAdventureList.length-1];
whitelistedAdventures[whitelistedAdventureList[itemPositionToDelete]].arrayIndex = itemPositionToDelete;
whitelistedAdventureList.pop();
delete whitelistedAdventures[adventure];
emit AdventureWhitelistUpdated(adventure, false);
}
/// @notice Similar to {IERC721-setApprovalForAll}, but for special in-game adventures onlyfunctionsetAdventuresApprovedForAll(address operator, bool approved) public{
_setAdventuresApprovedForAll(_msgSender(), operator, approved);
}
/// @notice Similar to {IERC721-isApprovedForAll}, but for special in-game adventures onlyfunctionareAdventuresApprovedForAll(address owner, address operator) publicviewreturns (bool) {
return _operatorAdventureApprovals[owner][operator];
}
/// @dev Approve `operator` to operate on all of `owner` tokens for special in-game adventures onlyfunction_setAdventuresApprovedForAll(address tokenOwner, address operator, bool approved) internal{
require(tokenOwner != operator, "approve to caller");
_operatorAdventureApprovals[tokenOwner][operator] = approved;
emit AdventureApprovalForAll(tokenOwner, operator, approved);
}
/// Modify to remove individual approval check/// @dev Returns whether `spender` is allowed to manage `tokenId`, for special in-game adventures only.function_isApprovedForAdventure(address spender, uint256 tokenId) internalviewvirtualreturns (bool) {
address tokenOwner = IERC721(address(this)).ownerOf(tokenId);
return (areAdventuresApprovedForAll(tokenOwner, spender));
}
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^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.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 6 of 19: DigiDaigakuHeroes.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.9;import"./AdventureERC721.sol";
import"./Bloodlines.sol";
import"@openzeppelin/contracts/token/common/ERC2981.sol";
contractDigiDaigakuHeroesisAdventureERC721, ERC2981{
usingStringsforuint256;
/// @dev Largest unsigned int 256 bit valueuint256privateconstant MAX_UINT =type(uint256).max;
/// @dev The maximum hero token supplyuint256publicconstant MAX_SUPPLY =2022;
/// @dev The maximum allowable royalty fee is 10%uint96publicconstant MAX_ROYALTY_FEE_NUMERATOR =1000;
/// @dev Bloodline array - uses tight variable packing to save gas
Bloodlines.Bloodline[MAX_SUPPLY] private bloodlines;
/// @dev Bitmap that helps determine if a token was ever minted previouslyuint256[] private mintedTokenTracker;
/// @dev Base token uristringpublic baseTokenURI;
/// @dev Token uri suffix/extensionstringpublic suffixURI =".json";
/// @dev Whitelisted minter mappingmapping (address=>bool) public whitelistedMinters;
/// @dev Emitted when base URI is set.eventBaseURISet(string baseTokenURI);
/// @dev Emitted when suffix URI is set.eventSuffixURISet(string suffixURI);
/// @dev Emitted when royalty is set.eventRoyaltySet(address receiver, uint96 feeNumerator);
/// @dev Emitted when the minter whitelist is updatedeventMinterWhitelistUpdated(addressindexed minter, bool whitelisted);
/// @dev Emitted when a hero is mintedeventMintHero(addressindexed to, uint256indexed tokenId, uint256indexed genesisTokenId, uint256 timestamp);
constructor() ERC721("DigiDaigakuHeroes", "DIHE") {
unchecked {
// Initialize memory to use for tracking token ids that have been minted// The bit corresponding to token id defaults to 1 when unminted,// and will be set to 0 upon mint.uint256 numberOfTokenTrackerSlots = getNumberOfTokenTrackerSlots();
for(uint256 i =0; i < numberOfTokenTrackerSlots; ++i) {
mintedTokenTracker.push(MAX_UINT);
}
}
}
modifieronlyMinter() {
require(isMinterWhitelisted(_msgSender()), "Not a minter");
_;
}
/// @notice Returns whether the specified account is a whitelisted minterfunctionisMinterWhitelisted(address account) publicviewreturns (bool) {
return whitelistedMinters[account];
}
/// @notice Whitelists a minterfunctionwhitelistMinter(address minter) externalonlyOwner{
require(!whitelistedMinters[minter], "Already whitelisted");
whitelistedMinters[minter] =true;
emit MinterWhitelistUpdated(minter, true);
}
/// @notice Removes a minter from the whitelistfunctionunwhitelistMinter(address minter) externalonlyOwner{
require(whitelistedMinters[minter], "Not whitelisted");
delete whitelistedMinters[minter];
emit MinterWhitelistUpdated(minter, false);
}
/// @notice Allows whitelisted minters to mint a hero with the specified bloodlinefunctionmintHero(address to, uint256 tokenId, uint256 genesisTokenId) externalonlyMinter{
unchecked {
require(tokenId >0, "Token id out of range");
require(tokenId <= MAX_SUPPLY, "Token id out of range");
require(genesisTokenId <= MAX_SUPPLY, "Genesis token id out of range");
uint256 slot = tokenId /256;
uint256 offset = tokenId %256;
uint256 slotValue = mintedTokenTracker[slot];
require(((slotValue >> offset) &uint256(1)) ==1, "Token already minted");
mintedTokenTracker[slot] = slotValue &~(uint256(1) << offset);
bloodlines[tokenId -1] = determineBloodline(tokenId, genesisTokenId);
emit MintHero(to, tokenId, genesisTokenId, block.timestamp);
}
_mint(to, tokenId);
}
/// @dev Required to return baseTokenURI for tokenURIfunction_baseURI() internalviewvirtualoverridereturns (stringmemory) {
return baseTokenURI;
}
/// @notice Sets base URIfunctionsetBaseURI(stringcalldata baseTokenURI_) externalonlyOwner{
baseTokenURI = baseTokenURI_;
emit BaseURISet(baseTokenURI_);
}
/// @notice Sets suffix URIfunctionsetSuffixURI(stringcalldata suffixURI_) externalonlyOwner{
suffixURI = suffixURI_;
emit SuffixURISet(suffixURI_);
}
/// @notice Sets royalty informationfunctionsetRoyaltyInfo(address receiver, uint96 feeNumerator) externalonlyOwner{
require(feeNumerator <= MAX_ROYALTY_FEE_NUMERATOR, "Exceeds max royalty fee");
_setDefaultRoyalty(receiver, feeNumerator);
emit RoyaltySet(receiver, feeNumerator);
}
/// @notice Returns the bloodline of the specified hero token id./// Throws if the token does not exist.functiongetBloodline(uint256 tokenId) externalviewreturns (Bloodlines.Bloodline) {
require(_exists(tokenId), "Nonexistent token");
return bloodlines[tokenId -1];
}
/// @notice Returns tokenURI if baseURI is setfunctiontokenURI(uint256 tokenId) publicviewvirtualoverridereturns (stringmemory) {
require(_exists(tokenId), "Nonexistent token");
stringmemory baseURI = _baseURI();
returnbytes(baseURI).length>0
? string(abi.encodePacked(baseURI, tokenId.toString(), suffixURI))
: "";
}
functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverride (AdventureERC721, ERC2981) returns (bool) {
returnsuper.supportsInterface(interfaceId);
}
/// @dev Returns the bloodline based on the combination of token id and genesis token id/// A rogue is created when only a spirit token was staked./// A warrior is created when a spirit is staked with a genesis token and the token ids do not match./// A royal is created when a spirit is staked with a genesis token and the token ids match.functiondetermineBloodline(uint256 tokenId, uint256 genesisTokenId) internalpurereturns (Bloodlines.Bloodline) {
if(genesisTokenId ==0) {
return Bloodlines.Bloodline.Rogue;
} elseif(tokenId != genesisTokenId) {
return Bloodlines.Bloodline.Warrior;
} else {
return Bloodlines.Bloodline.Royal;
}
}
/// @dev Determines number of slots required to track minted tokens across the max supplyfunctiongetNumberOfTokenTrackerSlots() internalpurereturns (uint256 tokenTrackerSlotsRequired) {
unchecked {
// Add 1 because we are starting valid token id range at 1 instead of 0uint256 maxSupplyPlusOne =1+ MAX_SUPPLY;
tokenTrackerSlotsRequired = maxSupplyPlusOne /256;
if(maxSupplyPlusOne %256>0) {
++tokenTrackerSlotsRequired;
}
}
return tokenTrackerSlotsRequired;
}
}
Contract Source Code
File 7 of 19: ERC165.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)pragmasolidity ^0.8.0;import"./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 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);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/abstractcontractERC165isIERC165{
/**
* @dev See {IERC165-supportsInterface}.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverridereturns (bool) {
return interfaceId ==type(IERC165).interfaceId;
}
}
Contract Source Code
File 8 of 19: ERC2981.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (token/common/ERC2981.sol)pragmasolidity ^0.8.0;import"../../interfaces/IERC2981.sol";
import"../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of the NFT Royalty Standard, a standardized way to retrieve royalty payment information.
*
* Royalty information can be specified globally for all token ids via {_setDefaultRoyalty}, and/or individually for
* specific token ids via {_setTokenRoyalty}. The latter takes precedence over the first.
*
* Royalty is specified as a fraction of sale price. {_feeDenominator} is overridable but defaults to 10000, meaning the
* fee is specified in basis points by default.
*
* IMPORTANT: ERC-2981 only specifies a way to signal royalty information and does not enforce its payment. See
* https://eips.ethereum.org/EIPS/eip-2981#optional-royalty-payments[Rationale] in the EIP. Marketplaces are expected to
* voluntarily pay royalties together with sales, but note that this standard is not yet widely supported.
*
* _Available since v4.5._
*/abstractcontractERC2981isIERC2981, ERC165{
structRoyaltyInfo {
address receiver;
uint96 royaltyFraction;
}
RoyaltyInfo private _defaultRoyaltyInfo;
mapping(uint256=> RoyaltyInfo) private _tokenRoyaltyInfo;
/**
* @dev See {IERC165-supportsInterface}.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverride(IERC165, ERC165) returns (bool) {
return interfaceId ==type(IERC2981).interfaceId||super.supportsInterface(interfaceId);
}
/**
* @inheritdoc IERC2981
*/functionroyaltyInfo(uint256 _tokenId, uint256 _salePrice) publicviewvirtualoverridereturns (address, uint256) {
RoyaltyInfo memory royalty = _tokenRoyaltyInfo[_tokenId];
if (royalty.receiver ==address(0)) {
royalty = _defaultRoyaltyInfo;
}
uint256 royaltyAmount = (_salePrice * royalty.royaltyFraction) / _feeDenominator();
return (royalty.receiver, royaltyAmount);
}
/**
* @dev The denominator with which to interpret the fee set in {_setTokenRoyalty} and {_setDefaultRoyalty} as a
* fraction of the sale price. Defaults to 10000 so fees are expressed in basis points, but may be customized by an
* override.
*/function_feeDenominator() internalpurevirtualreturns (uint96) {
return10000;
}
/**
* @dev Sets the royalty information that all ids in this contract will default to.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/function_setDefaultRoyalty(address receiver, uint96 feeNumerator) internalvirtual{
require(feeNumerator <= _feeDenominator(), "ERC2981: royalty fee will exceed salePrice");
require(receiver !=address(0), "ERC2981: invalid receiver");
_defaultRoyaltyInfo = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev Removes default royalty information.
*/function_deleteDefaultRoyalty() internalvirtual{
delete _defaultRoyaltyInfo;
}
/**
* @dev Sets the royalty information for a specific token id, overriding the global default.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/function_setTokenRoyalty(uint256 tokenId,
address receiver,
uint96 feeNumerator
) internalvirtual{
require(feeNumerator <= _feeDenominator(), "ERC2981: royalty fee will exceed salePrice");
require(receiver !=address(0), "ERC2981: Invalid parameters");
_tokenRoyaltyInfo[tokenId] = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev Resets royalty information for the token id back to the global default.
*/function_resetTokenRoyalty(uint256 tokenId) internalvirtual{
delete _tokenRoyaltyInfo[tokenId];
}
}
Contract Source Code
File 9 of 19: ERC721.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/ERC721.sol)pragmasolidity ^0.8.0;import"./IERC721.sol";
import"./IERC721Receiver.sol";
import"./extensions/IERC721Metadata.sol";
import"../../utils/Address.sol";
import"../../utils/Context.sol";
import"../../utils/Strings.sol";
import"../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/contractERC721isContext, ERC165, IERC721, IERC721Metadata{
usingAddressforaddress;
usingStringsforuint256;
// Token namestringprivate _name;
// Token symbolstringprivate _symbol;
// Mapping from token ID to owner addressmapping(uint256=>address) private _owners;
// Mapping owner address to token countmapping(address=>uint256) private _balances;
// Mapping from token ID to approved addressmapping(uint256=>address) private _tokenApprovals;
// Mapping from owner to operator approvalsmapping(address=>mapping(address=>bool)) private _operatorApprovals;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/constructor(stringmemory name_, stringmemory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverride(ERC165, IERC165) returns (bool) {
return
interfaceId ==type(IERC721).interfaceId||
interfaceId ==type(IERC721Metadata).interfaceId||super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/functionbalanceOf(address owner) publicviewvirtualoverridereturns (uint256) {
require(owner !=address(0), "ERC721: address zero is not a valid owner");
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/functionownerOf(uint256 tokenId) publicviewvirtualoverridereturns (address) {
address owner = _owners[tokenId];
require(owner !=address(0), "ERC721: invalid token ID");
return owner;
}
/**
* @dev See {IERC721Metadata-name}.
*/functionname() publicviewvirtualoverridereturns (stringmemory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/functionsymbol() publicviewvirtualoverridereturns (stringmemory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/functiontokenURI(uint256 tokenId) publicviewvirtualoverridereturns (stringmemory) {
_requireMinted(tokenId);
stringmemory baseURI = _baseURI();
returnbytes(baseURI).length>0 ? string(abi.encodePacked(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() internalviewvirtualreturns (stringmemory) {
return"";
}
/**
* @dev See {IERC721-approve}.
*/functionapprove(address to, uint256 tokenId) publicvirtualoverride{
address owner = ERC721.ownerOf(tokenId);
require(to != owner, "ERC721: approval to current owner");
require(
_msgSender() == owner || isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not token owner nor approved for all"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/functiongetApproved(uint256 tokenId) publicviewvirtualoverridereturns (address) {
_requireMinted(tokenId);
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/functionsetApprovalForAll(address operator, bool approved) publicvirtualoverride{
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/functionisApprovedForAll(address owner, address operator) publicviewvirtualoverridereturns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/functiontransferFrom(addressfrom,
address to,
uint256 tokenId
) publicvirtualoverride{
//solhint-disable-next-line max-line-lengthrequire(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) publicvirtualoverride{
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId,
bytesmemory data
) publicvirtualoverride{
require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");
_safeTransfer(from, to, tokenId, data);
}
/**
* @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.
*
* `data` is additional data, it has no specified format and it is sent in call to `to`.
*
* This internal function is equivalent to {safeTransferFrom}, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - 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(addressfrom,
address to,
uint256 tokenId,
bytesmemory data
) internalvirtual{
_transfer(from, to, tokenId);
require(_checkOnERC721Received(from, to, tokenId, data), "ERC721: transfer to non ERC721Receiver implementer");
}
/**
* @dev Returns whether `tokenId` exists.
*
* Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
*
* Tokens start existing when they are minted (`_mint`),
* and stop existing when they are burned (`_burn`).
*/function_exists(uint256 tokenId) internalviewvirtualreturns (bool) {
return _owners[tokenId] !=address(0);
}
/**
* @dev Returns whether `spender` is allowed to manage `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/function_isApprovedOrOwner(address spender, uint256 tokenId) internalviewvirtualreturns (bool) {
address owner = ERC721.ownerOf(tokenId);
return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == spender);
}
/**
* @dev Safely mints `tokenId` and transfers it to `to`.
*
* 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) internalvirtual{
_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,
bytesmemory data
) internalvirtual{
_mint(to, tokenId);
require(
_checkOnERC721Received(address(0), to, tokenId, data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @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) internalvirtual{
require(to !=address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_balances[to] +=1;
_owners[tokenId] = to;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/function_burn(uint256 tokenId) internalvirtual{
address owner = ERC721.ownerOf(tokenId);
_beforeTokenTransfer(owner, address(0), tokenId);
// Clear approvals
_approve(address(0), tokenId);
_balances[owner] -=1;
delete _owners[tokenId];
emit Transfer(owner, address(0), tokenId);
_afterTokenTransfer(owner, address(0), 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(addressfrom,
address to,
uint256 tokenId
) internalvirtual{
require(ERC721.ownerOf(tokenId) ==from, "ERC721: transfer from incorrect owner");
require(to !=address(0), "ERC721: transfer to the zero address");
_beforeTokenTransfer(from, to, tokenId);
// Clear approvals from the previous owner
_approve(address(0), tokenId);
_balances[from] -=1;
_balances[to] +=1;
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
_afterTokenTransfer(from, to, tokenId);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits an {Approval} event.
*/function_approve(address to, uint256 tokenId) internalvirtual{
_tokenApprovals[tokenId] = to;
emit Approval(ERC721.ownerOf(tokenId), to, tokenId);
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits an {ApprovalForAll} event.
*/function_setApprovalForAll(address owner,
address operator,
bool approved
) internalvirtual{
require(owner != operator, "ERC721: approve to caller");
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Reverts if the `tokenId` has not been minted yet.
*/function_requireMinted(uint256 tokenId) internalviewvirtual{
require(_exists(tokenId), "ERC721: invalid token ID");
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address.
* The call is not executed if the target address is not a contract.
*
* @param from address representing the previous owner of the given token ID
* @param to target address that will receive the tokens
* @param tokenId uint256 ID of the token to be transferred
* @param data bytes optional data to send along with the call
* @return bool whether the call correctly returned the expected magic value
*/function_checkOnERC721Received(addressfrom,
address to,
uint256 tokenId,
bytesmemory data
) privatereturns (bool) {
if (to.isContract()) {
try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
return retval == IERC721Receiver.onERC721Received.selector;
} catch (bytesmemory reason) {
if (reason.length==0) {
revert("ERC721: transfer to non ERC721Receiver implementer");
} else {
/// @solidity memory-safe-assemblyassembly {
revert(add(32, reason), mload(reason))
}
}
}
} else {
returntrue;
}
}
/**
* @dev Hook that is called before any token transfer. This includes minting
* and burning.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be
* transferred to `to`.
* - When `from` is zero, `tokenId` will be minted for `to`.
* - When `to` is zero, ``from``'s `tokenId` will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/function_beforeTokenTransfer(addressfrom,
address to,
uint256 tokenId
) internalvirtual{}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/function_afterTokenTransfer(addressfrom,
address to,
uint256 tokenId
) internalvirtual{}
}
Contract Source Code
File 10 of 19: IAdventure.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.9;import"@openzeppelin/contracts/utils/introspection/IERC165.sol";
/**
* @dev Required interface of a contract that complies with the adventure/quest system that is permitted to interact with an AdventureERC721.
*/interfaceIAdventureisIERC165{
/**
* @dev Returns whether or not quests on this adventure lock tokens.
* Developers of adventure contract should ensure that this is immutable
* after deployment of the adventure contract. Failure to do so
* can lead to error that deadlock token transfers.
*/functionquestsLockTokens() externalviewreturns (bool);
/**
* @dev A callback function that AdventureERC721 must invoke when a quest has been successfully entered.
* Throws if the caller is not an expected AdventureERC721 contract designed to work with the Adventure.
* Not permitted to throw in any other case, as this could lead to tokens being locked in quests.
*/functiononQuestEntered(address adventurer, uint256 tokenId, uint256 questId) external;
/**
* @dev A callback function that AdventureERC721 must invoke when a quest has been successfully exited.
* Throws if the caller is not an expected AdventureERC721 contract designed to work with the Adventure.
* Not permitted to throw in any other case, as this could lead to tokens being locked in quests.
*/functiononQuestExited(address adventurer, uint256 tokenId, uint256 questId, uint256 questStartTimestamp) external;
}
Contract Source Code
File 11 of 19: IERC165.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)pragmasolidity ^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}.
*/interfaceIERC165{
/**
* @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.
*/functionsupportsInterface(bytes4 interfaceId) externalviewreturns (bool);
}
Contract Source Code
File 12 of 19: IERC2981.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.6.0) (interfaces/IERC2981.sol)pragmasolidity ^0.8.0;import"../utils/introspection/IERC165.sol";
/**
* @dev Interface for the NFT Royalty Standard.
*
* A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
* support for royalty payments across all NFT marketplaces and ecosystem participants.
*
* _Available since v4.5._
*/interfaceIERC2981isIERC165{
/**
* @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
* exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
*/functionroyaltyInfo(uint256 tokenId, uint256 salePrice)
externalviewreturns (address receiver, uint256 royaltyAmount);
}
Contract Source Code
File 13 of 19: IERC721.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/IERC721.sol)pragmasolidity ^0.8.0;import"../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/interfaceIERC721isIERC165{
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/eventTransfer(addressindexedfrom, addressindexed to, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/eventApproval(addressindexed owner, addressindexed approved, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/eventApprovalForAll(addressindexed owner, addressindexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/functionbalanceOf(address owner) externalviewreturns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functionownerOf(uint256 tokenId) externalviewreturns (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.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId,
bytescalldata 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.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.
*
* 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.
*/functiontransferFrom(addressfrom,
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.
*/functionapprove(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.
*/functionsetApprovalForAll(address operator, bool _approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functiongetApproved(uint256 tokenId) externalviewreturns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/functionisApprovedForAll(address owner, address operator) externalviewreturns (bool);
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC721/IERC721Receiver.sol)pragmasolidity ^0.8.0;/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/interfaceIERC721Receiver{
/**
* @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`.
*/functiononERC721Received(address operator,
addressfrom,
uint256 tokenId,
bytescalldata data
) externalreturns (bytes4);
}
Contract Source Code
File 16 of 19: IQuestStaking.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.9;import"./Quest.sol";
import"@openzeppelin/contracts/utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract that supports adventures and quest staking.
*/interfaceIQuestStakingisIERC165{
/**
* @dev Emitted when a token enters or exits a quest
*/eventQuestUpdated(uint256indexed tokenId, addressindexed tokenOwner, addressindexed adventure, uint256 questId, bool active, bool booted);
/**
* @notice Allows an authorized game contract to transfer a player's token if they have opted in
*/functionadventureTransferFrom(addressfrom, address to, uint256 tokenId) external;
/**
* @notice Allows an authorized game contract to safe transfer a player's token if they have opted in
*/functionadventureSafeTransferFrom(addressfrom, address to, uint256 tokenId) external;
/**
* @notice Allows an authorized game contract to burn a player's token if they have opted in
*/functionadventureBurn(uint256 tokenId) external;
/**
* @notice Allows an authorized game contract to stake a player's token into a quest if they have opted in
*/functionenterQuest(uint256 tokenId, uint256 questId) external;
/**
* @notice Allows an authorized game contract to unstake a player's token from a quest if they have opted in
*/functionexitQuest(uint256 tokenId, uint256 questId) external;
/**
* @notice Returns the number of quests a token is actively participating in for a specified adventure
*/functiongetQuestCount(uint256 tokenId, address adventure) externalviewreturns (uint256);
/**
* @notice Returns the amount of time a token has been participating in the specified quest
*/functiongetTimeOnQuest(uint256 tokenId, address adventure, uint256 questId) externalviewreturns (uint256);
/**
* @notice Returns whether or not a token is currently participating in the specified quest as well as the time it was started and the quest index
*/functionisParticipatingInQuest(uint256 tokenId, address adventure, uint256 questId) externalviewreturns (bool participatingInQuest, uint256 startTimestamp, uint256 index);
/**
* @notice Returns a list of all active quests for the specified token id and adventure
*/functiongetActiveQuests(uint256 tokenId, address adventure) externalviewreturns (Quest[] memory activeQuests);
}
Contract Source Code
File 17 of 19: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)pragmasolidity ^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.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed 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.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
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.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
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) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}