Merge pull request #217 from MoMannn/master

Breaking dangerous superuser burn into mock and test mocks.

Author: xpepermint

README.md

@@ -18,6 +18,10 @@ All contracts and tests are in the [src](src/) folder. There are multiple implem
 
 Other files in the [tokens](src/contracts/tokens) and [utils](src/contracts/utils) directories named like `erc*.sol` are interfaces and define the respective standards.
 
+Mock contract showing basic contract usage are available in [mocks](src/contracts/mocks) folder. 
+
+There are also test mocks which can be seen [here](src/tests/mocks). These are specifically made to test different edge cases and behaviours and should NOT be used as a reference for implementation.
+
 ## Requirements
 
 * NodeJS 9.0+ is supported
@@ -114,19 +118,6 @@ contract MyArtSale is
     super._setTokenUri(_tokenId, _uri);
   }
 
-  /**
-   * @dev Removes a NFT from owner.
-   * @param _tokenId Which NFT we want to remove.
-   */
-  function burn(
-    uint256 _tokenId
-  )
-    external
-    onlyOwner
-  {
-    super._burn(_tokenId);
-  }
-
 }
 ```
 

src/contracts/mocks/nf-token-mock.sol

@@ -26,17 +26,4 @@ contract NFTokenMock is
     super._mint(_to, _tokenId);
   }
 
-  /**
-   * @dev Removes a NFT from owner.
-   * @param _tokenId Which NFT we want to remove.
-   */
-  function burn(
-    uint256 _tokenId
-  )
-    external
-    onlyOwner
-  {
-    super._burn(_tokenId);
-  }
-
 }

src/tests/mocks/nf-token-test-mock.sol

@@ -0,0 +1,22 @@
+pragma solidity 0.5.2;
+
+import "../../contracts/mocks/nf-token-mock.sol";
+
+contract NFTokenTestMock is
+  NFTokenMock
+{
+
+ /**
+   * @dev Removes a NFT from owner.
+   * @param _tokenId Which NFT we want to remove.
+   */
+  function burn(
+    uint256 _tokenId
+  )
+    external
+    onlyOwner
+  {
+    super._burn(_tokenId);
+  }
+
+}

src/tests/tokens/nf-token.test.ts

@@ -39,8 +39,8 @@ spec.beforeEach(async (ctx) => {
 
 spec.beforeEach(async (ctx) => {
   const nfToken = await ctx.deploy({ 
-    src: './build/nf-token-mock.json',
-    contract: 'NFTokenMock',
+    src: './build/nf-token-test-mock.json',
+    contract: 'NFTokenTestMock',
   });
   ctx.set('nfToken', nfToken);
 });