erc721n v1.2.8
About The Project
The goal of ERC721N is to provide a fully compliant implementation of IERC721 with a bonus ERC20 Treasury Management and Redeemption system. This project and implementation will be updated regularly and will continue to stay up to date with best practices.
The NoRamp team created ERC721N as an extension of the ERC721 standard with the additional features that make the NFTs token warrants on a treasury reserve ERC20. Mint NFT. Burn the NFT. Claim tokens.
For more information on how ERC721N works under the hood, please visit our blog. To find other projects that are using ERC721N, please visit erc721n.org
NoRamp Labs is not liable for any outcomes as a result of using ERC721N. DYOR.
Docs
https://docs.noramp.io/erc721n/quickstart
Installation
npm install --save-dev erc721n
Usage
Once installed, you can use the contracts in the library by importing them:
pragma solidity ^0.8.2;
import "erc721n/contracts/ERC721N.sol";
contract ERC721NTest is ERC721N {
constructor(IERC20 _erc20Token) ERC721N(_erc20Token) {
reserveTokenAddress = _erc20Token;
}
function mint(address to, uint256 amount) external {
safeMint(to, amount);
}
}
Roadmap
- Improve general repo and code quality (workflows, comments, etc.)
- Add more documentation on benefits of using ERC721N
- Maintain full test coverage
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Running tests locally
npm install
npm run test
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
- rarepepi (owner) - @rarepepi
- 0xinuarashi (maintainer) - @0xinuarashi
- cygaar (maintainer) - @0xCygaar
- vectorized.eth (maintainer) - @optimizoor
Project Link: https://github.com/noramp/ERC721N