Concepts
Post
Inside Desmos, a post represents a single piece of content within a subspace. This can be used to represent things such as a blog post, a tweet, or anything else. A post can also be used to represents a quote of another post, a comment or a re-post of another content.
Aside from the inner text, developers can put on chain some metadata that can be useful during the visualization of the post, such as (but not limited to): links, users mentions or hashtags.
Subspace ID
The subspace id specifies the id of the subspace inside which the post is placed.
Section ID
The section id specifies the id of the subspace section where the post is placed.
ID
A post id is the unique identifier of that post within the subspace. Each post id is generated automatically when handling a MsgCreatePost and can be used along with the subspace id itself to uniquely identify a post within Desmos.
External ID (Optional)
A post external id is an optional text field that can be useful to developers that want to link this post to an external data storage. As an example, if a developer wants to store the post content on their own data storage what they can do is use the external id field to tell how the content should be retrieved.
Text (Optional)
A post text is the actual textual content of the post. It has a fixed max length that is determined by an on-chain governance parameter. Any post with a text length greater than the current max length allowed will be considered invalid and not stored on the chain (an error will be returned during the saving). To store large text posts we recommend storing the post text contents on an external storage and then using either the text or external id fields to specify how to retrieve them.
Entities (Optional)
Entities represent part of the post's text content that should be rendered in a particular way. These include hashtags, mentions to other users or links.
TextTag
Both hashtags and mentions are represented as a TextTag. The TextTag structure contains the necessary fields that ease the process of
text's parsing.
Start
Index within the post text at which the tag starts.
End
Index within the post text at which the tag ends.
Tag
The actual value of the tag. Usually this is going to be either the hashtag value, or the address of the mentioned user (if within the post text the DTag is used to reference the user).
Url
Within Desmos there is no URL validation, so this type can be used to represent any kind of URL that might be present inside the post text.
Start
Index within the post text at which the URL starts.
End
Index within the post text at which the URL ends.
Url
The actual value of the url where the user should be redirected to.
Display url (Optional)
Value to be displayed within the post text instead of the URL value itself. This might be useful if you want to shorten a link or if you want to represent a clickable text.
Tags (optional)
Tags represent a set of strings that can be useful to quickly identify the post's contents. They can be used for content categorization or other different scopes.
Author
Address of the post author.
Conversation ID (optional)
In order to be able to display a conversation properly, you can use the conversation id to specify the id of the post that should be considered as the first post of the conversation itself. As an example, if a thread is started then all posts referring to that thread should have the same conversation, even if they are answering other posts. This is to make sure they can be connected to the original conversation and displayed within it.
Referenced Posts
In order to represent various interactions with a post, inside Desmos we use post references. All the references that a post has to other posts should be placed inside the referenced posts array.
PostReference
A reference to an external post. This can be used to represent a reply (comment), repost or quote of another post.
Type
Type of the post reference. It can be one of the following values:
| Name | Description |
|---|---|
POST_REFERENCE_TYPE_REPLY | This reference represents a reply to the specified post |
POST_REFERENCE_TYPE_QUOTE | This reference represents a quote of the specified post |
POST_REFERENCE_TYPE_REPOST | This reference represents a repost of the specified post |
Post ID
The id of the referenced post. Note that it's possible to reference only posts within the same subspace. Trying to reference a post within another subspace will return an error or might end up in unwanted behavior.
Position
If the post reference represents a quote of a post, it might be useful to be able to specify the index within the text at which the quoted post should be rendered. This is particularly useful if a post should quote more than one post: with different positions application will be able to render the quoted post properly.
Note that trying to set this field to a non-zero value with any kind of reference aside TYPE_QUOTE will end up in the post being considered invalid.
Reply Setting
This field contains the possible reply settings that a post can have. It can be one of the following values:
| Name | Description |
|---|---|
REPLY_SETTING_EVERYONE | This reference represents a reply to the specified post |
REPLY_SETTING_FOLLOWERS | This reference represents a quote of the specified post |
REPLY_SETTING_MUTUAL | This reference represents a repost of the specified post |
REPLY_SETTING_MENTIONS | Only people mentioned inside this post will be able to reply |
Creation Date
The creation date of the post.
Last Edited Date
The las time the post has been edited.
Owner
The owner of the post. This is the user that can edit or delete the post. Usually this is the same as the author, but it might be different if the post ownership has been transferred.
Attachment
An attachment represents any kind of media that can be attached to a post, such as (but not limited to): an image, a GIF, or a poll.
Subspace ID
The subspace id specifies the id of the subspace inside which the post related to the attachment is.
Post ID
The post id specifies the id of the post to which the attachment is associated.
ID
An attachment id is the unique identifier within a specific post. This is automatically created when handling a MsgCreatePost or MsgAddPostAttachment. With the subspace id and post id, it can be used to uniquely identify an attachment within Desmos.
Content
The content of the attachment. It can be either a media content (e.g. a picture, a video, a GIF, etc), or a poll.
Media
A media content can be used to specify the details of a media attachment (e.g. an image, a video, a GIF, etc).
URI
The URI referencing the media.
Mime type
The mime type of the media.
Poll
A poll media can be used to represent a poll attachment.
Question
The question of the poll.
Provided answers
The possible answers the users can chose from to reply the poll. They are each an instance of ProvidedAnswer.
Provided Answer
The representation of a provided answer for a poll.
Text (Optional)
The text of the answer. Note that either one of the text or attachments field must be specified within a provided answer to make sure it's valid.
Attachments (Optional)
The attachments associated to the answer. This can be useful to allow polls where answers are represented by a media content (e.g. an image) instead of a text. Note that either one of the text or attachments field must be specified within a provided answer to make sure it's valid.
End Date
The date when the poll will close. Once this date has passed, the final results of the poll will be automatically tallied on the next block after such date. Also, all new answers after the date will not be considered valid.
Allow Multiple Answers
This field tells if the poll allows multiple answers from the same user or not.
Allow Answer Edits
This field tells if the poll allows users to edit their answers or not.
Final Tally Results
This fields contains the final results of the poll. It's going to be populated by the chain after the poll has ended. Trying to provide a final tally results value inside a MsgCreatePost or MsgAddPostAttachment will return an error.
Results
The poll results for each provided answer, represented each one by an AnswerResult.
Answer Result
This structure contains the result of a single poll provided answer
Answer Index
The index of the answer within the post's ProvidedAnswer field associated to which these results.
Votes
The number of votes received by an answer.
User Answer
The user answer represent an answer given by a user to a poll.
Subspace ID
The subspace id represents the id of the subspace inside which is placed the post that contains the poll to which this answer refers.
Post ID
Id of the post that contains the poll to which this answer refers.
Poll ID
Id of the poll to which this answer refers.
Answer Indexes
The answer indexes contains a list of user answers, each one identified by the index of the chosen option within the poll's ProvidedAnswer array.
User
The address of the user answering the poll.
PostOwnerTransferRequest
A post owner transfer request is a request that can be used to transfer the ownership of a post from one user to another. This can be useful in case a user wants to transfer the ownership of a post to another user, for example because they are leaving the platform.
Subspace ID
The subspace id represents the id of the subspace inside which is present the post which ownership should be transferred.
Post ID
The id of the post which ownership should be transferred.
Sender
Address of the user that has sent the post ownership transfer request.
Receiver
Address of the user that should receive the post ownership.