Skip to content

Latest commit

 

History

History
 
 

twitch-bot

README.md

Manifold Markets Twitch Bot

This sub-repo has everything required to host the Manifold Twitch Bot and associated overlay and dock browser sources for OBS.

OBS example

Environmental variables

This Twitch bot requires the following environmental variables to be defined:

  • PUBLIC_FACING_URL: The public URL of the host server, without trailing slash, e.g. https://manifold.markets
  • TWITCH_BOT_USERNAME: The username for the Twitch bot account.
  • TWITCH_BOT_OAUTH_TOKEN: A valid OAuth token for the Twitch bot account obtained via this tool.
  • TWITCH_BOT_CLIENT_ID: The client ID of the Twitch app used to authorize new users. This app can be created in the Twitch Developer Console.
  • TWITCH_BOT_CLIENT_SECRET: The client secret of the Twitch app used to authorize new users.
  • TWITCH_BOT_FIREBASE_KEY: The API key for the relevant Firebase Firestore. This is currently hardcoded - please ask the author of this repo for the key, or modify the code to point to a new Firestore appropriately.

The following environmental variables are available but optional:

These can either be defined as global environmental variables on the system, or as a .env file in the root of the repository.

Starting development

  • Ensure the environmental variables are correctly configured
  • Ensure Yarn is installed
  • Ensure concurrently is installed globally (run npm install -g concurrently to install)
  • Run the following commands from the root of the Manifold repository:
    • $ yarn
    • $ cd twitch-bot
    • $ yarn
    • $ yarn dev:fullstack

The server automatically enables debugging in development mode. If using VSCode, you can attach to the process by pressing F5 and launching the Debug Twitch bot session.

Quick deployment to prod or dev servers

In order to deploy to the Manifold Twitch servers, you will need to have the appropriate permissions on your Google account, and the following software installed:

If you are using Windows, it is also recommended to have Git Bash installed, as the deployment script is targeted for use on Unix OSs.

Launch scripts/deploy-to-remote.sh. On Windows, this must be done through Git Bash. The script will ask whether you wish to deploy to the development or production server, and should then handle everything else.

Note: appropriate .env files must be copied into the scripts/build directory for the deployed bot to launch successfully.

The first time this script is run it will need to download docker images, Yarn dependencies and build all the source from scratch, so be patient! Subsequent runs should only take a matter of seconds to complete.

Alternative deployment

This repo can be built into a Docker image ready for deployment to a hosting site as-is. The container host must have all the environmental variables set for this to work.

The Docker image can be built using the scripts/build-docker.sh script, and run with the scripts/launch-docker.sh script.

Fixing failed deployments

In the case that the bot fails to deploy, it is possible that future "quick deployments" (i.e. using the deploy-to-remote script) will fail due to being unable to instigate a smooth handover of control to the updated bot container.

In order to fix this, all running Docker containers must be killed before the script can be run. This can be done by SSHing into the remote server using gcloud compute ssh dev-twitch-bot OR gcloud compute ssh twitch-bot and then running docker kill $(docker ps -q)

Viewing logs in production

There are two ways to view the logs of the deployed bot:

  1. Go to https://console.cloud.google.com/logs/query?project=mantic-markets and select either bot-DEV or bot-PROD under Log name.
  2. SSH into the remote server using gcloud compute ssh dev-twitch-bot OR gcloud compute ssh twitch-bot and run docker logs $(docker ps -q) -n 100

Viewing usage metrics

Future development

  • Port the overlay to a Twitch Extension to decrease viewer latency when viewing bets
  • Support market types other than binary
  • Rate limit management in the Twitch bot to prioritize outgoing messages when there is a risk of Twitch dropping them
  • Support betting to a percentage
  • Save which markets are currently featured on each Twitch channel to Firestore to support server rebooting without interruption
  • Allow docks to set the group within which markets created through chat will be added
  • Support renewing dock and overlay links in case of a leak
  • Reduce image sizes loaded from googleusercontent
  • Use gzip compression for serving webpages

Potential Kubernetes structure

Key principles

  • Only max one instance of TMI server to prevent multiple bots responding to the same message
  • Streams are sharded by hash to determine which bot responds to said stream's chat messages
  • Bots can come online and go offline as demand increases or decreases (effectively autoscaling without the risk of multiple responses)
                                      ┌───────────►DOCK
                                      │
                        stream1   ┌───┴───┐
                       ┌─────────►│ BOT 1 ├───────►OVERLAY
                       │          └───┬───┘
                       │              │
                       │              └───────────►DOCK
                       │
                       │
                       │
┌───────────┐       ┌──▼──┐   s2  ┌───────┐
│ TWITCH.TV │◄─────►│ TMI │◄─────►│ BOT 2 ├──────►DOCK
│  SERVERS  │       └──▲──┘       └───────┘
└───────────┘          │
                       │              .
                       │              .
                       │              .
                       │
                       │          ┌───────┐
                       └─────────►│ BOT 9 ├──────►OVERLAY
                            s9    └───────┘