Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.17 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.17 KB

Music NFT Metadata

This minimalist npm package contains Typescript typings for the evolving music nft metadata standard defined in collaboration with Mint Songs and Catalog. Reference docs can be found here and here

Usage

Full Schema Type

import type { MusicNftMetadataSchema } from 'music-nft-metadata';

const uploadMetadata(metadata: MusicNftMetadataSchema) => {
    // upload logic
}

Required Schema Type

import type { RequiredValues } from 'music-nft-metadata';

const uploadMetadata(requiredMetadata: RequiredValues) => {
    // upload logic
}

Optional Schema Type

import type { OptionalValues } from 'music-nft-metadata';

const uploadMetadata(optionalMetadata: OptionalValues) => {
    // upload logic
}

OpenSea Standard Schema Type

import type { OpenSeaStandardValues } from 'music-nft-metadata';

const uploadMetadata(openseaMetadata: OpenSeaStandardValues) => {
    // upload logic
}

Other exported types

Attributes Artwork Project Visualizer Lyrics Credit