MMM-NFTcollections

MagicMirror module for displaying an NFT collection with the number of minted avatars and a progress bar.

The module is displaying some of the collection's details (see the list below) using the Alchemy API that reads data from the blockhain and from the Opensea:

• Name
• Image
• Nb. of minted avatars with progress bar

Installation

cd ~/MagicMirror/modules
git clone https://github.com/TemianMihai/MMM-NFTcollections.git
cd MMM-NFTcollections
npm install

Alchemy API Key

Alchemy combines the most powerful web3 developer products and tools with resources, community and legendary support.

Get your free API key here: https://dashboard.alchemy.com/

Free account has a limit of 330 compute units per seconds. This should be more than enough if you are fetching date once per minute. For more info please check this docs: https://docs.alchemy.com/reference/throughput

Configuration

{
  module: "MMM-NFTcollections",
  position: "bottom_bar",
  config: {
    apiKey: "YOUR_ALCHEMY_KEY",
    network: "THE_COLLECTION_NETWORK",
    contractAddress: "THE_COLLECTION_CONTRACT_ADDRESS",
    maxSupply: 3000,
    updateInterval: 60000
  }
},

Configuration Options

Option	Type	Default	Description
apiKey	string	''	Your API Key obtained from https://dashboard.alchemy.com/ (limited to 330 CPUS/s)
network	string	''	The network on whick the collection is deployed. Most of them are deployed on ETH Mainnet, but this module also supports testnets. Supported options: eth-mainnet, eth-goerli, matic-mainnet, matic-mumbai etc. For more info and values please check https://github.com/alchemyplatform/alchemy-sdk-js/blob/main/docs-md/enums/Network.md/
contractAddress	string	''	The contract address associated with the collection. E.g: 0xe785e82358879f061bc3dcac6f0444462d4b5330 for World of Women collection
masSupply	integer	0	Set the max nb. of avatars that can be minted for the progress bar to work.
updateInterval	integer	60000	Set the interval in milliseconds for how often the details should update.