Files
nutshell/cashu/lightning/corelightningrest.py
callebtc fc0e3fe663 Mint: watchdog balance log and killswitch (#705)
* wip store balance

* store balances in watchdog worker

* move mint_auth_database setting

* auth db

* balances returned as Amount (instead of int)

* add test for balance change on invoice receive

* fix 1 test

* cancel tasks on shutdown

* watchdog can now abort

* remove wallet api server

* fix lndgrpc

* fix lnbits balance

* disable watchdog

* balance lnbits msat

* test db watcher with its own database connection

* init superclass only once

* wip: log balance in keysets table

* check max balance using new keyset balance

* fix test

* fix another test

* store fees in keysets

* format

* cleanup

* shorter

* add keyset migration to auth server

* fix fakewallet

* fix db tests

* fix postgres problems during migration 26 (mint)

* fix cln

* ledger

* working with pending

* super fast watchdog, errors

* test new pipeline

* delete walletapi

* delete unneeded files

* revert workflows
2025-05-11 20:29:13 +02:00

343 lines
12 KiB
Python

import asyncio
import json
import random
from typing import AsyncGenerator, Dict, Optional
import httpx
from bolt11 import (
Bolt11Exception,
decode,
)
from loguru import logger
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,
Unsupported,
)
from .macaroon import load_macaroon
# https://docs.corelightning.org/reference/lightning-pay
PAYMENT_RESULT_MAP = {
"complete": PaymentResult.SETTLED,
"pending": PaymentResult.PENDING,
"failed": PaymentResult.FAILED,
}
# https://docs.corelightning.org/reference/lightning-listinvoices
INVOICE_RESULT_MAP = {
"paid": PaymentResult.SETTLED,
"unpaid": PaymentResult.PENDING,
"expired": PaymentResult.FAILED,
}
class CoreLightningRestWallet(LightningBackend):
supported_units = {Unit.sat, Unit.msat}
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
macaroon = settings.mint_corelightning_rest_macaroon
assert macaroon, "missing cln-rest macaroon"
self.macaroon = load_macaroon(macaroon)
url = settings.mint_corelightning_rest_url
if not url:
raise Exception("missing url for corelightning-rest")
if not macaroon:
raise Exception("missing macaroon for corelightning-rest")
self.url = url[:-1] if url.endswith("/") else url
self.url = (
f"https://{self.url}" if not self.url.startswith("http") else self.url
)
self.auth = {
"macaroon": self.macaroon,
"encodingtype": "hex",
"accept": "application/json",
}
self.cert = settings.mint_corelightning_rest_cert or False
self.client = httpx.AsyncClient(
base_url=self.url, verify=self.cert, headers=self.auth
)
self.last_pay_index = 0
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:
r = await self.client.get("/v1/listFunds", timeout=5)
r.raise_for_status()
if r.is_error or "error" in r.json():
try:
data = r.json()
error_message = data["error"]
except Exception:
error_message = r.text
return StatusResponse(
error_message=(
f"Failed to connect to {self.url}, got: '{error_message}...'"
),
balance=Amount(self.unit, 0),
)
data = r.json()
if len(data) == 0:
return StatusResponse(error_message="no data", balance=Amount(self.unit, 0))
balance_msat = int(sum([c["our_amount_msat"] for c in data["channels"]]))
return StatusResponse(
error_message=None, balance=Amount(self.unit, balance_msat // 1000)
)
async def create_invoice(
self,
amount: Amount,
memo: Optional[str] = None,
description_hash: Optional[bytes] = None,
unhashed_description: Optional[bytes] = None,
**kwargs,
) -> InvoiceResponse:
self.assert_unit_supported(amount.unit)
label = f"lbl{random.random()}"
data: Dict = {
"amount": amount.to(Unit.msat, round="up").amount,
"description": memo,
"label": label,
}
if description_hash and not unhashed_description:
raise Unsupported(
"'description_hash' unsupported by CoreLightningRest, "
"provide 'unhashed_description'"
)
if unhashed_description:
data["description"] = unhashed_description.decode("utf-8")
if kwargs.get("expiry"):
data["expiry"] = kwargs["expiry"]
if kwargs.get("preimage"):
data["preimage"] = kwargs["preimage"]
r = await self.client.post(
"/v1/invoice/genInvoice",
data=data,
)
if r.is_error or "error" in r.json():
try:
data = r.json()
error_message = data["error"]
except Exception:
error_message = r.text
return InvoiceResponse(
ok=False,
error_message=error_message,
)
data = r.json()
assert "payment_hash" in data
assert "bolt11" in data
return InvoiceResponse(
ok=True,
checking_id=data["payment_hash"],
payment_request=data["bolt11"],
)
async def pay_invoice(
self, quote: MeltQuote, fee_limit_msat: int
) -> PaymentResponse:
try:
invoice = decode(quote.request)
except Bolt11Exception as exc:
return PaymentResponse(
result=PaymentResult.FAILED,
error_message=str(exc),
)
if not invoice.amount_msat or invoice.amount_msat <= 0:
error_message = "0 amount invoices are not allowed"
return PaymentResponse(
result=PaymentResult.FAILED,
error_message=error_message,
)
fee_limit_percent = fee_limit_msat / invoice.amount_msat * 100
r = await self.client.post(
"/v1/pay",
data={
"invoice": quote.request,
"maxfeepercent": f"{fee_limit_percent:.11}",
"exemptfee": 0, # so fee_limit_percent is applied even on payments
# with fee < 5000 millisatoshi (which is default value of exemptfee)
},
timeout=None,
)
if r.is_error or "error" in r.json():
try:
data = r.json()
error_message = data["error"]["message"]
except Exception:
error_message = r.text
return PaymentResponse(
result=PaymentResult.FAILED,
error_message=error_message,
)
data = r.json()
checking_id = data["payment_hash"]
preimage = data["payment_preimage"]
fee_msat = data["amount_sent_msat"] - data["amount_msat"]
return PaymentResponse(
result=PAYMENT_RESULT_MAP[data["status"]],
checking_id=checking_id,
fee=Amount(unit=Unit.msat, amount=fee_msat) if fee_msat else None,
preimage=preimage,
)
async def get_invoice_status(self, checking_id: str) -> PaymentStatus:
r = await self.client.get(
"/v1/invoice/listInvoices",
params={"payment_hash": checking_id},
)
try:
r.raise_for_status()
data = r.json()
if r.is_error or "error" in data or data.get("invoices") is None:
raise Exception("error in cln response")
return PaymentStatus(
result=INVOICE_RESULT_MAP[data["invoices"][0]["status"]],
)
except Exception as e:
logger.error(f"Error getting invoice status: {e}")
return PaymentStatus(result=PaymentResult.UNKNOWN, error_message=str(e))
async def get_payment_status(self, checking_id: str) -> PaymentStatus:
r = await self.client.get(
"/v1/pay/listPays",
params={"payment_hash": checking_id},
)
r.raise_for_status()
data = r.json()
if not data.get("pays"):
# payment not found
logger.error(f"payment not found: {data.get('pays')}")
return PaymentStatus(
result=PaymentResult.UNKNOWN, error_message="payment not found"
)
if r.is_error or "error" in data:
message = data.get("error") or data
raise Exception(f"error in corelightning-rest response: {message}")
pay = data["pays"][0]
fee_msat, preimage = None, None
if PAYMENT_RESULT_MAP.get(pay["status"]) == PaymentResult.SETTLED:
fee_msat = -int(pay["amount_sent_msat"]) - int(pay["amount_msat"])
preimage = pay["preimage"]
return PaymentStatus(
result=PAYMENT_RESULT_MAP[pay["status"]],
fee=Amount(unit=Unit.msat, amount=fee_msat) if fee_msat else None,
preimage=preimage,
)
async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
# call listinvoices to determine the last pay_index
r = await self.client.get("/v1/invoice/listInvoices")
r.raise_for_status()
data = r.json()
if r.is_error or "error" in data:
raise Exception("error in cln response")
last_invoice_paid_invoice = next(
(i for i in reversed(data["invoices"]) if i["status"] == "paid"), None
)
last_pay_index = (
last_invoice_paid_invoice.get("pay_index")
if last_invoice_paid_invoice
else 0
)
self.last_pay_index = last_pay_index
while True:
try:
url = f"/v1/invoice/waitAnyInvoice/{self.last_pay_index}"
async with self.client.stream("GET", url, timeout=None) as r:
async for line in r.aiter_lines():
inv = json.loads(line)
if "error" in inv and "message" in inv["error"]:
logger.error("Error in paid_invoices_stream:", inv)
raise Exception(inv["error"]["message"])
try:
paid = inv["status"] == "paid"
if not paid:
continue
self.last_pay_index = inv["pay_index"]
except Exception:
continue
logger.trace(f"paid invoice: {inv}")
# NOTE: use payment_hash when corelightning-rest returns it
# when using waitAnyInvoice
# payment_hash = inv["payment_hash"]
# yield payment_hash
# hack to return payment_hash if the above shouldn't work
r = await self.client.get(
"/v1/invoice/listInvoices",
params={"label": inv["label"]},
)
paid_invoce = r.json()
logger.trace(f"paid invoice: {paid_invoce}")
if (
INVOICE_RESULT_MAP[paid_invoce["invoices"][0]["status"]]
!= PaymentResult.SETTLED
):
raise Exception("invoice not paid")
assert "invoices" in paid_invoce, "no invoices in response"
assert len(paid_invoce["invoices"]), "no invoices in response"
yield paid_invoce["invoices"][0]["payment_hash"]
except Exception as exc:
logger.debug(
f"lost connection to corelightning-rest invoices stream: '{exc}', "
"reconnecting..."
)
await asyncio.sleep(0.02)
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"),
)