Add backend: ln.tips (LightningTipBot) wallet (#921)

* add ln.tips

* add wallet

* revert lnbits

* make format

* .env.example

* listener fix

* reconnect fixed

* make format

* make format

.env.example

@@ -41,7 +41,7 @@ LNBITS_SITE_DESCRIPTION="Some description about your service, will display if ti
 LNBITS_THEME_OPTIONS="classic, bitcoin, flamingo, freedom, mint, autumn, monochrome, salvador"
 # LNBITS_CUSTOM_LOGO="https://lnbits.com/assets/images/logo/logo.svg"
 
-# Choose from LNPayWallet, OpenNodeWallet, LntxbotWallet, ClicheWallet
+# Choose from LNPayWallet, OpenNodeWallet, LntxbotWallet, ClicheWallet, LnTipsWallet
 #             LndRestWallet, CoreLightningWallet, LNbitsWallet, SparkWallet, FakeWallet, EclairWallet
 LNBITS_BACKEND_WALLET_CLASS=VoidWallet
 # VoidWallet is just a fallback that works without any actual Lightning capabilities,
@@ -92,3 +92,8 @@ LNBITS_DENOMINATION=sats
 # EclairWallet
 ECLAIR_URL=http://127.0.0.1:8283
 ECLAIR_PASS=eclairpw
+
+# LnTipsWallet
+# Enter /api in LightningTipBot to get your key
+LNTIPS_API_KEY=LNTIPS_ADMIN_KEY
+LNTIPS_API_ENDPOINT=https://ln.tips

lnbits/extensions/lnurldevice/__init__.py

@@ -1,9 +1,10 @@
 import asyncio
+
 from fastapi import APIRouter
 
 from lnbits.db import Database
-from lnbits.tasks import catch_everything_and_restart
 from lnbits.helpers import template_renderer
+from lnbits.tasks import catch_everything_and_restart
 
 db = Database("ext_lnurldevice")
 
@@ -14,8 +15,8 @@ def lnurldevice_renderer():
     return template_renderer(["lnbits/extensions/lnurldevice/templates"])
 
 
-from .tasks import wait_for_paid_invoices
 from .lnurl import *  # noqa
+from .tasks import wait_for_paid_invoices
 from .views import *  # noqa
 from .views_api import *  # noqa
 

lnbits/extensions/lnurldevice/templates/lnurldevice/_api_docs.html

@@ -4,19 +4,21 @@
       For LNURL based Points of Sale, ATMs, and relay devices<br />
       Use with: <br />
       LNPoS
-      <a href="https://lnbits.github.io/lnpos"
-        > https://lnbits.github.io/lnpos</a
+      <a href="https://lnbits.github.io/lnpos">
+        https://lnbits.github.io/lnpos</a
       ><br />
       bitcoinSwitch
-      <a href="https://github.com/lnbits/bitcoinSwitch"
-        > https://github.com/lnbits/bitcoinSwitch</a
+      <a href="https://github.com/lnbits/bitcoinSwitch">
+        https://github.com/lnbits/bitcoinSwitch</a
       ><br />
       FOSSA
-      <a href="https://github.com/lnbits/fossa"
-        > https://github.com/lnbits/fossa</a
+      <a href="https://github.com/lnbits/fossa">
+        https://github.com/lnbits/fossa</a
       ><br />
       <small>
-        Created by, <a href="https://github.com/benarc">Ben Arc</a>, <a href="https://github.com/blackcoffeexbt">BC</a>, <a href="https://github.com/motorina0">Vlad Stan</a></small
+        Created by, <a href="https://github.com/benarc">Ben Arc</a>,
+        <a href="https://github.com/blackcoffeexbt">BC</a>,
+        <a href="https://github.com/motorina0">Vlad Stan</a></small
       >
     </p>
   </q-card-section>

lnbits/extensions/lnurldevice/templates/lnurldevice/index.html

@@ -103,7 +103,9 @@
                   icon="visibility"
                   :color="($q.dark.isActive) ? 'grey-7' : 'grey-5'"
                   @click="openQrCodeDialog(props.row.id)"
-                ><q-tooltip v-if="protocol == 'http:'"> LNURLs only work over HTTPS </q-tooltip><q-tooltip v-else> view LNURL </q-tooltip></q-btn
+                  ><q-tooltip v-if="protocol == 'http:'">
+                    LNURLs only work over HTTPS </q-tooltip
+                  ><q-tooltip v-else> view LNURL </q-tooltip></q-btn
                 >
               </q-td>
               <q-td
@@ -156,9 +158,8 @@
           color="primary"
           size="md"
           @click="copyText(wslocation + '/lnurldevice/ws/' + settingsDialog.data.id, 'Link copied to clipboard!')"
-        >{% raw
-        %}{{wslocation}}/lnurldevice/ws/{{settingsDialog.data.id}}{% endraw
-        %}<q-tooltip> Click to copy URL </q-tooltip>
+          >{% raw %}{{wslocation}}/lnurldevice/ws/{{settingsDialog.data.id}}{%
+          endraw %}<q-tooltip> Click to copy URL </q-tooltip>
         </q-btn>
         <q-btn
           v-else
@@ -249,7 +250,6 @@
             type="number"
             value="1000"
             label="milesecs to turn Switch on for (1sec = 1000ms)"
-
           ></q-input>
         </div>
 
@@ -292,7 +292,6 @@
       </q-responsive>
       <p style="word-break: break-all">
         <strong>ID:</strong> {{ qrCodeDialog.data.id }}<br />
-
       </p>
       {% endraw %}
       <div class="row q-mt-lg q-gutter-sm">
@@ -434,7 +433,9 @@
     },
     methods: {
       openQrCodeDialog: function (lnurldevice_id) {
-      var lnurldevice = _.findWhere(this.lnurldeviceLinks, {id: lnurldevice_id})
+        var lnurldevice = _.findWhere(this.lnurldeviceLinks, {
+          id: lnurldevice_id
+        })
         console.log(lnurldevice)
         this.qrCodeDialog.data = _.clone(lnurldevice)
         this.qrCodeDialog.data.url =
@@ -617,10 +618,7 @@
         '//',
         window.location.host
       ].join('')
-      self.wslocation = [
-        'ws://',
-        window.location.host
-      ].join('')
+      self.wslocation = ['ws://', window.location.host].join('')
       LNbits.api
         .request('GET', '/api/v1/currencies')
         .then(response => {

lnbits/wallets/__init__.py

@@ -1,5 +1,6 @@
 # flake8: noqa
 
+
 from .cliche import ClicheWallet
 from .cln import CoreLightningWallet  # legacy .env support
 from .cln import CoreLightningWallet as CLightningWallet
@@ -9,6 +10,7 @@ from .lnbits import LNbitsWallet
 from .lndgrpc import LndWallet
 from .lndrest import LndRestWallet
 from .lnpay import LNPayWallet
+from .lntips import LnTipsWallet
 from .lntxbot import LntxbotWallet
 from .opennode import OpenNodeWallet
 from .spark import SparkWallet

lnbits/wallets/lntips.py

@@ -0,0 +1,170 @@
+import asyncio
+import hashlib
+import json
+import time
+from os import getenv
+from typing import AsyncGenerator, Dict, Optional
+
+import httpx
+from loguru import logger
+
+from .base import (
+    InvoiceResponse,
+    PaymentResponse,
+    PaymentStatus,
+    StatusResponse,
+    Wallet,
+)
+
+
+class LnTipsWallet(Wallet):
+    def __init__(self):
+        endpoint = getenv("LNTIPS_API_ENDPOINT")
+        self.endpoint = endpoint[:-1] if endpoint.endswith("/") else endpoint
+
+        key = (
+            getenv("LNTIPS_API_KEY")
+            or getenv("LNTIPS_ADMIN_KEY")
+            or getenv("LNTIPS_INVOICE_KEY")
+        )
+        self.auth = {"Authorization": f"Basic {key}"}
+
+    async def status(self) -> StatusResponse:
+        async with httpx.AsyncClient() as client:
+            r = await client.get(
+                f"{self.endpoint}/api/v1/balance", headers=self.auth, timeout=40
+            )
+        try:
+            data = r.json()
+        except:
+            return StatusResponse(
+                f"Failed to connect to {self.endpoint}, got: '{r.text[:200]}...'", 0
+            )
+
+        if data.get("error"):
+            return StatusResponse(data["error"], 0)
+
+        return StatusResponse(None, data["balance"] * 1000)
+
+    async def create_invoice(
+        self,
+        amount: int,
+        memo: Optional[str] = None,
+        description_hash: Optional[bytes] = None,
+        unhashed_description: Optional[bytes] = None,
+        **kwargs,
+    ) -> InvoiceResponse:
+        data: Dict = {"amount": amount}
+        if description_hash:
+            data["description_hash"] = description_hash.hex()
+        elif unhashed_description:
+            data["description_hash"] = hashlib.sha256(unhashed_description).hexdigest()
+        else:
+            data["memo"] = memo or ""
+
+        async with httpx.AsyncClient() as client:
+            r = await client.post(
+                f"{self.endpoint}/api/v1/createinvoice",
+                headers=self.auth,
+                json=data,
+                timeout=40,
+            )
+
+        if r.is_error:
+            try:
+                data = r.json()
+                error_message = data["message"]
+            except:
+                error_message = r.text
+                pass
+
+            return InvoiceResponse(False, None, None, error_message)
+
+        data = r.json()
+        return InvoiceResponse(
+            True, data["payment_hash"], data["payment_request"], None
+        )
+
+    async def pay_invoice(self, bolt11: str, fee_limit_msat: int) -> PaymentResponse:
+        async with httpx.AsyncClient() as client:
+            r = await client.post(
+                f"{self.endpoint}/api/v1/payinvoice",
+                headers=self.auth,
+                json={"pay_req": bolt11},
+                timeout=None,
+            )
+        if r.is_error:
+            return PaymentResponse(False, None, 0, None, r.text)
+
+        if "error" in r.json():
+            try:
+                data = r.json()
+                error_message = data["error"]
+            except:
+                error_message = r.text
+                pass
+            return PaymentResponse(False, None, 0, None, error_message)
+
+        data = r.json()["details"]
+        checking_id = data["payment_hash"]
+        fee_msat = -data["fee"]
+        preimage = data["preimage"]
+        return PaymentResponse(True, checking_id, fee_msat, preimage, None)
+
+    async def get_invoice_status(self, checking_id: str) -> PaymentStatus:
+        async with httpx.AsyncClient() as client:
+            r = await client.post(
+                f"{self.endpoint}/api/v1/invoicestatus/{checking_id}",
+                headers=self.auth,
+            )
+
+        if r.is_error or len(r.text) == 0:
+            return PaymentStatus(None)
+
+        data = r.json()
+        return PaymentStatus(data["paid"])
+
+    async def get_payment_status(self, checking_id: str) -> PaymentStatus:
+        async with httpx.AsyncClient() as client:
+            r = await client.post(
+                url=f"{self.endpoint}/api/v1/paymentstatus/{checking_id}",
+                headers=self.auth,
+            )
+
+        if r.is_error:
+            return PaymentStatus(None)
+        data = r.json()
+
+        paid_to_status = {False: None, True: True}
+        return PaymentStatus(paid_to_status[data.get("paid")])
+
+    async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
+        last_connected = None
+        while True:
+            url = f"{self.endpoint}/api/v1/invoicestream"
+            try:
+                async with httpx.AsyncClient(timeout=None, headers=self.auth) as client:
+                    last_connected = time.time()
+                    async with client.stream("GET", url) as r:
+                        async for line in r.aiter_lines():
+                            try:
+                                prefix = "data: "
+                                if not line.startswith(prefix):
+                                    continue
+                                data = line[len(prefix) :]  # sse parsing
+                                inv = json.loads(data)
+                                if not inv.get("payment_hash"):
+                                    continue
+                            except:
+                                continue
+                            yield inv["payment_hash"]
+            except Exception as e:
+                pass
+
+            # do not sleep if the connection was active for more than 10s
+            # since the backend is expected to drop the connection after 90s
+            if last_connected is None or time.time() - last_connected < 10:
+                logger.error(
+                    f"lost connection to {self.endpoint}/api/v1/invoicestream, retrying in 5 seconds"
+                )
+                await asyncio.sleep(5)