Merge pull request #32 from jerolimov/icon

Add icon to readme and favicon to generated code

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: https://ln.michaelbumann.com?lightning=lnurlp:ln.michaelbumann.com/lnurlp/github

.github/workflows/on-push.yml

@@ -0,0 +1,43 @@
+name: Build on push
+
+permissions:
+  packages: write
+
+on:
+    push:
+        branches:
+            - main
+            - master
+
+jobs:
+  build:
+    name: Build image
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v2
+
+      - name: Set env variables
+        run: |
+          echo "BRANCH=$(echo ${GITHUB_REF#refs/heads/} | sed 's/\//-/g')" >> $GITHUB_ENV
+          IMAGE_NAME="${GITHUB_REPOSITORY#*/}"
+          echo "IMAGE_NAME=${IMAGE_NAME//docker-/}" >> $GITHUB_ENV
+
+      - name: Login to Docker Hub
+        run: echo ${{ secrets.GITHUB_TOKEN }} | docker login ghcr.io -u ${{ github.repository_owner }} --password-stdin
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+        id: qemu
+
+      - name: Setup Docker buildx action
+        uses: docker/setup-buildx-action@v1
+        id: buildx
+
+      - name: Run Docker buildx
+        run: |
+                docker buildx build \
+                --platform linux/amd64,linux/arm64 \
+                --tag ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME:$BRANCH \
+                --output "type=registry" ./

.github/workflows/on-tag.yml

@@ -0,0 +1,43 @@
+name: Build on tag
+
+permissions:
+  packages: write
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+      - v[0-9]+.[0-9]+.[0-9]+-*
+
+jobs:
+  build:
+    name: Build image
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v2
+
+      - name: Set env variables
+        run: |
+          echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+          IMAGE_NAME="${GITHUB_REPOSITORY#*/}"
+          echo "IMAGE_NAME=${IMAGE_NAME//docker-/}" >> $GITHUB_ENV
+
+      - name: Login to Docker Hub
+        run: echo ${{ secrets.GITHUB_TOKEN }} | docker login ghcr.io -u ${{ github.repository_owner }} --password-stdin
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+        id: qemu
+
+      - name: Setup Docker buildx action
+        uses: docker/setup-buildx-action@v1
+        id: buildx
+
+      - name: Run Docker buildx
+        run: |
+                docker buildx build \
+                --platform linux/amd64,linux/arm64 \
+                --tag ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME:$BRANCH \
+                --output "type=registry" ./

.gitignore

@@ -1,2 +1,4 @@
 vendor
 config.toml
+
+data-dir*

.lndonate

@@ -0,0 +1 @@
+lnurlp://ln.michaelbumann.com/.well-known/lnurlp/bumi

Dockerfile

@@ -0,0 +1,20 @@
+# Go base image
+FROM golang:1.17-alpine as builder
+
+RUN go get github.com/GeertJohan/go.rice && go get github.com/GeertJohan/go.rice/rice
+
+WORKDIR /app
+
+COPY . .
+
+RUN go install
+
+RUN rice embed-go && go build
+
+FROM alpine:3.14
+
+COPY --from=builder /app/lnme /lnme
+
+EXPOSE 1323
+
+CMD ["/lnme"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Michael Bumann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,26 +1,31 @@
-# LnMe - your friendly ⚡ payment page
+<p align="center"><br/><br/><img src="https://raw.githubusercontent.com/bumi/lnme/master/icon/lnme-icon-rrect.svg" height="128" width="128" /><br/><br/></p>
+<h1 align="center">LnMe - your friendly payment page</h1><br/><br/>
 
-LnMe is a personal Bitcoin Lightning payment website and payment widget.
+LnMe is a personal Bitcoin Lightning payment page/widget and self-hosted [Lightning Address](https://lightningaddress.com/) server.
 
 ![demo](./lnme-demo.gif)
 
-It is a small service written in Go that connects to a [lnd node](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) and exposes a simple HTTP JSON API to create and monitor invoices. 
-It comes with a configurable personal payment website and offers a JavaScript widget to integrate in existing websites.
+**See it in action: [ln.michaelbumann.com](https://ln.michaelbumann.com/) - my lightning address: bumi@ln.michaelbumann.com**
 
-If [webln](https://github.com/wbobeirne/webln) is available the widget automatically use webln to request the payment; 
-otherwise an overlay will be shown with the payment request and a QR code.
+LnMe focusses on simplicity and ease of deployment. It connects to an existing lightning node (currently LND is supported).
 
-## Motivation
+LnMe is one [simple executable](https://github.com/bumi/lnme/releases) file that can be deployed anywhere with no dependencies. (on your own node or for example with [one click on Heroku](#heroku))
 
-I wanted a simple way for people to send Lightning payments using my own lightning node.
-
-BTCPay Server is too big and hard to run for that and I do not need most of its features.
+## Features
 
+- [x] Embeded payment page - customizable (see demo)
+- [x] [Lightning Address](https://lightningaddress.com/) support
+- [x] WebLN integration - if [WebLN](https://webln.dev/) is not available a QRcode and the invoice will be shown
+- [x] [JavaScript widget](#javascript-widget-integration) for existing websites
+- [x] [Invoice API](https://github.com/bumi/lnme/wiki/API) - simple REST API to create LN invoices from existing JS code
+- [ ] [LNURL-pay](https://github.com/fiatjaf/lnurl-rfc/blob/luds/06.md) support
 
 ## Installation
 
 LnMe connects to your [LND node](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md), so a running LND node is required.
-LnMe can easily run next to LND on the same system.
+LnMe can easily run next to LND on the same system or any other hosting provider.
+
+There are no other dependencies. Simply download the binary and run it!
 
 1. Download the latest [release](https://github.com/bumi/lnme/releases)
 2. Run `lnme`
@@ -35,6 +40,12 @@ LnMe can easily run next to LND on the same system.
 
 Note: You must have [go.rice installed](https://github.com/GeertJohan/go.rice#installation)
 
+### Running in Docker
+
+LnMe is now available in docker too.
+You can start LnMe like this: `docker run -it --rm ghcr.io/bumi/lnme:master`
+A list of existing tags is available [here](https://github.com/bumi/lnme/pkgs/container/lnme).
+
 ### Configuration
 
 #### LND configuration
@@ -55,6 +66,7 @@ Instead of the path to the macaroon and cert files you can also provide the hex
 * `static-path`: Path to a folder that you want to serve with LnMe (e.g. /home/bitcoin/lnme/website). Use this if you want to customize your ⚡website. default: disabled
 * `disable-website`: Disable the default LnMe website. Disable the website if you only want to embed the LnMe widget on your existing website.
 * `disable-cors`: Disable CORS headers. (default: false)
+* `disable-ln-address`: Disable [Lightning Address](https://lightningaddress.com/) handling.
 * `port`: Port to listen on. (default: 1323)
 * `request-limit`: Limit the allowed requests per second. (default: 5)
 
@@ -84,17 +96,52 @@ All environment variables must be prefixed by `LNME_` use `_` instead of `-`
 
     $ LNME_LND_ADDRESS=127.0.0.1:10005 lnme
 
+### LND Permissions
 
-### Deployment
+LnMe needs the following LND permissions:
 
-It is the easiest to run LnMe on the same node as LND. But you can run it anywhere as long as your LND node is accessible.
+* Read/Write permission for `invoices`
+* Write permission for `address` (if you want to use the onchain option)
 
-#### Heroku 
+Use the LND [macaroon bakery](http://macaroon-bakery.freedomnode.com/) to create a new macaroon for LnMe.
+
+To get the HEX versions of the files use `xxd -plain` e.g. `xxd -plain invoice.macaroon | tr -d '\n'`
+
+### TOR
+
+LnMe can connect to your lightning node through [Tor](https://www.torproject.org/). You need to have Tor installed on your system and then simply provide your LND `.onion` address (don't forget to specify the port).
+
+
+## Deployment
+
+It is the easiest to run LnMe on the same node as LND. But you can run it anywhere as long as your LND node is accessible. Simply run the binary and make sure the PORT is accessible.
+
+If you run LNMe on a different server you will need your LND address, the LND TLS certificate (HEX) and the macaroon (HEX). (see above)
+
+When getting the HEX of the LND files use `xxd -plain YOUR_FILE.cert | tr -d '\n'`. For example for the TLS certificate, use `xxd -plain tls.cert | tr -d '\n'`. 
+
+The TLS cert is located in the lnd directory:
+* ~/umbrel/lnd/tls.cert on Umbrel
+* /mnt/hdd/lnd/tls.cert on Raspiblitz
+* Can also be located in ~/.lnd
+
+You should find the macaroon files in the LND data dir (e.g. ~.lnd/data/chain/bitcoin/mainnet/) or see "LND Permissions" how to create a new one. 
+
+
+### Heroku
 One click deployment with Heroku:
 
 [![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/bumi/lnme)
 
-#### Notes
+Here is a [Video Demo of the Heroku deployment](https://www.youtube.com/watch?v=hSFXhnLp_Rc)
+
+In order to run Tor on Heroku, the Heroku deployment includes a non-official buildpack: https://github.com/iamashks/heroku-buildpack-tor-proxy
+This buildpack can be disabled and removed if not needed or desired, through the Settings tab on the Heroku dashboard, or by editing app.json and removing the buildpack.
+
+Lastly, using the Heroku deployment, you can link the app to your own domain by following the directions here: https://help.heroku.com/MTG1BIA7/how-do-i-connect-a-domain-to-my-heroku-app
+
+
+### Deployment Notes
 
 To run LnMe as systemd service have a look at the [systemd service example config](https://github.com/bumi/lnme/blob/master/examples/lnme.service)
 
@@ -109,6 +156,18 @@ lnme.michaelbumann.com {
 `$ caddy  --config /etc/caddy/Caddyfile`
 
 
+## Feature Usage
+
+### Lightning Address
+
+The Lightning Address is an Internet Identifier that allows anyone to send you Bitcoin over the Lightning Network.
+Lightning Address builds on [LNURL-pay](https://github.com/fiatjaf/lnurl-rfc/blob/luds/06.md) LnMe handles the necessary requests for you.
+
+For more information check out the website: [lightningaddress.com](https://lightningaddress.com/)
+
+Your Lightning Address: `{anything}@{your domain}`
+
+
 ### Customize your ⚡ website
 
 LnMe comes with a default website but you can easily configure and build your own using the the LnMe JavaScript widget or JSON API.
@@ -168,6 +227,11 @@ lnme.watchPayment().then(invoice => {
 
 ```
 
+## Motivation
+
+I wanted a simple way for people to send Lightning payments using my own lightning node.
+BTCPay Server is too big and hard to run for that and I do not need most of its features.
+
 ## Development
 
 Use `go run` to ron the service locally:

app.json

@@ -16,11 +16,18 @@
     "LNME_LND_CERT": {
       "description": "LND TLS cert as HEX",
       "value": ""
+    },
+    "LNME_TOR_EXE_PATH": {
+      "description": "Path to the tor executable",
+      "value": "/app/tor/bin/tor"
     }
   },
   "buildpacks": [
     {
       "url": "https://github.com/heroku/heroku-buildpack-go"
+    },
+    {
+      "url": "https://github.com/iamashks/heroku-buildpack-tor-proxy.git"
     }
   ]
 }

files/assets/favicon.svg

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon-no-padding</title>
+    <defs>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
+            <stop stop-color="#FFA500" offset="0%"></stop>
+            <stop stop-color="#FFE300" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFE300" offset="0%"></stop>
+            <stop stop-color="#FFA500" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon-no-padding" transform="translate(0.000000, -0.460904)">
+            <polygon id="Path1" fill="url(#linearGradient-1)" points="439.147203 0 192.83828 475.102188 823.013089 475.102188 909.205258 386.884293 491.070577 386.884293 737.132519 0.460904"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-2)" points="115.14578 615.666174 528.131075 615.666174 327.461698 1024 793.918502 509.464888 174.115801 509.464888"></polygon>
+        </g>
+    </g>
+</svg>

files/assets/icon.svg

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon-rect</title>
+    <defs>
+        <linearGradient x1="0%" y1="64.5790537%" x2="100%" y2="64.5790537%" id="linearGradient-1">
+            <stop stop-color="#3D3393" offset="0%"></stop>
+            <stop stop-color="#2B76B9" offset="24.6013508%"></stop>
+            <stop stop-color="#2CACD1" offset="67.981896%"></stop>
+            <stop stop-color="#35EB93" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFA500" offset="0%"></stop>
+            <stop stop-color="#FFE300" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-3">
+            <stop stop-color="#FFE300" offset="0%"></stop>
+            <stop stop-color="#FFA500" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon-rect">
+            <rect id="Background" fill="url(#linearGradient-1)" x="0" y="0" width="1024" height="1024"></rect>
+            <polygon id="Path1" fill="url(#linearGradient-2)" points="456 91.539096 254.655336 479.91029 769.790288 479.91029 840.247879 407.796774 498.444643 407.796774 698.541282 95.539096"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-3)" points="191.14578 594.813998 528.739662 594.813998 364.70294 928.605547 746.006985 508 239.350688 508"></polygon>
+        </g>
+    </g>
+</svg>

files/assets/zap.svg

@@ -1,3 +0,0 @@
-<svg width="128" height="128" style="enable-background:new 0 0 128 128;" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-  <path d="M115.36,61.84L70.22,50.49L114.45,2.4c0.41-0.45,0.43-1.13,0.05-1.6c-0.39-0.48-1.07-0.59-1.59-0.27 L12.3,61.98c-0.41,0.25-0.64,0.72-0.57,1.2c0.06,0.48,0.4,0.87,0.87,1.01l45.07,13.25L13.38,125.6c-0.42,0.46-0.44,1.15-0.04,1.61 c0.24,0.29,0.58,0.44,0.94,0.44c0.22,0,0.45-0.06,0.65-0.19l100.78-63.41c0.42-0.26,0.64-0.75,0.56-1.22 C116.19,62.34,115.84,61.95,115.36,61.84z" style="fill:#FCC21B;"/>
-</svg>

files/root/index.html

@@ -6,9 +6,9 @@
     <meta property="og:site_name" content="">
     <meta property="og:description" content="">
 
-    <meta property="og:image" content="/lnme/zap.svg">
+    <meta property="og:image" content="/lnme/icon.svg">
 
-    <title>⚡ Send me some Sats</title>
+    <title>Send me some Sats</title>
     <style>
       html {
         width: 100%;
@@ -111,6 +111,7 @@
         cursor: pointer;
       }
     </style>
+    <link rel="icon" type="image/svg+xml" href="/lnme/favicon.svg" />
   </head>
   <body>
     <div class="wrapper">

go.mod

@@ -7,6 +7,7 @@ go 1.15
 replace go.etcd.io/etcd => go.etcd.io/etcd v0.5.0-alpha.5.0.20201125193152-8a03d2e9614b
 require (
 	github.com/GeertJohan/go.rice v1.0.2
+	github.com/cretz/bine v0.2.0
 	github.com/didip/tollbooth/v6 v6.1.1
 	github.com/knadh/koanf v1.2.1
 	github.com/labstack/echo/v4 v4.5.0

go.sum

@@ -135,6 +135,8 @@ github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f h1:lBNOc5arjvs8E5mO2tbp
 github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
 github.com/creack/pty v1.1.7 h1:6pwm8kMQKCmgUg0ZHTm5+/YvRK0s3THD/28+T6/kk4A=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
+github.com/cretz/bine v0.2.0 h1:8GiDRGlTgz+o8H9DSnsl+5MeBK4HsExxgl6WgzOCuZo=
+github.com/cretz/bine v0.2.0/go.mod h1:WU4o9QR9wWp8AVKtTM1XD5vUHkEqnf2vVSo6dBqbetI=
 github.com/daaku/go.zipexe v1.0.0 h1:VSOgZtH418pH9L16hC/JrgSNJbbAL26pj7lmD1+CGdY=
 github.com/daaku/go.zipexe v1.0.0/go.mod h1:z8IiR6TsVLEYKwXAoE/I+8ys/sDkgTzSL0CLnGVd57E=
 github.com/davecgh/go-spew v0.0.0-20171005155431-ecdeabc65495/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -568,6 +570,8 @@ golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a h1:vclmkQCjlDX5OydZ9wv8rB
 golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2 h1:It14KIkyBFYkHkwZ7k45minvA9aorojkyjGk9KJ5B/w=
 golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
+golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a h1:kr2P4QFmQr29mSLA43kwrOcgcReGTfbE9N577tCTuBc=
+golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4 h1:c2HOrn5iMezYjSlGPncknSEr/8x5LELb/ilJbXi9DEA=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/lint v0.0.0-20180702182130-06c8688daad7/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
@@ -599,6 +603,8 @@ golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81R
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 h1:4nGaVu0QrbjT/AK2PRLuQfQuh6DJve+pELhqTdAj3x0=
 golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
+golang.org/x/net v0.0.0-20210525063256-abc453219eb5 h1:wjuX4b5yYQnEQHzd+CBcrcC6OVR2J1CN6mUy0oSxIPo=
+golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d h1:TzXSXBo42m9gQenoE3b9BGiEpg5IG2JkU5FkPIawgtw=
 golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -636,6 +642,7 @@ golang.org/x/sys v0.0.0-20200826173525-f9321e4c35a6/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210426080607-c94f62235c83 h1:kHSDPqCtsHZOg0nVylfTo20DDhE9gG4Y0jn7hKQ0QAM=
 golang.org/x/sys v0.0.0-20210426080607-c94f62235c83/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 h1:v+OssWQX+hTHEmOBgwxdZxK4zHq3yOs8F9J7mk0PY8E=

icon/lnme-icon-bnw.svg

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon-bnw</title>
+    <defs>
+        <linearGradient x1="0%" y1="64.5790537%" x2="100%" y2="64.5790537%" id="linearGradient-1">
+            <stop stop-color="#3A3A3A" offset="0%"></stop>
+            <stop stop-color="#595959" offset="24.6013508%"></stop>
+            <stop stop-color="#7B7B7B" offset="67.981896%"></stop>
+            <stop stop-color="#8B8B8B" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#B4B4B4" offset="0%"></stop>
+            <stop stop-color="#FFFFFF" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-3">
+            <stop stop-color="#FFFFFF" offset="0%"></stop>
+            <stop stop-color="#AEAEAE" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon-bnw">
+            <rect id="Background" fill="url(#linearGradient-1)" x="0" y="0" width="1024" height="1024" rx="128"></rect>
+            <polygon id="Path1" fill="url(#linearGradient-2)" points="456 91.539096 254.655336 479.91029 769.790288 479.91029 840.247879 407.796774 498.444643 407.796774 698.541282 95.539096"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-3)" points="191.15 594.813998 528.743882 594.813998 364.70716 928.605547 746.011205 508 239.354908 508"></polygon>
+        </g>
+    </g>
+</svg>

icon/lnme-icon-no-padding.svg

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon-no-padding</title>
+    <defs>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
+            <stop stop-color="#FFA500" offset="0%"></stop>
+            <stop stop-color="#FFE300" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFE300" offset="0%"></stop>
+            <stop stop-color="#FFA500" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon-no-padding" transform="translate(0.000000, -0.460904)">
+            <polygon id="Path1" fill="url(#linearGradient-1)" points="439.147203 0 192.83828 475.102188 823.013089 475.102188 909.205258 386.884293 491.070577 386.884293 737.132519 0.460904"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-2)" points="115.14578 615.666174 528.131075 615.666174 327.461698 1024 793.918502 509.464888 174.115801 509.464888"></polygon>
+        </g>
+    </g>
+</svg>

icon/lnme-icon-rect.svg

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon-rect</title>
+    <defs>
+        <linearGradient x1="0%" y1="64.5790537%" x2="100%" y2="64.5790537%" id="linearGradient-1">
+            <stop stop-color="#3D3393" offset="0%"></stop>
+            <stop stop-color="#2B76B9" offset="24.6013508%"></stop>
+            <stop stop-color="#2CACD1" offset="67.981896%"></stop>
+            <stop stop-color="#35EB93" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFA500" offset="0%"></stop>
+            <stop stop-color="#FFE300" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-3">
+            <stop stop-color="#FFE300" offset="0%"></stop>
+            <stop stop-color="#FFA500" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon-rect">
+            <rect id="Background" fill="url(#linearGradient-1)" x="0" y="0" width="1024" height="1024"></rect>
+            <polygon id="Path1" fill="url(#linearGradient-2)" points="456 91.539096 254.655336 479.91029 769.790288 479.91029 840.247879 407.796774 498.444643 407.796774 698.541282 95.539096"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-3)" points="191.14578 594.813998 528.739662 594.813998 364.70294 928.605547 746.006985 508 239.350688 508"></polygon>
+        </g>
+    </g>
+</svg>

icon/lnme-icon-rrect.svg

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon-rrect</title>
+    <defs>
+        <linearGradient x1="0%" y1="64.5790537%" x2="100%" y2="64.5790537%" id="linearGradient-1">
+            <stop stop-color="#3D3393" offset="0%"></stop>
+            <stop stop-color="#2B76B9" offset="24.6013508%"></stop>
+            <stop stop-color="#2CACD1" offset="67.981896%"></stop>
+            <stop stop-color="#35EB93" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFA500" offset="0%"></stop>
+            <stop stop-color="#FFE300" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-3">
+            <stop stop-color="#FFE300" offset="0%"></stop>
+            <stop stop-color="#FFA500" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon-rrect">
+            <rect id="Background" fill="url(#linearGradient-1)" x="0" y="0" width="1024" height="1024" rx="128"></rect>
+            <polygon id="Path1" fill="url(#linearGradient-2)" points="456 91.539096 254.655336 479.91029 769.790288 479.91029 840.247879 407.796774 498.444643 407.796774 698.541282 95.539096"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-3)" points="191.14578 594.813998 528.739662 594.813998 364.70294 928.605547 746.006985 508 239.350688 508"></polygon>
+        </g>
+    </g>
+</svg>

icon/lnme-icon.svg

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="1024px" height="1024px" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>lnme-icon</title>
+    <defs>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
+            <stop stop-color="#FFA500" offset="0%"></stop>
+            <stop stop-color="#FFE300" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFE300" offset="0%"></stop>
+            <stop stop-color="#FFA500" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="lnme-icon">
+            <polygon id="Path1" fill="url(#linearGradient-1)" points="456 91.539096 254.655336 479.91029 769.790288 479.91029 840.247879 407.796774 498.444643 407.796774 698.541282 95.539096"></polygon>
+            <polygon id="Path2" fill="url(#linearGradient-2)" points="191.14578 594.813998 528.739662 594.813998 364.70294 928.605547 746.006985 508 239.350688 508"></polygon>
+        </g>
+    </g>
+</svg>

ln/lnd.go

@@ -7,12 +7,15 @@ import (
 	"fmt"
 	"io/ioutil"
 	"log"
+	"net"
 	"os"
+	"strings"
 
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"github.com/lightningnetwork/lnd/macaroons"
 	"gopkg.in/macaroon.v2"
 
+	"github.com/cretz/bine/tor"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials"
 )
@@ -34,6 +37,7 @@ type LNDoptions struct {
 	CertHex      string
 	MacaroonFile string
 	MacaroonHex  string
+	TorExePath   string // used when connecting through tor to LND
 }
 
 type LNDclient struct {
@@ -43,12 +47,13 @@ type LNDclient struct {
 }
 
 // AddInvoice generates an invoice with the given price and memo.
-func (c LNDclient) AddInvoice(value int64, memo string) (Invoice, error) {
+func (c LNDclient) AddInvoice(value int64, memo string, descriptionHash []byte) (Invoice, error) {
 	result := Invoice{}
 
 	stdOutLogger.Printf("Adding invoice: memo=%s value=%v", memo, value)
 	invoice := lnrpc.Invoice{
 		Memo:            memo,
+		DescriptionHash: descriptionHash,
 		Value:           value,
 	}
 	res, err := c.lndClient.AddInvoice(c.ctx, &invoice)
@@ -132,6 +137,21 @@ func NewLNDclient(lndOptions LNDoptions) (LNDclient, error) {
 		grpc.WithTransportCredentials(creds),
 	}
 
+	if strings.Contains(lndOptions.Address, ".onion") {
+		// Start Tor
+		t, err := tor.Start(nil, &tor.StartConf{ExePath: lndOptions.TorExePath})
+		if err != nil {
+			return result, err
+		}
+		torDialer, err := t.Dialer(context.Background(), nil)
+		if err != nil {
+			return result, err
+		}
+		opts = append(opts, grpc.WithContextDialer(func(ctx context.Context, addr string) (net.Conn, error) {
+			return torDialer.DialContext(ctx, "tcp", addr)
+		}))
+	}
+
 	var macaroonData []byte
 	if lndOptions.MacaroonHex != "" {
 		macBytes, err := hex.DecodeString(lndOptions.MacaroonHex)

lnme.go

@@ -1,14 +1,18 @@
 package main
 
 import (
+	"crypto/sha256"
 	"flag"
+	"fmt"
 	"log"
 	"net/http"
 	"os"
+	"strconv"
 	"strings"
 
 	rice "github.com/GeertJohan/go.rice"
 	"github.com/bumi/lnme/ln"
+	"github.com/bumi/lnme/lnurl"
 	"github.com/didip/tollbooth/v6"
 	"github.com/didip/tollbooth/v6/limiter"
 	"github.com/knadh/koanf"
@@ -20,6 +24,8 @@ import (
 	"github.com/labstack/echo/v4/middleware"
 )
 
+const DEFAULT_LISTEN = ":1323"
+
 // Middleware for request limited to prevent too many requests
 // TODO: move to file
 func LimitMiddleware(lmt *limiter.Limiter) echo.MiddlewareFunc {
@@ -88,6 +94,7 @@ func main() {
 		CertHex:      cfg.String("lnd-cert"),
 		MacaroonFile: cfg.String("lnd-macaroon-path"),
 		MacaroonHex:  cfg.String("lnd-macaroon"),
+		TorExePath:   cfg.String("tor-exe-path"),
 	}
 	lnClient, err := ln.NewLNDclient(lndOptions)
 	if err != nil {
@@ -105,7 +112,7 @@ func main() {
 			return c.JSON(http.StatusBadRequest, "Bad request")
 		}
 
-		invoice, err := lnClient.AddInvoice(i.Value, i.Memo)
+		invoice, err := lnClient.AddInvoice(i.Value, i.Memo, nil)
 		if err != nil {
 			stdOutLogger.Printf("Error creating invoice: %s", err)
 			return c.JSON(http.StatusInternalServerError, "Error adding invoice")
@@ -137,16 +144,79 @@ func main() {
 		return c.JSON(http.StatusOK, invoice)
 	})
 
+	if !cfg.Bool("disable-ln-address") {
+		lnurlHandler := func(c echo.Context) error {
+			host := c.Request().Host
+			if c.Request().Header.Get(echo.HeaderXForwardedFor) != "" {
+				host = c.Request().Header.Get(echo.HeaderXForwardedFor)
+			}
+			name := c.Param("name")
+			lightningAddress := name + "@" + host
+			lnurlMetadata := "[[\"text/identifier\", \"" + lightningAddress + "\"], [\"text/plain\", \"Sats for " + lightningAddress + "\"]]"
+
+			if amount := c.QueryParam("amount"); amount == "" {
+				lnurlPayResponse1 := lnurl.LNURLPayResponse1{
+					LNURLResponse:   lnurl.LNURLResponse{Status: "OK"},
+					Callback:        fmt.Sprintf("%s://%s%s", c.Scheme(), host, c.Request().URL.Path),
+					MinSendable:     1000,
+					MaxSendable:     100000000,
+					EncodedMetadata: lnurlMetadata,
+					CommentAllowed:  0,
+					Tag:             "payRequest",
+				}
+				return c.JSON(http.StatusOK, lnurlPayResponse1)
+			} else {
+				stdOutLogger.Printf("New LightningAddress request amount: %s", amount)
+				msats, err := strconv.ParseInt(amount, 10, 64)
+				if err != nil || msats < 1000 {
+					stdOutLogger.Printf("Invalid amount: %s", amount)
+					return c.JSON(http.StatusOK, lnurl.LNURLErrorResponse{Status: "ERROR", Reason: "Invalid Amount"})
+				}
+				sats := msats / 1000 // we need sats
+				metadataHash := sha256.Sum256([]byte(lnurlMetadata))
+				invoice, err := lnClient.AddInvoice(sats, lightningAddress, metadataHash[:])
+				if err != nil {
+					stdOutLogger.Printf("Error creating invoice: %s", err)
+					return c.JSON(http.StatusOK, lnurl.LNURLErrorResponse{Status: "ERROR", Reason: "Server Error"})
+				}
+				lnurlPayResponse2 := lnurl.LNURLPayResponse2{
+					LNURLResponse: lnurl.LNURLResponse{Status: "OK"},
+					PR:            invoice.PaymentRequest,
+					Routes:        make([][]lnurl.RouteInfo, 0),
+					Disposable:    false,
+					SuccessAction: &lnurl.SuccessAction{Tag: "message", Message: "Thanks, payment received!"},
+				}
+				return c.JSON(http.StatusOK, lnurlPayResponse2)
+			}
+		}
+		e.GET("/.well-known/lnurlp/:name", lnurlHandler)
+		e.GET("/lnurlp/:name", lnurlHandler)
+	}
+
 	// Debug test endpoint
 	e.GET("/ping", func(c echo.Context) error {
 		return c.JSON(http.StatusOK, "pong")
 	})
 
 	port := cfg.String("port")
+	// Special case for PORT instead of LNME_PORT due to cloud-providers
 	if os.Getenv("PORT") != "" {
 		port = os.Getenv("PORT")
 	}
-	e.Logger.Fatal(e.Start(":" + port))
+	listen := cfg.String("listen")
+	if listen != "" && port != "" {
+		log.Fatalf("Port and listen options are mutually exclusive, please just use listen.")
+	}
+	if listen == "" {
+		if port != "" {
+			stdOutLogger.Printf("Please use listen instead of deprecated port setting.")
+			listen = fmt.Sprintf(":%s", port)
+		} else {
+			listen = DEFAULT_LISTEN
+		}
+	}
+
+	e.Logger.Fatal(e.Start(listen))
 }
 
 func LoadConfig() *koanf.Koanf {
@@ -157,10 +227,13 @@ func LoadConfig() *koanf.Koanf {
 	f.String("lnd-macaroon-path", "~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon", "Path to the LND macaroon file.")
 	f.String("lnd-cert-path", "~/.lnd/tls.cert", "Path to the LND tls.cert file.")
 	f.Bool("disable-website", false, "Disable default embedded website.")
+	f.Bool("disable-ln-address", false, "Disable Lightning Address handling")
 	f.Bool("disable-cors", false, "Disable CORS headers.")
 	f.Float64("request-limit", 5, "Request limit per second.")
 	f.String("static-path", "", "Path to a static assets directory.")
-	f.String("port", "1323", "Port to bind on.")
+	f.String("port", "", "Port to bind on (deprecated - use listen).")
+	f.String("listen", "", fmt.Sprintf("Address to bind on. (default \"%s\")", DEFAULT_LISTEN))
+	f.String("tor-exe-path", "tor", "Path to the Tor executable. Used when connecting through Tor. (default: tor)")
 	var configPath string
 	f.StringVar(&configPath, "config", "config.toml", "Path to a .toml config file.")
 	f.Parse(os.Args[1:])

lnurl/types.go

@@ -0,0 +1,52 @@
+// THANKS: https://github.com/fiatjaf/go-lnurl/blob/d50a8e916232580895822178fe36e0f5cf400554/base.go
+// only using the LNURL types here
+package lnurl
+
+import "net/url"
+
+type LNURLResponse struct {
+	Status string `json:"status,omitempty"`
+	Reason string `json:"reason,omitempty"`
+}
+
+type LNURLPayResponse1 struct {
+	LNURLResponse
+	Callback        string   `json:"callback"`
+	CallbackURL     *url.URL `json:"-"`
+	Tag             string   `json:"tag"`
+	MaxSendable     int64    `json:"maxSendable"`
+	MinSendable     int64    `json:"minSendable"`
+	EncodedMetadata string   `json:"metadata"`
+	Metadata        Metadata `json:"-"`
+	CommentAllowed  int64    `json:"commentAllowed"`
+}
+
+type LNURLPayResponse2 struct {
+	LNURLResponse
+	SuccessAction *SuccessAction `json:"successAction"`
+	Routes        [][]RouteInfo  `json:"routes"`
+	PR            string         `json:"pr"`
+	Disposable    bool           `json:"disposable,omitempty"`
+}
+
+type RouteInfo struct {
+	NodeId        string `json:"nodeId"`
+	ChannelUpdate string `json:"channelUpdate"`
+}
+
+type SuccessAction struct {
+	Tag         string `json:"tag"`
+	Description string `json:"description,omitempty"`
+	URL         string `json:"url,omitempty"`
+	Message     string `json:"message,omitempty"`
+	Ciphertext  string `json:"ciphertext,omitempty"`
+	IV          string `json:"iv,omitempty"`
+}
+
+type LNURLErrorResponse struct {
+	Status string   `json:"status,omitempty"`
+	Reason string   `json:"reason,omitempty"`
+	URL    *url.URL `json:"-"`
+}
+
+type Metadata [][]string