From ed083e4268631136fb244c46beb0d7053cc4f9c8 Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 14 Feb 2023 14:46:19 +0000 Subject: [PATCH] Add files via upload --- README.md | 34 +++++ __init__.py | 35 +++++ config.json | 6 + crud.py | 36 +++++ migrations.py | 99 +++++++++++++ models.py | 28 ++++ static/image/split-payments.png | Bin 0 -> 9839 bytes static/js/index.js | 195 +++++++++++++++++++++++++ tasks.py | 76 ++++++++++ templates/splitpayments/_api_docs.html | 97 ++++++++++++ templates/splitpayments/index.html | 147 +++++++++++++++++++ views.py | 17 +++ views_api.py | 63 ++++++++ 13 files changed, 833 insertions(+) create mode 100644 README.md create mode 100644 __init__.py create mode 100644 config.json create mode 100644 crud.py create mode 100644 migrations.py create mode 100644 models.py create mode 100644 static/image/split-payments.png create mode 100644 static/js/index.js create mode 100644 tasks.py create mode 100644 templates/splitpayments/_api_docs.html create mode 100644 templates/splitpayments/index.html create mode 100644 views.py create mode 100644 views_api.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..8b0554c --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Split Payments + +## Have payments split between multiple wallets + +LNbits Split Payments extension allows for distributing payments across multiple wallets. Set it and forget it. It will keep splitting your payments across wallets forever. + +## Usage + +1. After enabling the extension, choose the source wallet that will receive and distribute the Payments + +![choose wallet](https://i.imgur.com/nPQudqL.png) + +2. Add the wallet or wallets info to split payments to + +![split wallets](https://i.imgur.com/5hCNWpg.png) - get the wallet id, or an invoice key from a different wallet. It can be a completely different user as long as it's under the same LNbits instance/domain. You can get the wallet information on the API Info section on every wallet page\ + ![wallet info](https://i.imgur.com/betqflC.png) - set a wallet _Alias_ for your own identification\ + +- set how much, in percentage, this wallet will receive from every payment sent to the source wallets + +3. When done, click "SAVE TARGETS" to make the splits effective + +4. You can have several wallets to split to, as long as the sum of the percentages is under or equal to 100% + +5. When the source wallet receives a payment, the extension will automatically split the corresponding values to every wallet\ + - on receiving a 20 sats payment\ + ![get 20 sats payment](https://i.imgur.com/BKp0xvy.png) + - source wallet gets 18 sats\ + ![source wallet](https://i.imgur.com/GCxDZ5s.png) + - Ben's wallet (the wallet from the example) instantly, and feeless, gets the corresponding 10%, or 2 sats\ + ![ben wallet](https://i.imgur.com/MfsccNa.png) + +## Sponsored by + +[![](https://cdn.shopify.com/s/files/1/0826/9235/files/cryptograffiti_logo_clear_background.png?v=1504730421)](https://cryptograffiti.com/) diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..5efb633 --- /dev/null +++ b/__init__.py @@ -0,0 +1,35 @@ +import asyncio + +from fastapi import APIRouter +from fastapi.staticfiles import StaticFiles + +from lnbits.db import Database +from lnbits.helpers import template_renderer +from lnbits.tasks import catch_everything_and_restart + +db = Database("ext_splitpayments") + +splitpayments_static_files = [ + { + "path": "/splitpayments/static", + "app": StaticFiles(packages=[("lnbits", "extensions/splitpayments/static")]), + "name": "splitpayments_static", + } +] +splitpayments_ext: APIRouter = APIRouter( + prefix="/splitpayments", tags=["splitpayments"] +) + + +def splitpayments_renderer(): + return template_renderer(["lnbits/extensions/splitpayments/templates"]) + + +from .tasks import wait_for_paid_invoices +from .views import * # noqa: F401,F403 +from .views_api import * # noqa: F401,F403 + + +def splitpayments_start(): + loop = asyncio.get_event_loop() + loop.create_task(catch_everything_and_restart(wait_for_paid_invoices)) diff --git a/config.json b/config.json new file mode 100644 index 0000000..1e0c967 --- /dev/null +++ b/config.json @@ -0,0 +1,6 @@ +{ + "name": "Split Payments", + "short_description": "Split incoming payments across wallets", + "tile": "/splitpayments/static/image/split-payments.png", + "contributors": ["fiatjaf", "cryptograffiti"] +} diff --git a/crud.py b/crud.py new file mode 100644 index 0000000..737e7bb --- /dev/null +++ b/crud.py @@ -0,0 +1,36 @@ +from typing import List + +from lnbits.helpers import urlsafe_short_hash + +from . import db +from .models import Target + + +async def get_targets(source_wallet: str) -> List[Target]: + rows = await db.fetchall( + "SELECT * FROM splitpayments.targets WHERE source = ?", (source_wallet,) + ) + return [Target(**row) for row in rows] + + +async def set_targets(source_wallet: str, targets: List[Target]): + async with db.connect() as conn: + await conn.execute( + "DELETE FROM splitpayments.targets WHERE source = ?", (source_wallet,) + ) + for target in targets: + await conn.execute( + """ + INSERT INTO splitpayments.targets + (id, source, wallet, percent, tag, alias) + VALUES (?, ?, ?, ?, ?, ?) + """, + ( + urlsafe_short_hash(), + source_wallet, + target.wallet, + target.percent, + target.tag, + target.alias, + ), + ) diff --git a/migrations.py b/migrations.py new file mode 100644 index 0000000..eb72387 --- /dev/null +++ b/migrations.py @@ -0,0 +1,99 @@ +from lnbits.helpers import urlsafe_short_hash + + +async def m001_initial(db): + """ + Initial split payment table. + """ + await db.execute( + """ + CREATE TABLE splitpayments.targets ( + wallet TEXT NOT NULL, + source TEXT NOT NULL, + percent INTEGER NOT NULL CHECK (percent >= 0 AND percent <= 100), + alias TEXT, + + UNIQUE (source, wallet) + ); + """ + ) + + +async def m002_float_percent(db): + """ + Add float percent and migrates the existing data. + """ + await db.execute("ALTER TABLE splitpayments.targets RENAME TO splitpayments_old") + await db.execute( + """ + CREATE TABLE splitpayments.targets ( + wallet TEXT NOT NULL, + source TEXT NOT NULL, + percent REAL NOT NULL CHECK (percent >= 0 AND percent <= 100), + alias TEXT, + + UNIQUE (source, wallet) + ); + """ + ) + + for row in [ + list(row) + for row in await db.fetchall("SELECT * FROM splitpayments.splitpayments_old") + ]: + await db.execute( + """ + INSERT INTO splitpayments.targets ( + wallet, + source, + percent, + alias + ) + VALUES (?, ?, ?, ?) + """, + (row[0], row[1], row[2], row[3]), + ) + + await db.execute("DROP TABLE splitpayments.splitpayments_old") + + +async def m003_add_id_and_tag(db): + """ + Add float percent and migrates the existing data. + """ + await db.execute("ALTER TABLE splitpayments.targets RENAME TO splitpayments_old") + await db.execute( + """ + CREATE TABLE splitpayments.targets ( + id TEXT PRIMARY KEY, + wallet TEXT NOT NULL, + source TEXT NOT NULL, + percent REAL NOT NULL CHECK (percent >= 0 AND percent <= 100), + tag TEXT NOT NULL, + alias TEXT, + + UNIQUE (source, wallet) + ); + """ + ) + + for row in [ + list(row) + for row in await db.fetchall("SELECT * FROM splitpayments.splitpayments_old") + ]: + await db.execute( + """ + INSERT INTO splitpayments.targets ( + id, + wallet, + source, + percent, + tag, + alias + ) + VALUES (?, ?, ?, ?, ?, ?) + """, + (urlsafe_short_hash(), row[0], row[1], row[2], "", row[3]), + ) + + await db.execute("DROP TABLE splitpayments.splitpayments_old") diff --git a/models.py b/models.py new file mode 100644 index 0000000..4f2bb01 --- /dev/null +++ b/models.py @@ -0,0 +1,28 @@ +from sqlite3 import Row +from typing import List, Optional + +from fastapi import Query +from pydantic import BaseModel + + +class Target(BaseModel): + wallet: str + source: str + percent: float + tag: str + alias: Optional[str] + + @classmethod + def from_row(cls, row: Row): + return cls(**dict(row)) + + +class TargetPutList(BaseModel): + wallet: str = Query(...) + alias: str = Query("") + percent: float = Query(..., ge=0, lt=100) + tag: str + + +class TargetPut(BaseModel): + __root__: List[TargetPutList] diff --git a/static/image/split-payments.png b/static/image/split-payments.png new file mode 100644 index 0000000000000000000000000000000000000000..10b8e7f2370d7b325ff5b27964e18e79bbeeacb2 GIT binary patch literal 9839 zcmeAS@N?(olHy`uVBq!ia0y~yU}ykg4mJh`hQoG=rx_Roc&kDpN`ey06$*;-(=u~X z6-p`#QWa7wGSe6sDsHWvm02dUv(N2+vFKhFzXuy+_#Rm9ZH}vpHwe~R8n^0{p8d&l z9>)(TFxD_Dz4`M0-}fE=AF6+sik)`LOaJKS$<^-)KP>%u{QQpj2cQ40theL)_i%m2oz>fq%`Ja$MM6TS;AH;)UHA7skZE?} z*jIb3tMX{Z!8EC9mcO5v7zv#-UQxvS=i~3c$3M+Fu^?g!uhQHD=Z*^mABy*xkhe%! zo$EGxjMLroj2wd7#ngm_Bo(q1Jv9zqm&oQ|*)(y%!7It93MVxx2$@grv0Unu7qun2 z*pv7B6^)5^`~FUloH-#RNY#8nPs&rBEB84SZnH1DS-So1_X`WAOiB~gjoO-dy-;K8K)p3=ABOdAqo-fGyy@2Fl}JZDptEz7?xb1z+d zxGamiJL;jwnp>$GUwN+kzw6uWsTt=V-ngf?Y(DOa;eVzr2RJH+e$t2ne40=FTYyeG|9I{Td8H~hP}n_zV`U+n<#FqnZNDb za_0TJ_c9-Rr**}{wl(6-tfqNvo7B~e#gCXTlM8vQJ8^>-o2u1n`SNwk7$WD))cmcK z$UN;z*1XO0Ois;|z0o69#_j%K%1Pd6xhatu$>)?p{=S*J=c%pnOYu)hN8HSQDM%|$ zo%?FtHud{0**eN^C%%3&+vz#mV~yamvnwVYc>KF$sekGe!FR13b++2m&h|KL*yQkS z9go5`(FiN!xeDxQ7x>yUR-U)sU7fw#aC`3g%)0qc=lUo&g(@Ev_~pix8W@t85g%FT z*(bPHBJuq!$;>Mu#W|VVl1lTlPn%x@oI^U9(N@M~}d{ z(xm3f3o|0M=g6FMYuObLez9rJD=(>I8XBJuyjd_&mdnSUbH7d|Rh*K>SxeXj<4v7v-zl6k&Uy+zW?^D0cr;pOY4r)-yX zIrw_#v-!K{JY-zGsKC6wX>LXJ8C$+vD$S7>%u0Q2GuJw8e8L-fzC)_$SG|t!=_NN- z)d|+#zRo5$@sFr=usd#SN0U^@|Q3fX$y?Ut5u)AAV)9~ry81~8{)f%pSYMb>!Ot1D& zNc)m}jOkN@=gZ@=OYCm0&2N}`Lq7KLH46@_j0JD)T|O+6y!&j!n`KEgdzBcLFXoUO-jVqx}^A4_F(xrRxCEpu{sP=oa^gJ66FHCmWW-sZeV6i%-=1|=c zE%6n~DjbYgs`z@O(Ct^znZ0s%ZgoAfl2cu^ zFEl2kX3D(-?LFdBzjl=#o3?tw4-WAFGo6J#XKozND_%CA-5@)Ktuto2?e?fA+Pma3 z{}gpE5!G++cAEG>d(%n_K0Z~2%Q6iUrB~*xR$6r-!^BBcMa<`sQbT6Z6fV8eb1Q6@ zG=E<_Mfq>y;TMW~pK!iw(Jgwv`51HHZ9`#AlcPR~ooeqMNiF7jq7wbss&&J8&RZG2 z*5(Y~+j-8HHBNG0{^Qu01G`VOWgleOe#k#5+vZ5y#Z60cSwz-sVJJGfqs{X!)9se3 z3$90dTv;7Yh%H4e0#&Gr^8M9;6m@Z;Lb?JP0c$*LTVp& zawSEaZIwB=Y4VMRzYeMDS6lAivU_a2OvcCL>Ta2$@IdEjD|7eC{Ce$Ss9$urx=yF; z`?6d2!@piHst0xcO=&;K| zxANyF*wxrrba>yY+?wa_-1XA!WQc0|q4M`xcWX7jS?x-(+Qz-zwR`$Uo`9{QfwQi> zF}S;V(VZ{z66?iOubJ;K%a~`d+oSAQ>l>y=0q4t#n0ka)_wXOSWE8*b=IUwBEVu2^ z>k+pVdwGO0jQ!k!OZE)w>Y3iT@38#vExvK~<~jQhyuJSLYm?r0_77E#(|_Amgk~?D z;8r7Ym^UhZX8DffNx2zE|0vxqx43iZck%r>QJH?ie`KaN=P&er!ZBNIY11h_ffo&Y zn>-sYzg)GDb)$V%C^ne^+^GkiM%#J!|ou$aO{c+}M5kPX0l{mMG0{2}#_Xi7C}94qUgHyHco5aQCvmJg2s5z3etVwdkPji~_CN36B3- ze&>76WZN-Y_~Zu8D3@}3+2+Yyi#uE2cVBF9T9aXUrb(iDYD?jw^4ZTK4RmrjX0+Y+ zvHb42c^ zb2inQ_I1O7Tvd^ObHD8h|9CX}e1JpXlF2-5yHra&cYoc?ptp=weDi2 z+Vtd2=gpjqgzY3Xs!nT3W@Wwgo|tle(uN()YOMd}c}N|X*4=iaSeh}bq-zC(?|}t( zS7b7UvLE5^DWA>CrMadh@Yv}(%jbVJugq1Ndw#k9X~&m0LVCU~`)K{;6N{nyh1fSc zt6t9UvPu+O^7K?%m(%7=f5N}aW{o>qes=ShxFvxHC+DbUS1-BoGw?xCcDRp3vC96s z2!-CIA1+QV^XL}#j&wWbr7k7WV5O@+ZBnV~RKE(j{*qfNeeXqB{!H+z-_jWHjcMk= zuVxQ5_MVxhVHlBl_Q}e!>}&<5Nvl6@Q*IJ@`t9b-J$ZBgKRj^U>_`0N{O^+^|EmA} zHz7ab`Ks-|mG0Lsx%aNS=KrLs|0&b&mhb=LyI)gj5(o1Qg_U>8o#Z#%e~_^uV1|jq zzk7a%+T8Nu&-N{nw4KVA)OE%2v%1+o_d44mRWy#kqe=3?DO*T)O-Jd>HAiCt2 zpl)^CSB~rH8?4-;tR-}xHOywtikk2w+TQw_=|8XS-2az4{VH6ry>!FgTgiJ<<+R#v zobfz(@zQpSXfv-`c_yX4FHs!#mV|D0ciwK#rE4o!HS26!*c0W5c;~6I6E{8g)0VcI zd9dZ@PK|?au2-)1e5t=DwBYgmy=_1C&3%`A@>|_;v0Q(zoSOpcH5$F-vnIY>d%^L7 zSZCT@X08-QlWfT+Grs?i8tHmnl2vyfterd+!%@pkqw{J)O~0E+b43UXWN$w?I(_! zvL}7^|M>Ol_O-t+vvoF#AG21z`Qvqtoctr3PPQ8VE7Ik?FTYK&nz!)6wVXGXK8sGt zU-ir|(|7q^ktMD3QZJ`zo|NF?9nOR5OHb2+}&ef76Rk&dhZ=Wj^5U+!n%-<^=Q#pc5GLp+T|9NHRr zD`(D?`rcYNt#$t5-_{sbQqcormPn;0IW{I`0B zaOGmhrL42|GAw>9)~hV>N^0Sb7cc)^(W<-b%WnMc#}grDw^(N%EI6`|M_xGXk4ne`}u7tYnTS-GGUii=2!>wXZJsJMlW-lWhvx7p?kCb zx1t+=?OzLrt&)EAavuW&V@sy9bAYF_Gi+dhfuUkf?L=FT!vP|#{=u#jyPT~%EK*kZ ziLL3f$P(=eP`tvm)@sI{FZ{DiR5bPanz9cboPTsxbNA+TeCwJNelS0J^=QcpCDnV= zMWT*WJp5>PZuj#K_i7t1tS~tHN{Zd&uG!_2Ei=xp?Xq3Zq0nLQsN?h*qh~6btoMKI zTAsIRx5W8R?|*Opb#>3th6WFt(>#~e?kUW>w}toI?<0a?lR_UAKQf%G=ke!6>CwmL z=Uk_=&XY7Wep&g5V`Iddgr&`qC$DrY?^wKQS@6CIUn8FGIU2e8O2q4Ve_9vr*|+IT zY1CnlBth>93Qmr^sUZo)Ll=gBNDZnDlQJ^s_KY|b-Iff}}TU$*VP#gJy_xqkcB7lH;Gcw=I=o2K&b zxWmXcpXcV3SWORa4UvZL#=n-y2<&71b#2eit>+4VF{EUKt(1Q7KtMt_=-aOIyQ{6A zf6MpJuCt#%v1sR$BO<3682BD!hD4M^`1)8S=jZArrsOB3>Q&?xFo1xKeMLcHa&~Ho zLQ-maW}dCm``!DM6f#q6mBLMZ4SWlnQ!_F>s)|yBtNcQetFn_VQ&bX_Yl%Z!xl zxD;%PQqrt~T-=~W6s4ruDrJnJX9Ei1vVqd26pAXPsowK%`DC^^-&EH$r08QF-GWVrr< z(xM!&cT$q|Q*%;tQ}arS^$qn5QLJ?L^bLUP00lvMW^MskS4D0CiprAAG(=#b_y!~c z_71W`Dsl_p=Ax*E`5mkn97a|y`N^dq=Xtu=DuL{`O36>oOtAtp(@f114NQ|$brUVq zjC4&>jSX~@j0`PxjS~~i3{w*=O-&8ckc{%oD=taQOHKtDRgqhumzkMjWond?XlZJc zqMMXzX{u|IW}2*PX^@ztYi5vYVwRe0Y?*3liDZO-QD%B(USbZit3XDjfQ(8uO*6B! zG}lc@GfvVqF}F<8wMa}f(={?lO-V5}PP8;kF#{Wwl5FLcUzD3zVyl#yo0y)eUyzp$ zmH-8~m1BUXt&)+R0YW4oC$S_gzbMyM$tN?fv;rX!l9`(tT#^V1O+zztBXe_8OEVKo zLvwROh(%!Y!cvQhGxPI6W*Qpk8AHqkMT?bxQD$mhNg^nn+A0}>jjhNnuyQU+O)SYT z3dzsUu~h;Yp^%TiOo7Ae4_k~0$X(o<7xm7oaMX@FIS7NK=o|#(!_KkuDI4Cty-BO;B3JNC! zBO_fyBVA*|5CcmqV@oR|18oBXD+2>1ecF4`*do<5)iTjg*T}-qK-a_|(L~q6FxgNy zInmVI$j~e;&A==P)zK7s(a_k+z|6|foPJ(RPPQ<#urN#1H88X^*EKOpG}X080_8x9 zG}9z=lSFfiG)R`CG!~6@4GeV+j6)19txPSgj7(6yXrm7*n_=nJMjs<(Llhtt=5|~P z5V0T^H#;sHeQ=Ees$HPT0#v-y5JPhm4Q)_RP#Cp@r0^XLuF>EkDFjGTJes;jgNvjP zAW89P>Y`e3aUr^`sd*{3O65xSb{ZuSk_-$CY)RhkE)4%caKYZ?lNlHoI14-?iy0WW zg+Z8+Vb&Z81_lQ95>H=O_UDYu!qyTu|K&C_FtDb3x;TbZ+eGw=NOm)m;<+TN|x zn4odjs!`*ROI1Vh0l`Z%HyV_8wD9cP{3ZC{?Sm2p5*8-YIVMIP>Sv5pSovVB_(O)5 zXZC(zDk)d>-fXwhu%zj-!>UOv6S*F~XX#@$?4A8v$VKbSpUGVJq- zxr4J9-hTM$#dAY$%BlSyHj8_(%=#O5Su%s?&pIZd1H~#0ECNCf9t?_%E$t@P-c00f zJzD8H(c|p=q+(~~TwdPN`pln9F>`jD-|>-2gzLlecmso&{~xy7aObWyt(|o^`hLRk zXVYKl9Z1QWBztrHkIF~;SVa>OBzA57D!cH9(TyGJo-vuQFZy zpMJ0oTN^0+Vm8aNw)}6A4a!0@Wd1$k6zCNB{`Ps+ms3JKy;?QPSu#2gwrf_@W?OLf z)n&)3u2B0^qxe3MHDV`IP=4$51B;$6nDybe8{3Pwzwd6ATTr^QSSUpL-@eW267%PL z*}z%i(e$%r{{->M8|7jT8d%KQ@~>qsI4X2QYG37V1~IRM;vdgA6K1k(YtLWCFwNtE z(~oCd2|HNUwd8MOX!Cjy^y3+K!VH#v={mdl%kyvC`S4cYfB>hQ`Jc|1KK(kI!?)8n z9c#<)XXw^(G<{fqvwB+pZ~a15^UNxa&3^|*BFy~-c&a+f!rzq&knx^q_e$M5s?&ixDga=P}z+42tucWhLPylnCuXXmHy#9b^ZPVQuxz#_CDi!-j; zat_OJze96(3mvfJ{PvD7oRiJ{!TjGs2VOsQ@NRf4lyiI0lf5Dg3ip^~rKj%M&eSlC z;XNxX;j>I&aAM-%R8VQ4m~kjYYH!We*Yn%H+;jKoWSEyRiQ$}3=Yit4M{nmG_h2}# zD)5T2g=GSR6cfn04^!qbytrslar!5N#qz=rlQ3_>{ z9Wm_-oA>IgPyFY@+y<&nGB@~ZSdKKTICgE)gN4iQybaes@V~nGtpn4GDI9L|ZqH}0 eI?NLP%zo2?)-^{8vnGLtA3a_DT-G@yGywqnn1xmV literal 0 HcmV?d00001 diff --git a/static/js/index.js b/static/js/index.js new file mode 100644 index 0000000..f5f1627 --- /dev/null +++ b/static/js/index.js @@ -0,0 +1,195 @@ +/* globals Quasar, Vue, _, VueQrcode, windowMixin, LNbits, LOCALE */ + +Vue.component(VueQrcode.name, VueQrcode) + +function hashTargets(targets) { + return targets + .filter(isTargetComplete) + .map(({wallet, percent, alias}) => `${wallet}${percent}${alias}`) + .join('') +} + +function isTargetComplete(target) { + return ( + target.wallet && + target.wallet.trim() !== '' && + (target.percent > 0 || target.tag != '') + ) +} + +new Vue({ + el: '#vue', + mixins: [windowMixin], + data() { + return { + selectedWallet: null, + currentHash: '', // a string that must match if the edit data is unchanged + targets: [ + { + method: 'split' + } + ] + } + }, + computed: { + isDirty() { + return hashTargets(this.targets) !== this.currentHash + } + }, + methods: { + clearTargets() { + this.targets = [{}] + this.$q.notify({ + message: + 'Cleared the form, but not saved. You must click to save manually.', + timeout: 500 + }) + }, + clearTarget(index) { + this.targets.splice(index, 1) + console.log(this.targets) + this.$q.notify({ + message: 'Removed item. You must click to save manually.', + timeout: 500 + }) + }, + getTargets() { + LNbits.api + .request( + 'GET', + '/splitpayments/api/v1/targets', + this.selectedWallet.adminkey + ) + .catch(err => { + LNbits.utils.notifyApiError(err) + }) + .then(response => { + this.currentHash = hashTargets(response.data) + this.targets = response.data.concat({}) + for (let i = 0; i < this.targets.length; i++) { + if (this.targets[i].tag.length > 0) { + this.targets[i].method = 'tag' + } else if (this.targets[i].percent.length > 0) { + this.targets[i].method = 'split' + } else { + this.targets[i].method = '' + } + } + }) + }, + changedWallet(wallet) { + this.selectedWallet = wallet + this.getTargets() + }, + clearChanged(index) { + if (this.targets[index].method == 'split') { + this.targets[index].tag = null + this.targets[index].method = 'split' + } else { + this.targets[index].percent = null + this.targets[index].method = 'tag' + } + }, + targetChanged(index) { + // fix percent min and max range + if (this.targets[index].percent) { + if (this.targets[index].percent > 100) this.targets[index].percent = 100 + if (this.targets[index].percent < 0) this.targets[index].percent = 0 + this.targets[index].tag = '' + } + + // not percentage + if (!this.targets[index].percent) { + this.targets[index].percent = 0 + } + + // remove empty lines (except last) + if (this.targets.length >= 2) { + for (let i = this.targets.length - 2; i >= 0; i--) { + let target = this.targets[i] + if ( + (!target.wallet || target.wallet.trim() === '') && + (!target.alias || target.alias.trim() === '') && + (!target.tag || target.tag.trim() === '') && + !target.percent + ) { + this.targets.splice(i, 1) + } + } + } + + // add a line at the end if the last one is filled + let last = this.targets[this.targets.length - 1] + if (last.wallet && last.wallet.trim() !== '') { + this.targets.push({}) + } + + // sum of all percents + let currentTotal = this.targets.reduce( + (acc, target) => acc + (target.percent || 0), + 0 + ) + + // remove last (unfilled) line if the percent is already 100 + if (currentTotal >= 100) { + let last = this.targets[this.targets.length - 1] + if ( + (!last.wallet || last.wallet.trim() === '') && + (!last.alias || last.alias.trim() === '') && + !last.percent + ) { + this.targets = this.targets.slice(0, -1) + } + } + + // adjust percents of other lines (not this one) + if (currentTotal > 100 && isPercent) { + let diff = (currentTotal - 100) / (100 - this.targets[index].percent) + this.targets.forEach((target, t) => { + if (t !== index) target.percent -= +(diff * target.percent).toFixed(2) + }) + } + // overwrite so changes appear + this.targets = this.targets + }, + saveTargets() { + for (let i = 0; i < this.targets.length; i++) { + if (this.targets[i].tag != '') { + this.targets[i].percent = 0 + } else { + this.targets[i].tag = '' + } + } + LNbits.api + .request( + 'PUT', + '/splitpayments/api/v1/targets', + this.selectedWallet.adminkey, + { + targets: this.targets + .filter(isTargetComplete) + .map(({wallet, percent, tag, alias}) => ({ + wallet, + percent, + tag, + alias + })) + } + ) + .then(response => { + this.$q.notify({ + message: 'Split payments targets set.', + timeout: 700 + }) + this.getTargets() + }) + .catch(err => { + LNbits.utils.notifyApiError(err) + }) + } + }, + created() { + this.selectedWallet = this.g.user.wallets[0] + this.getTargets() + } +}) diff --git a/tasks.py b/tasks.py new file mode 100644 index 0000000..59aa8e0 --- /dev/null +++ b/tasks.py @@ -0,0 +1,76 @@ +import asyncio + +from loguru import logger + +from lnbits.core.models import Payment +from lnbits.core.services import create_invoice, pay_invoice +from lnbits.helpers import get_current_extension_name +from lnbits.tasks import register_invoice_listener + +from .crud import get_targets + + +async def wait_for_paid_invoices(): + invoice_queue = asyncio.Queue() + register_invoice_listener(invoice_queue, get_current_extension_name()) + + while True: + payment = await invoice_queue.get() + await on_invoice_paid(payment) + + +async def on_invoice_paid(payment: Payment) -> None: + + if payment.extra.get("tag") == "splitpayments" or payment.extra.get("splitted"): + # already a splitted payment, ignore + return + + targets = await get_targets(payment.wallet_id) + + if not targets: + return + + # validate target percentages + total_percent = sum([target.percent for target in targets]) + + if total_percent > 100: + logger.error("splitpayment: total percent adds up to more than 100%") + return + + logger.trace(f"splitpayments: performing split payments to {len(targets)} targets") + + if payment.extra.get("amount"): + amount_to_split = (payment.extra.get("amount") or 0) * 1000 + else: + amount_to_split = payment.amount + + if not amount_to_split: + logger.error("splitpayments: no amount to split") + return + + for target in targets: + tagged = target.tag in payment.extra + + if tagged or target.percent > 0: + + if tagged: + memo = f"Pushed tagged payment to {target.alias}" + amount_msat = int(amount_to_split) + else: + amount_msat = int(amount_to_split * target.percent / 100) + memo = f"Split payment: {target.percent}% for {target.alias or target.wallet}" + + payment_hash, payment_request = await create_invoice( + wallet_id=target.wallet, + amount=int(amount_msat / 1000), + internal=True, + memo=memo, + ) + + extra = {**payment.extra, "tag": "splitpayments", "splitted": True} + + await pay_invoice( + payment_request=payment_request, + wallet_id=payment.wallet_id, + extra=extra, + ) diff --git a/templates/splitpayments/_api_docs.html b/templates/splitpayments/_api_docs.html new file mode 100644 index 0000000..4b5ed97 --- /dev/null +++ b/templates/splitpayments/_api_docs.html @@ -0,0 +1,97 @@ + + + +

+ Add some wallets to the list of "Target Wallets", each with an + associated percent. After saving, every time any payment + arrives at the "Source Wallet" that payment will be split with the + target wallets according to their percent. +

+

This is valid for every payment, doesn't matter how it was created.

+

Target wallets can be any wallet from this same LNbits instance.

+

+ To remove a wallet from the targets list, just erase its fields and + save. To remove all, click "Clear" then save. +

+ + + + + + + + + + GET + /splitpayments/api/v1/targets +
Headers
+ {"X-Api-Key": <admin_key>}
+
Body (application/json)
+
+ Returns 200 OK (application/json) +
+ [{"wallet": <wallet id>, "alias": <chosen name for this + wallet>, "percent": <number between 1 and 100>}, ...] +
Curl example
+ curl -X GET {{ request.base_url }}splitpayments/api/v1/targets -H + "X-Api-Key: {{ user.wallets[0].inkey }}" + + + + + + + + PUT + /splitpayments/api/v1/targets +
Headers
+ {"X-Api-Key": <admin_key>}
+
Body (application/json)
+
+ Returns 200 OK (application/json) +
+
Curl example
+ curl -X PUT {{ request.base_url }}splitpayments/api/v1/targets -H + "X-Api-Key: {{ user.wallets[0].adminkey }}" -H 'Content-Type: + application/json' -d '{"targets": [{"wallet": <wallet id or invoice + key>, "alias": <name to identify this>, "percent": <number + between 1 and 100>}, ...]}' + + + + + diff --git a/templates/splitpayments/index.html b/templates/splitpayments/index.html new file mode 100644 index 0000000..b105bf2 --- /dev/null +++ b/templates/splitpayments/index.html @@ -0,0 +1,147 @@ +{% extends "base.html" %} {% from "macros.jinja" import window_vars with context +%} {% block page %} +
+
+ + + + + + + + + + + +
+
Target Wallets
+
+ + +
+ + + + + + + + + + + + Add more + + +
+
+
+ + Clear + +
+ +
+ + Save Targets + +
+
+ + + +
+ +
+ + +
+ {{SITE_TITLE}} SplitPayments extension +
+ + + + {% include "splitpayments/_api_docs.html" %} + + +
+
+{% endblock %} {% block scripts %} {{ window_vars(user) }} + +{% endblock %} diff --git a/views.py b/views.py new file mode 100644 index 0000000..c33fd42 --- /dev/null +++ b/views.py @@ -0,0 +1,17 @@ +from fastapi import Depends, Request +from fastapi.templating import Jinja2Templates +from starlette.responses import HTMLResponse + +from lnbits.core.models import User +from lnbits.decorators import check_user_exists + +from . import splitpayments_ext, splitpayments_renderer + +templates = Jinja2Templates(directory="templates") + + +@splitpayments_ext.get("/", response_class=HTMLResponse) +async def index(request: Request, user: User = Depends(check_user_exists)): + return splitpayments_renderer().TemplateResponse( + "splitpayments/index.html", {"request": request, "user": user.dict()} + ) diff --git a/views_api.py b/views_api.py new file mode 100644 index 0000000..f83f2b4 --- /dev/null +++ b/views_api.py @@ -0,0 +1,63 @@ +from http import HTTPStatus + +from fastapi import Depends, Request +from starlette.exceptions import HTTPException + +from lnbits.core.crud import get_wallet, get_wallet_for_key +from lnbits.decorators import WalletTypeInfo, require_admin_key + +from . import splitpayments_ext +from .crud import get_targets, set_targets +from .models import Target, TargetPut + + +@splitpayments_ext.get("/api/v1/targets") +async def api_targets_get(wallet: WalletTypeInfo = Depends(require_admin_key)): + targets = await get_targets(wallet.wallet.id) + return [target.dict() for target in targets] or [] + + +@splitpayments_ext.put("/api/v1/targets") +async def api_targets_set( + req: Request, wal: WalletTypeInfo = Depends(require_admin_key) +): + body = await req.json() + targets = [] + data = TargetPut.parse_obj(body["targets"]) + for entry in data.__root__: + wallet = await get_wallet(entry.wallet) + if not wallet: + wallet = await get_wallet_for_key(entry.wallet, "invoice") + if not wallet: + raise HTTPException( + status_code=HTTPStatus.BAD_REQUEST, + detail=f"Invalid wallet '{entry.wallet}'.", + ) + + if wallet.id == wal.wallet.id: + raise HTTPException( + status_code=HTTPStatus.BAD_REQUEST, detail="Can't split to itself." + ) + + if entry.percent < 0: + raise HTTPException( + status_code=HTTPStatus.BAD_REQUEST, + detail=f"Invalid percent '{entry.percent}'.", + ) + + targets.append( + Target( + wallet=wallet.id, + source=wal.wallet.id, + tag=entry.tag, + percent=entry.percent, + alias=entry.alias, + ) + ) + percent_sum = sum([target.percent for target in targets]) + if percent_sum > 100: + raise HTTPException( + status_code=HTTPStatus.BAD_REQUEST, detail="Splitting over 100%." + ) + await set_targets(wal.wallet.id, targets) + return ""