Files
nutshell/cashu/lightning/lnbits.py
callebtc d8d3037cc5 WIP: New melt flow (#622)
* `PaymentResult`

* ledger: rely on PaymentResult instead of paid flag. Double check for payments marked pending.

* `None` is `PENDING`

* make format

* reflected changes API tests where `PaymentStatus` is used + reflected changes in lnbits

* reflect changes in blink backend and tests

* fix lnbits get_payment_status

* remove paid flag

* fix mypy

* remove more paid flags

* fix strike mypy

* green

* shorten all state checks

* fix

* fix some tests

* gimme 

* fix............

* fix lnbits

* fix error

* lightning refactor

* add more regtest tests

* add tests for pending state and failure

* shorten checks

* use match case for startup check - and remember modified checking_id from pay_invoice

* fix strike pending return

* new tests?

* refactor startup routine into get_melt_quote

* test with purge

* refactor blink

* cleanup responses

* blink: return checking_id on failure

* fix lndgrpc try except

* add more testing for melt branches

* speed things up a bit

* remove comments

* remove comments

* block pending melt quotes

* remove comments

---------

Co-authored-by: lollerfirst <lollerfirst@gmail.com>
2024-09-24 14:55:35 +02:00

258 lines
8.5 KiB
Python

# type: ignore
import asyncio
import json
from typing import AsyncGenerator, Optional
import httpx
from bolt11 import (
decode,
)
from ..core.base import Amount, MeltQuote, Unit
from ..core.helpers import fee_reserve
from ..core.models import PostMeltQuoteRequest
from ..core.settings import settings
from .base import (
InvoiceResponse,
LightningBackend,
PaymentQuoteResponse,
PaymentResponse,
PaymentResult,
PaymentStatus,
StatusResponse,
)
class LNbitsWallet(LightningBackend):
"""https://github.com/lnbits/lnbits"""
supported_units = {Unit.sat}
unit = Unit.sat
supports_incoming_payment_stream: bool = True
supports_description: bool = True
def __init__(self, unit: Unit = Unit.sat, **kwargs):
self.assert_unit_supported(unit)
self.unit = unit
self.endpoint = settings.mint_lnbits_endpoint
self.client = httpx.AsyncClient(
verify=not settings.debug,
headers={"X-Api-Key": settings.mint_lnbits_key},
)
async def status(self) -> StatusResponse:
try:
r = await self.client.get(url=f"{self.endpoint}/api/v1/wallet", timeout=15)
r.raise_for_status()
except Exception as exc:
return StatusResponse(
error_message=f"Failed to connect to {self.endpoint} due to: {exc}",
balance=0,
)
try:
data: dict = r.json()
except Exception:
return StatusResponse(
error_message=(
f"Received invalid response from {self.endpoint}: {r.text}"
),
balance=0,
)
if "detail" in data:
return StatusResponse(
error_message=f"LNbits error: {data['detail']}", balance=0
)
return StatusResponse(error_message=None, balance=data["balance"])
async def create_invoice(
self,
amount: Amount,
memo: Optional[str] = None,
description_hash: Optional[bytes] = None,
unhashed_description: Optional[bytes] = None,
) -> InvoiceResponse:
self.assert_unit_supported(amount.unit)
data = {"out": False, "amount": amount.to(Unit.sat).amount}
if description_hash:
data["description_hash"] = description_hash.hex()
if unhashed_description:
data["unhashed_description"] = unhashed_description.hex()
data["memo"] = memo or ""
try:
r = await self.client.post(
url=f"{self.endpoint}/api/v1/payments", json=data
)
r.raise_for_status()
except Exception:
return InvoiceResponse(
ok=False,
error_message=r.json()["detail"],
)
data = r.json()
checking_id, payment_request = data["checking_id"], data["payment_request"]
return InvoiceResponse(
ok=True,
checking_id=checking_id,
payment_request=payment_request,
)
async def pay_invoice(
self, quote: MeltQuote, fee_limit_msat: int
) -> PaymentResponse:
try:
r = await self.client.post(
url=f"{self.endpoint}/api/v1/payments",
json={"out": True, "bolt11": quote.request},
timeout=None,
)
r.raise_for_status()
except Exception:
return PaymentResponse(
result=PaymentResult.FAILED, error_message=r.json()["detail"]
)
if r.status_code > 299:
return PaymentResponse(
result=PaymentResult.FAILED,
error_message=(f"HTTP status: {r.reason_phrase}",),
)
if "detail" in r.json():
return PaymentResponse(
result=PaymentResult.FAILED, error_message=(r.json()["detail"],)
)
data: dict = r.json()
checking_id = data["payment_hash"]
# we do this to get the fee and preimage
payment: PaymentStatus = await self.get_payment_status(checking_id)
return PaymentResponse(
result=payment.result,
checking_id=checking_id,
fee=payment.fee,
preimage=payment.preimage,
)
async def get_invoice_status(self, checking_id: str) -> PaymentStatus:
try:
r = await self.client.get(
url=f"{self.endpoint}/api/v1/payments/{checking_id}"
)
r.raise_for_status()
except Exception as e:
return PaymentStatus(result=PaymentResult.UNKNOWN, error_message=str(e))
data: dict = r.json()
if data.get("detail"):
return PaymentStatus(
result=PaymentResult.UNKNOWN, error_message=data["detail"]
)
if data["paid"]:
result = PaymentResult.SETTLED
elif not data["paid"] and data["details"]["pending"]:
result = PaymentResult.PENDING
elif not data["paid"] and not data["details"]["pending"]:
result = PaymentResult.FAILED
else:
result = PaymentResult.UNKNOWN
return PaymentStatus(
result=result,
fee=Amount(unit=Unit.msat, amount=abs(data["details"]["fee"])),
preimage=data["preimage"],
)
async def get_payment_status(self, checking_id: str) -> PaymentStatus:
try:
r = await self.client.get(
url=f"{self.endpoint}/api/v1/payments/{checking_id}"
)
r.raise_for_status()
except httpx.HTTPStatusError as e:
if e.response.status_code != 404:
raise e
return PaymentStatus(
result=PaymentResult.UNKNOWN, error_message=e.response.text
)
data = r.json()
if "paid" not in data and "details" not in data:
return PaymentStatus(
result=PaymentResult.UNKNOWN, error_message="invalid response"
)
if data["paid"]:
result = PaymentResult.SETTLED
elif not data["paid"] and data["details"]["pending"]:
result = PaymentResult.PENDING
elif not data["paid"] and not data["details"]["pending"]:
result = PaymentResult.FAILED
else:
result = PaymentResult.UNKNOWN
return PaymentStatus(
result=result,
fee=Amount(unit=Unit.msat, amount=abs(data["details"]["fee"])),
preimage=data.get("preimage"),
)
async def get_payment_quote(
self, melt_quote: PostMeltQuoteRequest
) -> PaymentQuoteResponse:
invoice_obj = decode(melt_quote.request)
assert invoice_obj.amount_msat, "invoice has no amount."
amount_msat = int(invoice_obj.amount_msat)
fees_msat = fee_reserve(amount_msat)
fees = Amount(unit=Unit.msat, amount=fees_msat)
amount = Amount(unit=Unit.msat, amount=amount_msat)
return PaymentQuoteResponse(
checking_id=invoice_obj.payment_hash,
fee=fees.to(self.unit, round="up"),
amount=amount.to(self.unit, round="up"),
)
async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
url = f"{self.endpoint}/api/v1/payments/sse"
try:
sse_headers = self.client.headers.copy()
sse_headers.update(
{
"accept": "text/event-stream",
"cache-control": "no-cache",
"connection": "keep-alive",
}
)
async with self.client.stream(
"GET",
url,
content="text/event-stream",
timeout=None,
headers=sse_headers,
) as r:
sse_trigger = False
async for line in r.aiter_lines():
# The data we want to listen to is of this shape:
# event: payment-received
# data: {.., "payment_hash" : "asd"}
if line.startswith("event: payment-received"):
sse_trigger = True
continue
elif sse_trigger and line.startswith("data:"):
data = json.loads(line[len("data:") :])
sse_trigger = False
yield data["payment_hash"]
else:
sse_trigger = False
except (OSError, httpx.ReadError, httpx.ConnectError, httpx.ReadTimeout):
pass
await asyncio.sleep(1)