mirror of
https://github.com/aljazceru/nutshell.git
synced 2025-12-19 10:04:19 +01:00
45d3059c2d
* update * working * test with lnd * update action * cache poetry * add lndrest * enable regtest * add regtests.yml * poetry version * add helpers * save * run legend regtest fork * actually start * use bash * give rights * remove cache? * change order * tests succeed with lndrestwallet * check if wallet is set * settings for regtest * fix fakewallet test * remove wacky balance check * adjust permissions * try with sudo * adjust example * remove eclair
272 lines
9.1 KiB
Python
272 lines
9.1 KiB
Python
import asyncio
|
|
import base64
|
|
import hashlib
|
|
import json
|
|
from typing import AsyncGenerator, Dict, Optional
|
|
|
|
import httpx
|
|
from loguru import logger
|
|
|
|
from ..core.settings import settings
|
|
from .base import (
|
|
InvoiceResponse,
|
|
PaymentResponse,
|
|
PaymentStatus,
|
|
StatusResponse,
|
|
Wallet,
|
|
)
|
|
|
|
|
|
def load_macaroon(macaroon: str) -> str:
|
|
"""Returns hex version of a macaroon encoded in base64 or the file path.
|
|
|
|
:param macaroon: Macaroon encoded in base64 or file path.
|
|
:type macaroon: str
|
|
:return: Hex version of macaroon.
|
|
:rtype: str
|
|
"""
|
|
|
|
# if the macaroon is a file path, load it and return hex version
|
|
if macaroon.split(".")[-1] == "macaroon":
|
|
with open(macaroon, "rb") as f:
|
|
macaroon_bytes = f.read()
|
|
return macaroon_bytes.hex()
|
|
else:
|
|
# if macaroon is a provided string
|
|
# check if it is hex, if so, return
|
|
try:
|
|
bytes.fromhex(macaroon)
|
|
return macaroon
|
|
except ValueError:
|
|
pass
|
|
# convert the bas64 macaroon to hex
|
|
try:
|
|
macaroon = base64.b64decode(macaroon).hex()
|
|
except Exception:
|
|
pass
|
|
return macaroon
|
|
|
|
|
|
class LndRestWallet(Wallet):
|
|
"""https://api.lightning.community/rest/index.html#lnd-rest-api-reference"""
|
|
|
|
def __init__(self):
|
|
endpoint = settings.mint_lnd_rest_endpoint
|
|
cert = settings.mint_lnd_rest_cert
|
|
|
|
macaroon = (
|
|
settings.mint_lnd_rest_macaroon
|
|
or settings.mint_lnd_rest_admin_macaroon
|
|
or settings.mint_lnd_rest_invoice_macaroon
|
|
)
|
|
|
|
if not endpoint:
|
|
raise Exception("cannot initialize lndrest: no endpoint")
|
|
|
|
if not macaroon:
|
|
raise Exception("cannot initialize lndrest: no macaroon")
|
|
|
|
if not cert:
|
|
logger.warning(
|
|
"no certificate for lndrest provided, this only works if you have a"
|
|
" publicly issued certificate"
|
|
)
|
|
|
|
endpoint = endpoint[:-1] if endpoint.endswith("/") else endpoint
|
|
endpoint = (
|
|
f"https://{endpoint}" if not endpoint.startswith("http") else endpoint
|
|
)
|
|
self.endpoint = endpoint
|
|
self.macaroon = load_macaroon(macaroon)
|
|
|
|
# if no cert provided it should be public so we set verify to True
|
|
# and it will still check for validity of certificate and fail if its not valid
|
|
# even on startup
|
|
self.cert = cert or True
|
|
|
|
self.auth = {"Grpc-Metadata-macaroon": self.macaroon}
|
|
self.client = httpx.AsyncClient(
|
|
base_url=self.endpoint, headers=self.auth, verify=self.cert
|
|
)
|
|
|
|
async def status(self) -> StatusResponse:
|
|
try:
|
|
r = await self.client.get("/v1/balance/channels")
|
|
r.raise_for_status()
|
|
except (httpx.ConnectError, httpx.RequestError) as exc:
|
|
return StatusResponse(
|
|
error_message=f"Unable to connect to {self.endpoint}. {exc}",
|
|
balance_msat=0,
|
|
)
|
|
|
|
try:
|
|
data = r.json()
|
|
if r.is_error:
|
|
raise Exception
|
|
except Exception:
|
|
return StatusResponse(error_message=r.text[:200], balance_msat=0)
|
|
|
|
return StatusResponse(
|
|
error_message=None, balance_msat=int(data["balance"]) * 1000
|
|
)
|
|
|
|
async def create_invoice(
|
|
self,
|
|
amount: int,
|
|
memo: Optional[str] = None,
|
|
description_hash: Optional[bytes] = None,
|
|
unhashed_description: Optional[bytes] = None,
|
|
**kwargs,
|
|
) -> InvoiceResponse:
|
|
data: Dict = {"value": amount, "private": True, "memo": memo or ""}
|
|
if kwargs.get("expiry"):
|
|
data["expiry"] = kwargs["expiry"]
|
|
if description_hash:
|
|
data["description_hash"] = base64.b64encode(description_hash).decode(
|
|
"ascii"
|
|
)
|
|
elif unhashed_description:
|
|
data["description_hash"] = base64.b64encode(
|
|
hashlib.sha256(unhashed_description).digest()
|
|
).decode("ascii")
|
|
|
|
r = await self.client.post(url="/v1/invoices", json=data)
|
|
|
|
if r.is_error:
|
|
error_message = r.text
|
|
try:
|
|
error_message = r.json()["error"]
|
|
except Exception:
|
|
pass
|
|
return InvoiceResponse(
|
|
ok=False,
|
|
checking_id=None,
|
|
payment_request=None,
|
|
error_message=error_message,
|
|
)
|
|
|
|
data = r.json()
|
|
payment_request = data["payment_request"]
|
|
payment_hash = base64.b64decode(data["r_hash"]).hex()
|
|
checking_id = payment_hash
|
|
|
|
return InvoiceResponse(
|
|
ok=True,
|
|
checking_id=checking_id,
|
|
payment_request=payment_request,
|
|
error_message=None,
|
|
)
|
|
|
|
async def pay_invoice(self, bolt11: str, fee_limit_msat: int) -> PaymentResponse:
|
|
# set the fee limit for the payment
|
|
lnrpcFeeLimit = dict()
|
|
lnrpcFeeLimit["fixed_msat"] = f"{fee_limit_msat}"
|
|
|
|
r = await self.client.post(
|
|
url="/v1/channels/transactions",
|
|
json={"payment_request": bolt11, "fee_limit": lnrpcFeeLimit},
|
|
timeout=None,
|
|
)
|
|
|
|
if r.is_error or r.json().get("payment_error"):
|
|
error_message = r.json().get("payment_error") or r.text
|
|
return PaymentResponse(
|
|
ok=False,
|
|
checking_id=None,
|
|
fee_msat=None,
|
|
preimage=None,
|
|
error_message=error_message,
|
|
)
|
|
|
|
data = r.json()
|
|
checking_id = base64.b64decode(data["payment_hash"]).hex()
|
|
fee_msat = int(data["payment_route"]["total_fees_msat"])
|
|
preimage = base64.b64decode(data["payment_preimage"]).hex()
|
|
return PaymentResponse(
|
|
ok=True,
|
|
checking_id=checking_id,
|
|
fee_msat=fee_msat,
|
|
preimage=preimage,
|
|
error_message=None,
|
|
)
|
|
|
|
async def get_invoice_status(self, checking_id: str) -> PaymentStatus:
|
|
r = await self.client.get(url=f"/v1/invoice/{checking_id}")
|
|
|
|
if r.is_error or not r.json().get("settled"):
|
|
# this must also work when checking_id is not a hex recognizable by lnd
|
|
# it will return an error and no "settled" attribute on the object
|
|
return PaymentStatus(paid=None)
|
|
|
|
return PaymentStatus(paid=True)
|
|
|
|
async def get_payment_status(self, checking_id: str) -> PaymentStatus:
|
|
"""
|
|
This routine checks the payment status using routerpc.TrackPaymentV2.
|
|
"""
|
|
# convert checking_id from hex to base64 and some LND magic
|
|
try:
|
|
checking_id = base64.urlsafe_b64encode(bytes.fromhex(checking_id)).decode(
|
|
"ascii"
|
|
)
|
|
except ValueError:
|
|
return PaymentStatus(paid=None)
|
|
|
|
url = f"/v2/router/track/{checking_id}"
|
|
|
|
# check payment.status:
|
|
# https://api.lightning.community/?python=#paymentpaymentstatus
|
|
statuses = {
|
|
"UNKNOWN": None,
|
|
"IN_FLIGHT": None,
|
|
"SUCCEEDED": True,
|
|
"FAILED": False,
|
|
}
|
|
|
|
async with self.client.stream("GET", url, timeout=None) as r:
|
|
async for json_line in r.aiter_lines():
|
|
try:
|
|
line = json.loads(json_line)
|
|
if line.get("error"):
|
|
logger.error(
|
|
line["error"]["message"]
|
|
if "message" in line["error"]
|
|
else line["error"]
|
|
)
|
|
return PaymentStatus(paid=None)
|
|
payment = line.get("result")
|
|
if payment is not None and payment.get("status"):
|
|
return PaymentStatus(
|
|
paid=statuses[payment["status"]],
|
|
fee_msat=payment.get("fee_msat"),
|
|
preimage=payment.get("payment_preimage"),
|
|
)
|
|
else:
|
|
return PaymentStatus(paid=None)
|
|
except Exception:
|
|
continue
|
|
|
|
return PaymentStatus(paid=None)
|
|
|
|
async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
|
|
while True:
|
|
try:
|
|
url = "/v1/invoices/subscribe"
|
|
async with self.client.stream("GET", url, timeout=None) as r:
|
|
async for line in r.aiter_lines():
|
|
try:
|
|
inv = json.loads(line)["result"]
|
|
if not inv["settled"]:
|
|
continue
|
|
except Exception:
|
|
continue
|
|
|
|
payment_hash = base64.b64decode(inv["r_hash"]).hex()
|
|
yield payment_hash
|
|
except Exception as exc:
|
|
logger.error(
|
|
f"lost connection to lnd invoices stream: '{exc}', retrying in 5"
|
|
" seconds"
|
|
)
|
|
await asyncio.sleep(5)
|