ERC721.sol 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. pragma solidity ^0.5.2;
  2. import "./IERC721.sol";
  3. import "./IERC721Receiver.sol";
  4. import "../../math/SafeMath.sol";
  5. import "../../utils/Address.sol";
  6. import "../../drafts/Counters.sol";
  7. import "../../introspection/ERC165.sol";
  8. /**
  9. * @title ERC721 Non-Fungible Token Standard basic implementation
  10. * @dev see https://eips.ethereum.org/EIPS/eip-721
  11. */
  12. contract ERC721 is ERC165, IERC721 {
  13. using SafeMath for uint256;
  14. using Address for address;
  15. using Counters for Counters.Counter;
  16. // Equals to `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`
  17. // which can be also obtained as `IERC721Receiver(0).onERC721Received.selector`
  18. bytes4 private constant _ERC721_RECEIVED = 0x150b7a02;
  19. // Mapping from token ID to owner
  20. mapping (uint256 => address) private _tokenOwner;
  21. // Mapping from token ID to approved address
  22. mapping (uint256 => address) private _tokenApprovals;
  23. // Mapping from owner to number of owned token
  24. mapping (address => Counters.Counter) private _ownedTokensCount;
  25. // Mapping from owner to operator approvals
  26. mapping (address => mapping (address => bool)) private _operatorApprovals;
  27. /*
  28. * bytes4(keccak256('balanceOf(address)')) == 0x70a08231
  29. * bytes4(keccak256('ownerOf(uint256)')) == 0x6352211e
  30. * bytes4(keccak256('approve(address,uint256)')) == 0x095ea7b3
  31. * bytes4(keccak256('getApproved(uint256)')) == 0x081812fc
  32. * bytes4(keccak256('setApprovalForAll(address,bool)')) == 0xa22cb465
  33. * bytes4(keccak256('isApprovedForAll(address,address)')) == 0xe985e9c
  34. * bytes4(keccak256('transferFrom(address,address,uint256)')) == 0x23b872dd
  35. * bytes4(keccak256('safeTransferFrom(address,address,uint256)')) == 0x42842e0e
  36. * bytes4(keccak256('safeTransferFrom(address,address,uint256,bytes)')) == 0xb88d4fde
  37. *
  38. * => 0x70a08231 ^ 0x6352211e ^ 0x095ea7b3 ^ 0x081812fc ^
  39. * 0xa22cb465 ^ 0xe985e9c ^ 0x23b872dd ^ 0x42842e0e ^ 0xb88d4fde == 0x80ac58cd
  40. */
  41. bytes4 private constant _INTERFACE_ID_ERC721 = 0x80ac58cd;
  42. constructor () public {
  43. // register the supported interfaces to conform to ERC721 via ERC165
  44. _registerInterface(_INTERFACE_ID_ERC721);
  45. }
  46. /**
  47. * @dev Gets the balance of the specified address.
  48. * @param owner address to query the balance of
  49. * @return uint256 representing the amount owned by the passed address
  50. */
  51. function balanceOf(address owner) public view returns (uint256) {
  52. require(owner != address(0));
  53. return _ownedTokensCount[owner].current();
  54. }
  55. /**
  56. * @dev Gets the owner of the specified token ID.
  57. * @param tokenId uint256 ID of the token to query the owner of
  58. * @return address currently marked as the owner of the given token ID
  59. */
  60. function ownerOf(uint256 tokenId) public view returns (address) {
  61. address owner = _tokenOwner[tokenId];
  62. require(owner != address(0));
  63. return owner;
  64. }
  65. /**
  66. * @dev Approves another address to transfer the given token ID
  67. * The zero address indicates there is no approved address.
  68. * There can only be one approved address per token at a given time.
  69. * Can only be called by the token owner or an approved operator.
  70. * @param to address to be approved for the given token ID
  71. * @param tokenId uint256 ID of the token to be approved
  72. */
  73. function approve(address to, uint256 tokenId) public {
  74. address owner = ownerOf(tokenId);
  75. require(to != owner);
  76. require(msg.sender == owner || isApprovedForAll(owner, msg.sender));
  77. _tokenApprovals[tokenId] = to;
  78. emit Approval(owner, to, tokenId);
  79. }
  80. /**
  81. * @dev Gets the approved address for a token ID, or zero if no address set
  82. * Reverts if the token ID does not exist.
  83. * @param tokenId uint256 ID of the token to query the approval of
  84. * @return address currently approved for the given token ID
  85. */
  86. function getApproved(uint256 tokenId) public view returns (address) {
  87. require(_exists(tokenId));
  88. return _tokenApprovals[tokenId];
  89. }
  90. /**
  91. * @dev Sets or unsets the approval of a given operator
  92. * An operator is allowed to transfer all tokens of the sender on their behalf.
  93. * @param to operator address to set the approval
  94. * @param approved representing the status of the approval to be set
  95. */
  96. function setApprovalForAll(address to, bool approved) public {
  97. require(to != msg.sender);
  98. _operatorApprovals[msg.sender][to] = approved;
  99. emit ApprovalForAll(msg.sender, to, approved);
  100. }
  101. /**
  102. * @dev Tells whether an operator is approved by a given owner.
  103. * @param owner owner address which you want to query the approval of
  104. * @param operator operator address which you want to query the approval of
  105. * @return bool whether the given operator is approved by the given owner
  106. */
  107. function isApprovedForAll(address owner, address operator) public view returns (bool) {
  108. return _operatorApprovals[owner][operator];
  109. }
  110. /**
  111. * @dev Transfers the ownership of a given token ID to another address.
  112. * Usage of this method is discouraged, use `safeTransferFrom` whenever possible.
  113. * Requires the msg.sender to be the owner, approved, or operator.
  114. * @param from current owner of the token
  115. * @param to address to receive the ownership of the given token ID
  116. * @param tokenId uint256 ID of the token to be transferred
  117. */
  118. function transferFrom(address from, address to, uint256 tokenId) public {
  119. require(_isApprovedOrOwner(msg.sender, tokenId));
  120. _transferFrom(from, to, tokenId);
  121. }
  122. /**
  123. * @dev Safely transfers the ownership of a given token ID to another address
  124. * If the target address is a contract, it must implement `onERC721Received`,
  125. * which is called upon a safe transfer, and return the magic value
  126. * `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`; otherwise,
  127. * the transfer is reverted.
  128. * Requires the msg.sender to be the owner, approved, or operator
  129. * @param from current owner of the token
  130. * @param to address to receive the ownership of the given token ID
  131. * @param tokenId uint256 ID of the token to be transferred
  132. */
  133. function safeTransferFrom(address from, address to, uint256 tokenId) public {
  134. safeTransferFrom(from, to, tokenId, "");
  135. }
  136. /**
  137. * @dev Safely transfers the ownership of a given token ID to another address
  138. * If the target address is a contract, it must implement `onERC721Received`,
  139. * which is called upon a safe transfer, and return the magic value
  140. * `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`; otherwise,
  141. * the transfer is reverted.
  142. * Requires the msg.sender to be the owner, approved, or operator
  143. * @param from current owner of the token
  144. * @param to address to receive the ownership of the given token ID
  145. * @param tokenId uint256 ID of the token to be transferred
  146. * @param _data bytes data to send along with a safe transfer check
  147. */
  148. function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory _data) public {
  149. transferFrom(from, to, tokenId);
  150. require(_checkOnERC721Received(from, to, tokenId, _data));
  151. }
  152. /**
  153. * @dev Returns whether the specified token exists.
  154. * @param tokenId uint256 ID of the token to query the existence of
  155. * @return bool whether the token exists
  156. */
  157. function _exists(uint256 tokenId) internal view returns (bool) {
  158. address owner = _tokenOwner[tokenId];
  159. return owner != address(0);
  160. }
  161. /**
  162. * @dev Returns whether the given spender can transfer a given token ID.
  163. * @param spender address of the spender to query
  164. * @param tokenId uint256 ID of the token to be transferred
  165. * @return bool whether the msg.sender is approved for the given token ID,
  166. * is an operator of the owner, or is the owner of the token
  167. */
  168. function _isApprovedOrOwner(address spender, uint256 tokenId) internal view returns (bool) {
  169. address owner = ownerOf(tokenId);
  170. return (spender == owner || getApproved(tokenId) == spender || isApprovedForAll(owner, spender));
  171. }
  172. /**
  173. * @dev Internal function to mint a new token.
  174. * Reverts if the given token ID already exists.
  175. * @param to The address that will own the minted token
  176. * @param tokenId uint256 ID of the token to be minted
  177. */
  178. function _mint(address to, uint256 tokenId) internal {
  179. require(to != address(0));
  180. require(!_exists(tokenId));
  181. _tokenOwner[tokenId] = to;
  182. _ownedTokensCount[to].increment();
  183. emit Transfer(address(0), to, tokenId);
  184. }
  185. /**
  186. * @dev Internal function to burn a specific token.
  187. * Reverts if the token does not exist.
  188. * Deprecated, use _burn(uint256) instead.
  189. * @param owner owner of the token to burn
  190. * @param tokenId uint256 ID of the token being burned
  191. */
  192. function _burn(address owner, uint256 tokenId) internal {
  193. require(ownerOf(tokenId) == owner);
  194. _clearApproval(tokenId);
  195. _ownedTokensCount[owner].decrement();
  196. _tokenOwner[tokenId] = address(0);
  197. emit Transfer(owner, address(0), tokenId);
  198. }
  199. /**
  200. * @dev Internal function to burn a specific token.
  201. * Reverts if the token does not exist.
  202. * @param tokenId uint256 ID of the token being burned
  203. */
  204. function _burn(uint256 tokenId) internal {
  205. _burn(ownerOf(tokenId), tokenId);
  206. }
  207. /**
  208. * @dev Internal function to transfer ownership of a given token ID to another address.
  209. * As opposed to transferFrom, this imposes no restrictions on msg.sender.
  210. * @param from current owner of the token
  211. * @param to address to receive the ownership of the given token ID
  212. * @param tokenId uint256 ID of the token to be transferred
  213. */
  214. function _transferFrom(address from, address to, uint256 tokenId) internal {
  215. require(ownerOf(tokenId) == from);
  216. require(to != address(0));
  217. _clearApproval(tokenId);
  218. _ownedTokensCount[from].decrement();
  219. _ownedTokensCount[to].increment();
  220. _tokenOwner[tokenId] = to;
  221. emit Transfer(from, to, tokenId);
  222. }
  223. /**
  224. * @dev Internal function to invoke `onERC721Received` on a target address.
  225. * The call is not executed if the target address is not a contract.
  226. * @param from address representing the previous owner of the given token ID
  227. * @param to target address that will receive the tokens
  228. * @param tokenId uint256 ID of the token to be transferred
  229. * @param _data bytes optional data to send along with the call
  230. * @return bool whether the call correctly returned the expected magic value
  231. */
  232. function _checkOnERC721Received(address from, address to, uint256 tokenId, bytes memory _data)
  233. internal returns (bool)
  234. {
  235. if (!to.isContract()) {
  236. return true;
  237. }
  238. bytes4 retval = IERC721Receiver(to).onERC721Received(msg.sender, from, tokenId, _data);
  239. return (retval == _ERC721_RECEIVED);
  240. }
  241. /**
  242. * @dev Private function to clear current approval of a given token ID.
  243. * @param tokenId uint256 ID of the token to be transferred
  244. */
  245. function _clearApproval(uint256 tokenId) private {
  246. if (_tokenApprovals[tokenId] != address(0)) {
  247. _tokenApprovals[tokenId] = address(0);
  248. }
  249. }
  250. }