Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.92 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.92 KB
Raw

OpenSquare QA Specification and Standards

This repository hosts standards for creating and interacting with questions and answers in the OpenSquare collaboration platform.

There are three types of standards: entities, identifiers and interactions. Entities are definitions for how a paid question should be declared and how answers should be given and declared, so that tools can recognize them as valid. Identifiers are definitions to help user recognize what and how many tokens are promised to be awarded. Interactions are interactions between the off-chain world and the OpenSquare Paid QA protocol, between topics and answers.

Interactions

The standards currently cover the following basic interactions:

  • NEW creates a new paid topic with a promise to award at least some amount of tokens.
  • APPEND allows a topic author to append content to an existed topic.
  • SUPPORT allows anyone to grant extra fund to an existed topic.
  • ANSWER submits an answer to a blockchain. The submitted answer is signed by the author.
  • FUND funds an answer or a topic immediately.
  • RESOLVE allows a topic author or supporter to resolve a topic.

Entities

Entities are a group of stuffs for QA collaboration, while they are usually related to the QA content.

  • topic is a topic to be discussed, or a question the author expect an answer.
  • message is a piece of content a topic author want to append to the topic.
  • answer is an answer signed with the author. It can be submitted to a blockchain by anyone.

Identifiers

Identifiers help recognize the promised awarded token and amount.