misc improvements assert return messages, fix standard naming inconsiste…

Author: vincentgeneste

README.md

@@ -1,5 +1,5 @@
 # NEP11TemplatePy
-Fully featured NEP11 python contract to allow to easily deploy your own NFT minting contract, and make it seamless to integrate it on GhostMarket.
+Fully featured NEP-11 python contract to allow to easily deploy your own NFT minting contract, and make it seamless to integrate it on GhostMarket.
 
 
 ## Contract overview
@@ -37,7 +37,7 @@ This contract features two methods to handle properties:
 
 `properties` and `propertiesJson`
 
-`properties` returns a MAP of all the NFT metadata, and is what follows NEP11 standard (even though currently the standard is inconsistent as the signature shows it should be a MAP, while the explanation tied to it shows it should be a serialized NVM object).
+`properties` returns a MAP of all the NFT metadata, and is what follows NEP-11 standard (even though currently the standard is inconsistent as the signature shows it should be a MAP, while the explanation tied to it shows it should be a serialized NVM object).
 
 `propertiesJson` returns a serialized JSON string of all the NFT metadata, and is what makes more sense for us to handle metadata.
 

contracts/NEP11/NEP11-Template.py

@@ -172,7 +172,7 @@ def balanceOf(owner: UInt160) -> int:
     :return: the total amount of tokens owned by the specified address.
     :raise AssertionError: raised if `owner` length is not 20.
     """
-    expect(validateAddress(owner), "Not a valid address")
+    expect(validateAddress(owner), "balanceOf - not a valid address")
     debug(['balanceOf: ', get(mk_balance_key(owner), get_read_only_context()).to_int()])
     return get(mk_balance_key(owner), get_read_only_context()).to_int()
 
@@ -188,7 +188,7 @@ def tokensOf(owner: UInt160) -> Iterator:
     :return: an iterator that contains all of the token ids owned by the specified address.
     :raise AssertionError: raised if `owner` length is not 20.
     """
-    expect(validateAddress(owner), "Not a valid address")
+    expect(validateAddress(owner), "tokensOf - not a valid address")
     flags = FindOptions.REMOVE_PREFIX | FindOptions.KEYS_ONLY
     context = get_read_only_context()
     return find(mk_account_key(owner), context, flags)
@@ -218,8 +218,8 @@ def transfer(to: UInt160, tokenId: ByteString, data: Any) -> bool:
     :return: whether the transfer was successful
     :raise AssertionError: raised if `to` length is not 20 or if `tokenId` is not a valid NFT or if the contract is paused.
     """
-    expect(validateAddress(to), "Not a valid address")
-    expect(not isPaused(), "Contract is currently paused")
+    expect(validateAddress(to), "transfer - not a valid address")
+    expect(not isPaused(), "transfer - contract paused")
     token_owner = get_owner_of(tokenId)
 
     if not check_witness(token_owner):
@@ -238,7 +238,7 @@ def transfer(to: UInt160, tokenId: ByteString, data: Any) -> bool:
 
 def post_transfer(token_owner: Union[UInt160, None], to: Union[UInt160, None], tokenId: ByteString, data: Any):
     """
-    Checks if the one receiving NEP11 tokens is a smart contract and if it's one the onPayment method will be called - internal
+    Checks if the one receiving NEP-11 tokens is a smart contract and if it's one the onPayment method will be called - internal
 
     :param token_owner: the address of the sender
     :type token_owner: UInt160
@@ -296,7 +296,7 @@ def properties(tokenId: ByteString) -> Dict[Any, Any]:
     :raise AssertionError: raised if `tokenId` is not a valid NFT, or if no metadata available.
     """
     metaBytes = cast(str, get_meta(tokenId))
-    expect(len(metaBytes) != 0, 'No metadata available for token')
+    expect(len(metaBytes) != 0, 'properties - no metadata available for token')
     metaObject = cast(Dict[str, str], json_deserialize(metaBytes))
 
     return metaObject
@@ -314,7 +314,7 @@ def propertiesJson(tokenId: ByteString) -> ByteString:
     :raise AssertionError: raised if `tokenId` is not a valid NFT, or if no metadata available.
     """
     meta = get_meta(tokenId)
-    expect(len(meta) != 0, 'No metadata available for token')
+    expect(len(meta) != 0, 'propertiesJson - no metadata available for token')
     debug(['properties: ', meta])
     return meta
 
@@ -374,7 +374,7 @@ def burn(tokenId: ByteString) -> bool:
     :return: whether the burn was successful.
     :raise AssertionError: raised if the contract is paused.
     """
-    expect(not isPaused(), "Contract is currently paused")
+    expect(not isPaused(), "burn - contract paused")
     return internal_burn(tokenId)
 
 @public
@@ -393,13 +393,13 @@ def mint(account: UInt160, meta: ByteString, lockedContent: ByteString, royaltie
     :return: tokenId of the token minted
     :raise AssertionError: raised if the contract is paused or if check witness fails.
     """
-    expect(validateAddress(account), "Not a valid address")  # not really necessary because check_witness would catch an invalid address
-    expect(not isPaused(), "Contract is currently paused")
+    expect(validateAddress(account), "mint - not a valid address")  # not really necessary because check_witness would catch an invalid address
+    expect(not isPaused(), "mint - contract paused")
 
     # TODO_TEMPLATE: add own logic if necessary, or uncomment below to restrict minting to contract authorized addresses
     # verified: bool = verify()
     # expect(verified, '`account` is not allowed for mint')
-    expect(check_witness(account), "Invalid witness")
+    expect(check_witness(account), "mint - invalid witness")
 
     return internal_mint(account, meta, lockedContent, royalties)
 
@@ -442,7 +442,7 @@ def getLockedContent(tokenId: ByteString) -> ByteString:
     """
     owner = get_owner_of(tokenId)
 
-    expect(check_witness(owner), "Prohibited access to locked content!")
+    expect(check_witness(owner), "getLockedContent - prohibited access to locked content!")
     set_locked_view_counter(tokenId)
 
     debug(['getLockedContent: ', get_locked_content(tokenId)])
@@ -489,9 +489,9 @@ def setAuthorizedAddress(address: UInt160, authorized: bool):
     :raise AssertionError: raised if witness is not verified.
     """
     verified: bool = verify()
-    expect(verified, '`account` is not allowed for setAuthorizedAddress')
-    expect(validateAddress(address), "Not a valid address")
-    expect(isinstance(authorized, bool), "authorized has to be of type bool")
+    expect(verified, 'setAuthorizedAddress - `account` is not allowed for setAuthorizedAddress')
+    expect(validateAddress(address), "setAuthorizedAddress - not a valid address")
+    expect(isinstance(authorized, bool), "setAuthorizedAddress - authorized has to be of type bool")
     serialized = get(AUTH_ADDRESSES, get_read_only_context())
     auth = cast(list[UInt160], deserialize(serialized))
 
@@ -523,8 +523,8 @@ def updatePause(status: bool) -> bool:
     :raise AssertionError: raised if witness is not verified.
     """
     verified: bool = verify()
-    expect(verified, '`account` is not allowed for updatePause')
-    expect(isinstance(status, bool), "status has to be of type bool")
+    expect(verified, 'updatePause - `account` is not allowed for updatePause')
+    expect(isinstance(status, bool), "updatePause - status has to be of type bool")
     put(PAUSED, status)
     debug(['updatePause: ', get(PAUSED, get_read_only_context()).to_bool()])
     return get(PAUSED, get_read_only_context()).to_bool() 
@@ -577,7 +577,7 @@ def update(script: bytes, manifest: bytes):
     :raise AssertionError: raised if witness is not verified
     """
     verified: bool = verify()
-    expect(verified, '`account` is not allowed for update')
+    expect(verified, 'update - `account` is not allowed for update')
     update_contract(script, manifest) 
     debug(['update called and done'])
 
@@ -589,7 +589,7 @@ def destroy():
     :raise AssertionError: raised if witness is not verified
     """
     verified: bool = verify()
-    expect(verified, '`account` is not allowed for destroy')
+    expect(verified, 'destroy - `account` is not allowed for destroy')
     destroy_contract() 
     debug(['destroy called and done'])
 
@@ -633,7 +633,7 @@ def internal_mint(account: UInt160, meta: ByteString, lockedContent: ByteString,
     :return: tokenId of the token minted
     :raise AssertionError: raised if meta is empty, or if contract is paused.
     """
-    expect(len(meta) != 0, '`meta` can not be empty')
+    expect(len(meta) != 0, 'internal_mint - `meta` can not be empty')
 
     tokenId = get(TOKEN_COUNT, get_read_only_context()).to_int() + 1
     put(TOKEN_COUNT, tokenId)
@@ -651,7 +651,7 @@ def internal_mint(account: UInt160, meta: ByteString, lockedContent: ByteString,
         debug(['locked: ', lockedContent])
 
     if len(royalties) != 0:
-        expect(validateRoyalties(royalties), "Not a valid royalties format")
+        expect(validateRoyalties(royalties), "internal_mint - not a valid royalties format")
         add_royalties(tokenIdBytes, cast(str, royalties))
         debug(['royalties: ', royalties])