Merge branch 'main' into lnc

# Conflicts: # README.md # lnbits/core/templates/service-worker.js # lnbits/static/bundle.min.css # lnbits/templates/base.html
lightningcheckout · Apr 12, 2024 · 9af67df · 9af67df
2 parents 581c5a5 + e9e69d9
commit 9af67df
Show file tree

Hide file tree

Showing 193 changed files with 14,955 additions and 3,942 deletions.
diff --git a/.env.example b/.env.example
@@ -1,82 +1,17 @@
 #For more information on .env files, their content and format: https://pypi.org/project/python-dotenv/
 
-HOST=127.0.0.1
-PORT=5000
-
-# uvicorn variable, uncomment to allow https behind a proxy
-# FORWARDED_ALLOW_IPS="*"
-
-DEBUG=false
-
-# logging into LNBITS_DATA_FOLDER/logs/
-ENABLE_LOG_TO_FILE=true
-
-# https://loguru.readthedocs.io/en/stable/api/logger.html#file
-LOG_ROTATION="100 MB"
-LOG_RETENTION="3 months"
-
-# Server security, rate limiting ips, blocked ips, allowed ips
-LNBITS_RATE_LIMIT_NO="200"
-LNBITS_RATE_LIMIT_UNIT="minute"
-LNBITS_ALLOWED_IPS=""
-LNBITS_BLOCKED_IPS=""
-
-# Allow users and admins by user IDs (comma separated list)
-# if set new users will not be able to create accounts
-LNBITS_ALLOWED_USERS=""
-LNBITS_ADMIN_USERS=""
-# Extensions only admin can access
-LNBITS_ADMIN_EXTENSIONS="ngrok, admin"
-
-# Disable account creation for new users
-# LNBITS_ALLOW_NEW_ACCOUNTS=false
-
-# Enable Admin GUI, available for the first user in LNBITS_ADMIN_USERS if available
-# Warning: Enabling this will make LNbits ignore this configuration file. Your settings will
-# be stored in your database and you will be able to change them only through the Admin UI.
+######################################
+########### Admin Settings ###########
+######################################
+
+# Enable Admin GUI, available for the first user in LNBITS_ADMIN_USERS if available.
+# Warning: Enabling this will make LNbits ignore most configurations in file. Only the
+# configurations defined in `ReadOnlySettings` will still be read from the environment variables.
+# The rest of the settings will be stored in your database and you will be able to change them
+# only  through the Admin UI.
 # Disable this to make LNbits use this config file again.
 LNBITS_ADMIN_UI=false
 
-LNBITS_DEFAULT_WALLET_NAME="LNbits wallet"
-
-# Ad space description
-# LNBITS_AD_SPACE_TITLE="Supported by"
-# csv ad space, format "<url>;<img-light>;<img-dark>, <url>;<img-light>;<img-dark>", extensions can choose to honor
-# LNBITS_AD_SPACE="https://shop.lnbits.com/;https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits/static/images/lnbits-shop-light.png;https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits/static/images/lnbits-shop-dark.png"
-
-# Hides wallet api, extensions can choose to honor
-LNBITS_HIDE_API=false
-
-# LNBITS_EXTENSIONS_MANIFESTS="https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/extensions.json,https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/extensions-trial.json"
-# GitHub has rate-limits for its APIs. The limit can be increased specifying a GITHUB_TOKEN
-# LNBITS_EXT_GITHUB_TOKEN=github_pat_xxxxxxxxxxxxxxxxxx
-
-# Path where extensions will be installed (defaults to `./lnbits/`).
-# Inside this directory the `extensions` and `upgrades` sub-directories will be created.
-# LNBITS_EXTENSIONS_PATH="/path/to/some/dir"
-
-
-# Extensions to be installed by default. If an extension from this list is uninstalled then it will be re-installed on the next restart.
-# The extension must be removed from this list in order to not be re-installed.
-LNBITS_EXTENSIONS_DEFAULT_INSTALL="tpos"
-
-# Database: to use SQLite, specify LNBITS_DATA_FOLDER
-#           to use PostgreSQL, specify LNBITS_DATABASE_URL=postgres://...
-#           to use CockroachDB, specify LNBITS_DATABASE_URL=cockroachdb://...
-# for both PostgreSQL and CockroachDB, you'll need to install
-#   psycopg2 as an additional dependency
-LNBITS_DATA_FOLDER="./data"
-# LNBITS_DATABASE_URL="postgres://user:password@host:port/databasename"
-
-LNBITS_SERVICE_FEE="0.0"
-# value in millisats
-LNBITS_RESERVE_FEE_MIN=2000
-# value in percent
-LNBITS_RESERVE_FEE_PERCENT=1.0
-
-# Limit fiat currencies allowed to see in UI
-# LNBITS_ALLOWED_CURRENCIES="EUR, USD"
-
 # Change theme
 LNBITS_SITE_TITLE="LNbits"
 LNBITS_SITE_TAGLINE="free and open-source lightning wallet"
@@ -85,8 +20,15 @@ LNBITS_SITE_DESCRIPTION="Some description about your service, will display if ti
 LNBITS_THEME_OPTIONS="classic, bitcoin, flamingo, freedom, mint, autumn, monochrome, salvador, cyber"
 # LNBITS_CUSTOM_LOGO="https://lnbits.com/assets/images/logo/logo.svg"
 
+HOST=127.0.0.1
+PORT=5000
+
+######################################
+########## Funding Source ############
+######################################
+
 # which fundingsources are allowed in the admin ui
-LNBITS_ALLOWED_FUNDING_SOURCES="VoidWallet, FakeWallet, CoreLightningWallet, CoreLightningRestWallet, LndRestWallet, EclairWallet, LndWallet, LnTipsWallet, LNPayWallet, LNbitsWallet, OpenNodeWallet"
+LNBITS_ALLOWED_FUNDING_SOURCES="VoidWallet, FakeWallet, CoreLightningWallet, CoreLightningRestWallet, LndRestWallet, EclairWallet, LndWallet, LnTipsWallet, LNPayWallet, LNbitsWallet, AlbyWallet, ZBDWallet, OpenNodeWallet"
 
 LNBITS_BACKEND_WALLET_CLASS=VoidWallet
 # VoidWallet is just a fallback that works without any actual Lightning capabilities,
@@ -109,8 +51,7 @@ CORELIGHTNING_RPC="/home/bob/.lightning/bitcoin/lightning-rpc"
 
 # CoreLightningRestWallet
 CORELIGHTNING_REST_URL=http://127.0.0.1:8185/
-# Path or BASE64/HEX STRING
-CORELIGHTNING_REST_MACAROON="/path/to/clnrest/access.macaroon"
+CORELIGHTNING_REST_MACAROON="/path/to/clnrest/access.macaroon"  # or BASE64/HEXSTRING
 CORELIGHTNING_REST_CERT="/path/to/clnrest/tls.cert"
 
 # LnbitsWallet
@@ -120,15 +61,15 @@ LNBITS_KEY=LNBITS_ADMIN_KEY
 # LndWallet
 LND_GRPC_ENDPOINT=127.0.0.1
 LND_GRPC_PORT=10009
-LND_GRPC_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"
-LND_GRPC_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/admin.macaroon or HEXSTRING"
+LND_GRPC_CERT="/home/bob/.lnd/tls.cert"
+LND_GRPC_MACAROON="/home/bob/.lnd/data/chain/bitcoin/mainnet/admin.macaroon"  # or HEXSTRING
 # To use an AES-encrypted macaroon, set
 # LND_GRPC_MACAROON="eNcRyPtEdMaCaRoOn"
 
 # LndRestWallet
 LND_REST_ENDPOINT=https://127.0.0.1:8080/
-LND_REST_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"
-LND_REST_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/admin.macaroon or HEXSTRING"
+LND_REST_CERT="/home/bob/.lnd/tls.cert"
+LND_REST_MACAROON="/home/bob/.lnd/data/chain/bitcoin/mainnet/admin.macaroon"  # or HEXSTRING
 # To use an AES-encrypted macaroon, set
 # LND_REST_MACAROON_ENCRYPTED="eNcRyPtEdMaCaRoOn"
 
@@ -139,6 +80,14 @@ LNPAY_API_KEY=LNPAY_API_KEY
 # Wallet Admin in Wallet Access Keys
 LNPAY_WALLET_KEY=LNPAY_ADMIN_KEY
 
+# AlbyWallet
+ALBY_API_ENDPOINT=https://api.getalby.com/
+ALBY_ACCESS_TOKEN=ALBY_ACCESS_TOKEN
+
+# ZBDWallet
+ZBD_API_ENDPOINT=https://api.zebedee.io/v0/
+ZBD_API_KEY=ZBD_ACCESS_TOKEN
+
 # OpenNodeWallet
 OPENNODE_API_ENDPOINT=https://api.opennode.com/
 OPENNODE_KEY=OPENNODE_ADMIN_KEY
@@ -155,3 +104,139 @@ ECLAIR_PASS=eclairpw
 # Enter /api in LightningTipBot to get your key
 LNTIPS_API_KEY=LNTIPS_ADMIN_KEY
 LNTIPS_API_ENDPOINT=https://ln.tips
+
+######################################
+####### Auth Configurations ##########
+######################################
+# Secret Key: will default to the hash of the super user. It is strongly recommended that you set your own value.
+AUTH_SECRET_KEY=""
+AUTH_TOKEN_EXPIRE_MINUTES=525600
+# Possible authorization methods: user-id-only, username-password, google-auth, github-auth, keycloak-auth
+AUTH_ALLOWED_METHODS="user-id-only, username-password"
+# Set this flag if HTTP is used for OAuth
+# OAUTHLIB_INSECURE_TRANSPORT="1"
+
+# Google OAuth Config
+# Make sure that the authorized redirect URIs contain https://{domain}/api/v1/auth/google/token
+GOOGLE_CLIENT_ID=""
+GOOGLE_CLIENT_SECRET=""
+
+# GitHub OAuth Config
+# Make sure that the authorization callback URL is set to https://{domain}/api/v1/auth/github/token
+GITHUB_CLIENT_ID=""
+GITHUB_CLIENT_SECRET=""
+
+# Keycloak OAuth Config
+# Make sure that the valid redirect URIs contain https://{domain}/api/v1/auth/keycloak/token
+KEYCLOAK_CLIENT_ID=""
+KEYCLOAK_CLIENT_SECRET=""
+KEYCLOAK_DISCOVERY_URL=""
+
+
+######################################
+
+# uvicorn variable, uncomment to allow https behind a proxy
+# IMPORTANT: this also needs the webserver to be configured to forward the headers
+# http://docs.lnbits.org/guide/installation.html#running-behind-an-apache2-reverse-proxy-over-https
+# FORWARDED_ALLOW_IPS="*"
+
+# Server security, rate limiting ips, blocked ips, allowed ips
+LNBITS_RATE_LIMIT_NO="200"
+LNBITS_RATE_LIMIT_UNIT="minute"
+LNBITS_ALLOWED_IPS=""
+LNBITS_BLOCKED_IPS=""
+
+# Allow users and admins by user IDs (comma separated list)
+# if set new users will not be able to create accounts
+LNBITS_ALLOWED_USERS=""
+LNBITS_ADMIN_USERS=""
+# ID of the super user. The user ID must exist.
+# SUPER_USER=""
+
+# Extensions only admin can access
+LNBITS_ADMIN_EXTENSIONS="ngrok, admin"
+
+# Start LNbits core only. The extensions are not loaded.
+# LNBITS_EXTENSIONS_DEACTIVATE_ALL=true
+
+# Disable account creation for new users
+# LNBITS_ALLOW_NEW_ACCOUNTS=false
+
+# Enable Node Management without activating the LNBITS Admin GUI
+# by setting the following variables to true.
+LNBITS_NODE_UI=false
+LNBITS_PUBLIC_NODE_UI=false
+# Enabling the transactions tab can cause crashes on large Core Lightning nodes.
+LNBITS_NODE_UI_TRANSACTIONS=false
+
+LNBITS_DEFAULT_WALLET_NAME="LNbits wallet"
+
+# Ad space description
+# LNBITS_AD_SPACE_TITLE="Supported by"
+# csv ad space, format "<url>;<img-light>;<img-dark>, <url>;<img-light>;<img-dark>", extensions can choose to honor
+# LNBITS_AD_SPACE="https://shop.lnbits.com/;https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits/static/images/lnbits-shop-light.png;https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits/static/images/lnbits-shop-dark.png"
+
+# Hides wallet api, extensions can choose to honor
+LNBITS_HIDE_API=false
+
+# LNBITS_EXTENSIONS_MANIFESTS="https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/extensions.json,https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/extensions-trial.json"
+# GitHub has rate-limits for its APIs. The limit can be increased specifying a GITHUB_TOKEN
+# LNBITS_EXT_GITHUB_TOKEN=github_pat_xxxxxxxxxxxxxxxxxx
+
+# Path where extensions will be installed (defaults to `./lnbits/`).
+# Inside this directory the `extensions` and `upgrades` sub-directories will be created.
+# LNBITS_EXTENSIONS_PATH="/path/to/some/dir"
+
+# Extensions to be installed by default. If an extension from this list is uninstalled then it will be re-installed on the next restart.
+# The extension must be removed from this list in order to not be re-installed.
+LNBITS_EXTENSIONS_DEFAULT_INSTALL="tpos"
+
+# Database: to use SQLite, specify LNBITS_DATA_FOLDER
+#           to use PostgreSQL, specify LNBITS_DATABASE_URL=postgres://...
+#           to use CockroachDB, specify LNBITS_DATABASE_URL=cockroachdb://...
+# for both PostgreSQL and CockroachDB, you'll need to install
+#   psycopg2 as an additional dependency
+LNBITS_DATA_FOLDER="./data"
+# LNBITS_DATABASE_URL="postgres://user:password@host:port/databasename"
+
+# the service fee (in percent)
+LNBITS_SERVICE_FEE=0.0
+# the wallet where fees go to
+# LNBITS_SERVICE_FEE_WALLET=
+# the maximum fee per transaction (in satoshis)
+# LNBITS_SERVICE_FEE_MAX=1000
+# disable fees for internal transactions
+# LNBITS_SERVICE_FEE_IGNORE_INTERNAL=true
+
+# value in millisats
+LNBITS_RESERVE_FEE_MIN=2000
+# value in percent
+LNBITS_RESERVE_FEE_PERCENT=1.0
+
+# limit the maximum balance for each wallet
+# throw an error if the wallet attempts to create a new invoice
+
+# LNBITS_WALLET_LIMIT_MAX_BALANCE=1000000
+# LNBITS_WALLET_LIMIT_DAILY_MAX_WITHDRAW=1000000
+# LNBITS_WALLET_LIMIT_SECS_BETWEEN_TRANS=60
+
+# Limit fiat currencies allowed to see in UI
+# LNBITS_ALLOWED_CURRENCIES="EUR, USD"
+
+######################################
+###### Logging and Development #######
+######################################
+
+DEBUG=false
+DEBUG_DATABASE=false
+BUNDLE_ASSETS=true
+
+# logging into LNBITS_DATA_FOLDER/logs/
+ENABLE_LOG_TO_FILE=true
+
+# https://loguru.readthedocs.io/en/stable/api/logger.html#file
+LOG_ROTATION="100 MB"
+LOG_RETENTION="3 months"
+
+# for database cleanup commands
+# CLEANUP_WALLETS_DAYS=90
diff --git a/.github/actions/prepare/action.yml b/.github/actions/prepare/action.yml
@@ -7,10 +7,10 @@ inputs:
     default: "3.9"
   poetry-version:
     description: "Poetry Version"
-    default: "1.5.1"
+    default: "1.7.0"
   node-version:
     description: "Node Version"
-    default: "18.x"
+    default: "20.x"
   npm:
     description: "use npm"
     default: false
@@ -21,7 +21,7 @@ runs:
   using: "composite"
   steps:
     - name: Set up Python ${{ inputs.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
         # cache poetry install via pip
@@ -38,7 +38,7 @@ runs:
         poetry config virtualenvs.create true --local
         poetry config virtualenvs.in-project true --local
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Define a cache for the virtual environment based on the dependencies lock file
       with:
         path: ./.venv
@@ -50,11 +50,11 @@ runs:
 
     - name: Use Node.js ${{ inputs.node-version }}
       if: ${{ (inputs.npm == 'true') }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ inputs.node-version }}
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       if: ${{ (inputs.npm == 'true') }}
       name: Define a cache for the npm based on the dependencies lock file
       with:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,26 +21,25 @@ jobs:
     uses: ./.github/workflows/tests.yml
     with:
       python-version: ${{ matrix.python-version }}
+      db-url: ${{ matrix.db-url }}
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  migrations:
+  migration:
     needs: [ lint ]
     strategy:
       matrix:
-        python-version: ["3.9"]
-    uses: ./.github/workflows/tests.yml
+        python-version: ["3.9", "3.10"]
+    uses: ./.github/workflows/migration.yml
     with:
-      make: test-migration
-      db-name: migration
+      python-version: ${{ matrix.python-version }}
 
   openapi:
     needs: [ lint ]
     uses: ./.github/workflows/make.yml
     with:
       make: openapi
 
-  # docker:
-  #   uses: ./.github/workflows/docker.yml
-
   regtest:
     needs: [ lint ]
     uses: ./.github/workflows/regtest.yml
@@ -51,3 +50,16 @@ jobs:
     with:
       python-version: ${{ matrix.python-version }}
       backend-wallet-class: ${{ matrix.backend-wallet-class }}
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  jmeter:
+    needs: [ lint ]
+    strategy:
+      matrix:
+        python-version: ["3.9"]
+        poetry-version: ["1.5.1"]
+    uses: ./.github/workflows/jmeter.yml
+    with:
+      python-version: ${{ matrix.python-version }}
+      poetry-version: ${{ matrix.poetry-version }}
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 2
       - run: git checkout HEAD^2