Yash/pack #175
Merged
Yash/pack #175
Conversation
This file contains hidden or 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
…into yash/pack
…into yash/pack
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+210
to
+233
| function openPack(uint256 _packId, uint256 _amountToOpen) | ||
| external | ||
| nonReentrant | ||
| whenNotPaused | ||
| returns (Token[] memory) | ||
| { | ||
| address opener = _msgSender(); | ||
|
|
||
| require(opener == tx.origin, "opener must be eoa"); | ||
| require(balanceOf(opener, _packId) >= _amountToOpen, "opening more than owned"); | ||
|
|
||
| PackInfo memory pack = packInfo[_packId]; | ||
| require(pack.openStartTimestamp < block.timestamp, "cannot open yet"); | ||
|
|
||
| Token[] memory rewardUnits = getRewardUnits(_packId, _amountToOpen, pack.amountDistributedPerOpen, pack); | ||
|
|
||
| _burn(_msgSender(), _packId, _amountToOpen); | ||
|
|
||
| _transferTokenBatch(address(this), _msgSender(), rewardUnits); | ||
|
|
||
| emit PackOpened(_packId, _msgSender(), _amountToOpen, rewardUnits); | ||
|
|
||
| return rewardUnits; | ||
| } |
Check warning
Code scanning / Slither
Dangerous usage of `tx.origin`
| address _to, | ||
| Token[] memory _tokens | ||
| ) internal { | ||
| uint256 nativeTokenValue; |
Check warning
Code scanning / Slither
Uninitialized local variables
Comment on lines
+26
to
+404
| contract Pack is | ||
| Initializable, | ||
| ContractMetadata, | ||
| Ownable, | ||
| Royalty, | ||
| PermissionsEnumerable, | ||
| TokenStore, | ||
| ReentrancyGuardUpgradeable, | ||
| ERC2771ContextUpgradeable, | ||
| MulticallUpgradeable, | ||
| ERC1155PausableUpgradeable, | ||
| IPack | ||
| { | ||
| /*/////////////////////////////////////////////////////////////// | ||
| State variables | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| bytes32 private constant MODULE_TYPE = bytes32("Pack"); | ||
| uint256 private constant VERSION = 1; | ||
|
|
||
| // Token name | ||
| string public name; | ||
|
|
||
| // Token symbol | ||
| string public symbol; | ||
|
|
||
| /// @dev Only transfers to or from TRANSFER_ROLE holders are valid, when transfers are restricted. | ||
| bytes32 private constant TRANSFER_ROLE = keccak256("TRANSFER_ROLE"); | ||
| /// @dev Only MINTER_ROLE holders can create packs. | ||
| bytes32 private constant MINTER_ROLE = keccak256("MINTER_ROLE"); | ||
| /// @dev Only assets with ASSET_ROLE can be packed, when packing is restricted to particular assets. | ||
| bytes32 private constant ASSET_ROLE = keccak256("ASSET_ROLE"); | ||
|
|
||
| /// @dev The token Id of the next set of packs to be minted. | ||
| uint256 public nextTokenIdToMint; | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Mappings | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /// @dev Mapping from token ID => total circulating supply of token with that ID. | ||
| mapping(uint256 => uint256) public totalSupply; | ||
|
|
||
| /// @dev Mapping from pack ID => The state of that set of packs. | ||
| mapping(uint256 => PackInfo) private packInfo; | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Constructor + initializer logic | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| constructor(address _nativeTokenWrapper) TokenStore(_nativeTokenWrapper) initializer {} | ||
|
|
||
| /// @dev Initiliazes the contract, like a constructor. | ||
| function initialize( | ||
| address _defaultAdmin, | ||
| string memory _name, | ||
| string memory _symbol, | ||
| string memory _contractURI, | ||
| address[] memory _trustedForwarders, | ||
| address _royaltyRecipient, | ||
| uint256 _royaltyBps | ||
| ) external initializer { | ||
| // Initialize inherited contracts, most base-like -> most derived. | ||
| __ReentrancyGuard_init(); | ||
| __ERC2771Context_init(_trustedForwarders); | ||
| __ERC1155Pausable_init(); | ||
| __ERC1155_init(_contractURI); | ||
|
|
||
| name = _name; | ||
| symbol = _symbol; | ||
|
|
||
| _setupContractURI(_contractURI); | ||
| _setupOwner(_defaultAdmin); | ||
|
|
||
| _setupRole(DEFAULT_ADMIN_ROLE, _defaultAdmin); | ||
| _setupRole(TRANSFER_ROLE, _defaultAdmin); | ||
| _setupRole(MINTER_ROLE, _defaultAdmin); | ||
| _setupRole(TRANSFER_ROLE, address(0)); | ||
|
|
||
| // note: see `onlyRoleWithSwitch` for ASSET_ROLE behaviour. | ||
| _setupRole(ASSET_ROLE, address(0)); | ||
|
|
||
| _setupDefaultRoyaltyInfo(_royaltyRecipient, _royaltyBps); | ||
| } | ||
|
|
||
| receive() external payable { | ||
| require(_msgSender() == nativeTokenWrapper, "Caller is not native token wrapper."); | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Modifiers | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| modifier onlyRoleWithSwitch(bytes32 role) { | ||
| _checkRoleWithSwitch(role, _msgSender()); | ||
| _; | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Generic contract logic | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /// @dev Returns the type of the contract. | ||
| function contractType() external pure returns (bytes32) { | ||
| return MODULE_TYPE; | ||
| } | ||
|
|
||
| /// @dev Returns the version of the contract. | ||
| function contractVersion() external pure returns (uint8) { | ||
| return uint8(VERSION); | ||
| } | ||
|
|
||
| /// @dev Pauses / unpauses contract. | ||
| function pause(bool _toPause) internal onlyRole(DEFAULT_ADMIN_ROLE) { | ||
| if (_toPause) { | ||
| _pause(); | ||
| } else { | ||
| _unpause(); | ||
| } | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| ERC 165 / 1155 / 2981 logic | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /// @dev Returns the URI for a given tokenId. | ||
| function uri(uint256 _tokenId) public view override returns (string memory) { | ||
| return getUriOfBundle(_tokenId); | ||
| } | ||
|
|
||
| /// @dev See ERC 165 | ||
| function supportsInterface(bytes4 interfaceId) | ||
| public | ||
| view | ||
| virtual | ||
| override(ERC1155Receiver, ERC1155Upgradeable) | ||
| returns (bool) | ||
| { | ||
| return super.supportsInterface(interfaceId) || type(IERC2981Upgradeable).interfaceId == interfaceId; | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Pack logic: create | open packs. | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /// @dev Creates a pack with the stated contents. | ||
| function createPack( | ||
| Token[] calldata _contents, | ||
| uint256[] calldata _numOfRewardUnits, | ||
| string calldata _packUri, | ||
| uint128 _openStartTimestamp, | ||
| uint128 _amountDistributedPerOpen, | ||
| address _recipient | ||
| ) | ||
| external | ||
| payable | ||
| onlyRoleWithSwitch(MINTER_ROLE) | ||
| nonReentrant | ||
| whenNotPaused | ||
| returns (uint256 packId, uint256 packTotalSupply) | ||
| { | ||
| require(_contents.length > 0, "nothing to pack"); | ||
| require(_contents.length == _numOfRewardUnits.length, "invalid reward units"); | ||
|
|
||
| if (!hasRole(ASSET_ROLE, address(0))) { | ||
| for (uint256 i = 0; i < _contents.length; i += 1) { | ||
| _checkRole(ASSET_ROLE, _contents[i].assetContract); | ||
| } | ||
| } | ||
|
|
||
| packId = nextTokenIdToMint; | ||
| nextTokenIdToMint += 1; | ||
|
|
||
| packTotalSupply = escrowPackContents(_contents, _numOfRewardUnits, _packUri, packId, _amountDistributedPerOpen); | ||
|
|
||
| packInfo[packId].openStartTimestamp = _openStartTimestamp; | ||
| packInfo[packId].amountDistributedPerOpen = _amountDistributedPerOpen; | ||
|
|
||
| _mint(_recipient, packId, packTotalSupply, ""); | ||
|
|
||
| emit PackCreated(packId, _msgSender(), _recipient, packTotalSupply); | ||
| } | ||
|
|
||
| /// @notice Lets a pack owner open packs and receive the packs' reward units. | ||
| function openPack(uint256 _packId, uint256 _amountToOpen) | ||
| external | ||
| nonReentrant | ||
| whenNotPaused | ||
| returns (Token[] memory) | ||
| { | ||
| address opener = _msgSender(); | ||
|
|
||
| require(opener == tx.origin, "opener must be eoa"); | ||
| require(balanceOf(opener, _packId) >= _amountToOpen, "opening more than owned"); | ||
|
|
||
| PackInfo memory pack = packInfo[_packId]; | ||
| require(pack.openStartTimestamp < block.timestamp, "cannot open yet"); | ||
|
|
||
| Token[] memory rewardUnits = getRewardUnits(_packId, _amountToOpen, pack.amountDistributedPerOpen, pack); | ||
|
|
||
| _burn(_msgSender(), _packId, _amountToOpen); | ||
|
|
||
| _transferTokenBatch(address(this), _msgSender(), rewardUnits); | ||
|
|
||
| emit PackOpened(_packId, _msgSender(), _amountToOpen, rewardUnits); | ||
|
|
||
| return rewardUnits; | ||
| } | ||
|
|
||
| function escrowPackContents( | ||
| Token[] calldata _contents, | ||
| uint256[] calldata _numOfRewardUnits, | ||
| string calldata _packUri, | ||
| uint256 packId, | ||
| uint256 amountPerOpen | ||
| ) internal returns (uint256 packTotalSupply) { | ||
| uint256 totalRewardUnits; | ||
|
|
||
| for (uint256 i = 0; i < _contents.length; i += 1) { | ||
| require(_contents[i].totalAmount % _numOfRewardUnits[i] == 0, "invalid reward units"); | ||
| require( | ||
| _contents[i].tokenType != TokenType.ERC721 || _contents[i].totalAmount == 1, | ||
| "invalid erc721 rewards" | ||
| ); | ||
|
|
||
| totalRewardUnits += _numOfRewardUnits[i]; | ||
|
|
||
| packInfo[packId].perUnitAmounts.push(_contents[i].totalAmount / _numOfRewardUnits[i]); | ||
| } | ||
|
|
||
| require(totalRewardUnits % amountPerOpen == 0, "invalid amount to distribute per open"); | ||
| packTotalSupply = totalRewardUnits / amountPerOpen; | ||
|
|
||
| _storeTokens(_msgSender(), _contents, _packUri, packId); | ||
| } | ||
|
|
||
| /// @dev Returns the reward units to distribute. | ||
| function getRewardUnits( | ||
| uint256 _packId, | ||
| uint256 _numOfPacksToOpen, | ||
| uint256 _rewardUnitsPerOpen, | ||
| PackInfo memory pack | ||
| ) internal returns (Token[] memory rewardUnits) { | ||
| uint256 numOfRewardUnitsToDistribute = _numOfPacksToOpen * _rewardUnitsPerOpen; | ||
| rewardUnits = new Token[](numOfRewardUnitsToDistribute); | ||
|
|
||
| uint256 totalRewardUnits = totalSupply[_packId] * _rewardUnitsPerOpen; | ||
| uint256 totalRewardKinds = getTokenCountOfBundle(_packId); | ||
|
|
||
| uint256 random = generateRandomValue(); | ||
|
|
||
| for (uint256 i = 0; i < numOfRewardUnitsToDistribute; i += 1) { | ||
| uint256 randomVal = uint256(keccak256(abi.encode(random, i))); | ||
| uint256 target = randomVal % totalRewardUnits; | ||
| uint256 step; | ||
|
|
||
| for (uint256 j = 0; j < totalRewardKinds; j += 1) { | ||
| uint256 id = _packId; | ||
|
|
||
| Token memory _token = getTokenOfBundle(id, j); | ||
| uint256 totalRewardUnitsOfKind = _token.totalAmount / pack.perUnitAmounts[j]; | ||
|
|
||
| if (target < step + totalRewardUnitsOfKind) { | ||
| _token.totalAmount -= pack.perUnitAmounts[j]; | ||
| _updateTokenInBundle(_token, id, j); | ||
| rewardUnits[i] = _token; | ||
| rewardUnits[i].totalAmount = pack.perUnitAmounts[j]; | ||
|
|
||
| totalRewardUnits -= 1; | ||
|
|
||
| break; | ||
| } else { | ||
| step += totalRewardUnitsOfKind; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Getter functions | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /// @dev Returns the underlying contents of a pack. | ||
| function getPackContents(uint256 _packId) | ||
| external | ||
| view | ||
| returns (Token[] memory contents, uint256[] memory perUnitAmounts) | ||
| { | ||
| PackInfo memory pack = packInfo[_packId]; | ||
| uint256 total = getTokenCountOfBundle(_packId); | ||
| contents = new Token[](total); | ||
| perUnitAmounts = new uint256[](total); | ||
|
|
||
| for (uint256 i = 0; i < total; i += 1) { | ||
| contents[i] = getTokenOfBundle(_packId, i); | ||
| perUnitAmounts[i] = pack.perUnitAmounts[i]; | ||
| } | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Internal functions | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /// @dev Returns whether owner can be set in the given execution context. | ||
| function _canSetOwner() internal view override returns (bool) { | ||
| return hasRole(DEFAULT_ADMIN_ROLE, _msgSender()); | ||
| } | ||
|
|
||
| /// @dev Returns whether royalty info can be set in the given execution context. | ||
| function _canSetRoyaltyInfo() internal view override returns (bool) { | ||
| return hasRole(DEFAULT_ADMIN_ROLE, _msgSender()); | ||
| } | ||
|
|
||
| /// @dev Returns whether contract metadata can be set in the given execution context. | ||
| function _canSetContractURI() internal view override returns (bool) { | ||
| return hasRole(DEFAULT_ADMIN_ROLE, _msgSender()); | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| Miscellaneous | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| function generateRandomValue() internal view returns (uint256 random) { | ||
| random = uint256(keccak256(abi.encodePacked(_msgSender(), blockhash(block.number - 1), block.difficulty))); | ||
| } | ||
|
|
||
| /** | ||
| * @dev See {ERC1155-_beforeTokenTransfer}. | ||
| */ | ||
| function _beforeTokenTransfer( | ||
| address operator, | ||
| address from, | ||
| address to, | ||
| uint256[] memory ids, | ||
| uint256[] memory amounts, | ||
| bytes memory data | ||
| ) internal virtual override { | ||
| super._beforeTokenTransfer(operator, from, to, ids, amounts, data); | ||
|
|
||
| // if transfer is restricted on the contract, we still want to allow burning and minting | ||
| if (!hasRole(TRANSFER_ROLE, address(0)) && from != address(0) && to != address(0)) { | ||
| require(hasRole(TRANSFER_ROLE, from) || hasRole(TRANSFER_ROLE, to), "restricted to TRANSFER_ROLE holders."); | ||
| } | ||
|
|
||
| if (from == address(0)) { | ||
| for (uint256 i = 0; i < ids.length; ++i) { | ||
| totalSupply[ids[i]] += amounts[i]; | ||
| } | ||
| } | ||
|
|
||
| if (to == address(0)) { | ||
| for (uint256 i = 0; i < ids.length; ++i) { | ||
| totalSupply[ids[i]] -= amounts[i]; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// @dev See EIP-2771 | ||
| function _msgSender() | ||
| internal | ||
| view | ||
| virtual | ||
| override(ContextUpgradeable, ERC2771ContextUpgradeable) | ||
| returns (address sender) | ||
| { | ||
| return ERC2771ContextUpgradeable._msgSender(); | ||
| } | ||
|
|
||
| /// @dev See EIP-2771 | ||
| function _msgData() | ||
| internal | ||
| view | ||
| virtual | ||
| override(ContextUpgradeable, ERC2771ContextUpgradeable) | ||
| returns (bytes calldata) | ||
| { | ||
| return ERC2771ContextUpgradeable._msgData(); | ||
| } | ||
| } |
Check warning
Code scanning / Slither
Missing inheritance
|
|
||
| contract TokenStore is TokenBundle, ERC721Holder, ERC1155Holder { | ||
| /// @dev The address interpreted as native token of the chain. | ||
| address public constant NATIVE_TOKEN = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; |
Check warning
Code scanning / Slither
Variable names too similar
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.