HackMD
    • Create new note
    • Create a note from template
    • Sharing Link copied
    • /edit
    • View mode
      • Edit mode
      • View mode
      • Book mode
      • Slide mode
      Edit mode View mode Book mode Slide mode
    • Customize slides
    • 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
    • Commenting & 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
    • Note settings
    • 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 Note settings 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
Customize slides
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
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_EXTENSIBLE_v1.0.0" sidebar_position: 1 --- # NIMDE_EXTENSIBLE_v1.0.0 | <!-- --> | <!-- --> | |-------------|-------------| | Authors | Zack Pantely, Kavan Sikand | | Contributors| Florian Uhde | | Type | Metadata Standard | | Standard Name | NIMDE_EXTENSIBLE_v1.0.0 | | Created | 2022-06-06 | ## Table of contents - [Summary](#summary) - [Abstract](#abstract) - [Motivation](#motivation) - [Specification](#specification) - [JSON Schema](#json-schema) - [Top Level Data Types](#top-level-data-types) - [`ExtensionName` Formatting](#extensionname-formatting) - [Backwards Compatibility](#backwards-compatibility) - [Security Considerations](#security-considerations) - [Copyright](#copyright) ## Summary NFTs have grown in popularity and complexity, but there currently exists no standard set of rules for understanding their associated metadata. Here, we propose a standard which allows NFT authors to define their metadata in a way which tells consumers what to expect, and provide a framework for extending the simple metadata specified in the ERC-721 and ERC-1155 standards with well-defined specifications. This enables content creators to use and contribute to a set of "extensions" which specify the structure of a token's metadata. ## Abstract This standard seeks to enforce well-defined, yet flexible, constraints upon NFT metadata in order to allow reliable and deterministic interpretation. This is achieved by solidifying and expanding upon the ERC-721 metadata guidelines to do the following: - Decouple token standards (such as ERC-721) from the standard of their associated metadata (such as this standard) - Set requirments for top-level metadata JSON keys - Define which standard the metadata adheres to - Allow extending the metadata by additively implementing other extension standards ## Motivation As the popularity of NFTs has grown, they have outgrown the simple and loose metadata suggestions specified in ERC-721 and ERC-1155. Authors have added arbitrary sets of extra fields into the metadata associated with their tokens, but there has been no standardization of this process. Some de-facto standards have arisen, but they are not formalized in any way, and authors often diverge from these standards in an ad-hoc manner, making it difficult for consumers to understand the assets. An example of such a de-facto standard is the concept of adding `attributes` to an NFT's metadata, which often takes the form of an array of objects which look like `[ { trait_type: string, value: string } ]`. However, not all NFTs have these fields, and there also exist assets which have `attributes` which take on a different form factor. For this example, we propose formalizing this standard as an "attributes" extension to the Extensible Metadata Standard to ensure consumers know exactly when to expect this attribute data and what form it will take. As NFTs grow in popularity, additional use cases have arisen for which ther are *no* widely-used standards, such as NFTs which represent 3D models, or groups of assets all governed by a single token (such as a skin pack). Some examples of motivation for specific extensions are given below. [Now, continue to motivate the previews / assets extensions and link to those <- can we link these or will they not exist by the time this is published?] ## 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). #### JSON Schema: ``` { "name": "My Cool NFT", "description": "A very cool NFT.", "image": "https://coolnfts.com/preview.mp4", "metadataStandard": "NIMDE_EXTENSIBLE_v1.0.0", "extensions": [] } ``` #### Top-Level Data Types: | Field Name | Data Type | Inclusion | | -------- | -------- | -------- | | name | string | REQUIRED | | description | string | OPTIONAL | | image | string (url) | RECOMMENDED | | metadataStandard | string | REQUIRED | | extensions | string[] (ExtensionName) | REQUIRED | The values of these fields MUST adhere to the data types listed. The `image` field points to the preview or main 2D asset of the NFT (typically an image or video). This field SHOULD be populated and is included in order to provide compatibility with existing NFT consumer infrastructure at the time of writing. However, this field has evolved to be a misnomer with a limiting and confusing function; therefore, it has been marked as not required in hopes to phase it out in preference of a more well-defined preview-handling extension to this metadata standard. The `metadataStandard` key allows a consumer to understand which metadata standard this JSON adheres to. The value is the technical name of the metadata standard, but no naming guidelines are specified here. If using version 1.0.0 of this standard, the value of this field would be "NIMDE_EXTENSIBLE_v1.0.0". The `extensions` array specifies which metadata extensions this metadata adheres to. Extensions can specify additional keys to the top-level metadata JSON or add constraints and definitions to another extension. Metadata extensions are intentionally differentiated from EIPs because they are relevant only to NFT metadata and should be constructed and interpreted in a chain-agnostic manner (i.e. they are not bound to the Ethereum network). #### `ExtensionName` Formatting: The format of an `ExtensionName` is defined as: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[*extension developer code*]_[*extension name/number*]_v[*version*] With each piece defined as: - **Extension developer code:** a unique code (which MUST NOT contain spaces or underscores) indicating the party or developer who originated the extension - **Extension name or number:** a name or number (which MUST NOT contain spaces or underscores) which is unique per extension developer code - **Version:** the version of the standard (which MUST follow Semantic Versioning 2.0.0) For example, extending with the initial release of Nifty Island's [Multi-Asset Standard](NIMDE_MULTIASSET_v1.0.0#top-level-metadata) linked below would have "NIMDE_MULTIASSET_v1.0.0" as a value in the `extensions` array. In alignment with [Semantic Versioning 2.0.0](https://semver.org/), an increment to the MAJOR version indicates breaking changes. This means that metadata interpreters must check at least the MAJOR version to determine compatibility with an extension standard. The MINOR version can be optionally checked to detect the presence of additional functionality. ## Backwards Compatibility This change to the metadata standard is backwards compatible with existing metadata suggestions proposed in ERC-1155. ## Security Considerations Because this standard only specifies metadata properties and does not involve a smart contract directly, there are no security concerns. ## 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

Discord

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