feat: phoenixd wallet integration (#2362)

* phoenixd integration
---------

Co-authored-by: Vlad Stan <stan.v.vlad@gmail.com>

lnbits/core/templates/core/index.html

@@ -499,6 +499,21 @@
             </a>
           </div>
         </div>
+        <div class="row">
+          <div class="col">
+            <a
+              href="https://phoenix.acinq.co/server"
+              target="_blank"
+              rel="noopener noreferrer"
+            >
+              <q-img
+                contain
+                :src="($q.dark.isActive) ? '{{ static_url_for('static', 'images/phoenixd.png') }}' : '{{ static_url_for('static', 'images/phoenixdl.png') }}'"
+              ></q-img>
+            </a>
+          </div>
+          <div class="col q-pl-md"></div>
+        </div>
       </div>
     </div>
   </div>

lnbits/settings.py

@@ -214,6 +214,11 @@ class ZBDFundingSource(LNbitsSettings):
     zbd_api_key: Optional[str] = Field(default=None)
 
 
+class PhoenixdFundingSource(LNbitsSettings):
+    phoenixd_api_endpoint: Optional[str] = Field(default="http://localhost:9740/")
+    phoenixd_api_password: Optional[str] = Field(default=None)
+
+
 class AlbyFundingSource(LNbitsSettings):
     alby_api_endpoint: Optional[str] = Field(default="https://api.getalby.com/")
     alby_access_token: Optional[str] = Field(default=None)
@@ -254,6 +259,7 @@ class FundingSourcesSettings(
     LnPayFundingSource,
     AlbyFundingSource,
     ZBDFundingSource,
+    PhoenixdFundingSource,
     OpenNodeFundingSource,
     SparkFundingSource,
     LnTipsFundingSource,
@@ -410,6 +416,7 @@ class SuperUserSettings(LNbitsSettings):
             "LNPayWallet",
             "AlbyWallet",
             "ZBDWallet",
+            "PhoenixdWallet",
             "LNbitsWallet",
             "OpenNodeWallet",
         ]

lnbits/static/js/components/lnbits-funding-sources.js

@@ -115,6 +115,14 @@ Vue.component('lnbits-funding-sources', {
             zbd_api_key: 'Key'
           }
         ],
+        [
+          'PhoenixdWallet',
+          'Phoenixd',
+          {
+            phoenixd_api_endpoint: 'Endpoint',
+            phoenixd_api_password: 'Key'
+          }
+        ],
         [
           'OpenNodeWallet',
           'OpenNode',

lnbits/wallets/__init__.py

@@ -23,6 +23,7 @@ from .lndrest import LndRestWallet
 from .lnpay import LNPayWallet
 from .lntips import LnTipsWallet
 from .opennode import OpenNodeWallet
+from .phoenixd import PhoenixdWallet
 from .spark import SparkWallet
 from .void import VoidWallet
 from .zbd import ZBDWallet

lnbits/wallets/phoenixd.py

@@ -0,0 +1,230 @@
+import asyncio
+import base64
+import json
+import urllib.parse
+from typing import AsyncGenerator, Dict, Optional
+
+import httpx
+from loguru import logger
+from websockets.client import connect
+
+from lnbits.settings import settings
+
+from .base import (
+    InvoiceResponse,
+    PaymentPendingStatus,
+    PaymentResponse,
+    PaymentStatus,
+    PaymentSuccessStatus,
+    StatusResponse,
+    UnsupportedError,
+    Wallet,
+)
+
+
+class PhoenixdWallet(Wallet):
+    """https://phoenix.acinq.co/server/api"""
+
+    def __init__(self):
+        if not settings.phoenixd_api_endpoint:
+            raise ValueError(
+                "cannot initialize PhoenixdWallet: missing phoenixd_api_endpoint"
+            )
+        if not settings.phoenixd_api_password:
+            raise ValueError(
+                "cannot initialize PhoenixdWallet: missing phoenixd_api_password"
+            )
+
+        self.endpoint = self.normalize_endpoint(settings.phoenixd_api_endpoint)
+
+        self.ws_url = f"ws://{urllib.parse.urlsplit(self.endpoint).netloc}/websocket"
+        password = settings.phoenixd_api_password
+        encoded_auth = base64.b64encode(f":{password}".encode())
+        auth = str(encoded_auth, "utf-8")
+        self.headers = {
+            "Authorization": f"Basic {auth}",
+            "User-Agent": settings.user_agent,
+        }
+
+        self.client = httpx.AsyncClient(base_url=self.endpoint, headers=self.headers)
+
+    async def cleanup(self):
+        try:
+            await self.client.aclose()
+        except RuntimeError as e:
+            logger.warning(f"Error closing wallet connection: {e}")
+
+    async def status(self) -> StatusResponse:
+        try:
+            r = await self.client.get("/getinfo", timeout=10)
+            r.raise_for_status()
+            data = r.json()
+
+            if len(data) == 0:
+                return StatusResponse("no data", 0)
+
+            if r.is_error or "channels" not in data:
+                error_message = data["message"] if "message" in data else r.text
+                return StatusResponse(f"Server error: '{error_message}'", 0)
+
+            if len(data["channels"]) == 0:
+                # todo: add custom unit-test for this
+                return StatusResponse(None, 0)
+
+            balance_msat = int(data["channels"][0]["balanceSat"]) * 1000
+            return StatusResponse(None, balance_msat)
+        except json.JSONDecodeError:
+            return StatusResponse("Server error: 'invalid json response'", 0)
+        except Exception as exc:
+            logger.warning(exc)
+            return StatusResponse(f"Unable to connect to {self.endpoint}.", 0)
+
+    async def create_invoice(
+        self,
+        amount: int,
+        memo: Optional[str] = None,
+        description_hash: Optional[bytes] = None,
+        unhashed_description: Optional[bytes] = None,
+        **kwargs,
+    ) -> InvoiceResponse:
+        if description_hash or unhashed_description:
+            raise UnsupportedError("description_hash")
+
+        try:
+            msats_amount = amount
+            data: Dict = {
+                "amountSat": f"{msats_amount}",
+                "description": memo,
+                "externalId": "",
+            }
+
+            r = await self.client.post(
+                "/createinvoice",
+                data=data,
+                timeout=40,
+            )
+            r.raise_for_status()
+            data = r.json()
+
+            if r.is_error or "paymentHash" not in data:
+                error_message = data["message"]
+                return InvoiceResponse(
+                    False, None, None, f"Server error: '{error_message}'"
+                )
+
+            checking_id = data["paymentHash"]
+            payment_request = data["serialized"]
+            return InvoiceResponse(True, checking_id, payment_request, None)
+        except json.JSONDecodeError:
+            return InvoiceResponse(
+                False, None, None, "Server error: 'invalid json response'"
+            )
+        except KeyError as exc:
+            logger.warning(exc)
+            return InvoiceResponse(
+                False, None, None, "Server error: 'missing required fields'"
+            )
+        except Exception as exc:
+            logger.warning(exc)
+            return InvoiceResponse(
+                False, None, None, f"Unable to connect to {self.endpoint}."
+            )
+
+    async def pay_invoice(self, bolt11: str, fee_limit_msat: int) -> PaymentResponse:
+        try:
+            r = await self.client.post(
+                "/payinvoice",
+                data={
+                    "invoice": bolt11,
+                },
+                timeout=40,
+            )
+
+            r.raise_for_status()
+            data = r.json()
+
+            if "routingFeeSat" not in data and "reason" in data:
+                return PaymentResponse(False, None, None, None, data["reason"])
+
+            if r.is_error or "paymentHash" not in data:
+                error_message = data["message"] if "message" in data else r.text
+                return PaymentResponse(False, None, None, None, error_message)
+
+            checking_id = data["paymentHash"]
+            fee_msat = -int(data["routingFeeSat"])
+            preimage = data["paymentPreimage"]
+
+            return PaymentResponse(True, checking_id, fee_msat, preimage, None)
+
+        except json.JSONDecodeError:
+            return PaymentResponse(
+                False, None, None, None, "Server error: 'invalid json response'"
+            )
+        except KeyError:
+            return PaymentResponse(
+                False, None, None, None, "Server error: 'missing required fields'"
+            )
+        except Exception as exc:
+            logger.info(f"Failed to pay invoice {bolt11}")
+            logger.warning(exc)
+            return PaymentResponse(
+                False, None, None, None, f"Unable to connect to {self.endpoint}."
+            )
+
+    async def get_invoice_status(self, checking_id: str) -> PaymentStatus:
+        try:
+            r = await self.client.get(f"/payments/incoming/{checking_id}")
+            if r.is_error:
+                return PaymentPendingStatus()
+            data = r.json()
+
+            if data["isPaid"]:
+                fee_msat = data["fees"]
+                preimage = data["preimage"]
+                return PaymentSuccessStatus(fee_msat=fee_msat, preimage=preimage)
+
+            return PaymentPendingStatus()
+        except Exception as e:
+            logger.error(f"Error getting invoice status: {e}")
+            return PaymentPendingStatus()
+
+    async def get_payment_status(self, checking_id: str) -> PaymentStatus:
+        try:
+            r = await self.client.get(f"/payments/outgoing/{checking_id}")
+            if r.is_error:
+                return PaymentPendingStatus()
+            data = r.json()
+
+            if data["isPaid"]:
+                fee_msat = data["fees"]
+                preimage = data["preimage"]
+                return PaymentSuccessStatus(fee_msat=fee_msat, preimage=preimage)
+
+            return PaymentPendingStatus()
+        except Exception as e:
+            logger.error(f"Error getting invoice status: {e}")
+            return PaymentPendingStatus()
+
+    async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
+        while settings.lnbits_running:
+            try:
+                async with connect(
+                    self.ws_url,
+                    extra_headers=[("Authorization", self.headers["Authorization"])],
+                ) as ws:
+                    logger.info("connected to phoenixd invoices stream")
+                    while settings.lnbits_running:
+                        message = await ws.recv()
+                        message_json = json.loads(message)
+                        if message_json and message_json["type"] == "payment-received":
+                            logger.info(
+                                f'payment-received: {message_json["paymentHash"]}'
+                            )
+                            yield message_json["paymentHash"]
+
+            except Exception as exc:
+                logger.error(
+                    f"lost connection to phoenixd invoices stream: '{exc}'"
+                    "retrying in 5 seconds"
+                )
+                await asyncio.sleep(5)