Compare commits
No commits in common. "main" and "v1.0.0" have entirely different histories.
12 changed files with 2720 additions and 2418 deletions
24
Makefile
24
Makefile
|
|
@ -5,27 +5,27 @@ format: prettier black ruff
|
|||
check: mypy pyright checkblack checkruff checkprettier
|
||||
|
||||
prettier:
|
||||
uv run ./node_modules/.bin/prettier --write .
|
||||
poetry run ./node_modules/.bin/prettier --write .
|
||||
pyright:
|
||||
uv run ./node_modules/.bin/pyright
|
||||
poetry run ./node_modules/.bin/pyright
|
||||
|
||||
mypy:
|
||||
uv run mypy .
|
||||
poetry run mypy .
|
||||
|
||||
black:
|
||||
uv run black .
|
||||
poetry run black .
|
||||
|
||||
ruff:
|
||||
uv run ruff check . --fix
|
||||
poetry run ruff check . --fix
|
||||
|
||||
checkruff:
|
||||
uv run ruff check .
|
||||
poetry run ruff check .
|
||||
|
||||
checkprettier:
|
||||
uv run ./node_modules/.bin/prettier --check .
|
||||
poetry run ./node_modules/.bin/prettier --check .
|
||||
|
||||
checkblack:
|
||||
uv run black --check .
|
||||
poetry run black --check .
|
||||
|
||||
checkeditorconfig:
|
||||
editorconfig-checker
|
||||
|
|
@ -33,14 +33,14 @@ checkeditorconfig:
|
|||
test:
|
||||
PYTHONUNBUFFERED=1 \
|
||||
DEBUG=true \
|
||||
uv run pytest
|
||||
poetry run pytest
|
||||
install-pre-commit-hook:
|
||||
@echo "Installing pre-commit hook to git"
|
||||
@echo "Uninstall the hook with uv run pre-commit uninstall"
|
||||
uv run pre-commit install
|
||||
@echo "Uninstall the hook with poetry run pre-commit uninstall"
|
||||
poetry run pre-commit install
|
||||
|
||||
pre-commit:
|
||||
uv run pre-commit run --all-files
|
||||
poetry run pre-commit run --all-files
|
||||
|
||||
|
||||
checkbundle:
|
||||
|
|
|
|||
|
|
@ -33,9 +33,9 @@ LNbits Split Payments extension allows for distributing payments across multiple
|
|||
|
||||
IMPORTANT:
|
||||
|
||||
- If you split to a LNURLp or LNaddress through the LNURLp extension make sure your recipients allow comments ! Split&Scrub add a comment in your transaction - and if it is not allowed, the split/scrub will not take place.
|
||||
- Make sure the LNURLp / LNaddress of the recipient has its min-sats set very low (e.g. 1 sat). If the wallet does not belong to you you can [check with a Decoder](https://lightningdecoder.com/), if that is the case already
|
||||
- Yes, there is fees - internal and external! Updating your own wallets on your own instance will not cost any fees but sending to an external instance will. Please notice that you should therefore not split up to 100% if you send to a wallet that is external (leave 1-2% reserve for routing fees!). External fees are deducted from the individual payment percentage of the recipient
|
||||
- If you split to a LNURLp or LNaddress through the LNURLp extension make sure your receipients allow comments ! Split&Scrub add a comment in your transaction - and if it is not allowed, the split/scrub will not take place.
|
||||
- Make sure the LNURLp / LNaddress of the receipient has its min-sats set very low (e.g. 1 sat). If the wallet does not belong to you you can [check with a Decoder](https://lightningdecoder.com/), if that is the case already
|
||||
- Yes, there is fees - internal and external! Updating your own wallets on your own instance will not cost any fees but sending to an external instance will. Please notice that you should therefore not split up to 100% if you send to a wallet that is external (leave 1-2% reserve for routing fees!). External fees are deducted from the individual payment percentage of the receipient
|
||||
|
||||
<img width="1148" alt="Bildschirmfoto 2023-05-01 um 22 14 36" src="https://user-images.githubusercontent.com/63317640/235534056-49296aeb-7295-4b4e-9f57-914a677f5ad4.png">
|
||||
<img width="1402" alt="Bildschirmfoto 2023-05-01 um 22 17 52" src="https://user-images.githubusercontent.com/63317640/235534063-b2734654-7c1a-48a3-b48e-32798c232b49.png">
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ def splitpayments_start():
|
|||
__all__ = [
|
||||
"db",
|
||||
"splitpayments_ext",
|
||||
"splitpayments_start",
|
||||
"splitpayments_static_files",
|
||||
"splitpayments_start",
|
||||
"splitpayments_stop",
|
||||
]
|
||||
|
|
|
|||
|
|
@ -2,8 +2,7 @@
|
|||
"name": "Split Payments",
|
||||
"short_description": "Split incoming payments across wallets",
|
||||
"tile": "/splitpayments/static/image/split-payments.png",
|
||||
"version": "1.1.0",
|
||||
"min_lnbits_version": "1.3.0",
|
||||
"min_lnbits_version": "1.0.0",
|
||||
"contributors": [
|
||||
{
|
||||
"name": "cryptograffiti",
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"repos": [
|
||||
{
|
||||
"id": "splitpayments",
|
||||
"organisation": "PatMulligan",
|
||||
"organisation": "lnbits",
|
||||
"repository": "splitpayments"
|
||||
}
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
from typing import Optional
|
||||
|
||||
from fastapi import Query
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
|
@ -7,7 +9,7 @@ class Target(BaseModel):
|
|||
wallet: str
|
||||
source: str
|
||||
percent: float
|
||||
alias: str | None = None
|
||||
alias: Optional[str] = None
|
||||
|
||||
|
||||
class TargetPut(BaseModel):
|
||||
|
|
|
|||
2612
poetry.lock
generated
Normal file
2612
poetry.lock
generated
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -1,36 +1,39 @@
|
|||
[project]
|
||||
name = "splitpayments"
|
||||
version = "1.1.1"
|
||||
requires-python = ">=3.10,<3.13"
|
||||
description = "Send incoming payments to different targets"
|
||||
authors = [{name = "benarc"}, {name = "dni"}, {name = "alan"}]
|
||||
urls = { Homepage = "https://lnbits.com", Repository = "https://github.com/lnbits/splitpayments" }
|
||||
|
||||
dependencies = [ "lnbits>1" ]
|
||||
|
||||
[tool.poetry]
|
||||
package-mode = false
|
||||
name = "lnbits-splitpayments"
|
||||
version = "0.0.0"
|
||||
description = "LNbits, free and open-source Lightning wallet and accounts system."
|
||||
authors = ["Alan Bits <alan@lnbits.com>"]
|
||||
|
||||
[tool.uv]
|
||||
dev-dependencies = [
|
||||
"black",
|
||||
"pytest-asyncio",
|
||||
"pytest",
|
||||
"mypy==1.17.1",
|
||||
"pre-commit",
|
||||
"ruff",
|
||||
"pytest-md",
|
||||
]
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.10 | ^3.9"
|
||||
lnbits = {version = "*", allow-prereleases = true}
|
||||
|
||||
[tool.poetry.group.dev.dependencies]
|
||||
black = "^24.3.0"
|
||||
pytest-asyncio = "^0.21.0"
|
||||
pytest = "^7.3.2"
|
||||
mypy = "^1.5.1"
|
||||
pre-commit = "^3.2.2"
|
||||
ruff = "^0.3.2"
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core>=1.0.0"]
|
||||
build-backend = "poetry.core.masonry.api"
|
||||
|
||||
[tool.mypy]
|
||||
exclude = "(nostr/*)"
|
||||
plugins = ["pydantic.mypy"]
|
||||
|
||||
[tool.pydantic-mypy]
|
||||
init_forbid_extra = true
|
||||
init_typed = true
|
||||
warn_required_dynamic_aliases = true
|
||||
warn_untyped_fields = true
|
||||
[[tool.mypy.overrides]]
|
||||
module = [
|
||||
"lnbits.*",
|
||||
"lnurl.*",
|
||||
"loguru.*",
|
||||
"fastapi.*",
|
||||
"pydantic.*",
|
||||
"pyqrcode.*",
|
||||
"shortuuid.*",
|
||||
"httpx.*",
|
||||
]
|
||||
ignore_missing_imports = "True"
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
log_cli = false
|
||||
|
|
@ -73,7 +76,6 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
|
|||
# needed for pydantic
|
||||
[tool.ruff.lint.pep8-naming]
|
||||
classmethod-decorators = [
|
||||
"validator",
|
||||
"root_validator",
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -51,11 +51,8 @@ window.app = Vue.createApp({
|
|||
'/splitpayments/api/v1/targets',
|
||||
this.selectedWallet.adminkey
|
||||
)
|
||||
.then(res => {
|
||||
this.targets = res.data.map(t => ({
|
||||
...t,
|
||||
targetChoice: t.targetChoice || 'wallet'
|
||||
}))
|
||||
.then(response => {
|
||||
this.targets = response.data
|
||||
})
|
||||
.catch(err => {
|
||||
LNbits.utils.notifyApiError(err)
|
||||
|
|
@ -66,26 +63,16 @@ window.app = Vue.createApp({
|
|||
this.getTargets()
|
||||
},
|
||||
addTarget() {
|
||||
this.targets.push({
|
||||
source: this.selectedWallet,
|
||||
targetChoice: 'wallet'
|
||||
})
|
||||
this.targets.push({source: this.selectedWallet})
|
||||
},
|
||||
saveTargets() {
|
||||
const payload = this.targets
|
||||
.filter(t => t.wallet && String(t.wallet).trim() !== '')
|
||||
.map(({alias, percent, wallet}) => ({
|
||||
alias,
|
||||
percent: Number(percent) || 0,
|
||||
wallet
|
||||
}))
|
||||
LNbits.api
|
||||
.request(
|
||||
'PUT',
|
||||
'/splitpayments/api/v1/targets',
|
||||
this.selectedWallet.adminkey,
|
||||
{
|
||||
targets: payload
|
||||
targets: this.targets
|
||||
}
|
||||
)
|
||||
.then(response => {
|
||||
|
|
|
|||
94
tasks.py
94
tasks.py
|
|
@ -1,16 +1,13 @@
|
|||
import asyncio
|
||||
import json
|
||||
from math import floor
|
||||
from typing import Optional
|
||||
|
||||
import bolt11
|
||||
import httpx
|
||||
from lnbits.core.crud import get_standalone_payment
|
||||
from lnbits.core.crud.wallets import get_wallet_for_key
|
||||
from lnbits.core.models import Payment
|
||||
from lnbits.core.services import (
|
||||
create_invoice,
|
||||
fee_reserve,
|
||||
get_pr_from_lnurl,
|
||||
pay_invoice,
|
||||
)
|
||||
from lnbits.core.services import create_invoice, fee_reserve, pay_invoice
|
||||
from lnbits.tasks import register_invoice_listener
|
||||
from loguru import logger
|
||||
|
||||
|
|
@ -45,23 +42,20 @@ async def on_invoice_paid(payment: Payment) -> None:
|
|||
logger.trace(f"splitpayments: performing split payments to {len(targets)} targets")
|
||||
|
||||
for target in targets:
|
||||
|
||||
if target.percent > 0:
|
||||
|
||||
amount_msat = int(payment.amount * target.percent / 100)
|
||||
memo = (
|
||||
f"Split payment: {target.percent}% "
|
||||
f"for {target.alias or target.wallet}"
|
||||
f";{payment.memo};{payment.payment_hash}"
|
||||
f"Split payment: {target.percent}% for {target.alias or target.wallet}"
|
||||
)
|
||||
|
||||
if "@" in target.wallet or "LNURL" in target.wallet:
|
||||
if target.wallet.find("@") >= 0 or target.wallet.find("LNURL") >= 0:
|
||||
safe_amount_msat = amount_msat - fee_reserve(amount_msat)
|
||||
payment_request = await get_lnurl_invoice(
|
||||
target.wallet, payment.wallet_id, safe_amount_msat, memo
|
||||
)
|
||||
else:
|
||||
wallet = await get_wallet_for_key(target.wallet)
|
||||
if wallet is not None:
|
||||
target.wallet = wallet.id
|
||||
new_payment = await create_invoice(
|
||||
wallet_id=target.wallet,
|
||||
amount=int(amount_msat / 1000),
|
||||
|
|
@ -73,43 +67,48 @@ async def on_invoice_paid(payment: Payment) -> None:
|
|||
extra = {**payment.extra, "splitted": True}
|
||||
|
||||
if payment_request:
|
||||
task = asyncio.create_task(
|
||||
pay_invoice_in_background(
|
||||
payment_request=payment_request,
|
||||
wallet_id=payment.wallet_id,
|
||||
description=memo,
|
||||
extra=extra,
|
||||
)
|
||||
await pay_invoice(
|
||||
payment_request=payment_request,
|
||||
wallet_id=payment.wallet_id,
|
||||
description=memo,
|
||||
extra=extra,
|
||||
)
|
||||
task.add_done_callback(lambda fut: logger.success(fut.result()))
|
||||
|
||||
|
||||
async def pay_invoice_in_background(payment_request, wallet_id, description, extra):
|
||||
try:
|
||||
await pay_invoice(
|
||||
payment_request=payment_request,
|
||||
wallet_id=wallet_id,
|
||||
description=description,
|
||||
extra=extra,
|
||||
)
|
||||
return f"Splitpayments: paid invoice for {description}"
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to pay invoice: {e}")
|
||||
|
||||
|
||||
async def get_lnurl_invoice(
|
||||
payoraddress: str, wallet_id: str, amount_msat: int, memo: str
|
||||
) -> str | None:
|
||||
payoraddress, wallet_id, amount_msat, memo
|
||||
) -> Optional[str]:
|
||||
|
||||
from lnbits.core.views.api import api_lnurlscan
|
||||
|
||||
data = await api_lnurlscan(payoraddress)
|
||||
rounded_amount = floor(amount_msat / 1000) * 1000
|
||||
|
||||
try:
|
||||
payment_request = await get_pr_from_lnurl(payoraddress, rounded_amount, memo)
|
||||
except Exception as e:
|
||||
logger.error(f"Error getting LNURL invoice: {e!s}")
|
||||
async with httpx.AsyncClient() as client:
|
||||
try:
|
||||
r = await client.get(
|
||||
data["callback"],
|
||||
params={"amount": rounded_amount, "comment": memo},
|
||||
timeout=5,
|
||||
)
|
||||
if r.is_error:
|
||||
raise httpx.ConnectError("issue with scrub callback")
|
||||
r.raise_for_status()
|
||||
except (httpx.ConnectError, httpx.RequestError):
|
||||
logger.error(
|
||||
f"splitting LNURL failed: Failed to connect to {data['callback']}."
|
||||
)
|
||||
return None
|
||||
except Exception as exc:
|
||||
logger.error(f"splitting LNURL failed: {exc!s}.")
|
||||
return None
|
||||
|
||||
params = json.loads(r.text)
|
||||
if params.get("status") == "ERROR":
|
||||
logger.error(f"{data['callback']} said: '{params.get('reason', '')}'")
|
||||
return None
|
||||
|
||||
invoice = bolt11.decode(payment_request)
|
||||
invoice = bolt11.decode(params["pr"])
|
||||
|
||||
lnurlp_payment = await get_standalone_payment(invoice.payment_hash)
|
||||
|
||||
|
|
@ -117,4 +116,13 @@ async def get_lnurl_invoice(
|
|||
logger.error("split failed. cannot split payments to yourself via LNURL.")
|
||||
return None
|
||||
|
||||
return payment_request
|
||||
if invoice.amount_msat != rounded_amount:
|
||||
logger.error(
|
||||
f"""
|
||||
{data['callback']} returned an invalid invoice.
|
||||
Expected {amount_msat} msat, got {invoice.amount_msat}.
|
||||
"""
|
||||
)
|
||||
return None
|
||||
|
||||
return params["pr"]
|
||||
|
|
|
|||
|
|
@ -38,30 +38,12 @@
|
|||
:hint="t === targets.length - 1 ? 'A name to identify this target wallet locally.' : undefined"
|
||||
style="width: 150px"
|
||||
></q-input>
|
||||
<div class="column q-mt-none">
|
||||
<div class="col">
|
||||
<q-radio
|
||||
class="float-left"
|
||||
v-model="target.targetChoice"
|
||||
val="wallet"
|
||||
label="wallet"
|
||||
></q-radio>
|
||||
</div>
|
||||
<div class="col">
|
||||
<q-radio
|
||||
class="float-left"
|
||||
v-model="target.targetChoice"
|
||||
val="lnurl"
|
||||
label="lnurl"
|
||||
></q-radio>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<q-input
|
||||
v-if="target.targetChoice === 'lnurl'"
|
||||
dense
|
||||
v-model.trim="target.wallet"
|
||||
label="Target"
|
||||
hint="LNURLp or Lightning Address."
|
||||
hint="A wallet ID, invoice key, LNURLp or Lightning Address."
|
||||
option-label="name"
|
||||
style="width: 500px"
|
||||
new-value-mode="add-unique"
|
||||
|
|
@ -69,19 +51,6 @@
|
|||
input-debounce="0"
|
||||
emit-value
|
||||
></q-input>
|
||||
<q-select
|
||||
v-if="target.targetChoice === 'wallet'"
|
||||
class="q-pr-md q-pt-sm"
|
||||
filled
|
||||
dense
|
||||
style="width: 500px"
|
||||
v-model="target.wallet"
|
||||
:options="g.user.walletOptions"
|
||||
emit-value
|
||||
map-options
|
||||
label="Receive wallet *"
|
||||
>
|
||||
</q-select>
|
||||
|
||||
<q-input
|
||||
style="width: 150px"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue