base-nft-contract v0.1.5

About

Base NFT collection contract written in Solidity. It includes Enumerable, Royalty, multiple minting, and team minting features.

It extends OpenZeppelin ERC721 implementation and can be used for NFT collections with consecutive token numbers.

Features

• Public mint() and mintMultiple() functions
• teamMint() function that can be called only by the owner
• withdraw() function implementation
• Ability to update the base URI
• Ability to change the price
• Royalty implementation
• Light IERC721Enumerable implementation (Check caveats)
• Tokens start with 1 not 0

Caveats

OpenZeppelin ERC721Enumerable implementation was not used because it doubles the gas usage for minting and transferring tokens. Instead, we opted for writing a simple implementation for tokenOfOwnerByIndex() by looping over all tokens, this makes tokenOfOwnerByIndex() very inefficient and can't be called from other contracts. The same idea is used in the Azuki contract.

If you want to call tokenOfOwnerByIndex() from another contract, use OpenZeppelin ERC721Enumerable implementation instead.

Usage

npm install base-nft-contract

Once installed, write your contract and extend BaseNFTCollection:

pragma solidity ^0.8.19;

import "base-nft-contract/contracts/BaseNFTCollection.sol";

contract MyNFTCollection is BaseNFTCollection {

    constructor(uint price_, string memory baseUrl_, uint maxTokens_, uint firstMintNumber, uint96 feeNumerator) BaseNFTCollection(price_, baseUrl_, maxTokens_, firstMintNumber, feeNumerator) ERC721("My NFT Collection", "MNC") {}

}

Make sure to update the class name, and your NFT collection name and symbol.

You can also create a contract with default parameters:

pragma solidity ^0.8.19;

import "base-nft-contract/contracts/BaseNFTCollection.sol";

contract MyNFTCollection is BaseNFTCollection {

    constructor() BaseNFTCollection(10000000000000000, "https://yourbase.url/nft/", 5000, 40, 250) ERC721("My NFT Collection", "MNC") {}

}

Parameters:

• price_: Price of 1 NFT - ex: 10000000000000000 = 0.01 eth
• baseUrl_: Base URI for computing each token URI
• maxTokens_: Maximum number of tokens
• firstMintNumber: How many NFTs will be minted and transferred to the owner when deployed
• feeNumerator: Royalty fraction - ex: 250 = 2.5%