Accept Bitcoin donations on Twitch, and integrate them into your alerts!

Last update: Jan 08, 2023

Overview

The system in action

Check out how seamlessly the project works!

Support the project

You can tip me with some sats here!
This is, and always will be, entirely free to use of course!

Rough test setup guide

This is currently intended for testing only.
You need to have git, python, and it's virtualenv module installed.

Clone the repo and cd into it
Create and enable a virtualenv
In the venv, run pip install -r requirements.txt
Get an lntxbot wallet
Get an API key from lntxbot by messaging it /api full
Log in to https://streamlabs.com/
Register an App
As this is an app just for you, you can fill the name, description
phone, and email fields with whatever you want. They are not relevant.
In the "Whitelist Users" field, enter your Twitch username.
In "Redirect URI", enter "http://localhost:6969".
After hitting "Create", leave this page open for now, as it contains
your Client ID and Secret, which you will need in the next step
Run python initial_setup.py and follow the instructions (enter localhost as the IP for now)
Run python wait_for_token.py and leave this running
On the Streamlabs App page, click the link that says "Sample Authentication URL"
towards the bottom of the page
Click "Approve"; this should redirect you to a plain text page that tells you to stop the server
Go back to the terminal that is running wait_for_token.py,
and hit ctrl+c to stop the server
You should now be able to run . ./start_lnbits.sh, which should launch
LNbits in the background, making it reachable at http://localhost:5000/
Run python webhook.py and leave it running in the background
In LNbits, create a wallet, and enable the SatsPayServer extension under "Manage extensions"
In SatsPayServer, hit "NEW CHARGE," and fill out all the required fields
In the "webhook" field, enter http://localhost:5001/
Pay the charge with any lightning wallet
(After hitting "CREATE CHARGE," the charge should appear in a list after
an automatic refresh. On the very left side of that list entry is a small
grey button that will open the payment link in a new tab.)

If everything worked, you should see a new donation pop up here (remember to refresh).
If something went wrong, please submit an issue!

Contributing

I want this to be a project that allows streamers on Twitch to integrate Bitcoin donations
into their on-stream alerts with as little setup as possible.
Things you can help with:

Clarifying steps in the guide, or linking to/writing more detailed guides to get non-technical users up to speed
Writing scripts that would make this run on Windows (in case a streamer opts for self-hosting on Windows)

I'm not at all used to maintaining projects with other contributors, so I don't know, just follow the
common etiquette or whatever if you wanna help :)
I would especially appreciate help with just making things cleaner and more efficient (I'm not a professional),
as well as potentially integrating services other than Streamlabs (not sure if there are any
that are widely used like Streamlabs and actually have an API for this).

Comments

Create LNbits extension
Optimally, parts of this repo should become an LNbits extension:

Most of what is currently in settings.json could be set via UI

API endpoint that serves as redirect for Streamlabs access_token (essentially wait_for_token.py)

webhook.py as background service

The extension should also allow modification of the donation format that is sent here.

The extension's front end would ideally be a simple tipping form that asks for "Name," "Message," and "Amount" in either sats or any of the supported currencies, converting the amount to sats to create an invoice.
Another option that would be great to have available is a Twitch login button that auto-fills the "Name" field, and sets the identifier to a unique ID value, like the Twitch User ID (see here).

I've created a branch to work on this: https://github.com/Fittiboy/lnbits/tree/TwitchAlerts Will be closed by lnbits/lnbits#227
enhancement help wanted
opened by Fittiboy 5
Your tip link doesn't work from BLW

Hi,

I tried to send tip from the BLW wallet (@btcontract - author of the LNURL) but I got the error:

"requirement failed: Action domain mismatch"

From the Blixt wallet - there is everything OK.

I think your chain URLs from LNURL communication has different domains but the LNURL protocol requires to have the same domains (#6 point - "url domain must be the same as callback domain at step 3" in example comment)

Is it your the bug or the BLW?

opened by Perlover 3
Integreate StreamElements API

It appears that StreamElements is currently working on providing a nice API. They have a WIP API reference which includes an endpoint to post tips, exactly what is needed to integrate this.

Would be great to have this!
documentation enhancement help wanted

opened by Fittiboy 1
Sovereign
This PR adds a guide on how to cut out all middlemen and run this in self-sovereign mode.
The Bitcoin way.
Closes #5

[ ] How to set up your own node (Just link to Raspiblitz)

[ ] How to change the funding source of LNbits

documentation enhancement
opened by Fittiboy 0
Enable full self-sovereignty
The original purpose of this project was to cut out all middlemen.
To this end, the only change that has to be made is the LNbits funding source.
Two short guides are required for this:

[ ] How to set up your own node (Just link to Raspiblitz)

[ ] How to change the funding source of LNbits

It should also be considered to potentially use Raspiblitz' LNbits
documentation enhancement
opened by Fittiboy 0
Automate Bitclouds.sh Setup
A lot of the setup required for Bitclouds.sh hosting can be automated.

[ ] Purchasing a Bitclouds VPS instance

[ ] Checking remaining balance

[ ] Low balance alerts

[ ] Discord webhook?

[ ] Telegram bot?

[ ] Email?

[ ] Getting a top-up invoice

[ ] Installing git and python3-venv

[ ] Caddy

[ ] Adding the repo

[ ] Installing caddy

[ ] Creating the Caddyfile

documentation enhancement
opened by Fittiboy 0
Add hosting guides for #2
This PR adds guides on how to actually host this publicly.
Closes #2

[ ] Purchasing a Bitclouds VPS instance

[ ] Checking remaining balance

[ ] Low balance alerts

[ ] Discord webhook?

[ ] Telegram bot?

[ ] Email?

[ ] Getting a top-up invoice

[ ] Installing git and python3-venv

[ ] Caddy

[ ] Adding the repo

[ ] Installing caddy

[ ] Creating the Caddyfile

documentation enhancement
opened by Fittiboy 0
Create guide on how to deploy publicly
Currently, the system is fully functional, but does not yet include a guide on how to publicly deploy.

[ ] Acquiring a domain

[ ] Full domain name

[ ] Duck DNS

[ ] Guide on how to self-host

[ ] Setting up nginx

[ ] SSL cert via certbot

[ ] Enabling reverse-proxy

[ ] Opening the necessary port (443)

[ ] Setting up Cloudflare

[ ] Creating an account

[ ] Adding domain to Cloudflare

[ ] Hiding behind Cloudflare

[ ] Whitelisting Cloudflare IP range

[ ] Guide on how to host via Bitclouds

[ ] Basic Bitclouds setup guide

[ ] Keeping Bitclouds instance up (keep funding it!)

[ ] Installing git, python3-venv, and Caddy

[ ] Creating a Caddyfile

documentation enhancement
opened by Fittiboy 0

Releases(v1.0.2)

v1.0.2(Aug 4, 2021)

This release fixes an issue that caused whitelist_user.py to crash.
Source code(tar.gz)
Source code(zip)
v1.0.1(Aug 3, 2021)

This small update adds user whitelisting! The whitelist_user.py script allows users to add their user ID to the LNBITS_ALLOWED_USERS environment variable, preventing people from creating wallets on their LNbits instance. This change is reflected in the guide as well.
Source code(tar.gz)
Source code(zip)
v1.0.0(Aug 3, 2021)

This is the first functional release of the project! It can be fully utilized at this point.
Source code(tar.gz)
Source code(zip)

Owner

Fitti

Bitcoin, ML, self-study

GitHub Repository https://twitter.com/Fittiboy/status/1399753700445507590

Accept Bitcoin donations on Twitch, and integrate them into your alerts!

Related tags

Overview

The system in action

Support the project

Rough test setup guide

Contributing

Comments

Releases(v1.0.2)

v1.0.2(Aug 4, 2021)

v1.0.1(Aug 3, 2021)

v1.0.0(Aug 3, 2021)

Owner

Fitti

This folder contains all the assignment of the course COL759 : Cryptography & Computer Security

Blockchain with crypto transaction feature

E2EE disabling plugin for Synapse

SDU experiment of introduction to the cryptography

SVSHI - Secure and Verified Smart Home Infrastructure

A python-jvm wrapper for interacting with the Ergo blockchain.

Bitcoin & Lightning Container Manager for facilitating development tools

Python Dash app that tracks whale activity in cryptocurrency markets.

Python implementation of EIP 1577 content hash

Maximal extractable value inspector for Ethereum, to illuminate the dark forest 🌲 💡

BlockVis - Create beautiful visualizations of Bitcoin Blockheaders

Cyber Security Starter Kit Platform

一个关于摩斯密码解密与加密的库 / A library about encoding and decoding Morse code.

A simple web application with tools of cryptography, made with Flask and Cryptography.

Decrypting winrm traffic using password/ntlm hash

Get the length of the Instagram encrypted password

High Performance Blockchain Deserializer

Atomkraft - Lightweight e2e testing for cosmos blockchains

Python binding to the Networking and Cryptography (NaCl) library

Secure open-source password manager.