Michilis/lnbits
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: update and fixes for BreezWallet (#3246)

Browse Source
This commit is contained in:
dni ⚡
2025-07-15 11:14:28 +02:00
parent 69a7ef74fd
commit 209c251fb6
3 changed files with 155 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lnbits/wallets/breez.py
+97 -71
View File
@@ -1,15 +1,9 @@
import base64
from importlib.util import find_spec
from lnbits.exceptions import UnsupportedError
try:
import breez_sdk # type: ignore
BREEZ_SDK_INSTALLED = True
except ImportError:
BREEZ_SDK_INSTALLED = False
if not BREEZ_SDK_INSTALLED:
if not find_spec("breez_sdk"):
class BreezSdkWallet: # pyright: ignore
def __init__(self):
@@ -24,9 +18,31 @@ else:
from pathlib import Path
from typing import Optional
from bolt11 import Bolt11Exception
from bolt11 import decode as bolt11_decode
from breez_sdk import (
BreezEvent,
ConnectRequest,
EnvironmentType,
EventListener,
GreenlightCredentials,
GreenlightNodeConfig,
NodeConfig,
PaymentDetails,
PaymentType,
ReceivePaymentRequest,
ReceivePaymentResponse,
ReportIssueRequest,
ReportPaymentFailureDetails,
SendPaymentRequest,
SendPaymentResponse,
connect,
default_config,
mnemonic_to_seed,
)
from breez_sdk import PaymentStatus as BreezPaymentStatus
from loguru import logger
from lnbits import bolt11 as lnbits_bolt11
from lnbits.settings import settings
from .base import (
@@ -40,7 +56,15 @@ else:
Wallet,
)
breez_event_queue: asyncio.Queue = asyncio.Queue()
breez_incoming_queue: asyncio.Queue[PaymentDetails.LN] = asyncio.Queue()
class PaymentsListener(EventListener):
def on_event(self, e: BreezEvent) -> None:
logger.debug(f"received breez sdk event: {e}")
if isinstance(e, BreezEvent.PAYMENT_SUCCEED) and isinstance(
e.details, PaymentDetails.LN
):
breez_incoming_queue.put_nowait(e.details)
def load_bytes(source: str, extension: str) -> Optional[bytes]:
# first check if it can be read from a file
@@ -61,11 +85,7 @@ else:
logger.debug(exc)
return None
def load_greenlight_credentials() -> (
Optional[
breez_sdk.GreenlightCredentials # pyright: ignore[reportUnboundVariable]
]
):
def load_greenlight_credentials() -> Optional[GreenlightCredentials]:
if (
settings.breez_greenlight_device_key
and settings.breez_greenlight_device_cert
@@ -78,19 +98,12 @@ else:
"cannot decode breez_greenlight_device_key "
"or breez_greenlight_device_cert"
)
return breez_sdk.GreenlightCredentials( # pyright: ignore[reportUnboundVariable]
return GreenlightCredentials(
developer_key=list(device_key_bytes),
developer_cert=list(device_cert_bytes),
)
return None
class SDKListener(
breez_sdk.EventListener # pyright: ignore[reportUnboundVariable]
):
def on_event(self, event):
logger.debug(event)
breez_event_queue.put_nowait(event)
class BreezSdkWallet(Wallet): # type: ignore[no-redef]
def __init__(self):
if not settings.breez_greenlight_seed:
@@ -118,15 +131,15 @@ else:
"missing breez_greenlight_device_key"
)
self.config = breez_sdk.default_config(
breez_sdk.EnvironmentType.PRODUCTION,
gl_config = GreenlightNodeConfig(
partner_credentials=load_greenlight_credentials(),
invite_code=settings.breez_greenlight_invite_code,
)
node_config = NodeConfig.GREENLIGHT(config=gl_config)
self.config = default_config(
EnvironmentType.PRODUCTION,
settings.breez_api_key,
breez_sdk.NodeConfig.GREENLIGHT(
config=breez_sdk.GreenlightNodeConfig(
partner_credentials=load_greenlight_credentials(),
invite_code=settings.breez_greenlight_invite_code,
)
),
node_config=node_config, # type: ignore[arg-type]
)
breez_sdk_working_dir = Path(settings.lnbits_data_folder, "breez-sdk")
@@ -134,9 +147,9 @@ else:
self.config.working_dir = breez_sdk_working_dir.absolute().as_posix()
try:
seed = breez_sdk.mnemonic_to_seed(settings.breez_greenlight_seed)
connect_request = breez_sdk.ConnectRequest(self.config, seed)
self.sdk_services = breez_sdk.connect(connect_request, SDKListener())
seed = mnemonic_to_seed(settings.breez_greenlight_seed)
connect_request = ConnectRequest(config=self.config, seed=seed)
self.sdk_services = connect(connect_request, PaymentsListener())
except Exception as exc:
logger.warning(exc)
raise ValueError(f"cannot initialize BreezSdkWallet: {exc!s}") from exc
@@ -146,7 +159,7 @@ else:
async def status(self) -> StatusResponse:
try:
node_info: breez_sdk.NodeState = self.sdk_services.node_info()
node_info = self.sdk_services.node_info()
except Exception as exc:
return StatusResponse(f"Failed to connect to breez, got: '{exc}...'", 0)
@@ -168,14 +181,14 @@ else:
"'description_hash' unsupported by Greenlight, provide"
" 'unhashed_description'"
)
breez_invoice: breez_sdk.ReceivePaymentResponse = (
breez_invoice: ReceivePaymentResponse = (
self.sdk_services.receive_payment(
breez_sdk.ReceivePaymentRequest(
amount * 1000, # breez uses msat
(
ReceivePaymentRequest(
amount_msat=amount * 1000, # breez uses msat
description=(
unhashed_description.decode()
if unhashed_description
else memo
else memo or ""
),
preimage=kwargs.get("preimage"),
opening_fee_params=None,
@@ -198,36 +211,45 @@ else:
async def pay_invoice(
self, bolt11: str, fee_limit_msat: int
) -> PaymentResponse:
invoice = lnbits_bolt11.decode(bolt11)
logger.debug(f"fee_limit_msat {fee_limit_msat} is ignored by Breez SDK")
try:
send_payment_request = breez_sdk.SendPaymentRequest(
invoice = bolt11_decode(bolt11)
except Bolt11Exception as exc:
logger.warning(exc)
return PaymentResponse(
ok=False, error_message=f"invalid bolt11 invoice: {exc}"
)
try:
send_payment_request = SendPaymentRequest(
bolt11=bolt11, use_trampoline=settings.breez_use_trampoline
)
send_payment_response: breez_sdk.SendPaymentResponse = (
send_payment_response: SendPaymentResponse = (
self.sdk_services.send_payment(send_payment_request)
)
payment: breez_sdk.Payment = send_payment_response.payment
payment = send_payment_response.payment
except Exception as exc:
logger.warning(exc)
try:
# try to report issue to Breez to improve LSP routing
self.sdk_services.report_issue(
breez_sdk.ReportIssueRequest.PAYMENT_FAILURE(
breez_sdk.ReportPaymentFailureDetails(invoice.payment_hash)
)
# report issue to Breez to improve LSP routing
payment_error = ReportIssueRequest.PAYMENT_FAILURE(
ReportPaymentFailureDetails(payment_hash=invoice.payment_hash)
)
self.sdk_services.report_issue(payment_error) # type: ignore[arg-type]
except Exception as ex:
logger.info(ex)
# assume that payment failed?
return PaymentResponse(ok=False, error_message=f"payment failed: {exc}")
return PaymentResponse(error_message=f"exception while payment {exc!s}")
if payment.status != breez_sdk.PaymentStatus.COMPLETE:
return PaymentResponse(ok=False, error_message="payment is pending")
if payment.status != BreezPaymentStatus.COMPLETE:
return PaymentResponse(ok=None, error_message="payment is pending")
# let's use the payment_hash as the checking_id
checking_id = invoice.payment_hash
if not isinstance(payment.details, PaymentDetails.LN):
return PaymentResponse(
error_message="Breez SDK returned a non-LN payment details object",
)
return PaymentResponse(
ok=True,
checking_id=checking_id,
@@ -237,18 +259,22 @@ else:
async def get_invoice_status(self, checking_id: str) -> PaymentStatus:
try:
payment: breez_sdk.Payment = self.sdk_services.payment_by_hash(
checking_id
)
payment = self.sdk_services.payment_by_hash(checking_id)
if payment is None:
return PaymentPendingStatus()
if payment.payment_type != breez_sdk.PaymentType.RECEIVED:
if payment.payment_type != PaymentType.RECEIVED:
logger.warning(f"unexpected payment type: {payment.status}")
return PaymentPendingStatus()
if payment.status == breez_sdk.PaymentStatus.FAILED:
if not isinstance(payment.details, PaymentDetails.LN):
logger.warning(f"unexpected paymentdetails type: {payment.details}")
return PaymentPendingStatus()
if payment.status == BreezPaymentStatus.FAILED:
return PaymentFailedStatus()
if payment.status == breez_sdk.PaymentStatus.COMPLETE:
return PaymentSuccessStatus()
if payment.status == BreezPaymentStatus.COMPLETE:
return PaymentSuccessStatus(
fee_msat=payment.fee_msat,
preimage=payment.details.data.payment_preimage,
)
return PaymentPendingStatus()
except Exception as exc:
logger.warning(exc)
@@ -256,20 +282,21 @@ else:
async def get_payment_status(self, checking_id: str) -> PaymentStatus:
try:
payment: breez_sdk.Payment = self.sdk_services.payment_by_hash(
checking_id
)
payment = self.sdk_services.payment_by_hash(checking_id)
if payment is None:
return PaymentPendingStatus()
if payment.payment_type != breez_sdk.PaymentType.SENT:
logger.warning(f"unexpected payment type: {payment.status}")
if payment.payment_type != PaymentType.SENT:
logger.warning(f"unexpected payment type: {payment.payment_type}")
return PaymentPendingStatus()
if payment.status == breez_sdk.PaymentStatus.COMPLETE:
if not isinstance(payment.details, PaymentDetails.LN):
logger.warning(f"unexpected paymentdetails type: {payment.details}")
return PaymentPendingStatus()
if payment.status == BreezPaymentStatus.COMPLETE:
return PaymentSuccessStatus(
fee_msat=payment.fee_msat,
preimage=payment.details.data.payment_preimage,
)
if payment.status == breez_sdk.PaymentStatus.FAILED:
if payment.status == BreezPaymentStatus.FAILED:
return PaymentFailedStatus()
return PaymentPendingStatus()
except Exception as exc:
@@ -278,6 +305,5 @@ else:
async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
while settings.lnbits_running:
event = await breez_event_queue.get()
if event.is_invoice_paid():
yield event.details.payment_hash
details = await breez_incoming_queue.get()
yield details.data.payment_hash