HackMD
  • Beta
    Beta  Get a sneak peek of HackMD’s new design
    Turn on the feature preview and give us feedback.
    Go → Got it
      • Create new note
      • Create a note from template
    • Beta  Get a sneak peek of HackMD’s new design
      Beta  Get a sneak peek of HackMD’s new design
      Turn on the feature preview and give us feedback.
      Go → Got it
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Please check the box to agree to the Community Guidelines.
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive Export to Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive Import from Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Export to Google Drive Gist
    Import
    Dropbox Google Drive Import from Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Please check the box to agree to the Community Guidelines.
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with GitHub
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    --- slug: "/NIMDE_MULTIASSET_v1.0.0" sidebar_position: 1 --- # NIMDE_MULTIASSET_v1.0.0 | <!-- --> | <!-- --> | |-------------|-------------| | Authors | Zack Pantely, Kavan Sikand | | Contributors|Justin Bloomer, David Ceballos, Thomas Lisankie, Madrone, Spencer Obstinik, Eric Struhl, Tasheme Thomas, Florian Uhde, Andy Watson | | Type | NIMDE_EXTENSIBLE Extension | | Extension Name | NIMDE_MULTIASSET_v1.0.0 | | Created | 2022-06-06 | ## Table of contents - [Summary](#summary) - [Abstract](#abstract) - [Motivation](#motivation) - [Specification](#specification) - [Top-Level Metadata](#top-level-metadata) - [Extended Top-Level Data Types](#extended-top-level-data-types) - [`Asset` Data Type](#asset-data-type) - [`File` Data Type](#file-data-type) - [Assets and Files](#assets-and-files) - [Standard `MediaType` Definitions](#standard-mediatype-definitions) - [Metadata Examples](#metadata-examples) - [Multiple Assets](#multiple-assets) - [Multiple Files](#multiple-files) - [Backwards Compatibility](#backwards-compatibility) - [Security Considerations](#security-considerations) - [Copyright](#copyright) ## Summary With the expansion in use cases for NFTs, there has arisen a need to standardize the organization of assets represented by an NFT. Here, we define a standard by which an NFT can represent multiple assets of varying file types and implementations. ## Abstract This standard extends NIMDE_EXTENSIBLE to provide a decentralized approach to representing digital assets with an NFT in a scalable and maintainable way. The goal is to provide a streamlined approach to the following: - Locating heterogeneous files associated with an NFT (e.g. 3D models, animations, etc.) - Associating multiple assets with an NFT such that custom or centralized tooling is not required - Providing a clear definition of the media type and file type for associated assets ## Motivation As the use cases for NFTs have expanded, the need for an NFT to represent multiple files has grown and been addressed in several ways. However, the inconsistency in these varied approaches has rendered assets beyond images and videos unable to be ingested by NFT consumers in a streamlined way. This has forced consumers to create custom centralized tooling to upload specific assets - a path that is not scalable or maintainable for the long-term. Here's an example of the current method by which a user might bring an NFT representing multiple assets, including a 3D model, into a game: **Existing Ingestion Path Example** 1. User purchases an NFT 2. User navigates to NFT creator's website 3. User downloads the associated assets for the NFT 4. User interacts with game-specific tooling to upload these assets to the game This procedure necessitates a lot of manual interaction by the user, because there is no standard way by which an automated system can access all of the assets associated with this NFT. This approach also requires trust that the user actually owns the NFT that they uploaded. For NFTs which adhere to our proposed metadata standard, the path to ingesting assets into a game world looks like: **Proposed Ingestion Path Example** 1. User purchases an NFT 2. Game verifies that the user owns the NFT 3. Game parses NFT's metadata to ingest appropriate assets into the game world The clear benefit of this approach is that with no custom project-level support from the game developer and no manual action from the NFT owner, the user is able to use their assets in-game. ## Specification The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt). #### Top-Level Metadata: This specification adds the `assets` key to the top level of the NIMDE_EXTENSIBLE metadata JSON. The value is an array of the `Asset` data type defined below. ``` { "name": "My Cool NFT", "description": "A very cool NFT.", "image": "https://coolnfts.com/preview.mp4", "metadataStandard": "NIMDE_EXTENSIBLE_v1.0.0", "extensions": [ "NIMDE_MULTIASSET_v1.0.0" ], "assets": [] } ``` In the above metadata, the `assets` array is left empty in order to show the minimum valid implementation of this extension. For a non-trivial example, refer to the [Metadata Examples](##Metadata-Examples) section. #### Extended Top-Level Data Types: The top-level keys of the metadata MUST include all required fields in the below table in addition to fields required by the metadata standard to which this extension is applied. | Field Name | Data Type | Inclusion | | -------- | -------- | -------- | | assets| Asset[] | REQUIRED | The `assets` key provides an array of `Asset` data types, defined below. #### `Asset` Data Type: The `Asset` data type is a JSON object which represents all media surrounding a specific asset. An `Asset` MUST include all required fields and MAY include all nonrequired fields in the below table. The values of these fields MUST adhere to the data types listed. | Field Name | Data Type | Inclusion | | -------- | -------- | -------- | | name | string | OPTIONAL | | description | string | OPTIONAL | | mediaType | string (MediaType enum)| REQUIRED | | assetType | string | OPTIONAL | | files | File[] | REQUIRED | The `name` and `description` fields MAY be omitted (likely if there is only one `Asset` in the array), in which case the metadata interpreter might choose to fall back to the top-level `name` field. The `mediaType` key provides a `MediaType` enum which is used to convey how the asset should be interpreted. Example values include "image", "video", or "model". Valid `MediaType` values are detailed in the [Standard `MediaType` Definitions](####Standard-`MediaType`-Definitions) section. The `assetType` key allows creators to more-specifically define the usage of the asset. Example values include "preview", "avatar", "pistol", or "shirt". This specification does not specify a set of valid entries for the `assetType` and instead leaves that definition to a subsequent extension standard. If omitted, the asset can only be interpreted as a generic asset of the defined `MediaType`. The `file` key provides an array of `File` data types, defined below. #### `File` Data Type: The `File` data type is a JSON object which represents a single file that can be downloaded and interpreted using the `url` and `fileType` data. A `File` MUST include all required fields and MAY include all nonrequired fields in the below table. The values of these fields MUST adhere to the data types listed. | Field Name | Data Type | Inclusion | | -------- | -------- | -------- | | name | string | OPTIONAL | | description | string | OPTIONAL | | url | string (URL) | REQUIRED | | fileType | string (MIME type) | REQUIRED | The `name` and `description` fields MAY be omitted (likely if there is only one `File` in the array), in which case the metadata interpreter might choose to fall back to the `name` field of the `Asset` (or, if that is omitted, the top-level `name` field). The `url` key provides a URL which links to the file to be downloaded. This URL is NOT REQUIRED to contain a file extension since that is provided by the `fileType` value. The `fileType` key provides media type and a file extension in a [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) format. This is helpful during interpretation because some URLs (such as many IPFS URLs) do not contain a file extension. For convenience in interpreting this standard, we note here that the nomenclature of MIME types is [*type*]/[*subtype*] where the *type* is a media type and the *subtype* is a file extension. #### Assets and Files: It should be understood that an `Asset` represents some *thing* and a `File` gives a representation of that *thing* (of which there may be one or more). Each `Asset` REQUIRES that at least one `File` in the `files` array is of a `fileType` with a MIME *type* that matches the asset's `MediaType` (e.g. a "model" `MediaType` requires at least one file with a `fileType` of "model/[*any subtype*]"). Multiple files with the same MIME *type* as the `Asset`'s `MediaType` MAY be included if they have different MIME *subtypes* and represent the same asset (in the example of a model, a "model/fbx" and a "model/obj" could both be included in the same `files` array if they represent the same asset with different file types, but two "model/fbx" files are not allowed in the same `files` array because this would cause ambiguity and inherently indicate that a different `Asset` should be used to host each `File`). This restriction allows the metadata interpreter to assume that any file with the same MIME *type* as the `Asset`'s `MediaType` can equally be used to represent the asset and offers the choice of which file type to accept. For files with MIME *types* that are not the same as the `Asset`'s `MediaType`, there are no restrictions on the number that can be included. These can be considered previews or supporting materials of the asset that refers to them. In the example of a model, such supporting materials may be animations that are relevant to that model asset. This standard makes no restrictions to the MIME *subtypes* that can be used. The compatibility and handling of file types is dependent on the services that ingest NFT assets. #### Standard `MediaType` Definitions This standard defines a set of standardized `MediaType` values in order to provide a known interpretation for common types of assets. The `MediaType` MUST be a value from this list. These definitions and their requirements are defined below. - **model:** The "model" `MediaType` describes a single model, any previews of that model, and any supporting files (such as animations). This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has a a model MIME *type* (e.g. model/fbx). - **image:** The "image" `MediaType` describes an image asset. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has an image MIME *type* (e.g. image/png). Most images will either be provided by the top-level `image` key or provided as a preview `MediaType`, so the use-case for this `MediaType` may typically be to provide a higher-resolution version of the asset provided by the top-level `image` key. - **video:** The "video" `MediaType` describes a video asset. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has a video MIME *type* (e.g. video/mp4). Most videos will either be provided by the top-level `image` key or provided as a "preview" `MediaType`, so the use-case for this `MediaType` may typically be to provide a higher-resolution version of the asset provided by the top-level `image` key. - **animation:** The "animation" `MediaType` describes a single animation and any previews of that animation. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has an animation MIME *type* (e.g. animation/fbx). - **audio:** The "audio" `MediaType` describes a single audio track and any previews of that track. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has an audio MIME *type* (e.g. audio/wav). - **text:** The "text" `MediaType` describes a single body of text and any previews of that text. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has a text MIME *type* (e.g. text/txt). - **font:** The "font" `MediaType` describes a single font and any previews of that font. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has a font MIME *type* (e.g. font/ttf). - **application:** The "application" `MediaType` describes a single application and any previews of that application. This `MediaType` REQUIRES at least one file in the `files` array with a `fileType` that has an application MIME *type* (e.g. application/exe). ## Metadata Examples #### Multiple Assets The following is an example of this extension including data for an NFT that consists of two assets: a 3D model of glasses and a 3D model of a hat. Each asset includes a single 3D model file. ``` { "name": "Clever Disguise", "description": "Glasses and a hat.", "image": "https://coolnfts.com/clever-disguse-preview.png", "metadataStandard": "NIMDE_EXTENSIBLE_v1.0.0", "extensions": [ "NIMDE_MULTIASSET_v1.0.0" ], "assets": [ { "name": "Glasses", "description": "An unassuming pair of glasses.", "mediaType": "model", "files": [ { "url": "https://ipfs.io/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi", "fileType": "model/fbx" } ] }, { "name": "Hat", "description": "A suspicious-looking hat.", "mediaType": "model", "files": [ { "url": "https://ipfs.io/idzbf55yqtglco3fbaqlyufe3fn62y7hu67uh7mdu7pfs5tzrydgiebyfab", "fileType": "model/fbx" } ] } ] } ``` #### Multiple Files The following is an example of this extension including data for an NFT that consists of one asset with two files: a picture of a shirt and a 3D model of a shirt. This may be useful in the case that the web preview of the asset (the top-level `image` key) is a video, but the creator also wants to include a high-resolution image as well. ``` { "name": "Snazzy Shirt", "description": "A shirt to wear to the jazz club.", "image": "https://coolnfts.com/snazzy-shirt-preview.mp4", "metadataStandard": "NIMDE_EXTENSIBLE_v1.0.0", "extensions": [ "NIMDE_MULTIASSET_v1.0.0" ], "assets": [ { "mediaType": "model", "files": [ { "name": "Shirt Image", "description": "A high-res render of a snazzy shirt.", "url": "https://ipfs.io/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi", "fileType": "image/png" }, { "name": "Shirt Model", "description": "A rigged model of a snazzy shirt.", "url": "https://ipfs.io/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi", "fileType": "model/fbx" } ] } ] } ``` This also serves as an example of where the `mediaType` field may be necessary to interpret the asset. Because the asset consists of both an image and a model, some assumptions about the intention of the asset would otherwise have to be made. Since the `mediaType` is defined as a `model`, the included image can be considered a preview or ignored at the discretion of the metadata interpreter. ## Backwards Compatibility Because this standard is an extension upon NIMDE_EXTENSIBLE, backwards compatibility is not applicable. ## Security Considerations Because this standard is merely a metadata extension and does not interface with the underlying contract, there are no additional security considerations. ## Copyright Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.


    Upgrade

    All
    • All
    • Team
    No template found.

    Create custom template


    Upgrade

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Tutorials

    Book Mode Tutorial

    Slide Mode Tutorial

    YAML Metadata

    Contacts

    Facebook

    Twitter

    Feedback

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings
    Upgrade now

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Available push count

        Upgrade

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Upgrade

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully