gitpayd

Github Workflows + BTC / LND, gitpayd watches your repo for new commits and sends payments to contributors

[INFO]  2021-04-05T00:34:10.007Z => found lnd version: 0.12.0-beta.rc1 
[INFO]  2021-04-05T00:34:10.010Z => gitpayd started in 849ms on SERVER:7777
[INFO]  2021-04-05T00:36:41.376Z => x.x.x.x connected to gitpayd/health
[INFO]  2021-04-05T00:36:41.598Z => x.x.x.x connected to gitpayd/noops
[INFO]  2021-04-05T00:36:41.707Z => processing issue #13...
[INFO]  2021-04-05T00:36:41.779Z => attempting to settle pull request #14 for 150 sats
[INFO]  2021-04-05T00:36:41.890Z => payment amount decoded: 100 sats
[ERROR] 2021-04-05T00:36:41.892Z => decoded amount does not match bounty!
[INFO]  2021-04-05T00:38:07.507Z => x.x.x.x connected to gitpayd/health
[INFO]  2021-04-05T00:38:07.590Z => x.x.x.x connected to gitpayd/noops
[INFO]  2021-04-05T00:38:07.702Z => processing issue #13...
[INFO]  2021-04-05T00:38:07.772Z => attempting to settle pull request #14 for 100 sats
[INFO]  2021-04-05T00:38:07.869Z => payment amount decoded: 100 sats
[INFO]  2021-04-05T00:38:07.944Z => gitpayd channel balance is: 484976 sats
[INFO]  2021-04-05T00:38:08.926Z => Pull Request successfully merged
[INFO]  2021-04-05T00:38:13.092Z => payment pre-image: L2wHWnourzWsAsH0F3f2GKxDYilTUzNEavdhk6MKqF8=

*** Caution: This application is beta and breaking changes may occur. Use mainnet at your own risk!

Proposal

1. End user opens issue (generates invoice) and pays amount that becomes a bounty.
2. Developer picks up issue on first-come, first-serve basis
   • Pull request is opened to resolve the issue
   • aggressive build, testing and security analysis completes
   • PR is merged and % of bounty is paid to the developer
3. Payment is sent for production deployment to bots deploying and / maintaining infrastructure
   • end user gets feedback
   • issue is resolved

Project Layout

gitpayd/
├── src                # Directory of source code
   ├── test              # Test files
   ├── config.ts         # Configuration properties
   ├── gitpayd.ts        # Entry point for the app
   ├── noops.ts          # NoOps / DevOps script for processing CI / CD payments
   ├── setup.ts          # Creates configuration, connects to LND, helper functions, etc.
   ├── logging.ts        # In house logger, since TS hates console.log()
   ├── util.ts           # General purpose functions and logic for CI / CD

Building

1. cd gitpayd/ and run npm i to install modules
2. Run npm run clean && npm run build
3. Output is in /dist

Development

1. Set environment variable export GITPAYD_ENV=DEV for development if needed
2. Run node dist/gitpayd.js to run server *--help for help
3. Test health check at http://hostname:7778/gitpayd/health (*port 7777 is default secure port)
4. Verify configuration files at ~/.gitpayd/config.json

Options:
      --help                     Show help                             [boolean]
      --version                  Show version number                   [boolean]
      --key-path, --kp           Path to SSL private key                [string]
      --cert-path, --cep         Path to the server certification       [string]
      --ca-path, --cap           Path to the CA intermediate certification
                                                                        [string]
      --root-path, --rp          Path to the root intermediate certification
                                                                        [string]
  -p, --port                     port to run the server                 [number]
      --dev-port, --dvp          dev port to run the server             [number]
  -o, --owner                    owner of the repo NoOps is running
                                                             [string] [required]
  -r, --repo                     name of the repo NoOps is running
                                                             [string] [required]
      --max-pay, --mp            maximum allowable payment              [string]
      --payment-threshold, --pt  minimum channel balance to maintain    [string]
      --log-level, --ll          comma separated list of log levels to maintain
                                                                        [string]

Missing required arguments: owner, repo

Security

1. API key is generated at setup, protect or configure your own
2. Pull Requests are validated against OWNER and COLLABORATOR author associations.
3. Payment thresholds are configured in command line.
4. SSL certs / passphrase is required to start the https server (self-signed should be fine).
5. GITHUB_TOKEN runs at the repo level. Only authorized contributors are allowed.
6. It is possible to run dev server on http as fallback mechanism with export GITPAYD_ENV=DEV set

prompt: Enter SSL passphrase or press Enter for DEV mode 
        Hint: for DEV mode export GITPAYD_ENV=DEV
:  
[ERROR] 2021-04-03T00:30:49.164Z => https is not configured, check ssl certs location or passphrase
[user@server gitpayd]$ 

Notes

1. This application runs on the latest Node 12.x+
2. Currently, only battle tested on Fedora 34 Beta
3. Secrets can be configured in your repository settings => secrets
4. Sample Github workflow .yml is located in gitpayd/.github/workflows/build.yml

Required Secrets

GITHUB_TOKEN

Sample .gitpayd/config.json

{
  "macaroonPath": "/home/USER/path/to/macaroon",
  "lndHost": "localhost:10009",
  "internalApiKey": "xxx",
  "tlsPath": "/home/USER/path/to/tls.cert",
  "rpcProtoPath": "/home/USER/path/to/rpc.proto",
  "routerProtoPath": "/home/USER/path/to/routerrpc/router.proto"
}

Delimiters

Installation

1. Run npm i -g gitpayd
2. Execute gitpayd should start up the server
3. Execute from workflow as curl or create your own action thingy!

Releasing

TODO: Automated release management via npm publish and workflows

Testing with Jest

npm test more tests are encouraged