lza_menace 7fb6cb00fd | 2 years ago | |
---|---|---|
.. | ||
.github/workflows | 2 years ago | |
contracts | 2 years ago | |
docs | 2 years ago | |
scripts/release | 2 years ago | |
test | 2 years ago | |
.eslintrc | 2 years ago | |
.gitignore | 2 years ago | |
.prettierrc | 2 years ago | |
LICENSE.txt | 2 years ago | |
README.md | 2 years ago | |
hardhat.config.js | 2 years ago | |
package-lock.json | 2 years ago | |
package.json | 2 years ago |
README.md
📢 Version 4.x introduces several breaking changes. Please refer to the documentation for more details.
We highly recommend reading the migration guide, especially the part on supportsInterface
if you are using with OpenZeppelin extensions (e.g. ERC2981).
About The Project
The goal of ERC721A is to provide a fully compliant implementation of IERC721 with significant gas savings for minting multiple NFTs in a single transaction. This project and implementation will be updated regularly and will continue to stay up to date with best practices.
The Azuki team created ERC721A for its sale on 1/12/22. There was significant demand for 8700 tokens made available to the public, and all were minted within minutes. The network BASEFEE remained low despite huge demand, resulting in low gas costs for minters, while minimizing network disruption for the wider ecosystem as well.
For more information on how ERC721A works under the hood, please visit our blog. To find other projects that are using ERC721A, please visit erc721a.org and our curated projects list.
Chiru Labs is not liable for any outcomes as a result of using ERC721A. DYOR.
Docs
https://chiru-labs.github.io/ERC721A/
Upgradeable Version
https://github.com/chiru-labs/ERC721A-Upgradeable
Installation
npm install --save-dev erc721a
Usage
Once installed, you can use the contracts in the library by importing them:
pragma solidity ^0.8.4;
import "erc721a/contracts/ERC721A.sol";
contract Azuki is ERC721A {
constructor() ERC721A("Azuki", "AZUKI") {}
function mint(uint256 quantity) external payable {
// `_mint`'s second argument now takes in a `quantity`, not a `tokenId`.
_mint(msg.sender, quantity);
}
}
Roadmap
- Improve general repo and code quality (workflows, comments, etc.)
- Add more documentation on benefits of using ERC721A
- Maintain full test coverage
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".
Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Running tests locally
npm install
npm run test
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
- 2pm.flow (owner) - @2pmflow
- location tba (owner) - @locationtba
- cygaar (maintainer) - @0xCygaar
- vectorized.eth (maintainer) - @optimizoor
Project Link: https://github.com/chiru-labs/ERC721A