Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
channing-magiceden committed Mar 2, 2024
1 parent 02f62d6 commit 9d90f08
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -8,7 +12,7 @@ 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.
Expand All @@ -17,36 +21,33 @@ The composability of the stages is generic enough to enable flexible and complic
<img src="https://bafkreid7sfgi5tycdvbdtobl3mqnwjlrlawdgioaj6vxvtcmmda74doh7q.ipfs.nftstorage.link/" width="50%" >
</p>

## 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

<b>Built with</b>
- [hardhat](https://hardhat.org)
- [ERC721A](https://github.com/chiru-labs/ERC721A), ERC721M is based on the popular ERC721A contract.
- [ERC721C](https://github.com/limitbreakinc/creator-token-standards), extends ERC721 and add creator-definable transfer security profiles that are the foundation for enforceable, programmable royalties
- [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. |

Expand Down Expand Up @@ -104,3 +105,13 @@ We are targeting 100% lines coverage.
## License

MIT © [MagicEden Open Source](https://github.com/magiceden-oss)


<!-- MARKDOWN LINKS & IMAGES -->

[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

0 comments on commit 9d90f08

Please sign in to comment.