-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: ownable document store base
(cherry picked from commit e6c3430de59ff5addf4c6f8929f795328ffe8678)
- Loading branch information
Showing
2 changed files
with
165 additions
and
158 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| pragma solidity >=0.8.23 <0.9.0; | ||
|
|
||
| import "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol"; | ||
| import {Strings} from "@openzeppelin/contracts/utils/Strings.sol"; | ||
|
|
||
| import "../base/DocumentStoreAccessControl.sol"; | ||
| import "../interfaces/IOwnableDocumentStore.sol"; | ||
| import "../interfaces/IOwnableDocumentStoreErrors.sol"; | ||
| import "../interfaces/IERC5192.sol"; | ||
|
|
||
| abstract contract BaseOwnableDocumentStore is | ||
| DocumentStoreAccessControl, | ||
| ERC721Upgradeable, | ||
| IERC5192, | ||
| IOwnableDocumentStoreErrors, | ||
| IOwnableDocumentStore | ||
| { | ||
| using Strings for uint256; | ||
|
|
||
| /// @custom:storage-location erc7201:openattestation.storage.OwnableDocumentStore | ||
| struct DocumentStoreStorage { | ||
| string baseURI; | ||
| mapping(uint256 => bool) revoked; | ||
| mapping(uint256 => bool) locked; | ||
| } | ||
|
|
||
| // keccak256(abi.encode(uint256(keccak256("openattestation.storage.OwnableDocumentStore")) - 1)) & ~bytes32(uint256(0xff)) | ||
| bytes32 private constant _DocumentStoreStorageSlot = | ||
| 0x5b868bb5de5c3e5f8f786d02cbc568987b1921539a10331babbe7311c24de500; | ||
|
|
||
| function __OwnableDocumentStore_init( | ||
| string memory name_, | ||
| string memory symbol_, | ||
| address initAdmin | ||
| ) internal onlyInitializing { | ||
| __ERC721_init(name_, symbol_); | ||
| __DocumentStoreAccessControl_init(initAdmin); | ||
| } | ||
|
|
||
| function name() public view override(IDocumentStore, ERC721Upgradeable) returns (string memory) { | ||
| return super.name(); | ||
| } | ||
|
|
||
| function isActive(bytes32 document) public view nonZeroDocument(document) returns (bool) { | ||
| uint256 tokenId = uint256(document); | ||
| address owner = _ownerOf(tokenId); | ||
| if (owner == address(0) && _isRevoked(tokenId)) { | ||
| return false; | ||
| } | ||
| if (owner != address(0) && !_isRevoked(tokenId)) { | ||
| return true; | ||
| } | ||
| revert ERC721NonexistentToken(tokenId); | ||
| } | ||
|
|
||
| function issue(address to, bytes32 document, bool lock) public nonZeroDocument(document) onlyRole(ISSUER_ROLE) { | ||
| uint256 tokenId = uint256(document); | ||
| if (!_isRevoked(tokenId)) { | ||
| _mint(to, tokenId); | ||
| if (lock) { | ||
| _getStorage().locked[tokenId] = true; | ||
| emit Locked(tokenId); | ||
| } else { | ||
| emit Unlocked(tokenId); | ||
| } | ||
| } else { | ||
| revert DocumentIsRevoked(document); | ||
| } | ||
| } | ||
|
|
||
| function revoke(bytes32 document) public onlyRole(REVOKER_ROLE) { | ||
| uint256 tokenId = uint256(document); | ||
| _burn(tokenId); | ||
| _getStorage().revoked[tokenId] = true; | ||
| } | ||
|
|
||
| function isIssued(bytes32 document) public view nonZeroDocument(document) returns (bool) { | ||
| uint256 tokenId = uint256(document); | ||
| address owner = _ownerOf(tokenId); | ||
| if (owner != address(0) || _isRevoked(tokenId)) { | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| function isRevoked(bytes32 document) public view nonZeroDocument(document) returns (bool) { | ||
| uint256 tokenId = uint256(document); | ||
| address owner = _ownerOf(tokenId); | ||
| if (owner == address(0)) { | ||
| if (_isRevoked(tokenId)) { | ||
| return true; | ||
| } | ||
| revert ERC721NonexistentToken(tokenId); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| function tokenURI(uint256 tokenId) public view override returns (string memory) { | ||
| _requireOwned(tokenId); | ||
|
|
||
| string memory tokenIdHexStr = tokenId.toHexString(); | ||
|
|
||
| string memory baseURI = _baseURI(); | ||
| return bytes(baseURI).length > 0 ? string.concat(baseURI, tokenIdHexStr) : ""; | ||
| } | ||
|
|
||
| function supportsInterface( | ||
| bytes4 interfaceId | ||
| ) public view virtual override(ERC721Upgradeable, AccessControlUpgradeable) returns (bool) { | ||
| return | ||
| interfaceId == type(IDocumentStore).interfaceId || | ||
| interfaceId == type(IOwnableDocumentStore).interfaceId || | ||
| interfaceId == type(IERC5192).interfaceId || | ||
| super.supportsInterface(interfaceId); | ||
| } | ||
|
|
||
| function locked(uint256 tokenId) public view returns (bool) { | ||
| if (tokenId == 0) { | ||
| revert ZeroDocument(); | ||
| } | ||
| return _isLocked(tokenId); | ||
| } | ||
|
|
||
| function setBaseURI(string memory baseURI) public onlyRole(DEFAULT_ADMIN_ROLE) { | ||
| _getStorage().baseURI = baseURI; | ||
| } | ||
|
|
||
| function _isRevoked(uint256 tokenId) internal view returns (bool) { | ||
| return _getStorage().revoked[tokenId]; | ||
| } | ||
|
|
||
| function _isLocked(uint256 tokenId) internal view returns (bool) { | ||
| return _getStorage().locked[tokenId]; | ||
| } | ||
|
|
||
| function _update(address to, uint256 tokenId, address auth) internal virtual override returns (address) { | ||
| address from = super._update(to, tokenId, auth); | ||
| if (_isLocked(tokenId) && (from != address(0) && to != address(0))) { | ||
| revert DocumentLocked(bytes32(tokenId)); | ||
| } | ||
| return from; | ||
| } | ||
|
|
||
| function _baseURI() internal view virtual override returns (string memory) { | ||
| return _getStorage().baseURI; | ||
| } | ||
|
|
||
| function _getStorage() private pure returns (DocumentStoreStorage storage $) { | ||
| assembly { | ||
| $.slot := _DocumentStoreStorageSlot | ||
| } | ||
| } | ||
|
|
||
| modifier nonZeroDocument(bytes32 document) { | ||
| uint256 tokenId = uint256(document); | ||
| if (tokenId == 0) { | ||
| revert ZeroDocument(); | ||
| } | ||
| _; | ||
| } | ||
| } |