ERC721M

An ERC721 extension that is designed with Network Spirituality in mind.
THIS IS EXPERIMENTAL CODE, PLEASE PROCEED WITH CAUTION!!!
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This is an abstract contract intended to align NFT collections with Remilia's vision for Network Spirituality by deepening NFT collection liquidity using mint fees. It is designed such that the developer (or other recipient) can receive up to 50% of the mint fees, while the remainder is dedicated to deepening an NFT's NFTX liquidity. All funds directed towards deepening NFTX liquidity for a particular NFT collection are locked forever. Yield generated by that liquidity can still be utilized. Liquidity rewards are locked and redirected towards deepening liquidity if the dev's cut is >20%. They are only withdrawable if dev takes <=20%.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

ERC721M was designed using Foundry, so we recommend familiarizing yourself with that if required.

Prerequisites

• Foundry

  curl -L https://foundry.paradigm.xyz | bash
  foundryup

Installation

1. Set up your NFT project using Foundry

   forge init ProjectName

2. Install ERC721M

   forge install miyamaker/ERC721M --no-commit

3. Import the ERC721M standard
   Add the following above the beginning of your project's primary contract

   import "ERC721M/ERC721M.sol";

4. Inherit the module
   Add the following to the contract declaration

   contract ProjectName is ERC721M {}

5. Utilize each function as required
   A deeper understanding of Solady is required to continue beyond this point

(back to top)

Usage

TODO: Summarize all functions

(back to top)

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the AGPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contacts

Zodomo - @0xZodomo - [email protected] - Zodomo.eth

Miyagod - @miyamaker - [email protected] - miyagod.eth

Project Link: https://github.com/Zodomo/721M

(back to top)

Acknowledgments

• NFTX
• Remilia
• Network Spirituality
• Solady by Vectorized.eth
• Openzeppelin Contracts
• Uniswap V2 Core
• Uniswap V2 Periphery

(back to top)