diff --git a/lnbits/extensions/usermanager/README.md b/lnbits/extensions/usermanager/README.md deleted file mode 100644 index b6f306275..000000000 --- a/lnbits/extensions/usermanager/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# User Manager - -## Make and manage users/wallets - -To help developers use LNbits to manage their users, the User Manager extension allows the creation and management of users and wallets. - -For example, a games developer may be developing a game that needs each user to have their own wallet, LNbits can be included in the developers stack as the user and wallet manager. Or someone wanting to manage their family's wallets (wife, children, parents, etc...) or you want to host a community Lightning Network node and want to manage wallets for the users. - -## Usage - -1. Click the button "NEW USER" to create a new user\ - ![new user](https://i.imgur.com/4yZyfJE.png) -2. Fill the user information\ - - username - - the generated wallet name, user can create other wallets later on - - email - - set a password - ![user information](https://i.imgur.com/40du7W5.png) -3. After creating your user, it will appear in the **Users** section, and a user's wallet in the **Wallets** section. -4. Next you can share the wallet with the corresponding user\ - ![user wallet](https://i.imgur.com/gAyajbx.png) -5. If you need to create more wallets for some user, click "NEW WALLET" at the top\ - ![multiple wallets](https://i.imgur.com/wovVnim.png) - - select the existing user you wish to add the wallet - - set a wallet name\ - ![new wallet](https://i.imgur.com/sGwG8dC.png) diff --git a/lnbits/extensions/usermanager/__init__.py b/lnbits/extensions/usermanager/__init__.py deleted file mode 100644 index 8d8ff557b..000000000 --- a/lnbits/extensions/usermanager/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -from fastapi import APIRouter -from fastapi.staticfiles import StaticFiles - -from lnbits.db import Database -from lnbits.helpers import template_renderer - -db = Database("ext_usermanager") - -usermanager_ext: APIRouter = APIRouter(prefix="/usermanager", tags=["usermanager"]) - -usermanager_static_files = [ - { - "path": "/usermanager/static", - "app": StaticFiles(directory="lnbits/extensions/usermanager/static"), - "name": "usermanager_static", - } -] - - -def usermanager_renderer(): - return template_renderer(["lnbits/extensions/usermanager/templates"]) - - -from .views import * # noqa -from .views_api import * # noqa diff --git a/lnbits/extensions/usermanager/config.json b/lnbits/extensions/usermanager/config.json deleted file mode 100644 index 0b38a0833..000000000 --- a/lnbits/extensions/usermanager/config.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "name": "User Manager", - "short_description": "Generate users and wallets", - "tile": "/usermanager/static/image/usermanager.png", - "contributors": ["benarc"] -} diff --git a/lnbits/extensions/usermanager/crud.py b/lnbits/extensions/usermanager/crud.py deleted file mode 100644 index 959914f26..000000000 --- a/lnbits/extensions/usermanager/crud.py +++ /dev/null @@ -1,119 +0,0 @@ -from typing import List, Optional - -from lnbits.core.crud import ( - create_account, - create_wallet, - delete_wallet, - get_payments, - get_user, -) -from lnbits.core.models import Payment - -from . import db -from .models import CreateUserData, User, Wallet - - -async def create_usermanager_user(data: CreateUserData) -> User: - account = await create_account() - user = await get_user(account.id) - assert user, "Newly created user couldn't be retrieved" - - wallet = await create_wallet(user_id=user.id, wallet_name=data.wallet_name) - - await db.execute( - """ - INSERT INTO usermanager.users (id, name, admin, email, password) - VALUES (?, ?, ?, ?, ?) - """, - (user.id, data.user_name, data.admin_id, data.email, data.password), - ) - - await db.execute( - """ - INSERT INTO usermanager.wallets (id, admin, name, "user", adminkey, inkey) - VALUES (?, ?, ?, ?, ?, ?) - """, - ( - wallet.id, - data.admin_id, - data.wallet_name, - user.id, - wallet.adminkey, - wallet.inkey, - ), - ) - - user_created = await get_usermanager_user(user.id) - assert user_created, "Newly created user couldn't be retrieved" - return user_created - - -async def get_usermanager_user(user_id: str) -> Optional[User]: - row = await db.fetchone("SELECT * FROM usermanager.users WHERE id = ?", (user_id,)) - return User(**row) if row else None - - -async def get_usermanager_users(user_id: str) -> List[User]: - rows = await db.fetchall( - "SELECT * FROM usermanager.users WHERE admin = ?", (user_id,) - ) - - return [User(**row) for row in rows] - - -async def delete_usermanager_user(user_id: str, delete_core: bool = True) -> None: - if delete_core: - wallets = await get_usermanager_wallets(user_id) - for wallet in wallets: - await delete_wallet(user_id=user_id, wallet_id=wallet.id) - - await db.execute("DELETE FROM usermanager.users WHERE id = ?", (user_id,)) - await db.execute("""DELETE FROM usermanager.wallets WHERE "user" = ?""", (user_id,)) - - -async def create_usermanager_wallet( - user_id: str, wallet_name: str, admin_id: str -) -> Wallet: - wallet = await create_wallet(user_id=user_id, wallet_name=wallet_name) - await db.execute( - """ - INSERT INTO usermanager.wallets (id, admin, name, "user", adminkey, inkey) - VALUES (?, ?, ?, ?, ?, ?) - """, - (wallet.id, admin_id, wallet_name, user_id, wallet.adminkey, wallet.inkey), - ) - wallet_created = await get_usermanager_wallet(wallet.id) - assert wallet_created, "Newly created wallet couldn't be retrieved" - return wallet_created - - -async def get_usermanager_wallet(wallet_id: str) -> Optional[Wallet]: - row = await db.fetchone( - "SELECT * FROM usermanager.wallets WHERE id = ?", (wallet_id,) - ) - return Wallet(**row) if row else None - - -async def get_usermanager_wallets(admin_id: str) -> List[Wallet]: - rows = await db.fetchall( - "SELECT * FROM usermanager.wallets WHERE admin = ?", (admin_id,) - ) - return [Wallet(**row) for row in rows] - - -async def get_usermanager_users_wallets(user_id: str) -> List[Wallet]: - rows = await db.fetchall( - """SELECT * FROM usermanager.wallets WHERE "user" = ?""", (user_id,) - ) - return [Wallet(**row) for row in rows] - - -async def get_usermanager_wallet_transactions(wallet_id: str) -> List[Payment]: - return await get_payments( - wallet_id=wallet_id, complete=True, pending=False, outgoing=True, incoming=True - ) - - -async def delete_usermanager_wallet(wallet_id: str, user_id: str) -> None: - await delete_wallet(user_id=user_id, wallet_id=wallet_id) - await db.execute("DELETE FROM usermanager.wallets WHERE id = ?", (wallet_id,)) diff --git a/lnbits/extensions/usermanager/migrations.py b/lnbits/extensions/usermanager/migrations.py deleted file mode 100644 index 62a215752..000000000 --- a/lnbits/extensions/usermanager/migrations.py +++ /dev/null @@ -1,31 +0,0 @@ -async def m001_initial(db): - """ - Initial users table. - """ - await db.execute( - """ - CREATE TABLE usermanager.users ( - id TEXT PRIMARY KEY, - name TEXT NOT NULL, - admin TEXT NOT NULL, - email TEXT, - password TEXT - ); - """ - ) - - """ - Initial wallets table. - """ - await db.execute( - """ - CREATE TABLE usermanager.wallets ( - id TEXT PRIMARY KEY, - admin TEXT NOT NULL, - name TEXT NOT NULL, - "user" TEXT NOT NULL, - adminkey TEXT NOT NULL, - inkey TEXT NOT NULL - ); - """ - ) diff --git a/lnbits/extensions/usermanager/models.py b/lnbits/extensions/usermanager/models.py deleted file mode 100644 index 05122cc8f..000000000 --- a/lnbits/extensions/usermanager/models.py +++ /dev/null @@ -1,40 +0,0 @@ -from sqlite3 import Row -from typing import Optional - -from fastapi.param_functions import Query -from pydantic import BaseModel - - -class CreateUserData(BaseModel): - user_name: str = Query(...) - wallet_name: str = Query(...) - admin_id: str = Query(...) - email: str = Query("") - password: str = Query("") - - -class CreateUserWallet(BaseModel): - user_id: str = Query(...) - wallet_name: str = Query(...) - admin_id: str = Query(...) - - -class User(BaseModel): - id: str - name: str - admin: str - email: Optional[str] = None - password: Optional[str] = None - - -class Wallet(BaseModel): - id: str - admin: str - name: str - user: str - adminkey: str - inkey: str - - @classmethod - def from_row(cls, row: Row) -> "Wallet": - return cls(**dict(row)) diff --git a/lnbits/extensions/usermanager/static/image/usermanager.png b/lnbits/extensions/usermanager/static/image/usermanager.png deleted file mode 100644 index a38b2b3e0..000000000 Binary files a/lnbits/extensions/usermanager/static/image/usermanager.png and /dev/null differ diff --git a/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html b/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html deleted file mode 100644 index 55e9f5b3d..000000000 --- a/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html +++ /dev/null @@ -1,277 +0,0 @@ - - - -
- User Manager: Make and manager users/wallets -
-

- To help developers use LNbits to manage their users, the User Manager - extension allows the creation and management of users and wallets. -
For example, a games developer may be developing a game that needs - each user to have their own wallet, LNbits can be included in the - developers stack as the user and wallet manager.
- - Created by, - Ben Arc -

- - - - - - - - - GET - /usermanager/api/v1/users -
Body (application/json)
-
- Returns 200 OK (application/json) -
- JSON list of users -
Curl example
- curl -X GET {{ request.base_url }}usermanager/api/v1/users -H - "X-Api-Key: {{ user.wallets[0].adminkey }}" - - - - - - - - GET - /usermanager/api/v1/users/<user_id> -
Body (application/json)
- -
- Returns 200 OK (application/json) -
- {"id": <string>, "name": <string>, "admin": - <string>, "email": <string>, "password": - <string>} - -
Curl example
- curl -X GET {{ request.base_url - }}usermanager/api/v1/users/<user_id> -H "X-Api-Key: {{ - user.wallets[0].inkey }}" - - - - - - - - GET - /usermanager/api/v1/wallets -
Headers
- {"X-Api-Key": <string>} -
Body (application/json)
-
- Returns 200 OK (application/json) -
- JSON wallet data -
Curl example
- curl -X GET {{ request.base_url }}usermanager/api/v1/wallets -H - "X-Api-Key: {{ user.wallets[0].adminkey }}" - - - - - - - - GET - /usermanager/api/v1/transactions/<wallet_id> -
Headers
- {"X-Api-Key": <string>} -
Body (application/json)
-
- Returns 200 OK (application/json) -
- JSON a wallets transactions -
Curl example
- curl -X GET {{ request.base_url - }}usermanager/api/v1/transactions/<wallet_id> -H "X-Api-Key: {{ - user.wallets[0].inkey }}" - - - - - - - - POST - /usermanager/api/v1/users -
Headers
- {"X-Api-Key": <string>, "Content-type": - "application/json"} -
- Body (application/json) - "admin_id" is a YOUR user ID -
- {"admin_id": <string>, "user_name": <string>, - "wallet_name": <string>,"email": <Optional string> - ,"password": <Optional string>} -
- Returns 201 CREATED (application/json) -
- {"id": <string>, "name": <string>, "admin": - <string>, "email": <string>, "password": - <string>} -
Curl example
- curl -X POST {{ request.base_url }}usermanager/api/v1/users -d - '{"admin_id": "{{ user.id }}", "wallet_name": <string>, - "user_name": <string>, "email": <Optional string>, - "password": < Optional string>}' -H "X-Api-Key: {{ - user.wallets[0].inkey }}" -H "Content-type: application/json" - - - - - - - - POST - /usermanager/api/v1/wallets -
Headers
- {"X-Api-Key": <string>, "Content-type": - "application/json"} -
- Body (application/json) - "admin_id" is a YOUR user ID -
- {"user_id": <string>, "wallet_name": <string>, - "admin_id": <string>} -
- Returns 201 CREATED (application/json) -
- {"id": <string>, "admin": <string>, "name": - <string>, "user": <string>, "adminkey": <string>, - "inkey": <string>} -
Curl example
- curl -X POST {{ request.base_url }}usermanager/api/v1/wallets -d - '{"user_id": <string>, "wallet_name": <string>, - "admin_id": "{{ user.id }}"}' -H "X-Api-Key: {{ user.wallets[0].inkey - }}" -H "Content-type: application/json" - - - - - - - - DELETE - /usermanager/api/v1/users/<user_id> -
Headers
- {"X-Api-Key": <string>} -
Curl example
- curl -X DELETE {{ request.base_url - }}usermanager/api/v1/users/<user_id> -H "X-Api-Key: {{ - user.wallets[0].adminkey }}" - - - - - - - - DELETE - /usermanager/api/v1/wallets/<wallet_id> -
Headers
- {"X-Api-Key": <string>} -
Curl example
- curl -X DELETE {{ request.base_url - }}usermanager/api/v1/wallets/<wallet_id> -H "X-Api-Key: {{ - user.wallets[0].adminkey }}" - - - - - - - - POST - /usermanager/api/v1/extensions -
Headers
- {"X-Api-Key": <string>} -
Curl example
- curl -X POST {{ request.base_url - }}usermanager/api/v1/extensions?extension=withdraw&userid=user_id&active=true - -H "X-Api-Key: {{ user.wallets[0].inkey }}" -H "Content-type: - application/json" - -
- Returns 200 OK (application/json) -
- {"extension": "updated"} - - - - diff --git a/lnbits/extensions/usermanager/templates/usermanager/index.html b/lnbits/extensions/usermanager/templates/usermanager/index.html deleted file mode 100644 index da11ad44b..000000000 --- a/lnbits/extensions/usermanager/templates/usermanager/index.html +++ /dev/null @@ -1,474 +0,0 @@ -{% extends "base.html" %} {% from "macros.jinja" import window_vars with context -%} {% block page %} -
-
- - - New User - New Wallet - - - - - - -
-
-
Users
-
-
- Export to CSV -
-
- - {% raw %} - - - {% endraw %} - - - - - - -
-
-
Wallets
-
-
- Export to CSV -
-
- - {% raw %} - - - {% endraw %} - - - -
- -
- - -
- {{SITE_TITLE}} User Manager Extension -
- - - - {% include "usermanager/_api_docs.html" %} - - -
- - - - - - - - - - Create User - Cancel - - - - - - - - - - - Create Wallet - Cancel - - - -
-{% endblock %} {% block scripts %} {{ window_vars(user) }} - -{% endblock %} diff --git a/lnbits/extensions/usermanager/views.py b/lnbits/extensions/usermanager/views.py deleted file mode 100644 index 115cbfa60..000000000 --- a/lnbits/extensions/usermanager/views.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import Depends, Request -from starlette.responses import HTMLResponse - -from lnbits.core.models import User -from lnbits.decorators import check_user_exists - -from . import usermanager_ext, usermanager_renderer - - -@usermanager_ext.get("/", response_class=HTMLResponse) -async def index(request: Request, user: User = Depends(check_user_exists)): - return usermanager_renderer().TemplateResponse( - "usermanager/index.html", {"request": request, "user": user.dict()} - ) diff --git a/lnbits/extensions/usermanager/views_api.py b/lnbits/extensions/usermanager/views_api.py deleted file mode 100644 index 27c6f3cbb..000000000 --- a/lnbits/extensions/usermanager/views_api.py +++ /dev/null @@ -1,135 +0,0 @@ -from http import HTTPStatus - -from fastapi import Depends, Query -from starlette.exceptions import HTTPException - -from lnbits.core import update_user_extension -from lnbits.core.crud import get_user -from lnbits.decorators import WalletTypeInfo, get_key_type, require_admin_key - -from . import usermanager_ext -from .crud import ( - create_usermanager_user, - create_usermanager_wallet, - delete_usermanager_user, - delete_usermanager_wallet, - get_usermanager_user, - get_usermanager_users, - get_usermanager_users_wallets, - get_usermanager_wallet, - get_usermanager_wallet_transactions, - get_usermanager_wallets, -) -from .models import CreateUserData, CreateUserWallet - - -@usermanager_ext.get("/api/v1/users", status_code=HTTPStatus.OK) -async def api_usermanager_users( - wallet: WalletTypeInfo = Depends(require_admin_key), -): - user_id = wallet.wallet.user - return [user.dict() for user in await get_usermanager_users(user_id)] - - -@usermanager_ext.get( - "/api/v1/users/{user_id}", - status_code=HTTPStatus.OK, - dependencies=[Depends(get_key_type)], -) -async def api_usermanager_user(user_id): - user = await get_usermanager_user(user_id) - return user.dict() if user else None - - -@usermanager_ext.post( - "/api/v1/users", - status_code=HTTPStatus.CREATED, - dependencies=[Depends(get_key_type)], -) -async def api_usermanager_users_create(data: CreateUserData): - user = await create_usermanager_user(data) - full = user.dict() - full["wallets"] = [ - wallet.dict() for wallet in await get_usermanager_users_wallets(user.id) - ] - return full - - -@usermanager_ext.delete( - "/api/v1/users/{user_id}", dependencies=[Depends(require_admin_key)] -) -async def api_usermanager_users_delete( - user_id, - delete_core: bool = Query(True), -): - user = await get_usermanager_user(user_id) - if not user: - raise HTTPException( - status_code=HTTPStatus.NOT_FOUND, detail="User does not exist." - ) - await delete_usermanager_user(user_id, delete_core) - return "", HTTPStatus.NO_CONTENT - - -# Activate Extension - - -@usermanager_ext.post("/api/v1/extensions") -async def api_usermanager_activate_extension( - extension: str = Query(...), userid: str = Query(...), active: bool = Query(...) -): - user = await get_user(userid) - if not user: - raise HTTPException( - status_code=HTTPStatus.NOT_FOUND, detail="User does not exist." - ) - await update_user_extension(user_id=userid, extension=extension, active=active) - return {"extension": "updated"} - - -# Wallets - - -@usermanager_ext.post("/api/v1/wallets", dependencies=[Depends(get_key_type)]) -async def api_usermanager_wallets_create(data: CreateUserWallet): - user = await create_usermanager_wallet( - user_id=data.user_id, wallet_name=data.wallet_name, admin_id=data.admin_id - ) - return user.dict() - - -@usermanager_ext.get("/api/v1/wallets") -async def api_usermanager_wallets( - wallet: WalletTypeInfo = Depends(require_admin_key), -): - admin_id = wallet.wallet.user - return [wallet.dict() for wallet in await get_usermanager_wallets(admin_id)] - - -@usermanager_ext.get( - "/api/v1/transactions/{wallet_id}", dependencies=[Depends(get_key_type)] -) -async def api_usermanager_wallet_transactions(wallet_id): - return await get_usermanager_wallet_transactions(wallet_id) - - -@usermanager_ext.get( - "/api/v1/wallets/{user_id}", dependencies=[Depends(require_admin_key)] -) -async def api_usermanager_users_wallets(user_id): - return [ - s_wallet.dict() for s_wallet in await get_usermanager_users_wallets(user_id) - ] - - -@usermanager_ext.delete( - "/api/v1/wallets/{wallet_id}", dependencies=[Depends(require_admin_key)] -) -async def api_usermanager_wallets_delete(wallet_id): - get_wallet = await get_usermanager_wallet(wallet_id) - if not get_wallet: - raise HTTPException( - status_code=HTTPStatus.NOT_FOUND, detail="Wallet does not exist." - ) - await delete_usermanager_wallet(wallet_id, get_wallet.user) - return "", HTTPStatus.NO_CONTENT diff --git a/tests/data/mock_data.zip b/tests/data/mock_data.zip index 154c4528a..f1dfd6c38 100644 Binary files a/tests/data/mock_data.zip and b/tests/data/mock_data.zip differ