From fd6630e327d73cdfeb8660d56768c1697517b44d Mon Sep 17 00:00:00 2001 From: Andrew Fleming Date: Tue, 22 Mar 2022 19:14:39 -0400 Subject: [PATCH] Fix event param in erc20 and erc721 (#226) * fix _from param * replace _from with from_ * update _from in docs --- docs/ERC20.md | 6 ++-- docs/ERC721.md | 28 ++++++++-------- src/openzeppelin/token/erc20/library.cairo | 2 +- .../erc721/ERC721_Mintable_Burnable.cairo | 8 ++--- .../erc721/ERC721_Mintable_Pausable.cairo | 8 ++--- .../token/erc721/interfaces/IERC721.cairo | 4 +-- .../erc721/interfaces/IERC721_Receiver.cairo | 2 +- src/openzeppelin/token/erc721/library.cairo | 32 +++++++++---------- .../token/erc721/utils/ERC721_Holder.cairo | 2 +- .../ERC721_Enumerable_Mintable_Burnable.cairo | 8 ++--- .../token/erc721_enumerable/library.cairo | 26 +++++++-------- tests/mocks/ERC721_SafeMintable_mock.cairo | 8 ++--- 12 files changed, 67 insertions(+), 67 deletions(-) diff --git a/docs/ERC20.md b/docs/ERC20.md index 6c4e58f7d..ac201d738 100644 --- a/docs/ERC20.md +++ b/docs/ERC20.md @@ -313,7 +313,7 @@ success: felt ### Events ```jsx -func Transfer(_from: felt, to: felt, value: Uint256): +func Transfer(from_: felt, to: felt, value: Uint256): end func Approval(owner: felt, spender: felt, value: Uint256): @@ -322,14 +322,14 @@ end #### `Transfer (event)` -Emitted when `value` tokens are moved from one account (`_from`) to another (`to`). +Emitted when `value` tokens are moved from one account (`from_`) to another (`to`). Note that `value` may be zero. Parameters: ```jsx -_from: felt +from_: felt to: felt value: Uint256 ``` diff --git a/docs/ERC721.md b/docs/ERC721.md index aa6b14584..6507f88de 100644 --- a/docs/ERC721.md +++ b/docs/ERC721.md @@ -67,14 +67,14 @@ namespace IERC721: end func safeTransferFrom( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, data: felt* ): - func transferFrom(_from: felt, to: felt, tokenId: Uint256): + func transferFrom(from_: felt, to: felt, tokenId: Uint256): end func approve(approved: felt, tokenId: Uint256): @@ -219,7 +219,7 @@ Interface for any contract that wants to support safeTransfers from ERC721 asset namespace IERC721_Receiver: func onERC721Received( operator: felt, - _from: felt, + from_: felt, tokenId: Uint256, data_len: felt data: felt* @@ -354,7 +354,7 @@ func ownerOf(tokenId: Uint256) -> (owner: felt): end func safeTransferFrom( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, @@ -362,7 +362,7 @@ func safeTransferFrom( ): end -func transferFrom(_from: felt, to: felt, tokenId: Uint256): +func transferFrom(from_: felt, to: felt, tokenId: Uint256): end func approve(approved: felt, tokenId: Uint256): @@ -413,14 +413,14 @@ owner: felt #### `safeTransferFrom` -Safely transfers `tokenId` token from `_from` to `to`, checking first that contract recipients are aware of the ERC721 protocol to prevent tokens from being forever locked. For information regarding how contracts communicate their awareness of the ERC721 protocol, see [ERC721Received](#erc721received). +Safely transfers `tokenId` token from `from_` to `to`, checking first that contract recipients are aware of the ERC721 protocol to prevent tokens from being forever locked. For information regarding how contracts communicate their awareness of the ERC721 protocol, see [ERC721Received](#erc721received). Emits a [Transfer](#-Transfer-(event)-) event. Parameters: ```jsx -_from: felt +from_: felt to: felt tokenId: Uint256 data_len: felt @@ -433,7 +433,7 @@ None. #### `transferFrom` -Transfers `tokenId` token from `_from` to `to`. +Transfers `tokenId` token from `from_` to `to`. > Note that this function should be used instead of `safeTransferFrom` to transfer tokens. Exercise caution as tokens sent to a contract that does not support ERC721 can be lost forever. @@ -442,7 +442,7 @@ Emits a [Transfer](#-Transfer-(event)-) event. Parameters: ```jsx -_from: felt +from_: felt to: felt tokenId: Uint256 ``` @@ -545,12 +545,12 @@ approved: felt #### `Transfer (Event)` -Emitted when `tokenId` token is transferred from `_from` to `to`. +Emitted when `tokenId` token is transferred from `from_` to `to`. Parameters: ```jsx -_from: felt +from_: felt to: felt tokenId: Uint256 ``` @@ -679,7 +679,7 @@ tokenId: Uint256 ```jsx func onERC721Received( operator: felt, - _from: felt, + from_: felt, tokenId: Uint256, data_len: felt data: felt* @@ -689,14 +689,14 @@ end #### `onERC721Received` -Whenever an IERC721 `tokenId` token is transferred to this non-account contract via `safeTransferFrom` by `operator` from `_from`, this function is called. +Whenever an IERC721 `tokenId` token is transferred to this non-account contract via `safeTransferFrom` by `operator` from `from_`, this function is called. Parameters: ```jsx operator: felt -_from: felt +from_: felt tokenId: Uint256 data_len: felt data: felt* diff --git a/src/openzeppelin/token/erc20/library.cairo b/src/openzeppelin/token/erc20/library.cairo index fd013c3b7..a389d270d 100644 --- a/src/openzeppelin/token/erc20/library.cairo +++ b/src/openzeppelin/token/erc20/library.cairo @@ -17,7 +17,7 @@ from openzeppelin.utils.constants import TRUE, FALSE, UINT8_MAX # @event -func Transfer(_from: felt, to: felt, value: Uint256): +func Transfer(from_: felt, to: felt, value: Uint256): end @event diff --git a/src/openzeppelin/token/erc721/ERC721_Mintable_Burnable.cairo b/src/openzeppelin/token/erc721/ERC721_Mintable_Burnable.cairo index 0cca00ea5..7b0a6134d 100644 --- a/src/openzeppelin/token/erc721/ERC721_Mintable_Burnable.cairo +++ b/src/openzeppelin/token/erc721/ERC721_Mintable_Burnable.cairo @@ -167,11 +167,11 @@ func transferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256 ): - ERC721_transferFrom(_from, to, tokenId) + ERC721_transferFrom(from_, to, tokenId) return () end @@ -181,13 +181,13 @@ func safeTransferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, data: felt* ): - ERC721_safeTransferFrom(_from, to, tokenId, data_len, data) + ERC721_safeTransferFrom(from_, to, tokenId, data_len, data) return () end diff --git a/src/openzeppelin/token/erc721/ERC721_Mintable_Pausable.cairo b/src/openzeppelin/token/erc721/ERC721_Mintable_Pausable.cairo index f54b8d414..5129dec80 100644 --- a/src/openzeppelin/token/erc721/ERC721_Mintable_Pausable.cairo +++ b/src/openzeppelin/token/erc721/ERC721_Mintable_Pausable.cairo @@ -184,12 +184,12 @@ func transferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256 ): Pausable_when_not_paused() - ERC721_transferFrom(_from, to, tokenId) + ERC721_transferFrom(from_, to, tokenId) return () end @@ -199,14 +199,14 @@ func safeTransferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, data: felt* ): Pausable_when_not_paused() - ERC721_safeTransferFrom(_from, to, tokenId, data_len, data) + ERC721_safeTransferFrom(from_, to, tokenId, data_len, data) return () end diff --git a/src/openzeppelin/token/erc721/interfaces/IERC721.cairo b/src/openzeppelin/token/erc721/interfaces/IERC721.cairo index f2c0f7d45..959390e95 100644 --- a/src/openzeppelin/token/erc721/interfaces/IERC721.cairo +++ b/src/openzeppelin/token/erc721/interfaces/IERC721.cairo @@ -16,7 +16,7 @@ namespace IERC721: end func safeTransferFrom( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, @@ -24,7 +24,7 @@ namespace IERC721: ): end - func transferFrom(_from: felt, to: felt, tokenId: Uint256): + func transferFrom(from_: felt, to: felt, tokenId: Uint256): end func approve(approved: felt, tokenId: Uint256): diff --git a/src/openzeppelin/token/erc721/interfaces/IERC721_Receiver.cairo b/src/openzeppelin/token/erc721/interfaces/IERC721_Receiver.cairo index 2fd40e838..b335e18ba 100644 --- a/src/openzeppelin/token/erc721/interfaces/IERC721_Receiver.cairo +++ b/src/openzeppelin/token/erc721/interfaces/IERC721_Receiver.cairo @@ -9,7 +9,7 @@ from starkware.cairo.common.uint256 import Uint256 namespace IERC721_Receiver: func onERC721Received( operator: felt, - _from: felt, + from_: felt, tokenId: Uint256, data_len: felt, data: felt* diff --git a/src/openzeppelin/token/erc721/library.cairo b/src/openzeppelin/token/erc721/library.cairo index e0fd5c143..159082196 100644 --- a/src/openzeppelin/token/erc721/library.cairo +++ b/src/openzeppelin/token/erc721/library.cairo @@ -27,7 +27,7 @@ from openzeppelin.utils.constants import TRUE, FALSE # @event -func Transfer(_from: felt, to: felt, tokenId: Uint256): +func Transfer(from_: felt, to: felt, tokenId: Uint256): end @event @@ -255,7 +255,7 @@ func ERC721_transferFrom{ pedersen_ptr: HashBuiltin*, syscall_ptr: felt*, range_check_ptr - }(_from: felt, to: felt, token_id: Uint256): + }(from_: felt, to: felt, token_id: Uint256): alloc_locals with_attr error_message("ERC721: token_id is not a valid Uint256"): uint256_check(token_id) @@ -271,7 +271,7 @@ func ERC721_transferFrom{ # meaning that a*0==0 for all a in the field, # therefore a*b==0 implies that at least one of a,b is zero in the field - _transfer(_from, to, token_id) + _transfer(from_, to, token_id) return () end @@ -280,7 +280,7 @@ func ERC721_safeTransferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, token_id: Uint256, data_len: felt, @@ -301,7 +301,7 @@ func ERC721_safeTransferFrom{ # meaning that a*0==0 for all a in the field, # therefore a*b==0 implies that at least one of a,b is zero in the field - _safe_transfer(_from, to, token_id, data_len, data) + _safe_transfer(from_, to, token_id, data_len, data) return () end @@ -477,11 +477,11 @@ func _transfer{ syscall_ptr: felt*, pedersen_ptr: HashBuiltin*, range_check_ptr - }(_from: felt, to: felt, token_id: Uint256): - # ownerOf ensures '_from' is not the zero address + }(from_: felt, to: felt, token_id: Uint256): + # ownerOf ensures 'from_' is not the zero address let (_ownerOf) = ERC721_ownerOf(token_id) with_attr error_message("ERC721: transfer from incorrect owner"): - assert _ownerOf = _from + assert _ownerOf = from_ end with_attr error_message("ERC721: cannot transfer to the zero address"): @@ -492,9 +492,9 @@ func _transfer{ _approve(0, token_id) # Decrease owner balance - let (owner_bal) = ERC721_balances.read(_from) + let (owner_bal) = ERC721_balances.read(from_) let (new_balance: Uint256) = uint256_checked_sub_le(owner_bal, Uint256(1, 0)) - ERC721_balances.write(_from, new_balance) + ERC721_balances.write(from_, new_balance) # Increase receiver balance let (receiver_bal) = ERC721_balances.read(to) @@ -503,7 +503,7 @@ func _transfer{ # Update token_id owner ERC721_owners.write(token_id, to) - Transfer.emit(_from, to, token_id) + Transfer.emit(from_, to, token_id) return () end @@ -512,15 +512,15 @@ func _safe_transfer{ pedersen_ptr: HashBuiltin*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, token_id: Uint256, data_len: felt, data: felt* ): - _transfer(_from, to, token_id) + _transfer(from_, to, token_id) - let (success) = _check_onERC721Received(_from, to, token_id, data_len, data) + let (success) = _check_onERC721Received(from_, to, token_id, data_len, data) with_attr error_message("ERC721: transfer to non ERC721Receiver implementer"): assert_not_zero(success) end @@ -532,7 +532,7 @@ func _check_onERC721Received{ pedersen_ptr: HashBuiltin*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, token_id: Uint256, data_len: felt, @@ -545,7 +545,7 @@ func _check_onERC721Received{ let (selector) = IERC721_Receiver.onERC721Received( to, caller, - _from, + from_, token_id, data_len, data diff --git a/src/openzeppelin/token/erc721/utils/ERC721_Holder.cairo b/src/openzeppelin/token/erc721/utils/ERC721_Holder.cairo index fd6b0f915..b26ce0d6f 100644 --- a/src/openzeppelin/token/erc721/utils/ERC721_Holder.cairo +++ b/src/openzeppelin/token/erc721/utils/ERC721_Holder.cairo @@ -14,7 +14,7 @@ from openzeppelin.introspection.ERC165 import ( @view func onERC721Received( operator: felt, - _from: felt, + from_: felt, tokenId: Uint256, data_len: felt, data: felt* diff --git a/src/openzeppelin/token/erc721_enumerable/ERC721_Enumerable_Mintable_Burnable.cairo b/src/openzeppelin/token/erc721_enumerable/ERC721_Enumerable_Mintable_Burnable.cairo index d5af9fc8b..b58cace38 100644 --- a/src/openzeppelin/token/erc721_enumerable/ERC721_Enumerable_Mintable_Burnable.cairo +++ b/src/openzeppelin/token/erc721_enumerable/ERC721_Enumerable_Mintable_Burnable.cairo @@ -204,11 +204,11 @@ func transferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256 ): - ERC721_Enumerable_transferFrom(_from, to, tokenId) + ERC721_Enumerable_transferFrom(from_, to, tokenId) return () end @@ -218,13 +218,13 @@ func safeTransferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, data: felt* ): - ERC721_Enumerable_safeTransferFrom(_from, to, tokenId, data_len, data) + ERC721_Enumerable_safeTransferFrom(from_, to, tokenId, data_len, data) return () end diff --git a/src/openzeppelin/token/erc721_enumerable/library.cairo b/src/openzeppelin/token/erc721_enumerable/library.cairo index a7a225be9..a21c47b7d 100644 --- a/src/openzeppelin/token/erc721_enumerable/library.cairo +++ b/src/openzeppelin/token/erc721_enumerable/library.cairo @@ -132,8 +132,8 @@ func ERC721_Enumerable_burn{ syscall_ptr: felt*, range_check_ptr }(token_id: Uint256): - let (_from) = ERC721_ownerOf(token_id) - _remove_token_from_owner_enumeration(_from, token_id) + let (from_) = ERC721_ownerOf(token_id) + _remove_token_from_owner_enumeration(from_, token_id) _remove_token_from_all_tokens_enumeration(token_id) ERC721_burn(token_id) return () @@ -143,10 +143,10 @@ func ERC721_Enumerable_transferFrom{ pedersen_ptr: HashBuiltin*, syscall_ptr: felt*, range_check_ptr - }(_from: felt, to: felt, token_id: Uint256): - _remove_token_from_owner_enumeration(_from, token_id) + }(from_: felt, to: felt, token_id: Uint256): + _remove_token_from_owner_enumeration(from_, token_id) _add_token_to_owner_enumeration(to, token_id) - ERC721_transferFrom(_from, to, token_id) + ERC721_transferFrom(from_, to, token_id) return () end @@ -155,15 +155,15 @@ func ERC721_Enumerable_safeTransferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, token_id: Uint256, data_len: felt, data: felt* ): - _remove_token_from_owner_enumeration(_from, token_id) + _remove_token_from_owner_enumeration(from_, token_id) _add_token_to_owner_enumeration(to, token_id) - ERC721_safeTransferFrom(_from, to, token_id, data_len, data) + ERC721_safeTransferFrom(from_, to, token_id, data_len, data) return () end @@ -226,9 +226,9 @@ func _remove_token_from_owner_enumeration{ pedersen_ptr: HashBuiltin*, syscall_ptr: felt*, range_check_ptr - }(_from: felt, token_id: Uint256): + }(from_: felt, token_id: Uint256): alloc_locals - let (last_token_index: Uint256) = ERC721_balanceOf(_from) + let (last_token_index: Uint256) = ERC721_balanceOf(from_) # the index starts at zero therefore the user's last token index is their balance minus one let (last_token_index) = uint256_sub(last_token_index, Uint256(1, 0)) let (token_index: Uint256) = ERC721_Enumerable_owned_tokens_index.read(token_id) @@ -237,13 +237,13 @@ func _remove_token_from_owner_enumeration{ let (is_equal) = uint256_eq(token_index, last_token_index) if is_equal == TRUE: ERC721_Enumerable_owned_tokens_index.write(token_id, Uint256(0, 0)) - ERC721_Enumerable_owned_tokens.write(_from, last_token_index, Uint256(0, 0)) + ERC721_Enumerable_owned_tokens.write(from_, last_token_index, Uint256(0, 0)) return () end # If index is not last, reposition owner's last token to the removed token's index - let (last_token_id: Uint256) = ERC721_Enumerable_owned_tokens.read(_from, last_token_index) - ERC721_Enumerable_owned_tokens.write(_from, token_index, last_token_id) + let (last_token_id: Uint256) = ERC721_Enumerable_owned_tokens.read(from_, last_token_index) + ERC721_Enumerable_owned_tokens.write(from_, token_index, last_token_id) ERC721_Enumerable_owned_tokens_index.write(last_token_id, token_index) return () end diff --git a/tests/mocks/ERC721_SafeMintable_mock.cairo b/tests/mocks/ERC721_SafeMintable_mock.cairo index 60ec6736e..1615c2a9b 100644 --- a/tests/mocks/ERC721_SafeMintable_mock.cairo +++ b/tests/mocks/ERC721_SafeMintable_mock.cairo @@ -162,11 +162,11 @@ func transferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256 ): - ERC721_transferFrom(_from, to, tokenId) + ERC721_transferFrom(from_, to, tokenId) return () end @@ -176,13 +176,13 @@ func safeTransferFrom{ syscall_ptr: felt*, range_check_ptr }( - _from: felt, + from_: felt, to: felt, tokenId: Uint256, data_len: felt, data: felt* ): - ERC721_safeTransferFrom(_from, to, tokenId, data_len, data) + ERC721_safeTransferFrom(from_, to, tokenId, data_len, data) return () end