Skip to content

Latest commit

 

History

History
166 lines (112 loc) · 7.82 KB

nft-rfc-001.md

File metadata and controls

166 lines (112 loc) · 7.82 KB
Raw
nft-rfc title stage category kind author created modified
1
NFT Specification Standard
draft
meta
meta
Shaun Conway @ig-shaun
2020-10-21

What is an NFT-RFC?

An inter-chain NFT and Metadata standard (NFT-RFC) is a design document describing a particular protocol, standard, or feature which is recommended by the InterNFT Working Group for adoption by implementers of Non-Fungible Tokens and Metadata, which (unless specified) should be agnostic to any specific blockchain or software implementation. An NFT-RFC should list the desired properties of the standard, explain the design rationale, and provide a concise but comprehensive technical specification. The primary NFT-RFC author is responsible for pushing the proposal through the standardisation process, soliciting input and support from the community, and communicating with relevant stakeholders to ensure (social) consensus.

Thia interchain NFT + Metadata standardisation process should be the primary vehicle for proposing ecosystem-wide protocols, changes, and features. All comments and documents should persist after consensus as the records of design decisions and to provide an information repository for future implementers.

Interchain standards should not be used for proposing changes to a particular blockchain (such as the Cosmos Hub) or to specify implementation particulars (such as language-specific data structures).

Components

An NFT-RFC consists of a header, synopsis, specification, history log, and copyright notice. All top-level sections are required. References should be included inline as links, or tabulated at the bottom of the section if necessary.

Header

The NFT-RFC header contains standard metadata relevant to the standard:

Required fields

nft-rfc: # - NFT-RFC number (assigned sequentially)

title - NFT-RFC title (keep it short & sweet)

stage - Current stage of the proposal.

category - NFT-RFC category, one of the following:

  • meta - A standard about the ICS process
  • NFT/USECASES - Use cases and requirements which can inform the development of standards.
  • NFT/INTERFACE - A standard about an inter-blockchain communication system core transport, authentication, and ordering layer protocol.
  • NFT/METADATA - A standard about an inter-blockchain communication system application layer protocol.

author - NFT-RFC author(s) & contact information (in order of preference: email, GitHub handle, Twitter handle, other contact methods likely to elicit response). The first author is the primary "owner" of the NFT-RFC and is responsible for advancing it through the standardisation process. Subsequent author ordering should be in order of contribution amount.

created - Date NFT-RFC was first created (YYYY-MM-DD)

modified - Date NFT-RFC was last modified (YYYY-MM-DD)

Optional fields

requires - Other NFT-RFC standards, referenced by number, which are required or depended upon by this standard.

required-by - Other NFT-RFC standards, referenced by number, which require or depend upon this standard.

replaces - Another NFT-RFC standard replaced or supplanted by this standard, if applicable.

replaced-by - Another NFT-RFC standard which replaces or supplants this standard, if applicable.

Synopsis

Following the header, an NFT-RFC should include a brief (~200 word) synopsis providing a high-level description of and rationale for the specification.

Specification

The specification section is the main component of an NFT-RFC, and should contain protocol documentation, design rationale, required references, and technical details where appropriate.

Sub-components

The specification may have any or all of the following sub-components, as appropriate to the particular NFT-RFC. Included sub-components should be listed in the order specified here.

  • Motivation - A rationale for the existence of the proposed feature, or the proposed changes to an existing feature.
  • Definitions - A list of new terms or concepts utilised in this NFT-RFC or required to understand this NFT-RFC. Any terms not defined in the top-level "docs" folder must be defined here.
  • Desired Properties - A list of the desired properties or characteristics of the protocol or feature specified, and expected effects or failures when the properties are violated.
  • Technical Specification - All technical details of the proposed protocol including syntax, semantics, sub-protocols, data structures, algorithms, and pseudocode as appropriate. The technical specification should be detailed enough such that separate correct implementations of the specification without knowledge of each other are compatible.
  • Backwards Compatibility - A discussion of compatibility (or lack thereof) with previous feature or protocol versions.
  • Forwards Compatibility - A discussion of compatibility (or lack thereof) with future possible or expected features or protocol versions.
  • Example Implementation - A concrete example implementation or description of an expected implementation to serve as the primary reference for implementers.
  • Other Implementations - A list of candidate or finalised implementations (external references, not inline).

History

An NFT-RFC should include a history section, listing any inspiring documents and a plain-text log of significant changes.

See an example history section below.

Copyright License

An NFT-RFC should include a copyright section waiving rights via Apache 2.0.

Formatting

General

NFT-RFC specifications must be written in GitHub-flavoured Markdown.

For a GitHub-flavoured Markdown cheat sheet, see here.

Language

NFT-RFC specifications should be written in Simple English, avoiding obscure terminology and unnecessary jargon. For excellent examples of Simple English, please see the Simple English Wikipedia.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in specifications are to be interpreted as described in RFC 2119.

Pseudocode

Pseudocode in specifications should be language-agnostic and formatted in a simple imperative standard, with line numbers, variables, simple conditional blocks, for loops, and English fragments where necessary to explain further functionality such as scheduling timeouts. LaTeX images should be avoided because they are difficult to review in diff form.

Pseudocode for structs should be written in simple Typescript, as interfaces.

Example pseudocode struct:

interface Connection {
  state: ConnectionState
  version: Version
  counterpartyIdentifier: Identifier
  consensusState: ConsensusState
}

Pseudocode for algorithms should be written in simple Typescript, as functions.

Example pseudocode algorithm:

function startRound(round) {
  round_p = round
  step_p = PROPOSE
  if (proposer(h_p, round_p) === p) {
    if (validValue_p !== nil)
      proposal = validValue_p
    else
      proposal = getValue()
    broadcast( {PROPOSAL, h_p, round_p, proposal, validRound} )
  } else
    schedule(onTimeoutPropose(h_p, round_p), timeoutPropose(round_p))
}

History

This specification was significantly inspired by and derived from Ethereum's EIP 1, which was in turn derived from Bitcoin's BIP process and Python's PEP process. Antecedent authors are not responsible for any shortcomings of this NFT-RFC spec or the NFT-RFC process. Please direct all comments to the NFT-RFC repository maintainers.

Oct 21, 2020 - Initial draft finished and submitted as a PR

Copyright

All content herein is licensed under Apache 2.0.