ts-vote-frame

Typescript frame service for Farcaster

Development

pnpm i
pnpm dev

Head to http://localhost:5173

Saldy the HMR does not work when using frog with node.js, so you'll have to stop and start the server between changes, manually (even tho the console will say "page reload").

Environment vars

• PORT - Port to listen to. Defaults to 5173.
• APP_BASE_URL - Base URL for the app. Defaults to http://localhost:${PORT}
• VOCDONI_ENV - Environment to use for vocdoni. Defaults to stg.

Usage

Main endpoint is /image which generates images based on the parameters received.

Receives either POST or GET requests. For GET requests, plural (array) parameters, should be defined in singular form, as many times as required (i.e. &choice=Choice1&choice=Choice2).

It requires a type parameter, which can be question, results, info or error.

The other parameters depend on the type:

error

Expects a error property with the error message.

curl -X POST -H "Content-Type: application/json" -d '{
  "type": "error",
  "error": "Invalid process id"
}' "http://localhost:5173/image"

Optional: title changing the default ERROR title.

votecast, alreadyvoted, noteligible

They all have a title set by default, but you can override it via title

curl -X POST -H "Content-Type: application/json" -d '{
  "type": "alreadyvoted",
  "title": "Dude, you cannot vote twice!"
}' "http://localhost:5173/image"

info

Expects an info property of type []string, which will be displayed as a list:

curl -X POST -H "Content-Type: application/json" -d '{
  "info": "info",
  "info": [
    "first line",
    "second line",
    "third line",
    "etc line"
  ]
}' "http://localhost:5173/image"

question

Expects question (string) and choices ([]string):

curl -X POST -H "Content-Type: application/json" -d '{
  "type": "question",
  "question": "How do you like kiwi?",
  "choices": [
    "Skin ON",
    "Skin OFF",
    "Dafuq, Kiwi???"
  ]
}' "http://localhost:5173/image"

results

Expects everything from question + results ([]string), voteCount (number) and maxCensusSize (number):

curl -X POST -H "Content-Type: application/json" -d '{
  "type": "results",
  "question": "How do you like kiwi?",
  "choices": [
    "Skin ON",
    "Skin OFF",
    "Dafuq, Kiwi???"
  ],
  "results": ["8", "3", "9"],
  "voteCount": 10,
  "maxCensusSize": 100
}' "http://localhost:5173/image"

Frames

This project also has some frames calls you can use to render images based on vochain data.

• /poll/:pid - Renders a poll frame based on the specified poll id.
• /poll/results/:pid - Renders a poll results frame based on the specified poll id.