Relay Robot

Relay <> GPT for fun and profit!

Development

To run the app locally:

• npm run dev:tsc (starts tsc in watch mode)
• npm run dev:express (starts the express server)
• npm run dev:xmtp (starts the xmtp server)

To understand what's going on, here's a suggested reading order:

• README.md
• deploy/docker-compose.yml
• package.json
• apps/*

App (src/)

For now we have some basic structure:

• apps/
  • entrypoints for the app
  • must not export anything
• features/
  • exactly like apps except for that they can be imported by apps
• apis/
  • completely gatekeep a single source of truth
  • cannot import from each other.

Deploy (deploy/)

To run in a docker compose cluster:

• npm run docker:up

Scripts and configuration for deploying the app. Deployed to Digital Ocean droplet instance.

Deploying to Production

v0 Requirements

• [x] A GitHub Action to build and push Docker images.
• [x] A manaul deploy script that uses docker-compose to pull the latest images and restart the containers.
• [ ] An as-simple-as-possible blue-green deployment strategy for zero-downtime deployments.

v1 Requirements

• [ ] Multiple environments (staging, production, etc).

Monitoring (monitor/)

Scripts and configuration for deploying the monitoring service. Deployed to Digital Ocean droplet instance.

v0 Requirements

To start, for each component, the two questions we want to answer are:

1. Is the component up?
2. Is the component struggling?

• [x] supabase
• [x] open ai
• [x] xmtp
• [ ] front
• [x] xmtp app
• [x] express app
• [ ] vps instance

Logging

v0 Requirements

• [ ] log all inbound requests
• [ ] log all open ai responses
• [ ] log all api errors
• [ ] log all slow requests
• [ ] log all uncaught entrypoint errors

Feature Roadmap

v1 Requirements

• [ ] device a QA AI assessment framework
• [ ] heavily favor escalation > hallucination
  • [ ] First pass: prompt engineering escalation
  • [ ] Second pass: pick a solution from the reliability whitepaper and implement it
• [ ] include wallet context in escalation

Technical Roadmap

v0

• [ ] LetsEncrypt SSL certificate and nginx reverse proxy w/ acme companion.
• [ ] deployment playbook
• [ ] canary service
• [ ] instance monitoring

vX

• [ ] error monitoring service
• [ ] multiple supabase environments

Technical BOM

For an end-to-end understanding of how this project works, you need to have a working familiarity with the following technologies:

• Digital Ocean Droplets
• Docker and Docker Compose
• GitHub and GitHub Actions
• Nginx
• LetsEncrypt
• Express
• XMTP
• Open AI
• Supabase
• Pinecone
• Front
• Discord
• TypeScript
• Express
• Zod
• Winston

ETL

• What are the links we want to scrape?