@charged-particles/peppermint v0.1.2

made with ❤️ by Rob Secord (Charged Particles & Taggr)

About Peppermint (ERC721 Pre-Mint v0.1.3)

Gas-efficient contracts for Pre-Minting 1,000,000,000 NFTs!

It's like handing out Candy!

Our goal is to Eliminate Minting Fees for all NFT projects by providing a new method of Pre-Minting an entire collection up-front for half the cost of minting a single, standard NFT. Everything afterwards remains standard.

We have created ERC721PreMint by utilizing and only slightly adapting the popular Open Zeppelin ERC721 contracts in order to maintain the highest level of open standards. However, the approach we have taken is so simple, that it can be easily adapted to any ERC721 framework.

By eliminating the heavy-lifting of Minting, we can help to alleviate some of the network congestion caused when there is huge demand for a new token release. Miners are simply able to process more "transfers" than "mints" in a single block.

For more information on how our ERC721PreMint works under the hood, please visit our blog.

These contracts, while simple, have not been audited. Charged Particles, and its affiliates, are not liable for any outcome as a result of using ERC721PreMint.

Blog Article

https://docs.charged.fi/peppermint/...

Live Demo

TODO: Link to Rorschachs

Installation

npm install --save-dev @charged-particles/peppermint

OR

yarn add -D @charged-particles/peppermint

Usage

After installation, just import and inherit ERC721PreMint.sol

pragma solidity ^0.8.4;

import "@charged-particles/peppermint/contracts/ERC721PreMint.sol";

contract MyNFT is ERC721PreMint {
  constructor(string memory name, string memory symbol, uint256 maxSupply)
    ERC721PreMint(name, symbol, _msgSender(), maxSupply) {}

  function preMint() external {
    _preMint();
  }
}

Deployment & Verification

npm run deploy <network_name>
npm run verify <network_name>

OR

yarn deploy <network_name>
yarn verify <network_name>

Where <network_name> is any valid network name configured in hardhat.config.js (ie. hardhat, mainnet, goerli, rinkeby, mumbai, etc..)

ConsecutiveTransfer Event

We use the ConsecutiveTransfer event of EIP-2309 during the Mint Phase.

Known marketplaces that support the EIP-2309 Standard:

• Opensea
• LooksRare

Roadmap

• Implement Pre-Mint for ERC1155
• Add support for Upgradeable Contracts
• Eliminate the Max-Supply and bring back the “allTokens” array.

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".

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

Running tests locally

npm run test

OR

yarn test

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

• Rob Secord (owner) - @RobSecord

Project Links:

• https://github.com/Charged-Particles/peppermint
• https://www.npmjs.com/package/@charged-particles/peppermint

Brought to you with Love

At Charged Particles & Taggr we strive to provide the greatest and most advanced tools for your NFT projects. We're always thrilled to innovate and share our developments with the crypto-community!

Don't forget to give the project a star! Thank You!

Charged Particles

Taggr