https://github.com/ElementsProject/nanotip

:zap: Lightning Tip Box :zap:
https://github.com/ElementsProject/nanotip

bitcoin donations lightning lightning-charge micropayments nanopayments tip tip-jar tips

Last synced: 3 months ago
JSON representation

:zap: Lightning Tip Box :zap:

• Host: GitHub
• URL: https://github.com/ElementsProject/nanotip
• Owner: ElementsProject
• License: mit
• Created: 2018-01-10T10:25:49.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-17T19:45:14.000Z (almost 6 years ago)
• Last Synced: 2024-10-03T09:24:39.940Z (4 months ago)
• Topics: bitcoin, donations, lightning, lightning-charge, micropayments, nanopayments, tip, tip-jar, tips
• Language: JavaScript
• Homepage: https://blockstream.com/2018/03/24/tipping-on-lightning-with-nanotip-lapp.html
• Size: 35.2 KB
• Stars: 85
• Watchers: 12
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-lightning-network - nanotip - Lightning Tip Box (based on c-lightning); [Blog Post](https://blockstream.com/2018/03/24/tipping-on-lightning-with-nanotip-lapp.html) (Applications / Misc)
• awesome-lightning-network - nanotip - Lightning Tip Box (based on c-lightning); [Blog Post](https://blockstream.com/2018/03/24/tipping-on-lightning-with-nanotip-lapp.html) (Applications / Misc)

README

        
# nanotip

[![npm release](https://img.shields.io/npm/v/nanotip.svg)](https://www.npmjs.com/package/nanotip)

[![MIT license](https://img.shields.io/github/license/elementsproject/nanotip.svg)](https://github.com/elementsproject/nanotip/blob/master/LICENSE)

[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

[![IRC](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](https://webchat.freenode.net/?channels=lightning-charge)

A simple web server for accepting lightning donations.

`nanotip` generates Lightning invoices on the fly using your Lightning Charge server,

allowing users to setup a tip jar that accepts Lightning Network payments.

Powered by :zap: [Lightning Charge](https://github.com/ElementsProject/lightning-charge).

![nanotip demo](https://i.imgur.com/WLoiRT2.gif)

## Setup

Setup [Lightning Charge](https://github.com/ElementsProject/lightning-charge), then:

```bash

$ npm install -g nanotip

$ nanotipd --charge-token mySecretToken # defaults: --charge-url http://localhost:9112 --port 9115

nanotipd running on http://localhost:9115

```

Note that `nanotip` uses Lightning Charge's built-in checkout page, meaning that the Lightning Charge

server has to be publicly accessible to users. If users need to access it using a different URL

than the one used for communicating with the API, set `--charge-public-url`.

You can use `--theme` to pick a different [theme from bootswatch](https://bootswatch.com).

## CLI options

```bash

$ nanotipd --help

  Lightning Tip Box

  Usage

    $ nanotipd [options]

  Options

    -c, --charge-url         lightning charge server url [default: http://localhost:9112]

    -t, --charge-token     lightning charge access token [required]

    -P, --charge-public-url  url where charge is publicly accessible [default: {charge-url}]

    -m, --theme             pick theme from bootswatch.com [default: yeti]

    -l, --title             website title [default: Lightning Tip Box]

    -p, --port              http server port [default: 9115]

    -i, --host              http server listen address [default: 127.0.0.1]

    -u, --url                http server public url (used for webhooks) [default: http://{host}:{port}]

    -T, --thankyou-url       url to send users to after completing the payment [default: {url}/thankyou]

    -e, --node-env           nodejs environment mode [default: production]

    -h, --help                    output usage information

    -v, --version                 output version number

  Example

    $ nanotipd -c http://localhost:9112 -t chargeSecretToken

```

## License

MIT