Skip to content

Latest commit

 

History

History
140 lines (92 loc) · 5.28 KB

README.md

File metadata and controls

140 lines (92 loc) · 5.28 KB
Raw

Docs NPM CI Issues MIT License

📢 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

This repository hosts the Upgradeable variant of 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.

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.

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.

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

npm install --save-dev erc721a-upgradeable

Usage

Once installed, you can use the contracts in the library by importing them:

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

Project Link: https://github.com/chiru-labs/ERC721A-Upgradeable