ERC721Generative

ERC721Generative

Git Source

Inherits: Owned, ERC721Burnable, ERC721Royalty, ERC721Metadata_URI_autoIncrementID, ERC721Enumerable

Author: cosimo.demedici.eth *

Self-sovereign ERC-721 Generative art minter preset *

State Variables

FACTORY

Address of the factory contract

address private immutable FACTORY;

scriptStorageAddress

Address of the deployed contract containing the script

address public scriptStorageAddress;

feeRecipient

Address to receive fees

address public feeRecipient;

feeAmount

Amount of fees

uint256 public feeAmount;

dropTime

Time when the NFT drop will happen

uint256 public dropTime;

dropDurationAL

Duration of the AL drop

uint256 public dropDurationAL;

dropDurationPublic

Duration of the public drop

uint256 public dropDurationPublic;

ALPrice

Price for addresses in the allow list

uint256 public ALPrice;

publicPrice

Price for the public

uint256 public publicPrice;

maxSupply

Maximum supply of the NFT

uint256 public maxSupply;

merkleRoot

Merkle root for the whitelist

bytes32 public merkleRoot;

Functions

onlyBeforeDropStart

Modifier to check if the current time is before the drop start

modifier onlyBeforeDropStart();

onlyBeforeALDropEnd

Modifier to check if the current time is before the AL drop end

modifier onlyBeforeALDropEnd();

constructor

Constructor that sets the factory address.

constructor(address factory_);

Parameters

Name	Type	Description
factory_	address	of the factory contract constant set at deployment of master contract, replaces initializer modifier reducing the cost of calling initialize from the factory contract whenever a new clone is deployed.

mint

Function to mint a new NFT.

Mints a new NFT if the conditions are met. The conditions include checking the Merkle proof for the address, checking if the value sent with the transaction matches the price, and checking if the maximum supply has not been reached.

function mint(
    address _to,
    bytes32[] calldata _merkleProof,
    bytes memory _data
)
    external
    payable
    returns (uint256 _tokenId);

Parameters

Name	Type	Description
_to	address	The address to mint the NFT to.
_merkleProof	bytes32[]	The Merkle proof for the address.
_data	bytes	Additional data to accompany the mint function.

Returns

Name	Type	Description
_tokenId	uint256	The ID of the minted NFT.

_mint

Overrides the _mint function of the base contract and all extensions

Calls parent functions from the most derived to the most base contract: ERC721Metadata_URI, ERC721Royalty, ERC721

function _mint(address _to, uint256 _id, bytes memory _data) internal override(ERC721Royalty, ERC721);

Parameters

Name	Type	Description
_to	address	The address to mint the NFT to.
_id	uint256	The ID of the NFT to mint.
_data	bytes	Additional data to accompany the mint function.

_burn

Overrides the _burn function of the base contract and all extensions

Deletes royalty info from storage

function _burn(uint256 _tokenId) internal override(ERC721Royalty, ERC721);

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the NFT to burn.

withdraw

Withdraws the contract balance to the fee recipient and the owner

No need to add non reentrant modifier as the feeRecipient is set by the owner we assume it is a trusted address

function withdraw() external;

setScript

Sets the script for the contract

Only callable by the owner before the drop start

function setScript(bytes calldata _script) external onlyBeforeDropStart onlyOwner;

Parameters

Name	Type	Description
_script	bytes	The script to set

setMerkleRoot

Sets the Merkle root for the contract

Only callable by the owner

function setMerkleRoot(bytes32 _merkleRoot) external onlyOwner;

Parameters

Name	Type	Description
_merkleRoot	bytes32	The Merkle root to set

setBaseURI

Sets the base URI for the contract

Only callable by the owner

function setBaseURI(string memory baseURI_, address deployedContract_) external onlyOwner;

Parameters

Name	Type	Description
baseURI_	string	The base URI to set
deployedContract_	address	The address of the deployed contract

setDropTime

Sets the drop time for the contract

Only callable by the owner before the AL drop end

function setDropTime(uint256 _newDropTime) external onlyOwner onlyBeforeALDropEnd;

Parameters

Name	Type	Description
_newDropTime	uint256	The new drop time to set

setMaxSupply

Sets the maximum supply for the contract

Only callable by the owner before the drop start

function setMaxSupply(uint256 maxSupply_) external onlyOwner onlyBeforeDropStart;

Parameters

Name	Type	Description
maxSupply_	uint256	The new maximum supply to set

setDropDurationAL

Sets the AL drop duration for the contract

Only callable by the owner before the AL drop end

function setDropDurationAL(uint256 _newDropDurationAL) external onlyOwner onlyBeforeALDropEnd;

Parameters

Name	Type	Description
_newDropDurationAL	uint256	The new AL drop duration to set

setDropDurationPublic

Sets the public drop duration for the contract

Only callable by the owner

function setDropDurationPublic(uint256 _newDropDurationPublic) external onlyOwner;

Parameters

Name	Type	Description
_newDropDurationPublic	uint256	The new public drop duration to set

setALPrice

Sets the AL price for the contract

Only callable by the owner before the drop start

function setALPrice(uint256 ALPrice_) external onlyOwner onlyBeforeDropStart;

Parameters

Name	Type	Description
ALPrice_	uint256	The new AL price to set

setPublicPrice

Sets the public price for the contract

Only callable by the owner before the drop start

function setPublicPrice(uint256 publicPrice_) external onlyOwner onlyBeforeDropStart;

Parameters

Name	Type	Description
publicPrice_	uint256	The new public price to set

setFeeRecipient

Sets the fee recipient for the contract

Only callable by the owner

function setFeeRecipient(address feeRecipient_) external onlyOwner;

Parameters

Name	Type	Description
feeRecipient_	address	The new fee recipient to set

setFeeAmount

Sets the fee amount for the contract

Only callable by the owner

function setFeeAmount(uint256 feeAmount_) external onlyOwner;

Parameters

Name	Type	Description
feeAmount_	uint256	The new fee amount to set

setDefaultRoyalty

Sets the default royalty for the contract

Only callable by the owner

function setDefaultRoyalty(address _receiver, uint96 _feeNumerator) external onlyOwner;

Parameters

Name	Type	Description
_receiver	address	The address to receive the royalty
_feeNumerator	uint96	The fee numerator for the royalty

setTokenRoyalty

Sets the royalty for a specific token

Only callable by the owner

function setTokenRoyalty(uint256 _tokenId, address _receiver, uint96 _feeNumerator) external onlyOwner;

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the token
_receiver	address	The address to receive the royalty
_feeNumerator	uint96	The fee numerator for the royalty

exists

Checks if a token exists.

function exists(uint256 _id) external view returns (bool);

Parameters

Name	Type	Description
_id	uint256	The token ID to check.

Returns

Name	Type	Description
<none>	bool	A boolean indicating if the token exists.

getScript

Reads the script from the contract.

function getScript() external view returns (string memory);

Returns

Name	Type	Description
<none>	string	The script as a string.

supportsInterface

Checks if the contract supports a given interface.

function supportsInterface(bytes4 interfaceId) external pure returns (bool);

Parameters

Name	Type	Description
interfaceId	bytes4	The interface ID to check.

Returns

Name	Type	Description
<none>	bool	A boolean indicating if the contract supports the interface.

receive

Fallback function that allows the contract to receive funds.

receive() external payable;

initialize

Initializes the contract, setting the initial state and granting roles.

function initialize(bytes calldata _data) external;

Parameters

Name	Type	Description
_data	bytes	The initialization data.