Music Token Metadata
Abstract
This proposal defines an extension to CIP-25 and CIP-68 for token metadata specific to music tokens.
Motivation: why is this CIP necessary?
Music tokens on Cardano can be either NFTs or FTs and contain links to audio files. In order for players, indexers, and wallets to be able to properly search and categorize a user's music collection, we need to define a common schema for creating music on Cardano. If all parties creating these music tokens follow similar patterns, apps can consume this information and make proper use of it. The existing CIP-25 is a good base to build upon, but for a good music experience, we need to standardize additional fields that will be required specifically for music tokens.
Specification
This CIP divides the additional metadata parameters into two categories of Required and Optional. When minting a music token on Cardano, you are expected to include ALL of the required fields. If you choose to include one or more of the optional fields, they must be named exactly as defined in this CIP. This will properly allow indexing apps and music players to utilize as much of your token metadata as possible without issues.
CDDL Spec Version 2 CDDL Spec Version 1 (deprecated)
Summary of v2 Changes
In version 2 of the CIP-60 spec, album_title has been renamed to release_title. release is a more generic name that covers all types of releases from Albums, EPs, LPs, Singles, and Compilations. At the top level, we are grouping those metadata items that relate to the release under a new key release. At the file for each song, there is a new song key that holds the metadata specific to the individual song. These changes separate the music-specific metadata from the general CIP-25/CIP-68 NFT metadata. A music player can look at just the information necessary instead of having to ignore extra NFT-related fields. CIP-68 NFTs are officially supported and an example specific to CIP-68 has been added below.
Required Fields
| Field | Type | Example(s) | Notes |
|---|---|---|---|
| artists | Array<Artist> | "artists": [ { "name": "Stevie Nicks" },{ "name": "Tom Petty" }] | |
| release_title | String | "release_title": "Mr. Bad Guy" | |
| track_number | Integer | "track_number": 1 | |
| song_title | String | Array<String> | "song_title": "Let's Turn it On" | |
| song_duration | String | "song_duration": "PT3M21S" | ISO8601 Duration Format |
| genres | Array<String> | "genres": ["Rock","Classic Rock"] | Limited to 3 genres total. Players should ignore extra genres. |
| copyright | String | "copyright": "℗ 1985 Sony Records" | |
| release_type | Enum<String> | "release_type": "Single" | Must be one of "Single" or "Multiple". Multiple includes anything that will have multiple tracks: Album, EP, Compilation, etc... |
| music_metadata_version | Integer | "music_metadata_version" : 1 | Players should look for the presence of this field to determine if the token is a Music Token |
Optional Fields
| Field | Type | Example(s) | Notes |
|---|---|---|---|
| contributing_artists | Array<Artist> | "contributing_artists": ["Dolly Parton"]or"contributing_artists": ["Brad Paisley","Keith Urban"] | |
| series | string | "series": "That's What I call Music" | |
| collection | string | "collection": "Now Dance" | |
| set | string | "set": "86 - 20 Smash Dance Hits of the Year" | |
| mood | String | "mood": "Empowered" | |
| lyrics | URL | "lyrics": "ipfs://QmSmadTEhB9bJQ1WHq58yN1YZaJo4jv5BwVNGaePvEj4Fy"or"Lyrics": "https://website.com/song_lyrics.txt" | |
| lyricists | Array<String> | "lyricists": ["Paul McCartney", "John Lennon"] | |
| special_thanks | Array<String> | "special_thanks": ["Your mom","Your grandma"] | |
| visual_artist | String | "visual_artist": "beeple" | |
| distributor | String | "distributor": "https://newm.io" | |
| release_date | String | "release_date": "2022-07-27" | ISO8601 Date Format |
| publication_date | String | "publication_date": "2022-07-27" | ISO8601 Date Format |
| catalog_number | Integer | "catalog_number": 2 | |
| bitrate | String | "bitrate": "256 kbit/s" | |
| bpm | String | "bpm": "120 BPM" | |
| mix_engineer | String | "mix_engineer": "Robert Smith II" | |
| mastering_engineer | String | "mastering_engineer": "Michael Tyson" | |
| producer | String | "producer": "Simon Cowell" | |
| co_producer | String | "co_producer": "Shavaun Dempsey" | |
| featured_artist | Artist | "featured_artist": {"name": "The Temptations"} | |
| recording_engineer | String | "recording_engineer": "Sharon Liston" | |
| release_version | Integer | "release_version": 2 | |
| parental_advisory | String | "parental_advisory": "Explicit" | Explicit/Censored/Non-Explicit |
| explicit | Boolean | "explicit": true | |
| isrc | String | "isrc": "US-SKG-22-12345" | |
| iswc | String | "iswc": "T-123456789-Z" | |
| ipi | Array<String> | "ipi": ["595014347","342287075","550983139"] | |
| ipn | Array<String> | "ipn": ["38474593","2734040"] | |
| isni | Array<String> | "isni": ["000000038578365X","0000000037234532X"] | |
| metadata_language | String | "metadata_language": "en-US" | https://tools.ietf.org/search/bcp47 |
| country_of_origin | String | "country_of_origin": "United States" | |
| language | String | "language": "en-US" | https://tools.ietf.org/search/bcp47 |
| derived_from | String | "derived_from" : "Some other work" | |
| links | Map<String,String> | "links" : {"website": "https://website.com","twitter": "https://twitter.com/username","discord_invite": "https://discord.gg/TEzXxjsN","TikTok": "https://www.tiktok.com/@knucklebumpfarms","discord_username": "MusicianPerson#8537","instagram":"...","facebook":"...","soundcloud": "...","bandcamp": "...","spotify": "...","apple_music": "...",......} |
Examples
Single
{
"721":
{
"123da5e4ef337161779c6729d2acd765f7a33a833b2a21a063ef65a5":
{
"SickCity354":
{
"name": "SickCity354-Phil z'viel",
"image": "ipfs://QmQ13Cv9Wouf4rcwtNsuFhEeJVK9bEYjCYo6AN986takiu",
"music_metadata_version": 2,
"release": {
"release_type": "Single",
"release_title": "C.H.I.L.L.",
"distributor": "https://sickcity.xyz"
}
"files":
[
{
"name": "C.H.I.L.L.",
"mediaType": "audio/mp3",
"src": "ipfs://QmfY4ugNdYYJxpbn5BnN8yt5EmiUCznexQoQi6RTEu9SuC"
"song": {
"song_title": "C.H.I.L.L.",
"song_duration": "PT3M6S",
"track_number": 1,
"mood": "chillout",
"artists":
[
{ "name": "Phil z'viel" }
],
"collection": "C.H.I.L.L.",
"genres":
[
"Guitar Live Looping",
"Progressive Ambient"
],
"copyright": "℗ 2022 Phil z'viel",
"links":
{
"discord_user": "Phil z'viel#4711",
"twitter": "@Phil_zviel_CNFT",
"website": "www.philzvielcnft.com"
}
}
}
],
}
}
}
}Multiple
{
"fb818dd32539209755211ab01cde517b044a742f1bc52e5cc57b25d9":
{
"JamisonDanielStudioLife83":
{
"name": "Jamison Daniel-Studio Life",
"image": "ipfs://QmUBLXPgJM6oSeybv7FB15kQzbZtzPXifk9fJhLVcbCjVh",
"mediaType": "image/webp",
"version": 1,
"music_metadata_version": 2,
"release": {
"release_type": "Multiple",
"release_title": "Studio Life",
"producer": "Jamison Daniel",
"distributor": "Jamison Daniel Music",
"visual_artist": "Jamison Daniel",
"links": {
"twitter": "@JamisonDMusic",
"website": "jamisondaniel.com"
}
},
"attributes":
{
"Collection": "Basic",
"Number": "83/500"
},
"files":
[
{
"name": "hi-res",
"mediaType": "image/webp",
"src": "ipfs://QmbU2Xm7swgYBQvN8cWXWVZJ1a2fMFmtFkymUu6fRogQwj"
},
{
"name": "Finally (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmduC7pkR14K3mhmvEazoyzGsMWVF4ji45HZ1XfEracKLv",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 1,
"song_title": "Finally (Master 2021)",
"song_duration": "PT6M36S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Funky Squirrel (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmW9sHugSArzf29JPuEC2MqjtbsNkDjd9xNUxZFLDXSDUY",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 2,
"song_title": "Funky Squirrel (Master 2021)",
"song_duration": "PT6M47S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Weekend Ride (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://Qmb8fm7CkzscjjoJGVp3p7qjSVMknsk27d3cwjqM26ELVB",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 3,
"song_title": "Weekend Ride (Master 2021)",
"song_duration": "PT6M39S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Rave Culture (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmTwvwpgE9Fx6QZsjbXe5STHb3WVmaDuxFzafqCPueCmqc",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 4,
"song_title": "Rave Culture (Master 2021)",
"song_duration": "PT6M39S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Vibrate (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmTETraR8WvExCaanc5aGT8EAUgCojyN8YSZYbGgmzVfja",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 5,
"song_title": "Vibrate (Master 2021)",
"song_duration": "PT6M51S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Top 40's (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://Qmdfr4PvuiZhi3a6EaDupGN6R33PKSy5kntwgFEzLQnPLR",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 6,
"song_title": "Top 40's (Master 2021)",
"song_duration": "PT6M33S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Acid Trip (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmSp4Cn7qrhLTovezS1ii7ct1VAPK6Gotd2GnxnBc6ngSv",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 7,
"song_title": "Acid Trip (Master 2021)",
"song_duration": "PT6M7S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "For The Win (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmV8ihv8R6cCKsFJyFP8fhnnQjeKjS7HAAjmxMgUPftmw6",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 8,
"song_title": "For The Win (Master 2021)",
"song_duration": "PT6M36S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
},
{
"name": "Sunday Sermon (Master 2021)",
"mediaType": "audio/flac",
"src": "ipfs://QmWux5UpX6BtYQ7pjugqRh6ySa2vVJN12iSC2AB1cAQynU",
"song": {
"artists": [{"name": "Jamison Daniel"}],
"track_number": 9,
"song_title": "Sunday Sermon (Master 2021)",
"song_duration": "PT5M13S",
"genres": ["electronic", "house"],
"copyright": "Jamison Daniel © 2021"
}
}
]
}
}
}CIP-68 Single
{
"constructor": 0,
"fields": [
{
"map": [
{"k": {"bytes": "6E616D65"}, "v": {"bytes": "5369636B436974793335342D5068696C207A277669656C"}},
{"k": {"bytes": "696D616765"}, "v": {"bytes": "697066733A2F2F516D513133437639576F756634726377744E7375466845654A564B396245596A43596F36414E39383674616B6975"}},
{"k": {"bytes": "6D757369635F6D657461646174615F76657273696F6E"}, "v": {"int": 2}},
{"k": {"bytes": "72656C656173655F74797065"}, "v": {"bytes": "53696E676C65"}},
{"k": {"bytes": "72656c65617365"}, "v":
{
"map": [
{"k": {"bytes": "72656c656173655f7469746c65"}, "v": {"bytes": "432e482e492e4c2e4c2e"}},
{"k": {"bytes": "6469737472696275746f72"}, "v": {"bytes": "68747470733a2f2f7369636b636974792e78797a"}},
]
}
},
{"k": {"bytes": "66696C6573"}, "v":
{
"array": [
{
"map": [
{"k": {"bytes": "6e616d65"}, "v": {"bytes": "432e482e492e4c2e4c2e"}},
{"k": {"bytes": "6d6564696154797065"}, "v": {"bytes": "617564696f2f6d7033"}},
{"k": {"bytes": "737263"}, "v": {"bytes": "697066733a2f2f516d66593475674e6459594a7870626e35426e4e38797435456d6955437a6e6578516f5169365254457539537543"}},
{"k": {"bytes": "736f6e67"}, "v":
{
"map": [
{"k": {"bytes": "736f6e675f7469746c65"}, "v": {"bytes": "432e482e492e4c2e4c2e"}},
{"k": {"bytes": "736f6e675f6475726174696f6e"}, "v": {"bytes": "5054334d3653"}},
{"k": {"bytes": "747261636b5f6e756d626572"}, "v": {"int": 1}},
{"k": {"bytes": "6d6f6f64"}, "v": {"bytes": "6368696c6c6f7574"}},
{"k": {"bytes": "61727469737473"}, "v":
{
"array": [
{
"map": [
{"k": {"bytes": "6e616d65"}, "v": {"bytes": "5068696c207a277669656c"}},
]
}
]
}
},
{"k": {"bytes": "636f6c6c656374696f6e"}, "v": {"bytes": "432e482e492e4c2e4c2e"}},
{"k": {"bytes": "67656e726573"}, "v":
{
"array": [
{"bytes": "477569746172204c697665204c6f6f70696e67"},
{"bytes": "50726f677265737369766520416d6269656e74"},
]
}
},
{"k": {"bytes": "636f70797269676874"}, "v": {"bytes": "2117 2032303232205068696c207a277669656c"}},
{"k": {"bytes": "6c696e6b73"}, "v":
{
"map": [
{"k": {"bytes": "646973636f72645f75736572"}, "v": {"bytes": "5068696c207a277669656c2334373131"}},
{"k": {"bytes": "74776974746572"}, "v": {"bytes": "405068696c5f7a7669656c5f434e4654"}},
{"k": {"bytes": "77656273697465"}, "v": {"bytes": "7777772e7068696c7a7669656c636e66742e636f6d"}}
]
}}
]
}
}
]
}
]
}
},
]
},
{
"int": 1
}
]
}Rationale: how does this CIP achieve its goals?
Implementing this simplifies and commonizes the process for creating music tokens on Cardano. It greatly simplifies the work that apps have to make when consuming such tokens.
This CIP is the result of several online meetings between many different companies building music-related projects on top of Cardano. These meetings were organized as many in the community started to see fragmentation in the way music NFTs were being minted on Cardano. These meetings gave the opportunity for a bit of a reset and will allow a much brighter future for music on Cardano. As long as all projects agree on some of these basic fields, there is great flexibility in this CIP to do application-specific unique things on top of the music NFT itself. The CIP is intentionally open-ended and can be updated in future versions if there are additional fields that the wider group could benefit from.
Path to Active
Acceptance Criteria
- Has been implemented by a number of parties, including:
- SickCityNFT - sickcity.xyz
- NEWM - newm.io
- SoundRig - soundrig.io
Implementation Plan
- Consensus of companies building music-related Cardano projects to develop a mutually beneficial metadata vocabulary.
Copyright
This CIP is licensed under CC-BY-4.0