# erc721a-upgradeable > ERC721A Upgradeable contract for Solidity Latest version **4.3.0** (published 2024-03-04) · ISC license · 0 weekly downloads ## Install ```sh npm install erc721a-upgradeable pnpm add erc721a-upgradeable yarn add erc721a-upgradeable bun add erc721a-upgradeable ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 4.3.0 | | Published | 2024-03-04 | | First published | 2022-04-05 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 91.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 161 | | Author | chiru-labs | | Maintainers | chirulabs | ## Links - npm: https://www.npmjs.com/package/erc721a-upgradeable - Repository: https://github.com/chiru-labs/ERC721A-Upgradeable - Homepage: https://github.com/chiru-labs/ERC721A-Upgradeable#readme - Issues: https://github.com/chiru-labs/ERC721A-Upgradeable/issues - npm.io page: https://npm.io/package/erc721a-upgradeable ## Recent versions - 4.3.0 (latest) — 2024-03-04 - 4.2.3 — 2022-11-20 - 4.2.2 — 2022-08-12 - 4.2.1 — 2022-07-24 - 4.2.0 — 2022-07-19 - 4.1.0 — 2022-06-15 - 4.0.0 — 2022-05-26 - 3.3.0 — 2022-05-07 - 3.2.0 — 2022-04-11 - 0.0.0 — 2022-04-05 ## README [![Docs][docs-shield]][docs-url] [![NPM][npm-shield]][npm-url] [![CI][ci-shield]][ci-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] > **📢 Version 4.x introduces several breaking changes. [Please refer to the documentation for more details.](https://chiru-labs.github.io/ERC721A/#/migration)** _We highly recommend reading the migration guide_, **especially** _the part on [`supportsInterface`](https://chiru-labs.github.io/ERC721A/#/migration?id=supportsinterface) if you are using with OpenZeppelin extensions_ (e.g. ERC2981). ## About The Project This repository hosts the Upgradeable variant of [ERC721A](https://github.com/chiru-labs/ERC721A), meant for use in upgradeable contracts. This variant is available as separate package called `erc721a-upgradeable`. This version uses the [diamond storage layout pattern](https://eips.ethereum.org/EIPS/eip-2535). It follows all of the rules for [Writing Upgradeable Contracts]: constructors are replaced by initializer functions, state variables are initialized in initializer functions, and we additionally check for storage incompatibilities across minor versions. [writing upgradeable contracts]: https://docs.openzeppelin.com/upgrades-plugins/writing-upgradeable > **Warning** > > There will be storage incompatibilities across major versions of this package, which makes it unsafe to upgrade a deployed contract from one major version to another, for example from 3.4.0 to 4.0.0. > > **It is strongly encouraged to use these contracts together with a tool that can simplify the deployment of upgradeable contracts, such as [OpenZeppelin Upgrades Plugins](https://github.com/OpenZeppelin/openzeppelin-upgrades).** This repository is generated by a transpiler. **Chiru Labs is not liable for any outcomes as a result of using ERC721A and ERC721A-Upgradeable.** DYOR. ## Docs https://chiru-labs.github.io/ERC721A/ ## Installation ```sh npm install --save-dev erc721a-upgradeable ``` ## Usage Once installed, you can use the contracts in the library by importing them: ```solidity pragma solidity ^0.8.4; import 'erc721a-upgradeable/contracts/ERC721AUpgradeable.sol'; import '@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol'; contract Something is ERC721AUpgradeable, OwnableUpgradeable { // Take note of the initializer modifiers. // - `initializerERC721A` for `ERC721AUpgradeable`. // - `initializer` for OpenZeppelin's `OwnableUpgradeable`. function initialize() initializerERC721A initializer public { __ERC721A_init('Something', 'SMTH'); __Ownable_init(); } function mint(uint256 quantity) external payable { // `_mint`'s second argument now takes in a `quantity`, not a `tokenId`. _mint(msg.sender, quantity); } function adminMint(uint256 quantity) external payable onlyOwner { _mint(msg.sender, quantity); } } ``` ## Contributing This repository is automatically transpiled from the main [ERC721A](https://github.com/chiru-labs/ERC721A) repository by a workflow. Any changes to the `contracts` and `test` directories will be overwritten. If you want to make a contribution to the transpiler workflow: 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request ### Running tests locally 1. `npm install` 2. `npm run test` ## License Distributed under the MIT License. See `LICENSE.txt` for more information. ## Contact - 2pm.flow (owner) - [@2pmflow](https://twitter.com/2pmflow) - location tba (owner) - [@locationtba](https://twitter.com/locationtba) - cygaar (maintainer) - [@cygaar_dev](https://twitter.com/cygaar_dev) - vectorized.eth (maintainer) - [@optimizoor](https://twitter.com/optimizoor) Project Link: [https://github.com/chiru-labs/ERC721A-Upgradeable](https://github.com/chiru-labs/ERC721A-Upgradeable) [docs-shield]: https://img.shields.io/badge/docs-%F0%9F%93%84-blue?style=for-the-badge [docs-url]: https://chiru-labs.github.io/ERC721A/#/upgradeable [npm-shield]: https://img.shields.io/npm/v/erc721a-upgradeable.svg?style=for-the-badge [npm-url]: https://www.npmjs.com/package/erc721a-upgradeable [ci-shield]: https://img.shields.io/github/actions/workflow/status/chiru-labs/ERC721A-Upgradeable/run-tests.yml?label=build&style=for-the-badge&branch=main [ci-url]: https://github.com/chiru-labs/ERC721A-Upgradeable/actions/workflows/run-tests.yml [issues-shield]: https://img.shields.io/github/issues/chiru-labs/ERC721A-Upgradeable.svg?style=for-the-badge [issues-url]: https://github.com/chiru-labs/ERC721A-Upgradeable/issues [license-shield]: https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge [license-url]: https://github.com/chiru-labs/ERC721A-Upgradeable/blob/main/LICENSE.txt --- _Source: https://npm.io/package/erc721a-upgradeable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._