What is the correct format for mintpass CSV files on Stacks?

If you're a creator deploying your collection using the Creators Self Service Portal, you'll have the option to create and upload a custom CSV file containing mintpass information. While this is an optional association, it can help set your collection apart from others, and provide added benefits relative to collections without them. We'll explain exactly how to format your file so you can easily add it to your collection if desired.

You can create a CSV file using many different applications, but the most common method would be to use Microsoft Excel or Google Sheets. These files can be exported as a CSV file when downloading them.

Mintpass CSV File

A mintpass is used to allow specific, pre-defined wallet addresses to mint NFTs from your collection ahead of its public sale. The file for mintpass is quite straightforward, simply requiring wallet addresses in one column, and the maximum mint limit in a second column.

During the mintpass sale period on mintpass-enabled collections, the smart contract will automatically check claim (i.e. mint) transactions for presence on the mintpass list and will ensure there are remaining mints within the max mint limit. If any mints remain, it will allow the mint to occur. If the address claiming is not on the list or has no remaining mints within its limit, then the transaction will fail. This enables only the addresses with a mintpass allocation to mint up to their mint limit, until the public sale is initiated, if it is.

Addresses must be entered as original STX addresses as the smart contract mintpass functionality does not support BNS names (e.g. mintpass addresses must be "SP...XYZ" versus "wallet.btc").

Here is an example of the file format needed for mintpass CSV. There should be no headings on the mintpass CSV file.

In this scenario, the addresses ending in A and B will be able to mint a maximum of 1 NFT from your collection during the mintpass sale period. Likewise, the addresses ending in C, D, and E will be able to mint a maximum of 2 NFTs from your collection during the mintpass sale period.

After the mintpass sale period is over, the listed addresses, and any other address regardless of its presence on the mintpass CSV file, will be able to mint any number of NFTs up to the maximum limit set for the entire collection. The upper limit by default will be the total number of tokens you submitted assets for, but this limit may be permanently lowered if the need arises via the Creator Admin Menu.

While the portal will accept any number of addresses as part of your mintpass, in cases of an extremely large number of defined wallet addresses, it's possible that your smart contract exceeds the size limitations of a Stacks transaction, and your smart contract will not successfully deploy. If you have fewer than a reasonably large number, for example, a thousand addresses, this is unlikely to be an issue.