// submission format
metadata.json
If you pin your track as an IPFS folder (rather than a single file),
you can drop a metadata.json file in that same folder. Paste the folder's
CID into the Folder CID field on the
submission form and, on blur, SignalChain will fetch
it and auto-fill Title / Artist / Genre / Audio CID for you -- so you don't have to
type them in by hand. It's entirely optional: no metadata.json, no
problem, just fill the form fields yourself.
Example folder layout
your-folder-cid/
metadata.json
track.mp3
Example metadata.json
{
"title": "Painted Sky",
"artist": "Don Buck",
"genre": "Stoner Rock",
"audio": "track.mp3"
}
With this in place, pasting just the folder CID into the form auto-fills all four
fields below it -- audio should be the filename of the track
inside that same folder, not a separate CID.
Recognized fields
| Field | Aliases | Fills in | Required? |
|---|---|---|---|
title | name | Track Title | No |
artist | author | Artist | No |
genre | -- | Genre Tag | No |
audio | audioFile | Audio IPFS CID (as a filename within the folder) | No |
Good to know
- Every field is optional and independent -- include just the ones you want auto-filled. A
metadata.jsonwith only atitleis fine. - Auto-fill never overwrites a field you've already typed something into -- it only fills in blanks. Always double-check the filled-in values before submitting.
- If no
metadata.jsonis found in the folder (or the CID hasn't propagated yet), nothing happens -- just fill in the form fields yourself as normal. audio/audioFileshould be a plain filename relative to the folder (e.g.track.mp3), not a separate CID or a path with the folder CID repeated in it.- Artwork isn't used anywhere on SignalChain right now -- no need to reference an image file in
metadata.json.