NIP-94 definiert ein Datei-Metadaten-Event vom kind 1063, um geteilte Dateien auf Nostr zu organisieren und zu klassifizieren. Dadurch können Relays Inhalte wirksam filtern und ordnen.

Funktionsweise

NIP-94 verwendet kind 1063 als eigenständiges Metadaten-Event für eine Datei. Der Event-content enthält eine menschenlesbare Beschreibung, während Tags maschinenlesbare Felder wie Download-URL, MIME type, Hashes, Abmessungen und Preview-Hints tragen.

Diese Trennung ist wichtig, weil das Metadaten-Event unabhängig von jeder Note, die auf die Datei verweist, indiziert, gefiltert und wiederverwendet werden kann. Ein Client kann ein kind-1063-Event als kanonische Beschreibung einer Datei behandeln, statt Metadaten aus freiformuliertem Post-Text herauszulesen.

Erforderliche und optionale Tags

Kern-Tags:

  • url - Download-Link zur Datei
  • m - MIME type, muss kleingeschrieben sein
  • x - SHA-256-Hash der Datei

Optionale Tags:

  • ox - SHA-256-Hash der Originaldatei vor Server-Transformationen
  • size - Dateigröße in Bytes
  • dim - Abmessungen, Breite x Höhe, für Bilder oder Video
  • magnet - Magnet-URI für Torrent-Verteilung
  • i - Torrent-Infohash
  • blurhash - Platzhalterbild für Vorschauen
  • thumb - Thumbnail-URL
  • image - Vorschaubild-URL
  • summary - Textauszug
  • alt - Barrierefreiheitsbeschreibung
  • fallback - Alternative Download-Quellen
  • service - Speicherprotokoll oder Diensttyp, etwa NIP-96

Die Tags ox und x werden leicht übersehen, sind in der Praxis aber sehr nützlich. ox identifiziert die ursprünglich hochgeladene Datei, während x die transformierte Version bezeichnen kann, die ein Server tatsächlich ausliefert. Wenn ein Medienhost Uploads komprimiert oder verkleinert, können Clients die Identität der Originaldatei trotzdem erhalten, ohne zu behaupten, dass das ausgelieferte Objekt bytegenau identisch ist.

Wann man es verwenden sollte

NIP-94 ist für File-Sharing-Anwendungen gedacht, nicht für Social- oder Longform-Clients. Vorgeschlagene Anwendungen sind unter anderem:

  • Torrent-Indexierungs-Relays
  • Plattformen zum Teilen von Portfolios, ähnlich wie Pinterest
  • Verteilung von Software-Konfigurationen und Updates
  • Medienbibliotheken und Archive

Wenn Dateimetadaten nur eine in ein anderes Event eingebettete URL ergänzen sollen, ist NIP-92: Media Attachments leichter. NIP-94 ist die bessere Wahl, wenn die Datei selbst als eigenständiges, abfragbares Objekt behandelt werden soll.

Interop-Hinweise

NIP-94 funktioniert über verschiedene Storage-Backends hinweg. Eine Datei kann über NIP-96: HTTP File Storage hochgeladen werden, über Blossom oder über einen anderen Dienst, und trotzdem mit demselben kind-1063-Format beschrieben werden. Genau deshalb überlebt das Metadatenformat jedes einzelne Upload-Protokoll.

Primärquellen:

Erwähnt in:

Siehe auch: