Improved SSE listeners (#865)

* logging listeners

* comments

* generate privkey upon init

* listener queue

* remove duplicate check

* make format

* reuse channel

* error handling in sse listener

* uuid for listeners

* register named invoices

* uuid for listeners and listener list

* fix poetry lock

* setuptools

* requirements asyncio timeout

* setuptool;s

* make format

* remove async-timeout

* async_timeout readd

* try lower setuptools version

* try lower lower setuptools version

* back to current version + fix, maybe

* fix worflows to use poetry 1.2.1

* remove uneeded setuptools from build-system

* fix up formatting workflow

* debug to trace

* more traces

* debug logs to trace

Co-authored-by: dni ⚡ <office@dnilabs.com>

lnbits/app.py

@@ -34,7 +34,6 @@ from .tasks import (
     check_pending_payments,
     internal_invoice_listener,
     invoice_listener,
-    run_deferred_async,
     webhook_handler,
 )
 
@@ -185,7 +184,7 @@ def register_async_tasks(app):
         loop.create_task(catch_everything_and_restart(invoice_listener))
         loop.create_task(catch_everything_and_restart(internal_invoice_listener))
         await register_task_listeners()
-        await run_deferred_async()
+        # await run_deferred_async() # calle: doesn't do anyting?
 
     @app.on_event("shutdown")
     async def stop_listeners():

lnbits/core/services.py

@@ -186,9 +186,9 @@ async def pay_invoice(
             )
 
         # notify receiver asynchronously
-
         from lnbits.tasks import internal_invoice_queue
 
+        logger.debug(f"enqueuing internal invoice {internal_checking_id}")
         await internal_invoice_queue.put(internal_checking_id)
     else:
         logger.debug(f"backend: sending payment {temp_id}")

lnbits/core/tasks.py

@@ -1,30 +1,43 @@
 import asyncio
-from typing import List
+from typing import Dict
 
 import httpx
 from loguru import logger
 
-from lnbits.tasks import register_invoice_listener
+from lnbits.helpers import get_current_extension_name
+from lnbits.tasks import SseListenersDict, register_invoice_listener
 
 from . import db
 from .crud import get_balance_notify
 from .models import Payment
 
-api_invoice_listeners: List[asyncio.Queue] = []
+api_invoice_listeners: Dict[str, asyncio.Queue] = SseListenersDict(
+    "api_invoice_listeners"
+)
 
 
 async def register_task_listeners():
+    """
+    Registers an invoice listener queue for the core tasks.
+    Incoming payaments in this queue will eventually trigger the signals sent to all other extensions
+    and fulfill other core tasks such as dispatching webhooks.
+    """
     invoice_paid_queue = asyncio.Queue(5)
-    register_invoice_listener(invoice_paid_queue)
+    # we register invoice_paid_queue to receive all incoming invoices
+    register_invoice_listener(invoice_paid_queue, "core/tasks.py")
+    # register a worker that will react to invoices
     asyncio.create_task(wait_for_paid_invoices(invoice_paid_queue))
 
 
 async def wait_for_paid_invoices(invoice_paid_queue: asyncio.Queue):
+    """
+    This worker dispatches events to all extensions, dispatches webhooks and balance notifys.
+    """
     while True:
         payment = await invoice_paid_queue.get()
-        logger.debug("received invoice paid event")
+        logger.trace("received invoice paid event")
         # send information to sse channel
-        await dispatch_invoice_listener(payment)
+        await dispatch_api_invoice_listeners(payment)
 
         # dispatch webhook
         if payment.webhook and not payment.webhook_status:
@@ -41,16 +54,23 @@ async def wait_for_paid_invoices(invoice_paid_queue: asyncio.Queue):
                     pass
 
 
-async def dispatch_invoice_listener(payment: Payment):
-    for send_channel in api_invoice_listeners:
+async def dispatch_api_invoice_listeners(payment: Payment):
+    """
+    Emits events to invoice listener subscribed from the API.
+    """
+    for chan_name, send_channel in api_invoice_listeners.items():
         try:
+            logger.debug(f"sending invoice paid event to {chan_name}")
             send_channel.put_nowait(payment)
         except asyncio.QueueFull:
-            logger.debug("removing sse listener", send_channel)
-            api_invoice_listeners.remove(send_channel)
+            logger.error(f"removing sse listener {send_channel}:{chan_name}")
+            api_invoice_listeners.pop(chan_name)
 
 
 async def dispatch_webhook(payment: Payment):
+    """
+    Dispatches the webhook to the webhook url.
+    """
     async with httpx.AsyncClient() as client:
         data = payment.dict()
         try:

lnbits/core/views/api.py

@@ -3,11 +3,13 @@ import binascii
 import hashlib
 import json
 import time
+import uuid
 from http import HTTPStatus
 from io import BytesIO
 from typing import Dict, List, Optional, Tuple, Union
 from urllib.parse import ParseResult, parse_qs, urlencode, urlparse, urlunparse
 
+import async_timeout
 import httpx
 import pyqrcode
 from fastapi import Depends, Header, Query, Request
@@ -16,7 +18,7 @@ from fastapi.params import Body
 from loguru import logger
 from pydantic import BaseModel
 from pydantic.fields import Field
-from sse_starlette.sse import EventSourceResponse
+from sse_starlette.sse import EventSourceResponse, ServerSentEvent
 from starlette.responses import HTMLResponse, StreamingResponse
 
 from lnbits import bolt11, lnurl
@@ -366,37 +368,48 @@ async def api_payments_pay_lnurl(
     }
 
 
-async def subscribe(request: Request, wallet: Wallet):
+async def subscribe_wallet_invoices(request: Request, wallet: Wallet):
+    """
+    Subscribe to new invoices for a wallet. Can be wrapped in EventSourceResponse.
+    Listenes invoming payments for a wallet and yields jsons with payment details.
+    """
     this_wallet_id = wallet.id
 
     payment_queue: asyncio.Queue[Payment] = asyncio.Queue(0)
 
-    logger.debug("adding sse listener", payment_queue)
-    api_invoice_listeners.append(payment_queue)
+    uid = f"{this_wallet_id}_{str(uuid.uuid4())[:8]}"
+    logger.debug(f"adding sse listener for wallet: {uid}")
+    api_invoice_listeners[uid] = payment_queue
 
     send_queue: asyncio.Queue[Tuple[str, Payment]] = asyncio.Queue(0)
 
     async def payment_received() -> None:
         while True:
-            payment: Payment = await payment_queue.get()
-            if payment.wallet_id == this_wallet_id:
-                logger.debug("payment received", payment)
-                await send_queue.put(("payment-received", payment))
+            try:
+                async with async_timeout.timeout(1):
+                    payment: Payment = await payment_queue.get()
+                    if payment.wallet_id == this_wallet_id:
+                        logger.debug("sse listener: payment receieved", payment)
+                        await send_queue.put(("payment-received", payment))
+            except asyncio.TimeoutError:
+                pass
 
-    asyncio.create_task(payment_received())
+    task = asyncio.create_task(payment_received())
 
     try:
         while True:
+            if await request.is_disconnected():
+                await request.close()
+                break
             typ, data = await send_queue.get()
-
             if data:
                 jdata = json.dumps(dict(data.dict(), pending=False))
 
-            # yield dict(id=1, event="this", data="1234")
-            # await asyncio.sleep(2)
             yield dict(data=jdata, event=typ)
-            # yield dict(data=jdata.encode("utf-8"), event=typ.encode("utf-8"))
-    except asyncio.CancelledError:
+    except asyncio.CancelledError as e:
+        logger.debug(f"CancelledError on listener {uid}: {e}")
+        api_invoice_listeners.pop(uid)
+        task.cancel()
         return
 
 
@@ -405,7 +418,9 @@ async def api_payments_sse(
     request: Request, wallet: WalletTypeInfo = Depends(get_key_type)
 ):
     return EventSourceResponse(
-        subscribe(request, wallet.wallet), ping=20, media_type="text/event-stream"
+        subscribe_wallet_invoices(request, wallet.wallet),
+        ping=20,
+        media_type="text/event-stream",
     )
 
 

lnbits/core/views/public_api.py

@@ -46,8 +46,8 @@ async def api_public_payment_longpolling(payment_hash):
 
     payment_queue = asyncio.Queue(0)
 
-    logger.debug("adding standalone invoice listener", payment_hash, payment_queue)
-    api_invoice_listeners.append(payment_queue)
+    logger.debug(f"adding standalone invoice listener for hash: {payment_hash}")
+    api_invoice_listeners[payment_hash] = payment_queue
 
     response = None
 

lnbits/extensions/boltcards/tasks.py

@@ -5,6 +5,7 @@ import httpx
 
 from lnbits.core import db as core_db
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import create_refund, get_hit
@@ -12,7 +13,7 @@ from .crud import create_refund, get_hit
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/boltz/boltz.py

@@ -34,8 +34,8 @@ from .models import (
 from .utils import check_balance, get_timestamp, req_wrap
 
 net = NETWORKS[BOLTZ_NETWORK]
-logger.debug(f"BOLTZ_URL: {BOLTZ_URL}")
-logger.debug(f"Bitcoin Network: {net['name']}")
+logger.trace(f"BOLTZ_URL: {BOLTZ_URL}")
+logger.trace(f"Bitcoin Network: {net['name']}")
 
 
 async def create_swap(data: CreateSubmarineSwap) -> SubmarineSwap:

lnbits/extensions/boltz/mempool.py

@@ -11,8 +11,8 @@ from lnbits.settings import BOLTZ_MEMPOOL_SPACE_URL, BOLTZ_MEMPOOL_SPACE_URL_WS
 
 from .utils import req_wrap
 
-logger.debug(f"BOLTZ_MEMPOOL_SPACE_URL: {BOLTZ_MEMPOOL_SPACE_URL}")
-logger.debug(f"BOLTZ_MEMPOOL_SPACE_URL_WS: {BOLTZ_MEMPOOL_SPACE_URL_WS}")
+logger.trace(f"BOLTZ_MEMPOOL_SPACE_URL: {BOLTZ_MEMPOOL_SPACE_URL}")
+logger.trace(f"BOLTZ_MEMPOOL_SPACE_URL_WS: {BOLTZ_MEMPOOL_SPACE_URL_WS}")
 
 websocket_url = f"{BOLTZ_MEMPOOL_SPACE_URL_WS}/api/v1/ws"
 

lnbits/extensions/boltz/tasks.py

@@ -5,6 +5,7 @@ from loguru import logger
 
 from lnbits.core.models import Payment
 from lnbits.core.services import check_transaction_status
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .boltz import (
@@ -127,7 +128,7 @@ async def check_for_pending_swaps():
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/copilot/tasks.py

@@ -7,6 +7,7 @@ from starlette.exceptions import HTTPException
 
 from lnbits.core import db as core_db
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import get_copilot
@@ -15,7 +16,7 @@ from .views import updater
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/jukebox/tasks.py

@@ -1,6 +1,7 @@
 import asyncio
 
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import update_jukebox_payment
@@ -8,7 +9,7 @@ from .crud import update_jukebox_payment
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/livestream/tasks.py

@@ -6,7 +6,7 @@ from loguru import logger
 from lnbits.core import db as core_db
 from lnbits.core.crud import create_payment
 from lnbits.core.models import Payment
-from lnbits.helpers import urlsafe_short_hash
+from lnbits.helpers import get_current_extension_name, urlsafe_short_hash
 from lnbits.tasks import internal_invoice_listener, register_invoice_listener
 
 from .crud import get_livestream_by_track, get_producer, get_track
@@ -14,7 +14,7 @@ from .crud import get_livestream_by_track, get_producer, get_track
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/lnaddress/tasks.py

@@ -3,6 +3,7 @@ import asyncio
 import httpx
 
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import get_address, get_domain, set_address_paid, set_address_renewed
@@ -10,7 +11,7 @@ from .crud import get_address, get_domain, set_address_paid, set_address_renewed
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/lnticket/__init__.py

@@ -1,4 +1,5 @@
 import asyncio
+import json
 
 from fastapi import APIRouter
 

lnbits/extensions/lnticket/tasks.py

@@ -3,6 +3,7 @@ import asyncio
 from loguru import logger
 
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import get_ticket, set_ticket_paid
@@ -10,7 +11,7 @@ from .crud import get_ticket, set_ticket_paid
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/lnurlp/tasks.py

@@ -5,6 +5,7 @@ import httpx
 
 from lnbits.core import db as core_db
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import get_pay_link
@@ -12,7 +13,7 @@ from .crud import get_pay_link
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/lnurlpayout/tasks.py

@@ -10,6 +10,7 @@ from lnbits.core.crud import get_wallet
 from lnbits.core.models import Payment
 from lnbits.core.services import pay_invoice
 from lnbits.core.views.api import api_payments_decode
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import get_lnurlpayout_from_wallet
@@ -17,7 +18,7 @@ from .crud import get_lnurlpayout_from_wallet
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/satspay/tasks.py

@@ -4,6 +4,7 @@ from loguru import logger
 
 from lnbits.core.models import Payment
 from lnbits.extensions.satspay.crud import check_address_balance, get_charge
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 # from .crud import get_ticket, set_ticket_paid
@@ -11,7 +12,7 @@ from lnbits.tasks import register_invoice_listener
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/scrub/tasks.py

@@ -9,6 +9,7 @@ from fastapi import HTTPException
 from lnbits import bolt11
 from lnbits.core.models import Payment
 from lnbits.core.services import pay_invoice
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .crud import get_scrub_by_wallet
@@ -16,7 +17,7 @@ from .crud import get_scrub_by_wallet
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/splitpayments/tasks.py

@@ -6,7 +6,7 @@ from loguru import logger
 from lnbits.core import db as core_db
 from lnbits.core.crud import create_payment
 from lnbits.core.models import Payment
-from lnbits.helpers import urlsafe_short_hash
+from lnbits.helpers import get_current_extension_name, urlsafe_short_hash
 from lnbits.tasks import internal_invoice_queue, register_invoice_listener
 
 from .crud import get_targets
@@ -14,7 +14,7 @@ from .crud import get_targets
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/subdomains/tasks.py

@@ -3,6 +3,7 @@ import asyncio
 import httpx
 
 from lnbits.core.models import Payment
+from lnbits.helpers import get_current_extension_name
 from lnbits.tasks import register_invoice_listener
 
 from .cloudflare import cloudflare_create_subdomain
@@ -11,7 +12,7 @@ from .crud import get_domain, set_subdomain_paid
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/extensions/tpos/tasks.py

@@ -4,7 +4,7 @@ import json
 from lnbits.core import db as core_db
 from lnbits.core.crud import create_payment
 from lnbits.core.models import Payment
-from lnbits.helpers import urlsafe_short_hash
+from lnbits.helpers import get_current_extension_name, urlsafe_short_hash
 from lnbits.tasks import internal_invoice_queue, register_invoice_listener
 
 from .crud import get_tpos
@@ -12,7 +12,7 @@ from .crud import get_tpos
 
 async def wait_for_paid_invoices():
     invoice_queue = asyncio.Queue()
-    register_invoice_listener(invoice_queue)
+    register_invoice_listener(invoice_queue, get_current_extension_name())
 
     while True:
         payment = await invoice_queue.get()

lnbits/helpers.py

@@ -183,3 +183,26 @@ def template_renderer(additional_folders: List = []) -> Jinja2Templates:
         t.env.globals["VENDORED_CSS"] = ["/static/bundle.css"]
 
     return t
+
+
+def get_current_extension_name() -> str:
+    """
+    Returns the name of the extension that calls this method.
+    """
+    import inspect
+    import json
+    import os
+
+    callee_filepath = inspect.stack()[1].filename
+    callee_dirname, callee_filename = os.path.split(callee_filepath)
+
+    path = os.path.normpath(callee_dirname)
+    extension_director_name = path.split(os.sep)[-1]
+    try:
+        config_path = os.path.join(callee_dirname, "config.json")
+        with open(config_path) as json_file:
+            config = json.load(json_file)
+        ext_name = config["name"]
+    except:
+        ext_name = extension_director_name
+    return ext_name

lnbits/tasks.py

@@ -1,8 +1,9 @@
 import asyncio
 import time
 import traceback
+import uuid
 from http import HTTPStatus
-from typing import Callable, List
+from typing import Callable, Dict, List
 
 from fastapi.exceptions import HTTPException
 from loguru import logger
@@ -18,20 +19,6 @@ from lnbits.settings import WALLET
 
 from .core import db
 
-deferred_async: List[Callable] = []
-
-
-def record_async(func: Callable) -> Callable:
-    def recorder(state):
-        deferred_async.append(func)
-
-    return recorder
-
-
-async def run_deferred_async():
-    for func in deferred_async:
-        asyncio.create_task(catch_everything_and_restart(func))
-
 
 async def catch_everything_and_restart(func):
     try:
@@ -50,18 +37,48 @@ async def send_push_promise(a, b) -> None:
     pass
 
 
-invoice_listeners: List[asyncio.Queue] = []
+class SseListenersDict(dict):
+    """
+    A dict of sse listeners.
+    """
+
+    def __init__(self, name: str = None):
+        self.name = name or f"sse_listener_{str(uuid.uuid4())[:8]}"
+
+    def __setitem__(self, key, value):
+        assert type(key) == str, f"{key} is not a string"
+        assert type(value) == asyncio.Queue, f"{value} is not an asyncio.Queue"
+        logger.trace(f"sse: adding listener {key} to {self.name}. len = {len(self)+1}")
+        return super().__setitem__(key, value)
+
+    def __delitem__(self, key):
+        logger.trace(f"sse: removing listener from {self.name}. len = {len(self)-1}")
+        return super().__delitem__(key)
+
+    _RaiseKeyError = object()  # singleton for no-default behavior
+
+    def pop(self, key, v=_RaiseKeyError) -> None:
+        logger.trace(f"sse: removing listener from {self.name}. len = {len(self)-1}")
+        return super().pop(key)
 
 
-def register_invoice_listener(send_chan: asyncio.Queue):
+invoice_listeners: Dict[str, asyncio.Queue] = SseListenersDict("invoice_listeners")
+
+
+def register_invoice_listener(send_chan: asyncio.Queue, name: str = None):
     """
-    A method intended for extensions to call when they want to be notified about
-    new invoice payments incoming.
+    A method intended for extensions (and core/tasks.py) to call when they want to be notified about
+    new invoice payments incoming. Will emit all incoming payments.
     """
-    invoice_listeners.append(send_chan)
+    name_unique = f"{name or 'no_name'}_{str(uuid.uuid4())[:8]}"
+    logger.trace(f"sse: registering invoice listener {name_unique}")
+    invoice_listeners[name_unique] = send_chan
 
 
 async def webhook_handler():
+    """
+    Returns the webhook_handler for the selected wallet if present. Used by API.
+    """
     handler = getattr(WALLET, "webhook_listener", None)
     if handler:
         return await handler()
@@ -72,18 +89,36 @@ internal_invoice_queue: asyncio.Queue = asyncio.Queue(0)
 
 
 async def internal_invoice_listener():
+    """
+    internal_invoice_queue will be filled directly in core/services.py
+    after the payment was deemed to be settled internally.
+
+    Called by the app startup sequence.
+    """
     while True:
         checking_id = await internal_invoice_queue.get()
+        logger.info("> got internal payment notification", checking_id)
         asyncio.create_task(invoice_callback_dispatcher(checking_id))
 
 
 async def invoice_listener():
+    """
+    invoice_listener will collect all invoices that come directly
+    from the backend wallet.
+
+    Called by the app startup sequence.
+    """
     async for checking_id in WALLET.paid_invoices_stream():
         logger.info("> got a payment notification", checking_id)
         asyncio.create_task(invoice_callback_dispatcher(checking_id))
 
 
 async def check_pending_payments():
+    """
+    check_pending_payments is called during startup to check for pending payments with
+    the backend and also to delete expired invoices. Incoming payments will be
+    checked only once, outgoing pending payments will be checked regularly.
+    """
     outgoing = True
     incoming = True
 
@@ -133,9 +168,14 @@ async def perform_balance_checks():
 
 
 async def invoice_callback_dispatcher(checking_id: str):
+    """
+    Takes incoming payments, sets pending=False, and dispatches them to
+    invoice_listeners from core and extensions.
+    """
     payment = await get_standalone_payment(checking_id, incoming=True)
     if payment and payment.is_in:
-        logger.trace("sending invoice callback for payment", checking_id)
+        logger.trace(f"sse sending invoice callback for payment {checking_id}")
         await payment.set_pending(False)
-        for send_chan in invoice_listeners:
+        for chan_name, send_chan in invoice_listeners.items():
+            logger.trace(f"sse sending to chan: {chan_name}")
             await send_chan.put(payment)

lnbits/wallets/fake.py

@@ -8,9 +8,7 @@ from typing import AsyncGenerator, Dict, Optional
 from environs import Env  # type: ignore
 from loguru import logger
 
-from lnbits.helpers import urlsafe_short_hash
-
-from ..bolt11 import decode, encode
+from ..bolt11 import Invoice, decode, encode
 from .base import (
     InvoiceResponse,
     PaymentResponse,
@@ -24,6 +22,16 @@ env.read_env()
 
 
 class FakeWallet(Wallet):
+    queue: asyncio.Queue = asyncio.Queue(0)
+    secret: str = env.str("FAKE_WALLET_SECTRET", default="ToTheMoon1")
+    privkey: str = hashlib.pbkdf2_hmac(
+        "sha256",
+        secret.encode("utf-8"),
+        ("FakeWallet").encode("utf-8"),
+        2048,
+        32,
+    ).hex()
+
     async def status(self) -> StatusResponse:
         logger.info(
             "FakeWallet funding source is for using LNbits as a centralised, stand-alone payment system with brrrrrr."
@@ -39,18 +47,12 @@ class FakeWallet(Wallet):
     ) -> InvoiceResponse:
         # we set a default secret since FakeWallet is used for internal=True invoices
         # and the user might not have configured a secret yet
-        secret = env.str("FAKE_WALLET_SECTRET", default="ToTheMoon1")
+
         data: Dict = {
             "out": False,
             "amount": amount,
             "currency": "bc",
-            "privkey": hashlib.pbkdf2_hmac(
-                "sha256",
-                secret.encode("utf-8"),
-                ("FakeWallet").encode("utf-8"),
-                2048,
-                32,
-            ).hex(),
+            "privkey": self.privkey,
             "memo": None,
             "description_hash": None,
             "description": "",
@@ -86,8 +88,9 @@ class FakeWallet(Wallet):
         invoice = decode(bolt11)
         if (
             hasattr(invoice, "checking_id")
-            and invoice.checking_id[6:] == data["privkey"][:6]  # type: ignore
+            and invoice.checking_id[:6] == self.privkey[:6]  # type: ignore
         ):
+            await self.queue.put(invoice)
             return PaymentResponse(True, invoice.payment_hash, 0)
         else:
             return PaymentResponse(
@@ -101,7 +104,6 @@ class FakeWallet(Wallet):
         return PaymentStatus(None)
 
     async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
-        self.queue: asyncio.Queue = asyncio.Queue(0)
         while True:
-            value = await self.queue.get()
-            yield value
+            value: Invoice = await self.queue.get()
+            yield value.payment_hash