Giter Site home page Giter Site logo

anastur / erc721m Goto Github PK

View Code? Open in Web Editor NEW

This project forked from me-foundation/magicdrop

0.0 0.0 0.0 1.38 MB

ERC721M is a EVM minting protocol that enables the multi stage minting, per stage WL management, per stage supply limit, and crossmint support.

License: MIT License

JavaScript 0.17% TypeScript 72.93% Solidity 26.90%

erc721m's Introduction

ERC721M

NPM CI MIT License Coverage

ERC721M is a EVM minting protocol that enables the multi stage minting, per stage WL management, per stage supply limit, and crossmint support.

Motivation

We'd like to introduce the standard of "minting stages". At each stage, the creators can define the following properties:

  • per-stage price
  • per-stage walletLimit
  • per-stage merkleRoot(whitelist)
  • per-stage maxStageSupply

The composability of the stages is generic enough to enable flexible and complicated EVM minting contracts.

Tech/ Framework

Built with

  • Hardhat
  • ERC721A by Azuki. Fully compliant implementation of IERC721 with significant gas savings for batch minting.
  • ERC721C 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 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 based on ERC721A.
ERC721CM The basic minting contract based on ERC721C and ERC721M.
ERC721CMRoyalties Based on ERC721CM, implementing ERC2981 for on-chain royalty.
ERC721MOperatorFilterer ERC721M with OpenSea Operator Filterer
BucketAuction Bucket auction style minting contract. The contract is on beta. Use at your own risk.

Please read ERC721M Contract Usage Guide for more details.

Installation

Provide step by step series of examples and explanations about how to get a development env running.

npm add @magiceden-oss/erc721m

Code Example

import { ERC721M, ERC721M__factory } from '@magiceden-oss/erc721m';

const contract = ERC721M__factory.connect(
  contractAddress,
  signerOrProvider,
);

API Reference

# Compile the contract
npm run build

# Get the auto generated typechain-types
./typechain-types

Tests

npm run test

We are targeting 100% lines coverage.

Security

Bounty Program

Used By

License

MIT © MagicEden Open Source

erc721m's People

Contributors

channing-magiceden avatar mi-yu avatar nothing0012 avatar destinymagicchen avatar henry-magiceden avatar me-gozer avatar arivictor avatar magicfish23 avatar macelai avatar magicbok avatar cygaar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.