Music-metadata-ipfs NPM

Music NFT IPFS Metadata

Standard for musicians pioneered by Catalog & Mint Songs.

Compatible with contracts created by:

- WARNING: this code is unaudited

Get Started

To add music NFT metadata to your next music NFT drop, just

install with NPM

npm i music-metadata-ipfs

or install with Yarn

yarn add music-metadata-ipfs

Configure your API key

set your .env.local file with NEXT_PUBLIC_NFT_STORAGE_API_KEY=YOUR_API_KEY
get a free API key from nft.storage

Usage

import { MusicMetadataProvider } from 'music-metadata-ipfs'
wrap your Music Metadata Form in a <MusicMetadataProvider>.
import { useMusicMetadata } from 'music-metadata-ipfs'
const { metadata, setMetadata, createIpfsMetadata } = useMusicMetadata()
modify music metadata: onChange={(e) => setMetadata({ ...metadata, image: e })}
upload your metadata to IPFS: const ipfs = await createIpfsMetadata()
take your music metadata to any ERC721 token contract (Catalog, Manifold, Zora, Sound, etc.)

Example Music NFT:

import MusicMetadataForm from '...'
import { MusicMetadataProvider } from 'music-metadata-ipfs'

const MusicNFTMinter = () => {
  return (
    <MusicMetadataProvider>
      <MusicMetadataForm />
    </MusicMetadataProvider>
  )
}

export default MusicNFTMinter