-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add contractType to RewardNFTDeployed event * Add ConfigurableGuildRewardNFT * Add function to factory that deploys configurable NFTs * Unify comments * Update docs * Add configuration functions for owner * Add deploy scripts for the configurable NFT * Rename deploy-nft -> deploy-basic-nft * Test creating configurable nfts * Fix check for msg.value for multiple mints * Add tests for ConfigurableGuildRewardNFT * Remove unnecessary using * Remove unsafeSkipStorageCheck (leftover from testing) * Deploy to Sepolia * Optimize ConfigurableGuildRewardNFT * Use a modifier for repeated code in OptionallySoulboundERC721 * Add Unlocked event when minting non-soulbound tokens * Fix some comments
- Loading branch information
Showing
24 changed files
with
1,999 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| //SPDX-License-Identifier: MIT | ||
| pragma solidity 0.8.19; | ||
|
|
||
| import { IConfigurableGuildRewardNFT } from "./interfaces/IConfigurableGuildRewardNFT.sol"; | ||
| import { IGuildRewardNFTFactory } from "./interfaces/IGuildRewardNFTFactory.sol"; | ||
| import { ITreasuryManager } from "./interfaces/ITreasuryManager.sol"; | ||
| import { LibTransfer } from "./lib/LibTransfer.sol"; | ||
| import { OptionallySoulboundERC721 } from "./token/OptionallySoulboundERC721.sol"; | ||
| import { TreasuryManager } from "./utils/TreasuryManager.sol"; | ||
| import { OwnableUpgradeable } from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol"; | ||
| import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; | ||
| import { ECDSA } from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol"; | ||
|
|
||
| /// @title An NFT distributed as a reward for Guild.xyz users. | ||
| contract ConfigurableGuildRewardNFT is | ||
| IConfigurableGuildRewardNFT, | ||
| Initializable, | ||
| OwnableUpgradeable, | ||
| OptionallySoulboundERC721, | ||
| TreasuryManager | ||
| { | ||
| using ECDSA for bytes32; | ||
| using LibTransfer for address payable; | ||
|
|
||
| address public factoryProxy; | ||
| uint256 public mintableAmountPerUser; | ||
|
|
||
| /// @notice The cid for tokenURI. | ||
| string internal cid; | ||
|
|
||
| /// @notice The number of claimed tokens by userIds. | ||
| mapping(uint256 userId => uint256 claimed) internal claimedTokens; | ||
|
|
||
| function initialize( | ||
| IGuildRewardNFTFactory.ConfigurableNFTConfig memory nftConfig, | ||
| address factoryProxyAddress | ||
| ) public initializer { | ||
| cid = nftConfig.cid; | ||
| mintableAmountPerUser = nftConfig.mintableAmountPerUser; | ||
| factoryProxy = factoryProxyAddress; | ||
|
|
||
| __OptionallySoulboundERC721_init(nftConfig.name, nftConfig.symbol, nftConfig.soulbound); | ||
| __TreasuryManager_init(nftConfig.treasury, nftConfig.tokenFee); | ||
|
|
||
| _transferOwnership(nftConfig.tokenOwner); | ||
| } | ||
|
|
||
| function claim(uint256 amount, address receiver, uint256 userId, bytes calldata signature) external payable { | ||
| uint256 mintableAmount = mintableAmountPerUser; | ||
| if (amount > mintableAmount - balanceOf(receiver) || amount > mintableAmount - claimedTokens[userId]) | ||
| revert AlreadyClaimed(); | ||
| if (!isValidSignature(amount, receiver, userId, signature)) revert IncorrectSignature(); | ||
|
|
||
| (uint256 guildFee, address payable guildTreasury) = ITreasuryManager(factoryProxy).getFeeData(); | ||
|
|
||
| claimedTokens[userId] += amount; | ||
|
|
||
| uint256 firstTokenId = totalSupply(); | ||
| uint256 lastTokenId = firstTokenId + amount - 1; | ||
|
|
||
| for (uint256 tokenId = firstTokenId; tokenId <= lastTokenId; ) { | ||
| _safeMint(receiver, tokenId); | ||
|
|
||
| if (soulbound) emit Locked(tokenId); | ||
| else emit Unlocked(tokenId); | ||
|
|
||
| emit Claimed(receiver, tokenId); | ||
|
|
||
| unchecked { | ||
| ++tokenId; | ||
| } | ||
| } | ||
|
|
||
| // Fee collection | ||
| uint256 guildAmount = amount * guildFee; | ||
| uint256 ownerAmount = amount * fee; | ||
| if (msg.value == guildAmount + ownerAmount) { | ||
| guildTreasury.sendEther(guildAmount); | ||
| treasury.sendEther(ownerAmount); | ||
| } else revert IncorrectFee(msg.value, guildAmount + ownerAmount); | ||
| } | ||
|
|
||
| function burn(uint256[] calldata tokenIds, uint256 userId, bytes calldata signature) external { | ||
| uint256 amount = tokenIds.length; | ||
| if (!isValidSignature(amount, msg.sender, userId, signature)) revert IncorrectSignature(); | ||
|
|
||
| for (uint256 i; i < amount; ) { | ||
| uint256 tokenId = tokenIds[i]; | ||
| if (msg.sender != ownerOf(tokenId)) revert IncorrectSender(); | ||
| _burn(tokenId); | ||
|
|
||
| unchecked { | ||
| ++i; | ||
| } | ||
| } | ||
|
|
||
| claimedTokens[userId] -= amount; | ||
| } | ||
|
|
||
| function setLocked(bool newLocked) external onlyOwner { | ||
| soulbound = newLocked; | ||
| if (newLocked) emit Locked(0); | ||
| else emit Unlocked(0); | ||
| } | ||
|
|
||
| function setMintableAmountPerUser(uint256 newAmount) external onlyOwner { | ||
| mintableAmountPerUser = newAmount; | ||
| emit MintableAmountPerUserChanged(newAmount); | ||
| } | ||
|
|
||
| function updateTokenURI(string calldata newCid) external onlyOwner { | ||
| cid = newCid; | ||
| emit MetadataUpdate(); | ||
| } | ||
|
|
||
| function balanceOf(uint256 userId) external view returns (uint256 amount) { | ||
| return claimedTokens[userId]; | ||
| } | ||
|
|
||
| function tokenURI(uint256 tokenId) public view override returns (string memory) { | ||
| if (!_exists(tokenId)) revert NonExistentToken(tokenId); | ||
|
|
||
| return string.concat("ipfs://", cid); | ||
| } | ||
|
|
||
| /// @notice Checks the validity of the signature for the given params. | ||
| function isValidSignature( | ||
| uint256 amount, | ||
| address receiver, | ||
| uint256 userId, | ||
| bytes calldata signature | ||
| ) internal view returns (bool) { | ||
| if (signature.length != 65) revert IncorrectSignature(); | ||
| bytes32 message = keccak256(abi.encode(amount, receiver, userId, block.chainid, address(this))) | ||
| .toEthSignedMessageHash(); | ||
| return message.recover(signature) == IGuildRewardNFTFactory(factoryProxy).validSigner(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.