-
Notifications
You must be signed in to change notification settings - Fork 12.2k
Implement ERC721 standard #627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
facuspagnuolo
merged 8 commits into
OpenZeppelin:master
from
facuspagnuolo:feature/implement_erc721_standard
Jan 23, 2018
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5fc5ded
Provide ERC721 required functionality interface
facuspagnuolo b09d7aa
Implement ERC721 required functionality
facuspagnuolo 5b50e99
ERC721 required functionality tests
facuspagnuolo af33704
Fix solint errors
facuspagnuolo 23afc74
Address feedback comments for ERC721
facuspagnuolo 4859489
Merge branch 'master' into feature/implement_erc721_standard
facuspagnuolo 4be30dc
Merge branch 'master' into feature/implement_erc721_standard
facuspagnuolo e1d32ac
Merge branch 'master' into feature/implement_erc721_standard
facuspagnuolo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
pragma solidity ^0.4.18; | ||
|
||
import "../token/ERC721Token.sol"; | ||
|
||
/** | ||
* @title ERC721TokenMock | ||
* This mock just provides a public mint and burn functions for testing purposes. | ||
*/ | ||
contract ERC721TokenMock is ERC721Token { | ||
function ERC721TokenMock() ERC721Token() public { } | ||
|
||
function mint(address _to, uint256 _tokenId) public { | ||
super._mint(_to, _tokenId); | ||
} | ||
|
||
function burn(uint256 _tokenId) public { | ||
super._burn(_tokenId); | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
pragma solidity ^0.4.18; | ||
|
||
/** | ||
* @title ERC721 interface | ||
* @dev see https://github.com/ethereum/eips/issues/721 | ||
*/ | ||
contract ERC721 { | ||
event Transfer(address indexed _from, address indexed _to, uint256 _tokenId); | ||
event Approval(address indexed _owner, address indexed _approved, uint256 _tokenId); | ||
|
||
function balanceOf(address _owner) public view returns (uint256 _balance); | ||
function ownerOf(uint256 _tokenId) public view returns (address _owner); | ||
function transfer(address _to, uint256 _tokenId) public; | ||
function approve(address _to, uint256 _tokenId) public; | ||
function takeOwnership(uint256 _tokenId) public; | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,214 @@ | ||
pragma solidity ^0.4.18; | ||
|
||
import "./ERC721.sol"; | ||
import "../math/SafeMath.sol"; | ||
|
||
/** | ||
* @title ERC721Token | ||
* Generic implementation for the required functionality of the ERC721 standard | ||
*/ | ||
contract ERC721Token is ERC721 { | ||
using SafeMath for uint256; | ||
|
||
// Total amount of tokens | ||
uint256 private totalTokens; | ||
|
||
// Mapping from token ID to owner | ||
mapping (uint256 => address) private tokenOwner; | ||
|
||
// Mapping from token ID to approved address | ||
mapping (uint256 => address) private tokenApprovals; | ||
|
||
// Mapping from owner to list of owned token IDs | ||
mapping (address => uint256[]) private ownedTokens; | ||
|
||
// Mapping from token ID to index of the owner tokens list | ||
mapping(uint256 => uint256) private ownedTokensIndex; | ||
|
||
/** | ||
* @dev Guarantees msg.sender is owner of the given token | ||
* @param _tokenId uint256 ID of the token to validate its ownership belongs to msg.sender | ||
*/ | ||
modifier onlyOwnerOf(uint256 _tokenId) { | ||
require(ownerOf(_tokenId) == msg.sender); | ||
_; | ||
} | ||
|
||
/** | ||
* @dev Gets the total amount of tokens stored by the contract | ||
* @return uint256 representing the total amount of tokens | ||
*/ | ||
function totalSupply() public view returns (uint256) { | ||
return totalTokens; | ||
} | ||
|
||
/** | ||
* @dev Gets the balance of the specified address | ||
* @param _owner address to query the balance of | ||
* @return uint256 representing the amount owned by the passed address | ||
*/ | ||
function balanceOf(address _owner) public view returns (uint256) { | ||
return ownedTokens[_owner].length; | ||
} | ||
|
||
/** | ||
* @dev Gets the list of tokens owned by a given address | ||
* @param _owner address to query the tokens of | ||
* @return uint256[] representing the list of tokens owned by the passed address | ||
*/ | ||
function tokensOf(address _owner) public view returns (uint256[]) { | ||
return ownedTokens[_owner]; | ||
} | ||
|
||
/** | ||
* @dev Gets the owner of the specified token ID | ||
* @param _tokenId uint256 ID of the token to query the owner of | ||
* @return owner address currently marked as the owner of the given token ID | ||
*/ | ||
function ownerOf(uint256 _tokenId) public view returns (address) { | ||
address owner = tokenOwner[_tokenId]; | ||
require(owner != address(0)); | ||
return owner; | ||
} | ||
|
||
/** | ||
* @dev Gets the approved address to take ownership of a given token ID | ||
* @param _tokenId uint256 ID of the token to query the approval of | ||
* @return address currently approved to take ownership of the given token ID | ||
*/ | ||
function approvedFor(uint256 _tokenId) public view returns (address) { | ||
return tokenApprovals[_tokenId]; | ||
} | ||
|
||
/** | ||
* @dev Transfers the ownership of a given token ID to another address | ||
* @param _to address to receive the ownership of the given token ID | ||
* @param _tokenId uint256 ID of the token to be transferred | ||
*/ | ||
function transfer(address _to, uint256 _tokenId) public onlyOwnerOf(_tokenId) { | ||
clearApprovalAndTransfer(msg.sender, _to, _tokenId); | ||
} | ||
|
||
/** | ||
* @dev Approves another address to claim for the ownership of the given token ID | ||
* @param _to address to be approved for the given token ID | ||
* @param _tokenId uint256 ID of the token to be approved | ||
*/ | ||
function approve(address _to, uint256 _tokenId) public onlyOwnerOf(_tokenId) { | ||
address owner = ownerOf(_tokenId); | ||
require(_to != owner); | ||
if (approvedFor(_tokenId) != 0 || _to != 0) { | ||
tokenApprovals[_tokenId] = _to; | ||
Approval(owner, _to, _tokenId); | ||
} | ||
} | ||
|
||
/** | ||
* @dev Claims the ownership of a given token ID | ||
* @param _tokenId uint256 ID of the token being claimed by the msg.sender | ||
*/ | ||
function takeOwnership(uint256 _tokenId) public { | ||
require(isApprovedFor(msg.sender, _tokenId)); | ||
clearApprovalAndTransfer(ownerOf(_tokenId), msg.sender, _tokenId); | ||
} | ||
|
||
/** | ||
* @dev Mint token function | ||
* @param _to The address that will own the minted token | ||
* @param _tokenId uint256 ID of the token to be minted by the msg.sender | ||
*/ | ||
function _mint(address _to, uint256 _tokenId) internal { | ||
require(_to != address(0)); | ||
addToken(_to, _tokenId); | ||
Transfer(0x0, _to, _tokenId); | ||
} | ||
|
||
/** | ||
* @dev Burns a specific token | ||
* @param _tokenId uint256 ID of the token being burned by the msg.sender | ||
*/ | ||
function _burn(uint256 _tokenId) onlyOwnerOf(_tokenId) internal { | ||
if (approvedFor(_tokenId) != 0) { | ||
clearApproval(msg.sender, _tokenId); | ||
} | ||
removeToken(msg.sender, _tokenId); | ||
Transfer(msg.sender, 0x0, _tokenId); | ||
} | ||
|
||
/** | ||
* @dev Tells whether the msg.sender is approved for the given token ID or not | ||
* This function is not private so it can be extended in further implementations like the operatable ERC721 | ||
* @param _owner address of the owner to query the approval of | ||
* @param _tokenId uint256 ID of the token to query the approval of | ||
* @return bool whether the msg.sender is approved for the given token ID or not | ||
*/ | ||
function isApprovedFor(address _owner, uint256 _tokenId) internal view returns (bool) { | ||
return approvedFor(_tokenId) == _owner; | ||
} | ||
|
||
/** | ||
* @dev Internal function to clear current approval and transfer the ownership of a given token ID | ||
* @param _from address which you want to send tokens from | ||
* @param _to address which you want to transfer the token to | ||
* @param _tokenId uint256 ID of the token to be transferred | ||
*/ | ||
function clearApprovalAndTransfer(address _from, address _to, uint256 _tokenId) internal { | ||
require(_to != address(0)); | ||
require(_to != ownerOf(_tokenId)); | ||
require(ownerOf(_tokenId) == _from); | ||
|
||
clearApproval(_from, _tokenId); | ||
removeToken(_from, _tokenId); | ||
addToken(_to, _tokenId); | ||
Transfer(_from, _to, _tokenId); | ||
} | ||
|
||
/** | ||
* @dev Internal function to clear current approval of a given token ID | ||
* @param _tokenId uint256 ID of the token to be transferred | ||
*/ | ||
function clearApproval(address _owner, uint256 _tokenId) private { | ||
require(ownerOf(_tokenId) == _owner); | ||
tokenApprovals[_tokenId] = 0; | ||
Approval(_owner, 0, _tokenId); | ||
} | ||
|
||
/** | ||
* @dev Internal function to add a token ID to the list of a given address | ||
* @param _to address representing the new owner of the given token ID | ||
* @param _tokenId uint256 ID of the token to be added to the tokens list of the given address | ||
*/ | ||
function addToken(address _to, uint256 _tokenId) private { | ||
require(tokenOwner[_tokenId] == address(0)); | ||
tokenOwner[_tokenId] = _to; | ||
uint256 length = balanceOf(_to); | ||
ownedTokens[_to].push(_tokenId); | ||
ownedTokensIndex[_tokenId] = length; | ||
totalTokens = totalTokens.add(1); | ||
} | ||
|
||
/** | ||
* @dev Internal function to remove a token ID from the list of a given address | ||
* @param _from address representing the previous owner of the given token ID | ||
* @param _tokenId uint256 ID of the token to be removed from the tokens list of the given address | ||
*/ | ||
function removeToken(address _from, uint256 _tokenId) private { | ||
require(ownerOf(_tokenId) == _from); | ||
|
||
uint256 tokenIndex = ownedTokensIndex[_tokenId]; | ||
uint256 lastTokenIndex = balanceOf(_from).sub(1); | ||
uint256 lastToken = ownedTokens[_from][lastTokenIndex]; | ||
|
||
tokenOwner[_tokenId] = 0; | ||
ownedTokens[_from][tokenIndex] = lastToken; | ||
ownedTokens[_from][lastTokenIndex] = 0; | ||
// Note that this will handle single-element arrays. In that case, both tokenIndex and lastTokenIndex are going to | ||
// be zero. Then we can make sure that we will remove _tokenId from the ownedTokens list since we are first swapping | ||
// the lastToken to the first position, and then dropping the element placed in the last position of the list | ||
|
||
ownedTokens[_from].length--; | ||
ownedTokensIndex[_tokenId] = 0; | ||
ownedTokensIndex[lastToken] = tokenIndex; | ||
totalTokens = totalTokens.sub(1); | ||
} | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since it's kind of magical that the algorithm works when there is only one item in the list, what do you think about adding a brief note explaining it?
In particular, it feels worthy of mention that the order of lines 193 and 194 is important, because if
_tokenId
is the only item in the list, in this way it is properly deleted from storage.