├── contracts
    ├── NSToken.sol
    ├── Greeter.sol
    └── NFT.sol
├── .gitignore
├── hardhat.config.js
├── test
    └── sample-test.js
├── package.json
├── scripts
    └── sample-script.js
└── README.md


/contracts/NSToken.sol:
--------------------------------------------------------------------------------
 1 | // contracts/NSToken.sol
 2 | // SPDX-License-Identifier: MIT OR Apache-2.0
 3 | pragma solidity ^0.8.4;
 4 | 
 5 | import '@openzeppelin/contracts/token/ERC20/ERC20.sol';
 6 | 
 7 | contract NSToken is ERC20 {
 8 | 
 9 |     constructor() ERC20("NSToken", "NST") {
10 |         _mint(msg.sender, 1000000);
11 |     }
12 | 
13 | }


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 2 | 
 3 | # dependencies
 4 | /node_modules
 5 | /.pnp
 6 | .pnp.js
 7 | 
 8 | # testing
 9 | /coverage
10 | 
11 | # production
12 | /build
13 | 
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 | 
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 | 
25 | node_modules
26 | 
27 | #Hardhat files
28 | cache
29 | artifacts
30 | 
31 | node_modules
32 | .env
33 | 
34 | #Hardhat files
35 | cache
36 | artifacts
37 | 


--------------------------------------------------------------------------------
/contracts/Greeter.sol:
--------------------------------------------------------------------------------
 1 | //SPDX-License-Identifier: Unlicense
 2 | pragma solidity ^0.8.0;
 3 | 
 4 | import "hardhat/console.sol";
 5 | 
 6 | contract Greeter {
 7 |     string private greeting;
 8 | 
 9 |     constructor(string memory _greeting) {
10 |         console.log("Deploying a Greeter with greeting:", _greeting);
11 |         greeting = _greeting;
12 |     }
13 | 
14 |     function greet() public view returns (string memory) {
15 |         return greeting;
16 |     }
17 | 
18 |     function setGreeting(string memory _greeting) public {
19 |         console.log("Changing greeting from '%s' to '%s'", greeting, _greeting);
20 |         greeting = _greeting;
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/hardhat.config.js:
--------------------------------------------------------------------------------
 1 | require("@nomiclabs/hardhat-waffle");
 2 | require("@nomiclabs/hardhat-web3");
 3 | 
 4 | // This is a sample Hardhat task. To learn how to create your own go to
 5 | // https://hardhat.org/guides/create-task.html
 6 | task("accounts", "Prints the list of accounts", async (taskArgs, hre) => {
 7 |   const accounts = await hre.ethers.getSigners();
 8 | 
 9 |   for (const account of accounts) {
10 |     console.log(account.address);
11 |   }
12 | });
13 | 
14 | // You need to export an object to set up your config
15 | // Go to https://hardhat.org/config/ to learn more
16 | 
17 | /**
18 |  * @type import('hardhat/config').HardhatUserConfig
19 |  */
20 | module.exports = {
21 |   solidity: "0.8.4",
22 | };
23 | 


--------------------------------------------------------------------------------
/test/sample-test.js:
--------------------------------------------------------------------------------
 1 | const { expect } = require("chai");
 2 | const { ethers } = require("hardhat");
 3 | 
 4 | describe("Greeter", function () {
 5 |   it("Should return the new greeting once it's changed", async function () {
 6 |     const Greeter = await ethers.getContractFactory("Greeter");
 7 |     const greeter = await Greeter.deploy("Hello, world!");
 8 |     await greeter.deployed();
 9 | 
10 |     expect(await greeter.greet()).to.equal("Hello, world!");
11 | 
12 |     const setGreetingTx = await greeter.setGreeting("Hola, mundo!");
13 | 
14 |     // wait until the transaction is mined
15 |     await setGreetingTx.wait();
16 | 
17 |     expect(await greeter.greet()).to.equal("Hola, mundo!");
18 |   });
19 | });
20 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "nft-royalties",
 3 |   "version": "1.0.0",
 4 |   "description": "",
 5 |   "main": "index.js",
 6 |   "dependencies": {
 7 |     "@nomiclabs/hardhat-ethers": "^2.0.2",
 8 |     "@nomiclabs/hardhat-waffle": "^2.0.1",
 9 |     "@openzeppelin/contracts": "^4.3.0",
10 |     "axios": "^0.21.1",
11 |     "chai": "^4.3.4",
12 |     "ethereum-waffle": "^3.4.0",
13 |     "ethers": "^5.4.5",
14 |     "hardhat": "^2.6.1",
15 |     "ipfs-http-client": "^52.0.1",
16 |     "web3modal": "^1.9.4"
17 |   },
18 |   "devDependencies": {
19 |     "@nomiclabs/hardhat-web3": "^2.0.0",
20 |     "@openzeppelin/test-helpers": "^0.5.13",
21 |     "web3": "^1.5.2"
22 |   },
23 |   "scripts": {
24 |     "test": "mocha"
25 |   },
26 |   "repository": {
27 |     "type": "git",
28 |     "url": "git+https://github.com/nsinthunont/nft-royalties.git"
29 |   },
30 |   "author": "",
31 |   "license": "ISC",
32 |   "bugs": {
33 |     "url": "https://github.com/nsinthunont/nft-royalties/issues"
34 |   },
35 |   "homepage": "https://github.com/nsinthunont/nft-royalties#readme"
36 | }
37 | 


--------------------------------------------------------------------------------
/scripts/sample-script.js:
--------------------------------------------------------------------------------
 1 | // We require the Hardhat Runtime Environment explicitly here. This is optional
 2 | // but useful for running the script in a standalone fashion through `node <script>`.
 3 | //
 4 | // When running the script with `npx hardhat run <script>` you'll find the Hardhat
 5 | // Runtime Environment's members available in the global scope.
 6 | const hre = require("hardhat");
 7 | 
 8 | async function main() {
 9 |   // Hardhat always runs the compile task when running scripts with its command
10 |   // line interface.
11 |   //
12 |   // If this script is run directly using `node` you may want to call compile
13 |   // manually to make sure everything is compiled
14 |   // await hre.run('compile');
15 | 
16 |   // We get the contract to deploy
17 |   const Greeter = await hre.ethers.getContractFactory("Greeter");
18 |   const greeter = await Greeter.deploy("Hello, Hardhat!");
19 | 
20 |   await greeter.deployed();
21 | 
22 |   console.log("Greeter deployed to:", greeter.address);
23 | }
24 | 
25 | // We recommend this pattern to be able to use async/await everywhere
26 | // and properly handle errors.
27 | main()
28 |   .then(() => process.exit(0))
29 |   .catch((error) => {
30 |     console.error(error);
31 |     process.exit(1);
32 |   });
33 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # NFT Royalties
 2 | 
 3 | ## Introduction
 4 | This repo contains a template smart contract to create an NFT that pays royalties to the original artist each time it is transacted in the future. This feature is an extremely important one to have as many artists are currently struggling to monetize. In an ideal scenario, the royalty scheme can be customized at the NFT level. 
 5 | 
 6 | ## Openzeppelin
 7 | This smart contract relies on Openzeppelin's ERC721 standard for NFTs. There is also another ERC20 smart contract for a test token called NSToken (this can be replaced with any token)
 8 | 
 9 | 
10 | ## Setup dependencies
11 | To install all the dependencies in a all project:
12 | ```
13 | npm install --save ethers hardhat @nomiclabs/hardhat-waffle ethereum-waffle chai @nomiclabs/hardhat-ethers web3modal @openzeppelin/contracts 
14 | ```
15 | We will also want to install some dev dependencies for testing purposes
16 | ```
17 | npm install --save-dev @openzeppelin/test-helpers @nomiclabs/hardhat-web3 web3
18 | ```
19 | Don't forget to modify the hardhat.config.js file by adding the following to the top or else the test-helpers will not function properly
20 | ```
21 | require("@nomiclabs/hardhat-web3");
22 | ```
23 | 
24 | ## Usage
25 | To test the smart contracts using the provide test file:
26 | ```
27 | npx hardhat test
28 | ```
29 | 
30 | 
31 | ## Future
32 | There are several upgrades that are available to the current template including:
33 | * The royalty fee can be paid in any token currency that is equivalent to the fee which can be denominated in ETH (i.e. assume fee is 1 ETH and today the price of 1 ETH = 10 LINK then the royalty fee can either be paid using 1 ETH or 10 LINK)
34 | * Allow either the buyer or the seller of the NFT to cover the fee cost
35 | 
36 | 


--------------------------------------------------------------------------------
/contracts/NFT.sol:
--------------------------------------------------------------------------------
 1 | // contracts/NFT.sol
 2 | // SPDX-License-Identifier: MIT OR Apache-2.0
 3 | pragma solidity ^0.8.4;
 4 | 
 5 | import "@openzeppelin/contracts/utils/Counters.sol";
 6 | import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";
 7 | import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
 8 | import '@openzeppelin/contracts/token/ERC20/IERC20.sol';
 9 | 
10 | contract NFT is ERC721URIStorage {
11 |     using Counters for Counters.Counter;
12 |     Counters.Counter private _tokenIds;
13 | 
14 |     address _artist;
15 |     address _feeToken;
16 |     uint _feeAmount;
17 |     
18 |     mapping(uint => bool) public excludeList;
19 | 
20 |     constructor(
21 |         address artist,
22 |         address feeToken,
23 |         uint feeAmount
24 |         ) ERC721("Moogle Tokens", "MOG"){
25 | 
26 |         _artist = artist;
27 |         _feeTokent = feeToken;
28 |         _feeAmount = feeAmount;
29 | 
30 |     }
31 | 
32 |     function createToken(string memory tokenURI) public returns (uint) {
33 |         
34 |         _tokenIds.increment();
35 |         uint tokenId = _tokenIds.current();
36 | 
37 |         excludeList[tokenId] = false
38 | 
39 |         _mint(_artist, tokenId);
40 |         _setTokenURI(tokenId, tokenURI);
41 |         
42 |         return tokenId;
43 | 
44 |     }
45 | 
46 |     function setExcluded(uint tokenId, bool status) external {
47 |         require(msg.sender == _artist, 'only the artist can change the exclude value');
48 |         excludeList[tokenId] = status;
49 |     }
50 | 
51 |     function transferFrom(
52 |         address from, 
53 |         address to, 
54 |         uint tokenId
55 |     ) public override {
56 | 
57 |         require(from != address(0x0), 'invalid from address');
58 |         require(to != address(0x0), 'invalid to address');
59 | 
60 |         require(tokenId > 0, 'invalid tokenId');
61 |         require(tokenId <= _tokenIds.current(), 'invalid tokenId');
62 | 
63 |         require(_isApprovedOrOwner(_msgSender(), tokenId), 'msgSender is not the owner of the token');
64 | 
65 |         if(excludeList[tokenId] == false) {
66 |             _payTxFee(from);
67 |         }
68 | 
69 |         _transfer(from, to, tokenId);
70 | 
71 |     }
72 | 
73 |     function _payTxFee(address from) internal {
74 |         IERC20 token = IERC20(txFeeToken);
75 |         token.transferFrom(from, artist, txFeeAmount);
76 |     }
77 | 
78 | }


--------------------------------------------------------------------------------