Author: @NoahSaso
Build an interface that replaces the current DF retroactive compensation system powered by Google Forms and Qualtrics, utilizing wallet login.
This will be built using Cloudflare Workers and Cloudflare D1 for relational DB storage.
It should:
- allow any DAO member to create a survey if one is not already active, specifying:
- a label for the survey
- the date contributions will start being accepted
- the date contributions will stop being accepted, and ratings start being accepted
- the date ratings will stop being accepted
- the attributes that can be rated for each contributor, and the tokens distributed according to each attribute
- (e.g. we may want to rate "financial value produced" separately from "community value produced", and reward financial compensation and voting power compensation differently)
- a markdown-formatted description that will be displayed to contributors while submitting
- a markdown-formatted description that will be displayed to DF members while rating
- allow anyone to submit their contributions to the currently active survey, while contributions are being accepted
- allow any DAO member to view contribution submissions, while ratings are being accepted
- allow any DAO member to submit ratings for each contributor that submitted, while ratings are being accepted
- allow any DAO member to view ratings for the active survey, once they have submitted their ratings OR once ratings stop being accepted
- allow any DAO member to record the proposal ID of the created proposal, setting the status to complete, once ratings stop being accepted
- allow any DAO member to view contributions and ratings from past surveys
- allow any DAO member to nominate contributions during the rating phase, in case someone did not submit a contribution
For brevity, wallet authentication information is omitted in the request bodies below. This template will be used to implement wallet auth: https://github.com/NoahSaso/cloudflare-worker-cosmos-auth
All references to a wallet (i.e. contributor and rater keys) are public keys. This system is not aware of chain addresses at all, as they are derivations of the public key.
Create a survey for the DAO, if one is not already active (active determined by the ratingsCloseAt date being in the future).
{
survey: {
name: string
contributionsOpenAt: string
contributionsCloseRatingsOpenAt: string
ratingsCloseAt: string
contributionInstructions: string
ratingInstructions: string
attributes: {
name: string
nativeTokens: {
denom: string
amount: string
}[]
cw20Tokens: {
address: string
amount: string
}[]
}[]
}
}Retrieve the survey for this DAO, and provide specific context for a wallet.
{
survey: {
status: 'inactive' |
'accepting_contributions' |
'accepting_ratings' |
'awaiting_completion' |
'complete'
name: string
contributionsOpenAt: string
contributionsCloseRatingsOpenAt: string
ratingsCloseAt: string
contributionInstructions: string
ratingInstructions: string
createdAtBlockHeight: number
attributes: {
name: string
nativeTokens: {
denom: string
amount: string
}[]
cw20Tokens: {
address: string
amount: string
}[]
}[]
}
contribution: string | null
rated: boolean
}Submit a contribution to the active survey. Anyone can do this while contributions are being accepted.
{
contribution: string
}Nominate a contribution to the active survey. Any DAO member can do this while ratings are being accepted.
{
contributor: string
contribution: string
}Submit ratings to the active survey. Any DAO member can do this while ratings are being accepted.
{
ratings: {
contributionId: number
// The position matches the position in the survey's attributes list.
attributes: (number | null)[]
}[]
}Fetch contributions for the active survey and this wallet's ratings if submitted already. Any DAO member can do this.
{
contributions: {
id: number
nominatedBy: string | null
contributor: string
content: string
createdAt: string
updatedAt: string
}[]
ratings: {
contributionId: number
// The position matches the position in the survey's attributes list.
attributes: (number | null)[]
}[]
}Fetch contributions and ratings for the active survey. Any DAO member can do this after the rating period closes.
{
contributions: {
id: number
nominatedBy: string | null
contributor: string
content: string
createdAt: string
updatedAt: string
}[]
ratings: {
rater: string
contributions: {
id: number
// The position matches the position in the survey's attributes list.
attributes: (number | null)[]
}[]
}[]
}Set the active survey to completed and store the proposal ID for the created proposal. Any DAO member can do this once ratings stop being accepted.
{
proposalId: string
}List completed surveys. Anyone can do this.
{
surveys: {
id: number
name: string
contributionCount: number
contributionsOpenedAt: string
proposalId: string
}[]
}View specific info for a completed survey. Any DAO member can do this.
{
survey: {
name: string
contributionsOpenAt: string
contributionsCloseRatingsOpenAt: string
ratingsCloseAt: string
contributionInstructions: string
ratingInstructions: string
proposalId: string
createdAtBlockHeight: number
attributes: {
name: string
nativeTokens: {
denom: string
amount: string
}[]
cw20Tokens: {
address: string
amount: string
}[]
}[]
contributions: {
id: number
nominatedBy: string | null
contributor: string
content: string
createdAt: string
updatedAt: string
}[]
ratings: {
rater: string
contributions: {
id: number
// The position matches the position in the survey's attributes list.
attributes: (number | null)[]
}[]
}[]
}
}hasMany Contribution hasMany Rating
{
surveyId: number
dao: string
name: string
contributionsOpenAt: Date
contributionsCloseRatingsOpenAt: Date
ratingsCloseAt: Date
contributionInstructions: string
ratingInstructions: string
attributesJson: string
proposalId: string | NULL
createdAtBlockHeight: number | null
}hasOne Survey
{
contributionId: number
surveyId: number
contributorPublicKey: string
nominatedByPublicKey: string | null
content: string
}hasOne Survey hasOne Contribution
{
ratingId: number
surveyId: number
contributionId: number
attributeIndex: number
raterPublicKey: string
rating: number
}