Mint: add websockets for quote updates

.github/workflows/ci.yml

@@ -15,7 +15,6 @@ jobs:
         os: [ubuntu-latest]
         python-version: ["3.10"]
         poetry-version: ["1.7.1"]
-        mint-cache-secrets: ["false", "true"]
         mint-only-deprecated: ["false", "true"]
         mint-database: ["./test_data/test_mint", "postgres://cashu:cashu@localhost:5432/cashu"]
         backend-wallet-class: ["FakeWallet"]
@@ -24,7 +23,6 @@ jobs:
       os: ${{ matrix.os }}
       python-version: ${{ matrix.python-version }}
       poetry-version: ${{ matrix.poetry-version }}
-      mint-cache-secrets: ${{ matrix.mint-cache-secrets }}
       mint-only-deprecated: ${{ matrix.mint-only-deprecated }}
       mint-database: ${{ matrix.mint-database }}
   regtest:

.github/workflows/tests.yml

@@ -15,16 +15,13 @@ on:
       os:
         default: "ubuntu-latest"
         type: string
-      mint-cache-secrets:
-        default: "false"
-        type: string
       mint-only-deprecated:
         default: "false"
         type: string
 
 jobs:
   poetry:
-    name: Run (mint-cache-secrets ${{ inputs.mint-cache-secrets }}, mint-only-deprecated ${{ inputs.mint-only-deprecated }}, mint-database ${{ inputs.mint-database }})
+    name: Run (db ${{ inputs.mint-database }}, deprecated api ${{ inputs.mint-only-deprecated }})
     runs-on: ${{ inputs.os }}
     services:
       postgres:
@@ -54,7 +51,6 @@ jobs:
           MINT_HOST: localhost
           MINT_PORT: 3337
           MINT_TEST_DATABASE: ${{ inputs.mint-database }}
-          MINT_CACHE_SECRETS: ${{ inputs.mint-cache-secrets }}
           DEBUG_MINT_ONLY_DEPRECATED: ${{ inputs.mint-only-deprecated }}
           TOR: false
         run: |

cashu/core/base.py

@@ -7,8 +7,11 @@
 from typing import Dict, List, Optional, Union
 
 from loguru import logger
-from pydantic import BaseModel
+from pydantic import BaseModel, root_validator
 
+from cashu.core.json_rpc.base import JSONRPCSubscriptionKinds
+
+from ..mint.events.event_model import LedgerEvent
 from .crypto.aes import AESCipher
 from .crypto.b_dhke import hash_to_curve
 from .crypto.keys import (
@@ -54,11 +57,27 @@ def __str__(self):
         return self.name
 
 
-class ProofState(BaseModel):
+class ProofState(LedgerEvent):
     Y: str
     state: SpentState
     witness: Optional[str] = None
 
+    @root_validator()
+    def check_witness(cls, values):
+        state, witness = values.get("state"), values.get("witness")
+        if witness is not None and state != SpentState.spent:
+            raise ValueError('Witness can only be set if the spent state is "SPENT"')
+        return values
+
+    @property
+    def identifier(self) -> str:
+        """Implementation of the abstract method from LedgerEventManager"""
+        return self.Y
+
+    @property
+    def kind(self) -> JSONRPCSubscriptionKinds:
+        return JSONRPCSubscriptionKinds.PROOF_STATE
+
 
 class HTLCWitness(BaseModel):
     preimage: Optional[str] = None
@@ -249,7 +268,7 @@ class Invoice(BaseModel):
     time_paid: Union[None, str, int, float] = ""
 
 
-class MeltQuote(BaseModel):
+class MeltQuote(LedgerEvent):
     quote: str
     method: str
     request: str
@@ -290,8 +309,17 @@ def from_row(cls, row: Row):
             proof=row["proof"],
         )
 
+    @property
+    def identifier(self) -> str:
+        """Implementation of the abstract method from LedgerEventManager"""
+        return self.quote
+
+    @property
+    def kind(self) -> JSONRPCSubscriptionKinds:
+        return JSONRPCSubscriptionKinds.BOLT11_MELT_QUOTE
+
 
-class MintQuote(BaseModel):
+class MintQuote(LedgerEvent):
     quote: str
     method: str
     request: str
@@ -329,6 +357,15 @@ def from_row(cls, row: Row):
             paid_time=paid_time,
         )
 
+    @property
+    def identifier(self) -> str:
+        """Implementation of the abstract method from LedgerEventManager"""
+        return self.quote
+
+    @property
+    def kind(self) -> JSONRPCSubscriptionKinds:
+        return JSONRPCSubscriptionKinds.BOLT11_MINT_QUOTE
+
 
 # ------- KEYSETS -------
 

cashu/core/json_rpc/base.py

@@ -0,0 +1,86 @@
+from enum import Enum
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from ..settings import settings
+
+
+class JSONRPCRequest(BaseModel):
+    jsonrpc: str = "2.0"
+    id: int
+    method: str
+    params: dict
+
+
+class JSONRPCResponse(BaseModel):
+    jsonrpc: str = "2.0"
+    result: dict
+    id: int
+
+
+class JSONRPCNotification(BaseModel):
+    jsonrpc: str = "2.0"
+    method: str
+    params: dict
+
+
+class JSONRPCErrorCode(Enum):
+    PARSE_ERROR = -32700
+    INVALID_REQUEST = -32600
+    METHOD_NOT_FOUND = -32601
+    INVALID_PARAMS = -32602
+    INTERNAL_ERROR = -32603
+    SERVER_ERROR = -32000
+    APPLICATION_ERROR = -32099
+    SYSTEM_ERROR = -32098
+    TRANSPORT_ERROR = -32097
+
+
+class JSONRPCError(BaseModel):
+    code: JSONRPCErrorCode
+    message: str
+
+
+class JSONRPCErrorResponse(BaseModel):
+    jsonrpc: str = "2.0"
+    error: JSONRPCError
+    id: int
+
+
+# Cashu Websocket protocol
+
+
+class JSONRPCMethods(Enum):
+    SUBSCRIBE = "subscribe"
+    UNSUBSCRIBE = "unsubscribe"
+
+
+class JSONRPCSubscriptionKinds(Enum):
+    BOLT11_MINT_QUOTE = "bolt11_mint_quote"
+    BOLT11_MELT_QUOTE = "bolt11_melt_quote"
+    PROOF_STATE = "proof_state"
+
+
+class JSONRPCStatus(Enum):
+    OK = "OK"
+
+
+class JSONRPCSubscribeParams(BaseModel):
+    kind: JSONRPCSubscriptionKinds
+    filters: List[str] = Field(..., max_length=settings.mint_max_request_length)
+    subId: str
+
+
+class JSONRPCUnsubscribeParams(BaseModel):
+    subId: str
+
+
+class JSONRPCNotficationParams(BaseModel):
+    subId: str
+    payload: dict
+
+
+class JSONRRPCSubscribeResponse(BaseModel):
+    status: JSONRPCStatus
+    subId: str

cashu/core/models.py

@@ -33,6 +33,9 @@ class GetInfoResponse(BaseModel):
     motd: Optional[str] = None
     nuts: Optional[Dict[int, Any]] = None
 
+    def supports(self, nut: int) -> Optional[bool]:
+        return nut in self.nuts if self.nuts else None
+
 
 class Nut15MppSupport(BaseModel):
     method: str

cashu/core/nuts.py

@@ -0,0 +1,13 @@
+SWAP_NUT = 3
+MINT_NUT = 4
+MELT_NUT = 5
+INFO_NUT = 6
+STATE_NUT = 7
+FEE_RETURN_NUT = 8
+RESTORE_NUT = 9
+SCRIPT_NUT = 10
+P2PK_NUT = 11
+DLEQ_NUT = 12
+DETERMINSTIC_SECRETS_NUT = 13
+MPP_NUT = 15
+WEBSOCKETS_NUT = 17

cashu/core/settings.py

@@ -120,14 +120,20 @@ class MintLimits(MintSettings):
         title="Maximum mint balance",
         description="Maximum mint balance.",
     )
+    mint_websocket_read_timeout: int = Field(
+        default=10 * 60,
+        gt=0,
+        title="Websocket read timeout",
+        description="Timeout for reading from a websocket.",
+    )
 
 
 class FakeWalletSettings(MintSettings):
     fakewallet_brr: bool = Field(default=True)
-    fakewallet_delay_payment: bool = Field(default=False)
+    fakewallet_delay_outgoing_payment: Optional[int] = Field(default=3)
+    fakewallet_delay_incoming_payment: Optional[int] = Field(default=3)
     fakewallet_stochastic_invoice: bool = Field(default=False)
     fakewallet_payment_state: Optional[bool] = Field(default=None)
-    mint_cache_secrets: bool = Field(default=True)
 
 
 class MintInformation(CashuSettings):

cashu/lightning/base.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Coroutine, Optional, Union
+from typing import AsyncGenerator, Coroutine, Optional, Union
 
 from pydantic import BaseModel
 
@@ -68,6 +68,7 @@ def __str__(self) -> str:
 
 class LightningBackend(ABC):
     supports_mpp: bool = False
+    supports_incoming_payment_stream: bool = False
     supported_units: set[Unit]
     unit: Unit
 
@@ -124,9 +125,9 @@ async def get_payment_quote(
     # ) -> InvoiceQuoteResponse:
     #     pass
 
-    # @abstractmethod
-    # def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
-    #     pass
+    @abstractmethod
+    def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
+        pass
 
 
 class Unsupported(Exception):

cashu/lightning/blink.py

@@ -1,8 +1,7 @@
 # type: ignore
-import asyncio
 import json
 import math
-from typing import Dict, Optional, Union
+from typing import AsyncGenerator, Dict, Optional, Union
 
 import bolt11
 import httpx
@@ -454,10 +453,5 @@ async def get_payment_quote(
             amount=amount.to(self.unit, round="up"),
         )
 
-
-async def main():
-    pass
-
-
-if __name__ == "__main__":
-    asyncio.run(main())
+    async def paid_invoices_stream(self) -> AsyncGenerator[str, None]:
+        raise NotImplementedError("paid_invoices_stream not implemented")

cashu/lightning/corelightningrest.py

@@ -29,6 +29,7 @@
 class CoreLightningRestWallet(LightningBackend):
     supported_units = set([Unit.sat, Unit.msat])
     unit = Unit.sat
+    supports_incoming_payment_stream: bool = True
 
     def __init__(self, unit: Unit = Unit.sat, **kwargs):
         self.assert_unit_supported(unit)