diff --git a/README.md b/README.md index 6d0c6fe..1a5548f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -## ERC721M +# ERC721M + +[![NPM][npm-shield]][npm-url] +[![CI][ci-shield]][ci-url] +[![MIT License][license-shield]][license-url] ERC721M is a EVM minting protocol that enables the multi stage minting, per stage WL management, per stage supply limit, and crossmint support. @@ -8,43 +12,42 @@ We'd like to introduce the standard of "minting stages". At each stage, the crea - per-stage price - per-stage walletLimit -- per-stage merkleRoot +- per-stage merkleRoot(whitelist) - per-stage maxStageSupply The composability of the stages is generic enough to enable flexible and complicated EVM minting contracts. -![](https://bafkreid7sfgi5tycdvbdtobl3mqnwjlrlawdgioaj6vxvtcmmda74doh7q.ipfs.nftstorage.link/) - - -## Build status -![github ci status](https://github.com/magiceden-oss/erc721m/actions/workflows/ci.yml/badge.svg?branch=main) - -![npm](https://img.shields.io/npm/v/@magiceden-oss/erc721m?color=green) +

+ +

-## Tech/framework used +## Tech/ Framework Built with -- [hardhat](https://hardhat.org) -- [ERC721A](https://github.com/chiru-labs/ERC721A), ERC721M is based on the popular ERC721A contract. +- [Hardhat](https://hardhat.org) +- [ERC721A](https://github.com/chiru-labs/ERC721A) by Azuki. Fully compliant implementation of IERC721 with significant gas savings for batch minting. +- [ERC721C](https://github.com/limitbreakinc/creator-token-standards) by LimitBreak. Extends ERC721 and add creator-definable transfer security profiles that are the foundation for enforceable, programmable royalties. ## Features - Minting Stages - Permenent BaseURI Support - Non-incresing Max Total Supply Support -- Per-stage WL Merkle Tree +- Per-stage whitelist Merkle Tree - Per-stage Max Supply - Global and Per-stage Limit +- Crossmint support - Native TypeScript and Typechain-Types Support ## Contracts | Contract | Description | |-------------------------|---------------------------------------------------------------------------------------| -| ERC721M | The basic minting contract | +| ERC721M | The basic minting contract based on ERC721A. | +| ERC721CM | The basic minting contract based on ERC721C and ERC721M. | +| ERC721CMRoyalties | Based on ERC721CM, implementing ERC2981 for on-chain royalty. | | ERC721MLite | The lite version of ERC721M | | ERC721MOperatorFilterer | ERC721M with OpenSea Operator Filterer | -| ERC721MOnft | ERC721M with LayerZero bridging. The contract is on beta. Use at your own risk. | | BucketAuction | Bucket auction style minting contract. The contract is on beta. Use at your own risk. | | DutchAuction | Dutch auction style minting contract. The contract is on beta. Use at your own risk. | @@ -102,3 +105,13 @@ We are targeting 100% lines coverage. ## License MIT © [MagicEden Open Source](https://github.com/magiceden-oss) + + + + +[ci-shield]: https://img.shields.io/github/actions/workflow/status/magiceden-oss/erc721m/ci.yml?label=build&style=for-the-badge&branch=main +[ci-url]: https://github.com/magiceden-oss/erc721m/actions/workflows/run_tests.yml +[npm-shield]: https://img.shields.io/npm/v/@magiceden-oss/erc721m.svg?style=for-the-badge +[npm-url]: https://www.npmjs.com/package/@magiceden-oss/erc721m +[license-shield]: https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge +[license-url]: https://github.com/magiceden-oss/erc721m/blob/main/LICENSE.txt diff --git a/package.json b/package.json index ea0b142..979bb98 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@magiceden-oss/erc721m", - "version": "0.0.11", + "version": "0.1.0", "description": "erc721m contract for Solidity", "files": [ "/contracts/**/*.sol",