Skip to content
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.

Sign up for GitHub

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

Refactor ERC721 to use _update pattern #4419

Closed
wants to merge 8 commits into from
Closed

Refactor ERC721 to use _update pattern #4419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c9f7bb
Refactor ERC721 to use _update pattern
frangio Jul 4, 2023
930ee64
Update contracts/token/ERC721/ERC721.sol
frangio Jul 7, 2023
14ffe4d
Apply suggestions
ernestognw Jul 7, 2023
63717fc
Rename updateBalance to increaseBalance
ernestognw Jul 7, 2023
5f05fc9
Fix tests (omg hopefully)
ernestognw Jul 7, 2023
38c0bf0
Add changeset
ernestognw Jul 7, 2023
ca05bc5
Use _increaseBalance in _update
ernestognw Jul 7, 2023
cdacda1
Rollback _increaseBalance in _update
ernestognw Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/bright-tomatoes-sing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'openzeppelin-solidity': major
---

`ERC20`, `ERC1155`: Deleted `_beforeTokenTransfer` and `_afterTokenTransfer` hooks, added a new internal `_update` function for customizations, and refactored all extensions using those hooks to use `_update` instead. ([#3838](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3838), [#3876](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3876))
`ERC20`, `ERC721`, `ERC1155`: Deleted `_beforeTokenTransfer` and `_afterTokenTransfer` hooks, added a new internal `_update` function for customizations, and refactored all extensions using those hooks to use `_update` instead. ([#3838](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3838), [#4419](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4419), [#3876](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3876))
6 changes: 3 additions & 3 deletions contracts/interfaces/draft-IERC6093.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ interface IERC721Errors {

/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param claimedOwner Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
* @param actualOwner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
error ERC721IncorrectOwner(address claimedOwner, uint256 tokenId, address actualOwner);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this change also be needed in the EIP itself? I'm worried there's a table with definitions there that might need updating.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly. I made this change because I found the existing names confusing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see how the existing names are confusing, but I'd look for a way in which the naming makes sense for all errors. Would it be clear if we rename sender completely to from?


/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
Expand Down
22 changes: 6 additions & 16 deletions contracts/mocks/token/ERC721ConsecutiveEnumerableMock.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,25 +28,15 @@ contract ERC721ConsecutiveEnumerableMock is ERC721Consecutive, ERC721Enumerable
return super._ownerOf(tokenId);
}

function _mint(address to, uint256 tokenId) internal virtual override(ERC721, ERC721Consecutive) {
super._mint(to, tokenId);
}

function _beforeTokenTransfer(
function _update(
address from,
address to,
uint256 firstTokenId,
uint256 batchSize
) internal virtual override(ERC721, ERC721Enumerable) {
super._beforeTokenTransfer(from, to, firstTokenId, batchSize);
uint256 tokenId
) internal virtual override(ERC721Consecutive, ERC721Enumerable) {
super._update(from, to, tokenId);
}

function _afterTokenTransfer(
address from,
address to,
uint256 firstTokenId,
uint256 batchSize
) internal virtual override(ERC721, ERC721Consecutive) {
super._afterTokenTransfer(from, to, firstTokenId, batchSize);
function _increaseBalance(address account, uint128 value) internal virtual override(ERC721, ERC721Enumerable) {
super._increaseBalance(account, value);
}
}
22 changes: 6 additions & 16 deletions contracts/mocks/token/ERC721ConsecutiveMock.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,16 @@ contract ERC721ConsecutiveMock is ERC721Consecutive, ERC721Pausable, ERC721Votes
return super._ownerOf(tokenId);
}

function _mint(address to, uint256 tokenId) internal virtual override(ERC721, ERC721Consecutive) {
super._mint(to, tokenId);
}

function _beforeTokenTransfer(
function _update(
address from,
address to,
uint256 firstTokenId,
uint256 batchSize
) internal virtual override(ERC721, ERC721Pausable) {
super._beforeTokenTransfer(from, to, firstTokenId, batchSize);
uint256 tokenId
) internal virtual override(ERC721Consecutive, ERC721Pausable, ERC721Votes) {
super._update(from, to, tokenId);
}

function _afterTokenTransfer(
address from,
address to,
uint256 firstTokenId,
uint256 batchSize
) internal virtual override(ERC721, ERC721Votes, ERC721Consecutive) {
super._afterTokenTransfer(from, to, firstTokenId, batchSize);
function _increaseBalance(address account, uint128 value) internal virtual override(ERC721, ERC721Votes) {
super._increaseBalance(account, value);
}
}

Expand Down
Loading