feat: code quality

.github/workflows/lint.yml

@@ -0,0 +1,10 @@
+name: lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    uses: lnbits/lnbits/.github/workflows/lint.yml@dev

.github/workflows/release.yml

@@ -1,10 +1,9 @@
 on:
   push:
     tags:
-      - "v[0-9]+.[0-9]+.[0-9]+"
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
-
   release:
     runs-on: ubuntu-latest
     steps:
@@ -34,12 +33,12 @@ jobs:
       - name: Create pull request in extensions repo
         env:
           GH_TOKEN: ${{ secrets.EXT_GITHUB }}
-          repo_name: "${{ github.event.repository.name }}"
-          tag: "${{ github.ref_name }}"
-          branch: "update-${{ github.event.repository.name }}-${{ github.ref_name }}"
-          title: "[UPDATE] ${{ github.event.repository.name }} to ${{ github.ref_name }}"
-          body: "https://github.com/lnbits/${{ github.event.repository.name }}/releases/${{ github.ref_name }}"
-          archive: "https://github.com/lnbits/${{ github.event.repository.name }}/archive/refs/tags/${{ github.ref_name }}.zip"
+          repo_name: '${{ github.event.repository.name }}'
+          tag: '${{ github.ref_name }}'
+          branch: 'update-${{ github.event.repository.name }}-${{ github.ref_name }}'
+          title: '[UPDATE] ${{ github.event.repository.name }} to ${{ github.ref_name }}'
+          body: 'https://github.com/lnbits/${{ github.event.repository.name }}/releases/${{ github.ref_name }}'
+          archive: 'https://github.com/lnbits/${{ github.event.repository.name }}/archive/refs/tags/${{ github.ref_name }}.zip'
         run: |
           cd lnbits-extensions
           git checkout -b $branch

.gitignore

@@ -1 +1,4 @@
 __pycache__
+node_modules
+.mypy_cache
+.venv

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": false,
+  "arrowParens": "avoid",
+  "insertPragma": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "singleQuote": true,
+  "trailingComma": "none",
+  "useTabs": false,
+  "bracketSameLine": false,
+  "bracketSpacing": false
+}

Makefile

@@ -0,0 +1,47 @@
+all: format check
+
+format: prettier black ruff
+
+check: mypy pyright checkblack checkruff checkprettier
+
+prettier:
+	poetry run ./node_modules/.bin/prettier --write .
+pyright:
+	poetry run ./node_modules/.bin/pyright
+
+mypy:
+	poetry run mypy .
+
+black:
+	poetry run black .
+
+ruff:
+	poetry run ruff check . --fix
+
+checkruff:
+	poetry run ruff check .
+
+checkprettier:
+	poetry run ./node_modules/.bin/prettier --check .
+
+checkblack:
+	poetry run black --check .
+
+checkeditorconfig:
+	editorconfig-checker
+
+test:
+	PYTHONUNBUFFERED=1 \
+	DEBUG=true \
+	poetry run pytest
+install-pre-commit-hook:
+	@echo "Installing pre-commit hook to git"
+	@echo "Uninstall the hook with poetry run pre-commit uninstall"
+	poetry run pre-commit install
+
+pre-commit:
+	poetry run pre-commit run --all-files
+
+
+checkbundle:
+	@echo "skipping checkbundle"

__init__.py

@@ -1,41 +1,18 @@
 import asyncio
 
-from fastapi import APIRouter, Request, Response
-from fastapi.routing import APIRoute
-
-from lnbits.db import Database
-from lnbits.helpers import template_renderer
-from lnbits.tasks import create_permanent_unique_task
-from typing import Callable
-from fastapi.responses import JSONResponse
-
-db = Database("ext_tpos")
-
-
-class LNURLErrorResponseHandler(APIRoute):
-    def get_route_handler(self) -> Callable:
-        original_route_handler = super().get_route_handler()
-
-        async def custom_route_handler(request: Request) -> Response:
-            try:
-                response = await original_route_handler(request)
-            except HTTPException as exc:
-                logger.debug(f"HTTPException: {exc}")
-                response = JSONResponse(
-                    status_code=exc.status_code,
-                    content={"status": "ERROR", "reason": f"{exc.detail}"},
-                )
-            except Exception as exc:
-                raise exc
-
-            return response
-
-        return custom_route_handler
+from fastapi import APIRouter
+from loguru import logger
 
+from .crud import db
+from .tasks import wait_for_paid_invoices
+from .views import tpos_generic_router
+from .views_api import tpos_api_router
+from .views_lnurl import tpos_lnurl_router
 
-tpos_ext: APIRouter = APIRouter(
-    prefix="/tpos", tags=["TPoS"], route_class=LNURLErrorResponseHandler
-)
+tpos_ext = APIRouter(prefix="/tpos", tags=["TPoS"])
+tpos_ext.include_router(tpos_generic_router)
+tpos_ext.include_router(tpos_lnurl_router)
+tpos_ext.include_router(tpos_api_router)
 
 tpos_static_files = [
     {
@@ -44,26 +21,28 @@ async def custom_route_handler(request: Request) -> Response:
     }
 ]
 
-
-def tpos_renderer():
-    return template_renderer(["tpos/templates"])
-
-
-from .lnurl import *  # noqa: F401,F403
-from .tasks import wait_for_paid_invoices
-from .views import *  # noqa
-from .views_api import *  # noqa
-
-
 scheduled_tasks: list[asyncio.Task] = []
 
+
 def tpos_stop():
     for task in scheduled_tasks:
         try:
             task.cancel()
         except Exception as ex:
             logger.warning(ex)
 
+
 def tpos_start():
+    from lnbits.tasks import create_permanent_unique_task
+
     task = create_permanent_unique_task("ext_tpos", wait_for_paid_invoices)
     scheduled_tasks.append(task)
+
+
+__all__ = [
+    "db",
+    "tpos_ext",
+    "tpos_static_files",
+    "tpos_start",
+    "tpos_stop",
+]

crud.py

@@ -1,19 +1,19 @@
 from typing import List, Optional, Union
 
-from loguru import logger
-
+from lnbits.db import Database
 from lnbits.helpers import urlsafe_short_hash
+from loguru import logger
 
-from . import db
 from .models import CreateTposData, LNURLCharge, TPoS, TPoSClean
 
+db = Database("ext_tpos")
+
 
 async def get_current_timestamp():
     # Get current DB timestamp
+    timestamp_query = f"SELECT {db.timestamp_now}"
     if db.type in {"POSTGRES", "COCKROACH"}:
         timestamp_query = f"SELECT EXTRACT(EPOCH FROM {db.timestamp_now})"
-    elif db.type == "SQLITE":
-        timestamp_query = f"SELECT {db.timestamp_now}"
     current_timestamp = (await db.fetchone(timestamp_query))[0]
     return int(current_timestamp)
 
@@ -22,7 +22,12 @@ async def create_tpos(wallet_id: str, data: CreateTposData) -> TPoS:
     tpos_id = urlsafe_short_hash()
     await db.execute(
         """
-        INSERT INTO tpos.pos (id, wallet, name, currency, tip_options, tip_wallet, withdrawlimit, withdrawpin, withdrawamt, withdrawtime, withdrawbtwn, withdrawtimeopt, withdrawpindisabled, withdrawpremium)
+        INSERT INTO tpos.pos
+        (
+            id, wallet, name, currency, tip_options, tip_wallet, withdrawlimit,
+            withdrawpin, withdrawamt, withdrawtime, withdrawbtwn, withdrawtimeopt,
+            withdrawpindisabled, withdrawpremium
+        )
         VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
         """,
         (
@@ -62,7 +67,10 @@ async def start_lnurlcharge(tpos_id: str):
     )
     assert (
         now - tpos.withdrawtime > withdraw_time_seconds
-    ), f"Last withdraw was made too recently, please try again in {int(withdraw_time_seconds - (now - tpos.withdrawtime))} secs"
+    ), f"""
+    Last withdraw was made too recently, please try again in
+    {int(withdraw_time_seconds - (now - tpos.withdrawtime))} secs
+    """
 
     token = urlsafe_short_hash()
     await db.execute(
@@ -120,7 +128,10 @@ async def update_tpos_withdraw(data: TPoS, tpos_id: str) -> TPoS:
     # Check if the time between withdrawals is less than withdrawbtwn
     assert (
         time_elapsed > withdraw_time_seconds
-    ), f"Last withdraw was made too recently, please try again in {int(withdraw_time_seconds - (time_elapsed))} secs"
+    ), f"""
+    Last withdraw was made too recently, please try again in
+    {int(withdraw_time_seconds - (time_elapsed))} secs"
+    """
 
     # Update the withdraw time in the database
     await db.execute(

description.md

@@ -2,10 +2,10 @@ A powerful air-gapped software Point of Sale can be shared via a QR code.
 
 Its functions include:
 
-* Generating invoices
-* Denomination in sats and ANY fiat currency
-* Boltcard support
-* Adding items for a checkout experience
-* An ATM feature that allows you to sell Bitcoin back to your customers for a profit!
+- Generating invoices
+- Denomination in sats and ANY fiat currency
+- Boltcard support
+- Adding items for a checkout experience
+- An ATM feature that allows you to sell Bitcoin back to your customers for a profit!
 
-A favorite onboarding solution for merchants who want to accumulate Bitcoin, can ben achieved by also using the Boltz extension for automatic trustless swaps out to on-chain.
+A favorite onboarding solution for merchants who want to accumulate Bitcoin, can ben achieved by also using the Boltz extension for automatic trustless swaps out to on-chain.

migrations.py

@@ -113,10 +113,11 @@ async def m008_atm_time_option_and_pin_toggle(db):
     Add a time mins/sec and pin toggle
     """
     await db.execute(
-        "ALTER TABLE tpos.pos ADD COLUMN withdrawtimeopt TEXT DEFAULT 'mins';"
+        "ALTER TABLE tpos.pos " "ADD COLUMN withdrawtimeopt TEXT DEFAULT 'mins'"
     )
     await db.execute(
-        "ALTER TABLE tpos.pos ADD COLUMN withdrawpindisabled BOOL NOT NULL DEFAULT false;"
+        "ALTER TABLE tpos.pos "
+        "ADD COLUMN withdrawpindisabled BOOL NOT NULL DEFAULT false"
     )
 
 

models.py

@@ -2,9 +2,8 @@
 from typing import List, Optional
 
 from fastapi import Request
-from lnurl import Lnurl, LnurlWithdrawResponse
+from lnurl import Lnurl
 from lnurl import encode as lnurl_encode
-from lnurl.types import ClearnetUrl, MilliSatoshi
 from pydantic import BaseModel, Field, validator
 
 
@@ -77,18 +76,6 @@ def lnurl(self, req: Request) -> Lnurl:
         )
         return lnurl_encode(url)
 
-    def lnurl_response(self, req: Request) -> LnurlWithdrawResponse:
-        url = str(req.url_for("tpos.tposlnurlcharge.callback"))
-        assert self.amount
-        amount = int(self.amount)
-        return LnurlWithdrawResponse(
-            callback=ClearnetUrl(url, scheme="https"),
-            k1=self.k1,
-            minWithdrawable=MilliSatoshi(amount * 1000),
-            maxWithdrawable=MilliSatoshi(amount * 1000),
-            defaultDescription=self.title,
-        )
-
 
 class HashCheck(BaseModel):
     hash: bool