Feat: Add documentation for HCS-8 and HCS-9 #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kantorcodes
reviewed
Mar 8, 2025
| @@ -19,7 +18,7 @@ Polls are a common method of community engagement in which a question is posed t | |||
|
|
|||
| This framework provides a method to run a poll where poll activities are recorded on Hedera Hashgraph. Every poll is contained in a single HCS topic, allowing for retrieval of the history of the poll at any time. | |||
|
|
|||
| This standard is issued alongside HCS-YY: Poll Metadata Standards, which presents a robust specification for poll metadata for broader use in the ecosystem. | |||
| This standard is issued alongside hcs9: Poll Metadata Standards, which presents a robust specification for poll metadata for broader use in the ecosystem. | |||
kantorcodes
reviewed
Mar 8, 2025
|
|
||
| The Register operation must be the first message in the topic. Topics without a valid register operation as the first message are not considered valid HCS-8 polls. | ||
|
|
||
| The metadata for the register operation should be a JSON-formatted string. Poll metadata is recommended to follow hcs9: Poll Metadata Standard to allow for cross-platform compatibility. |
kantorcodes
reviewed
Mar 8, 2025
| } | ||
| }, | ||
| "options":{ | ||
| "schema":"hcs9", |
kantorcodes
reviewed
Mar 8, 2025
|
|
||
| When the Register metadata exceeds the maximum length of a HCS message (1024 characters), follow up Register operations are posted, as many as needed to complete the JSON string. | ||
|
|
||
| Only the first message in the topic, or the first set of messages (as identified by the ‘sid’ field) are legal register operations. Any register operations that occur after this are invalid and ignored. |
There was a problem hiding this comment.
optional (and probably out of scope for your work / timeline), but... consider storing full-json as an HCS-1 topic and referencing using t_id similar to other standards e.g.
reference to the standards-sdk for inscribing files: https://github.com/hashgraph-online/standards-sdk?tab=readme-ov-file#usage
kantorcodes
reviewed
Mar 8, 2025
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| #### [ hcs-8 - Poll Topic Standard ] |
There was a problem hiding this comment.
Can we add a table of contents?
kantorcodes
reviewed
Mar 8, 2025
|
|
||
| #### Topic Memo | ||
|
|
||
| Sets a short memo that is stored with the topic (100 bytes) |
There was a problem hiding this comment.
Can we have a formal memo standard similar to HCS-2 so its easy to find all HCS-8 topics? e.g.
hcs-8:poll-format...
kantorcodes
reviewed
Mar 8, 2025
|
|
||
| ``` | ||
| { | ||
| "p": "HCS-8", |
kantorcodes
reviewed
Mar 8, 2025
| If so, which features should be supported and how should we define it such that it is as simple to implement as possible? | ||
|
|
||
|
|
||
| ### Should 'schema' be optional (defaults to "hcs9")? |
kantorcodes
reviewed
Mar 8, 2025
| 2. Module Schemas define the structure of each of the modules in the base schema. | ||
| 3. The Vote Schema defines voting actions. | ||
|
|
||
| ### Base hcs9 Schema Specification |
kantorcodes
reviewed
Mar 8, 2025
|
|
||
| **Authors:** May Chan | ||
|
|
||
| ## Abstract |
There was a problem hiding this comment.
Could we have a section somewhere that explicitly states the memo format for an HCS-9 topic?
kantorcodes
reviewed
Mar 8, 2025
| title: HCS-9 Standard - Poll Metadata Schema | ||
| --- | ||
|
|
||
| #### [ hcs9 - Poll Metadata Schema ] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.