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:
Field Name | Description |
|---|---|
createdAtUnix | Shows when this lore was added. This is shared as a unix timestamp |
communityDetails | communityDetails shares the details of the NFT series for which this Canon was written. see communityDetails section below. |
canonDetails | canonDetails is the Object array of lore blocks which when combined together represent the entire lore. Lore can be made up of several text blocks, images, videos, embeds among different things. see canonDetails section below. |
previewText | This shares the text blurb which is displayed as a peek text on a preview card if you are designing a feed. |
previewImageUrl | 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. Optional. |
ipfsHash | This shares the unique id of the canon lore object pinned on ipfs. |
commentCount | This shares how many times the canon lore was commented on Hyy.pe. |
reactionLooksRareCount | This shares how many times the canon lore was reacted on Hyy.pe. |
communityDetails is the NFT collection / series summary object in the hyype API.Below are a few fields contained in a community Details object:
Field Name | Description |
|---|---|
name | Name of the collection e.g. Vogu |
symbol | Short symbol of associated the ERC721 / ERC1155 token |
discordUrl | Discord Join link of the collection optional |
twitterUsername | twitter username the collection optional |
communityNameLower | Lowercase collection name e.g. vogu |
slug | the friendly URL string on hyy.pe . If the slug value says "vogu" then it translates to https://hyy.pe/collection/vogu |
image | Object containing the thumbnail image of the collection |
searchKeys | 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 contract-projectId |
verified | whether the collection is verified or not. boolean |
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.
canonDetails is an array of block objects which together to form the whole lore. Field name | Type | Description |
|---|---|---|
blocks | Object Array | 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:
paragraph
image
video
quote
embed
{
"id": "tbqvAKSuyg",
"type": "paragraph",
"data": {
"text": "<b>There has always been a bit of mystery surrounding this one. </b>"
}
}
{
"id": "IfOVQ2AeDW",
"type": "image",
"data": {
"file": {
"url": "https://media.hyy.pe/700xAUTO/61561912f084510012274814-1635403828014.jpeg"
},
"caption": "Year 2133: Citizen #10082 looking at the vast emptiness of planet Laran",
"withBorder": false,
"stretched": false,
"withBackground": false
}
}
{
"id": "VYvoLmuo0X",
"type": "video",
"data": {
"url": "https://videos.ctfassets.net/znxnw90vc5ew/7uAidRmq7VC7bvTq1Zd8Rx/c821009212f9fcfb1e5052cf0051392a/cover28-timelapse2_1.mp4",
"caption": "",
"autoplay": true,
"controls": true,
"muted": true,
"stretched": false
}
}
{
"id": "_jwh8Miavq",
"type": "quote",
"data": {
"text": "How did it all come to this",
"caption": "- Alien king says to himself",
"alignment": "left"
}
}
{
"id": "TVJQ2E5vmU",
"type": "embed",
"data": {
"service": "youtube",
"source": "https://youtu.be/5GaJOnwTHw8",
"embed": "https://www.youtube.com/embed/5GaJOnwTHw8",
"width": 580,
"height": 320,
"caption": ""
}
}
Last modified 1yr ago