lnbits-legend/lnbits/wallets/base.py
2020-10-13 14:46:23 -03:00

63 lines
1.4 KiB
Python

from abc import ABC, abstractmethod
from typing import NamedTuple, Optional, AsyncGenerator
class StatusResponse(NamedTuple):
error_message: Optional[str]
balance_msat: int
class InvoiceResponse(NamedTuple):
ok: bool
checking_id: Optional[str] = None # payment_hash, rpc_id
payment_request: Optional[str] = None
error_message: Optional[str] = None
class PaymentResponse(NamedTuple):
ok: bool
checking_id: Optional[str] = None # payment_hash, rcp_id
fee_msat: int = 0
preimage: Optional[str] = None
error_message: Optional[str] = None
class PaymentStatus(NamedTuple):
paid: Optional[bool] = None
@property
def pending(self) -> bool:
return self.paid is not True
class Wallet(ABC):
@abstractmethod
def status(self) -> StatusResponse:
pass
@abstractmethod
def create_invoice(
self, amount: int, memo: Optional[str] = None, description_hash: Optional[bytes] = None
) -> InvoiceResponse:
pass
@abstractmethod
def pay_invoice(self, bolt11: str) -> PaymentResponse:
pass
@abstractmethod
def get_invoice_status(self, checking_id: str) -> PaymentStatus:
pass
@abstractmethod
def get_payment_status(self, checking_id: str) -> PaymentStatus:
pass
@abstractmethod
def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
pass
class Unsupported(Exception):
pass