update revert statements

Author: Krishang Nadgauda

contracts/multiwrap/Multiwrap.sol

@@ -83,7 +83,11 @@ contract Multiwrap is
         _setupRole(DEFAULT_ADMIN_ROLE, _defaultAdmin);
         _setupRole(MINTER_ROLE, _defaultAdmin);
         _setupRole(TRANSFER_ROLE, _defaultAdmin);
+
+        // note: see `_beforeTokenTransfer` for TRANSFER_ROLE behaviour.
         _setupRole(TRANSFER_ROLE, address(0));
+
+        // note: see `onlyRoleWithSwitch` for UNWRAP_ROLE behaviour.
         _setupRole(UNWRAP_ROLE, address(0));
 
         _revokeRole(DEFAULT_ADMIN_ROLE, _msgSender());
@@ -144,24 +148,24 @@ contract Multiwrap is
 
     /// @dev Wrap multiple ERC1155, ERC721, ERC20 tokens into a single wrapped NFT.
     function wrap(
-        Token[] calldata _wrappedContents,
+        Token[] calldata _tokensToWrap,
         string calldata _uriForWrappedToken,
         address _recipient
     ) external payable nonReentrant onlyRoleWithSwitch(MINTER_ROLE) returns (uint256 tokenId) {
         tokenId = nextTokenIdToMint;
         nextTokenIdToMint += 1;
 
-        _storeTokens(_msgSender(), _wrappedContents, _uriForWrappedToken, tokenId);
+        _storeTokens(_msgSender(), _tokensToWrap, _uriForWrappedToken, tokenId);
 
         _safeMint(_recipient, tokenId);
 
-        emit TokensWrapped(_msgSender(), _recipient, tokenId, _wrappedContents);
+        emit TokensWrapped(_msgSender(), _recipient, tokenId, _tokensToWrap);
     }
 
     /// @dev Unwrap a wrapped NFT to retrieve underlying ERC1155, ERC721, ERC20 tokens.
     function unwrap(uint256 _tokenId, address _recipient) external nonReentrant onlyRoleWithSwitch(UNWRAP_ROLE) {
-        require(_tokenId < nextTokenIdToMint, "invalid tokenId");
-        require(_isApprovedOrOwner(_msgSender(), _tokenId), "unapproved called");
+        require(_tokenId < nextTokenIdToMint, "Multiwrap: wrapped NFT DNE.");
+        require(_isApprovedOrOwner(_msgSender(), _tokenId), "Multiwrap: caller not approved for unwrapping.");
 
         _burn(_tokenId);
         _releaseTokens(_recipient, _tokenId);

docs/Multiwrap.md

@@ -322,7 +322,7 @@ function getWrappedContents(uint256 _tokenId) external view returns (struct ITok
 
 
 
-*Returns the underlygin contents of a wrapped NFT.*
+*Returns the underlying contents of a wrapped NFT.*
 
 #### Parameters
 
@@ -875,7 +875,7 @@ function unwrap(uint256 _tokenId, address _recipient) external nonpayable
 ### wrap
 
 ```solidity
-function wrap(ITokenBundle.Token[] _wrappedContents, string _uriForWrappedToken, address _recipient) external payable returns (uint256 tokenId)
+function wrap(ITokenBundle.Token[] _tokensToWrap, string _uriForWrappedToken, address _recipient) external payable returns (uint256 tokenId)
 ```
 
 
@@ -886,7 +886,7 @@ function wrap(ITokenBundle.Token[] _wrappedContents, string _uriForWrappedToken,
 
 | Name | Type | Description |
 |---|---|---|
-| _wrappedContents | ITokenBundle.Token[] | undefined
+| _tokensToWrap | ITokenBundle.Token[] | undefined
 | _uriForWrappedToken | string | undefined
 | _recipient | address | undefined
 

src/test/Multiwrap.t.sol

@@ -408,7 +408,7 @@ contract MultiwrapTest is BaseTest {
         // ===== target test content =====
 
         vm.prank(recipient);
-        vm.expectRevert("invalid tokenId");
+        vm.expectRevert("Multiwrap: wrapped NFT DNE.");
         multiwrap.unwrap(expectedIdForWrappedToken + 1, recipient);
     }
 
@@ -423,7 +423,7 @@ contract MultiwrapTest is BaseTest {
         // ===== target test content =====
 
         vm.prank(address(0x12));
-        vm.expectRevert("unapproved called");
+        vm.expectRevert("Multiwrap: caller not approved for unwrapping.");
         multiwrap.unwrap(expectedIdForWrappedToken, recipient);
     }
 
@@ -441,7 +441,7 @@ contract MultiwrapTest is BaseTest {
         multiwrap.transferFrom(recipient, address(0x12), 0);
 
         vm.prank(recipient);
-        vm.expectRevert("unapproved called");
+        vm.expectRevert("Multiwrap: caller not approved for unwrapping.");
         multiwrap.unwrap(expectedIdForWrappedToken, recipient);
     }
 
@@ -528,12 +528,11 @@ contract MultiwrapTest is BaseTest {
 
     function test_fuzz_state_wrap(uint256 x) public {
 
-        if(x == 0) {
+        ITokenBundle.Token[] memory tokensToWrap = getTokensToWrap(x);
+        if(tokensToWrap.length == 0) {
             return;
         }
 
-        ITokenBundle.Token[] memory tokensToWrap = getTokensToWrap(x);
-
         uint256 expectedIdForWrappedToken = multiwrap.nextTokenIdToMint();
         address recipient = address(0x123);
 
@@ -558,12 +557,11 @@ contract MultiwrapTest is BaseTest {
 
         // ===== setup: wrap tokens =====
 
-        if(x == 0) {
+        ITokenBundle.Token[] memory tokensToWrap = getTokensToWrap(x);
+        if(tokensToWrap.length == 0) {
             return;
         }
 
-        ITokenBundle.Token[] memory tokensToWrap = getTokensToWrap(x);
-
         uint256 expectedIdForWrappedToken = multiwrap.nextTokenIdToMint();
         address recipient = address(0x123);