We all love opensource, but often random opensource contributors don't receive tangible rewards for their efforts when contributing to established projects.
⚡plit Donation is a low-to-zero-trust self-hosted web application that aims to change that by providing a service that opensource projects can use to automatically share their incoming donations with contributors and teams on github.
This is possible thanks to the Bitcoin Lightning Network.
You can see this app in action at https://donate.jmonkeyengine.org
As an opensource developer you can receive rewards for your contributions to projects using ⚡plit Donation by adding a lightning address or LNURL to your github profile
You can host one yourself or use one of the following wallets that provide also a free lightning url or address:
Alby (browser extension)
Wallet of Satoshi (mobile wallet)
Bitcoin Beach Wallet (mobile wallet)
Or you can check a more exhaustive list of lightning address providers, here.
Once you have obtained a lightning address or LNURL, the quickest way to add it to your github account is by placing it in your bio preceeded by a ⚡ emoji.
Show example
Other ways: TO BE DOCUMENTED
As a project maintainer you can host your instance of ⚡plit Donation following these steps.
You will need an host running docker and a remote LNDHub instance with CORS enabled ( by default we use https://ln.getalby.com , the donor can chose to use its own ). By default the code uses a cloudflare worker at https://lnhub.rblb.workers.dev that is a proxy to https://lndhub.io with CORS enabled, if you intend to use this setup, please run your own worker (see code).
To run an instance you need to
- Create the host directories to hold configurations and data
mkdir -p /srv/splitdonation/config
mkdir -p /srv/splitdonation/data
chown 1000:1000 -Rf /srv/splitdonation/data
chown 1000:1000 -Rf /srv/splitdonation/config- Clone this repo
cd /tmp
git clone https://github.com/riccardobl/SplitDonation.git-
Customize the configurations
- copy
config/config.jsonc.templateto/srv/splitdonation/config/config.jsonc - copy
config/backend.jsonc.templateto/srv/splitdonation/config/backend.jsonc - open and edit
/srv/splitdonation/config/config.jsoncand/srv/splitdonation/config/backend.jsonc(the comments will tell you how)
- copy
-
Build and run with docker
./docker-start.shThis should be put behind an https reverse proxy such as nginx or caddy. For this reason, by default, there is no port exposed in production mode. If you wish to expose the http port you can add -p7069:7069 at the end of the command.
In config.jsonc you need to specify a list of targets that can receive the donations.
Each target has the following common params
- weight: the default weight of the target, higher weight mean the target will be set to receive a bigger donation than lower weights targets (the donor can tweak the weights).
- minSats: (optional) minimum amount of sats for the donation toward this target (values below this will automatically be set to zero)
- minWeight: (optional) minimum weight of the target, weights below this value will be set to zero
- enabled: (optional) boolean that tells if the target is enabled or not (true by default)
The other params depend fom the type of the target:
- Lightning Addresses
- Github Repo Contributors
- Github Team members
- Collectives hosted by OpenCollectives (opted in to crypto donations)
The lightning address target is a target pointing to a given lightning address:
{
"type":"lightning-address",
// customize this part
"addr":"[email protected]",
"description":"A description for this target",
"weight":0.5 ,
//"minSats": ...,
//"minWeight": ...
//
}The Github Repo target will try to find lightning addresses of the collaborators of the specified github repos:
{
"type":"github-repo",
// customize this part
"modifier":"top-alltime", // valid modifiers: top-alltime top-monthly
"limit":30, // top X contributors
"autorefresh":true, // tell the backend to autorefresh this target (makes donations computation faster for big repos)
"org":"organization or user owning these repos",
"repos":[ // list of repos
"repo1",
"repo2",
"repo3"
],
"description":"A description for this target",
"weight":0.7
//"minSats": ...,
//"minWeight": ...
//
}The Github Team target will try to find lightning addresses of the members of the specified github teams:
{
"type":"github-org-team",
// customize this part
"org":"organization owning these teams",
"autorefresh":true, // tell the backend to autorefresh this target (makes donations computation faster for big teams)
"teams":[ // list of teams
"team1",
"team2"
],
"description":"A description for this target",
"weight":0.5
//"minSats": ...,
//"minWeight": ...
//
}Since OpenCollective is already the established way for many opensource projects to receive donations, ⚡plit Donation provides a target to bridge donations to opencollectives opted in to receive crypto donations.
Since OpenCollective doesn't support lightning at the moment,this is done through an exchange and might incur in higher fees than usual.
{
"type":"opencollective",
// customize this part
"collective":"slug of the collective",
"minSats": 5034, // opencollective has a minimum donation size. You should probably leave this like that to avoid the donation being rejected.
"description":"A description for this target",
"weight":0.5
//"minWeight": ...
//
}For each donation made through ⚡plit Donation, a conservative fee reserve is allocated to pay for routing and (when needed) exchange fees.
Donors have an option to withdraw the unspent reserve after each donation or to send it to a predefined lightning address.
By default this address is hardcoded and associated with this project as a sort of dev fee, however you are free to replace it with your own if you wish so. The address to look for is [email protected].
If you still wish to donate some sats to the project you can scroll down to Donate to this project.
To build a development environment on linux you will need docker and polar.
First install docker and run the post installation steps to enable it for non root users (needed by polar);
Then install polar and create a network made by 1 btc node and 5 LND nodes.
Connect them together with some channels, see screenshot below.
The next step is to start the development environment, but first you'll have to configure it.
Cd into the cloned repo and rename .env-template to .env, open it with a text editor and configure each variable to match the ones provided by polar (GRPC address, CERT HEX and MACAROON HEX) for each node.
After that, you should add the following lines to your /etc/hosts
127.0.0.1 alice-lnsplitpay.test
127.0.0.1 bob-lnsplitpay.test
127.0.0.1 carol-lnsplitpay.test
127.0.0.1 dave-lnsplitpay.test
127.0.0.1 erin-lnsplitpay.test
This will provide the following lightning addresses that can be used for local testing:
Once the configuration is done, you can start the environment by running
./run-dev-env.shTo finish the setup we will connect a lightning wallet to one of our local node. We will use the GetAlby extension, but other wallets will work.
Go back to polaris, grab the RPC url and macaroon of the alice node:
Open the REST url and accept the self signed certificate in the browser.
Install the GetAlby extension and use it to connect to the LND node with the REST host and Macaroon obtained from polar
You can now start ⚡plit Donation in dev mode by running
DEV=1 CONFIG_PATH=test-config ./start.shOr with docker
DEV=1 ./docker-start.shYou can support this project through
- Bitcoin⚡ (Lightning Address):
[email protected] - Bitcoin:
bc1qdgugzpdvdvlme38zt7zt7jjh42htzu0txq8m9x - Github Sponsor
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent