integratingMetadataViews.md

How to add rich metadata to your NFT on .Find

Implementing MetadataViews correctly in NFT smart contracts enables DApps on flow to extract rich NFT metadata and display them on .Find. With MetadataViews, data such as display thumbnail, name, description, traits, collection information can be showcased in the exact way it is expected.

We advice anybody that is integrating to contact us in discord in the technical channel

Implementing MetadataViews.Display

For .Find to display an asset, the smart contract MUST implement MetadataViews.Display .Find gets the display information through resolving Display View. Let's take a closer look on code implementation.

pub fun resolveView(_ type: Type): AnyStruct? {
	switch type {

		// Example for Display 
		case Type<MetadataViews.Display>() : 

			return MetadataViews.Display(
				name: NFT name, // Type<String>
				description: NFT description, // Type<String>
				thumbnail: NFT thumbnail // Type<{MetadataViews.File}>
			)

	}
}

If the thumbnail is a HTTP resource

thumbnail : MetadataViews.HTTPFile(url: *Please put your url here)

If the thumbnail is an IPFS resource

//
thumbnail : MetadataViews.IPFSFile(
	cid: thumbnail cid, // Type <String>
	path: ipfs path // Type <String?> specify path if the cid is a folder hash, otherwise use nil here
)

Param	Description
name	Name of the NFT
description	Human readable description of the NFT
thumbnail	A small thumbnail representation of the object

Implementing MetadataViews.CollectionDisplay

.Find will resolve this MetadataViews struct for marketplace collection display from NFT Catalog. A rich and appropriata collection display will improve in UX when user browse your collection.

To enable a decent collection display, the specific NFT that implements MetadataViews.CollectionDisplay should be submitted to NFT-Catalog for approval.

pub fun resolveView(_ type: Type): AnyStruct? {
	switch type {

		// Example for NFTCollectionDisplay 
		case Type<MetadataViews.NFTCollectionDisplay>() : 

			return MetadataViews.NFTCollectionDisplay(
            name: collection name,  // Type<String>
            description: collection description,  // Type<String>
            externalURL: External url of the collection,  // Type<MetadataViews.ExternalURL>
            squareImage: square image,  // Type<MetadataViews.ExternalURL>
            bannerImage: banner image,  // Type<MetadataViews.ExternalURL>
            socials: { 
				"Twitter" : ExternalURL ,
				"Discord" : ExternalURL ,
				"Instagram" : ExternalURL ,
				"Facebook" : ExternalURL ,
				"TikTok" : ExternalURL ,
				"LinkedIn" : ExternalURL 
			}                           // Type<{String : MetadataViews.ExternalURL}>
			)

	}
}

Param	Description
name	Name of the NFT Collection
description	Human readable description of the NFT Collection
externalURL	The external url to the NFT Collection
squareImage	A square image that represent the NFT Collection
bannerImage	A 2 : 1 banner image that represent the NFT Collection
socials	Social links to your media

Implementing MetadataViews.Traits

Trait views can add a lot more attributes to the NFT display on .Find. By returning trait views as recommended, you can fit the data in the places you want.

pub fun resolveView(_ type: Type): AnyStruct? {
	switch type {

		// Example for NFTCollectionDisplay 
		case Type<MetadataViews.Traits>() : 

			let trait = MetadataViews.Trait(
				name: "edition_stamp" ,      // Type<String>
				value: "Grand Architect",    // Type<AnyStruct>
				displayType: "String",       // Type<String?>
				rarity: MetadataViews.Rarity(// Type<MetadataViews.Rarity?>
					score: nil,              // Type<UFix64?>
					max: nil,                // Type<UFix64?>
					description: "Common"     // Type<String?>
				)
			)

			let dateTrait = MetadataViews.Trait(
				name: "birthday" ,      // Type<String>
				value: "1546360800",    // Type<AnyStruct>
				displayType: "Date",    // Type<String?>
				rarity: nil             // Type<MetadataViews.Rarity?>
			)

			return MetadataViews.Traits(
				[
					trait, 
					dateTrait
				]
			)

	}
}

String Trait

Date Trait (Under development)

Param	Description
name	Name of the trait, prefer this to be snake_case in lower and url safe. .find will group traits on _ groups if possible
value	Value of the trait, prefer this to be a primitive value not a struct/dictionary/array.
displayType	Value of the trait, can be "String", "Number", "Date" etc.
rarity	Additional rarity to this trait, description / numbder / maximum number of the rarity