Canon Lore Object Model
Canon or Project Lore is only added by Project teams
Canon is the official representation of Lore / world pertaining to a specific NFT project contributed by the core team.
Who can write Canon?
Canon is only added/edited/deleted by the core project team. There is no single author attached to the Canon.
What is the difference between Lore Object and Canon Lore Object?
A Lore Object is always tagged to a token while a Canon Lore / Project Lore Object is attached to the collection as a whole.
Here's an overview of some of the fields contained in a Canon Lore:
Shows when this lore was added. This is shared as a
This shares the text blurb which is displayed as a peek text on a preview card if you are designing a feed.
This shares a preview image of the Lore (defined by the author) which is displayed as a peek image on a preview card if you are designing a feed.
This shares the unique id of the canon lore object pinned on ipfs.
This shares how many times the canon lore was commented on Hyy.pe.
This shares how many times the canon lore was reacted on Hyy.pe.
communityDetailsis the NFT collection / series summary object in the hyype API.
Below are a few fields contained in a community Details object:
Name of the collection e.g. Vogu
Short symbol of associated the ERC721 / ERC1155 token
Discord Join link of the collection
twitter username the collection
Lowercase collection name e.g. vogu
the friendly URL string on hyy.pe . If the slug value says "vogu" then it translates to https://hyy.pe/collection/vogu
Object containing the thumbnail image of the collection
contains an object of all smart contract addresses associated with a collection (can be multiple if it's a multi-contract NFT series). In case of Artblocks, it will be
whether the collection is verified or not.
A Canon lore can be formed by combining many building blocks sequenced together. Building blocks can come in many forms - paragraphs, quotes, links, embeds, and more.
canonDetailsis an array of block objects which together to form the whole lore.
blocks come in a variety of types - paragraph, embeds, images, videos & quotes being few of the more commonly used ones.
A few examples of blocks are included below:
"text": "<b>There has always been a bit of mystery surrounding this one. </b>"
"caption": "Year 2133: Citizen #10082 looking at the vast emptiness of planet Laran",
"text": "How did it all come to this",
"caption": "- Alien king says to himself",