98 | {% endif %}
99 | {% if not active_towers and not inactive_towers %}
100 |
101 |
No watch towers found!
102 |
103 | {% endif %}
104 |
105 |
Add A Watch Tower
106 |
107 |
113 |
114 |
115 | {% endblock %}
--------------------------------------------------------------------------------
/gui/urls.py:
--------------------------------------------------------------------------------
1 | from django.urls import path, include
2 | from rest_framework import routers
3 | from django.contrib import admin
4 | from . import views
5 |
6 | router = routers.DefaultRouter()
7 | router.register(r'payments', views.PaymentsViewSet)
8 | router.register(r'paymenthops', views.PaymentHopsViewSet)
9 | router.register(r'invoices', views.InvoicesViewSet)
10 | router.register(r'forwards', views.ForwardsViewSet)
11 | router.register(r'onchain', views.OnchainViewSet)
12 | router.register(r'closures', views.ClosuresViewSet)
13 | router.register(r'resolutions', views.ResolutionsViewSet)
14 | router.register(r'peers', views.PeersViewSet)
15 | router.register(r'channels', views.ChannelsViewSet)
16 | router.register(r'rebalancer', views.RebalancerViewSet)
17 | router.register(r'settings', views.LocalSettingsViewSet)
18 | router.register(r'pendinghtlcs', views.PendingHTLCViewSet)
19 | router.register(r'failedhtlcs', views.FailedHTLCViewSet)
20 | router.register(r'peerevents', views.PeerEventsViewSet)
21 | router.register(r'trades', views.TradeSalesViewSet)
22 | router.register(r'feelog', views.FeeLogViewSet)
23 | router.register(r'inboundfeelog', views.InboundFeeLogViewSet)
24 |
25 | urlpatterns = [
26 | path('', views.home, name='home'),
27 | path('route', views.route, name='route'),
28 | path('routes', views.routes, name='routes'),
29 | path('peers', views.peers, name='peers'),
30 | path('balances', views.balances, name='balances'),
31 | path('closures', views.closures, name='closures'),
32 | path('towers', views.towers, name='towers'),
33 | path('batch', views.batch, name='batch'),
34 | path('trades', views.trades, name='trades'),
35 | path('batchopen/', views.batch_open, name='batch-open'),
36 | path('resolutions', views.resolutions, name='resolutions'),
37 | path('channel', views.channel, name='channel'),
38 | path('pending_htlcs', views.pending_htlcs, name='pending-htlcs'),
39 | path('failed_htlcs', views.failed_htlcs, name='failed-htlcs'),
40 | path('payments', views.payments, name='payments'),
41 | path('invoices', views.invoices, name='invoices'),
42 | path('forwards', views.forwards, name='forwards'),
43 | path('income', views.income, name='income'),
44 | path('rebalances', views.rebalances, name='rebalances'),
45 | path('rebalancing', views.rebalancing, name='rebalancing'),
46 | path('openchannel/', views.open_channel_form, name='open-channel-form'),
47 | path('closechannel/', views.close_channel_form, name='close-channel-form'),
48 | path('connectpeer/', views.connect_peer_form, name='connect-peer-form'),
49 | path('addtower/', views.add_tower_form, name='add-tower-form'),
50 | path('deletetower/', views.delete_tower_form, name='delete-tower-form'),
51 | path('removetower/', views.remove_tower_form, name='remove-tower-form'),
52 | path('createinvoice/', views.add_invoice_form, name='add-invoice-form'),
53 | path('rebalancer/', views.rebalance, name='rebalancer'),
54 | path('update_settings/', views.update_settings, name='update-settings'),
55 | path('update_channel/', views.update_channel, name='update-channel'),
56 | path('update_pending/', views.update_pending, name='update-pending'),
57 | path('update_setting/', views.update_setting, name='update-setting'),
58 | path('update_closing/', views.update_closing, name='update-closing'),
59 | path('update_keysend/', views.update_keysend, name='update-keysend'),
60 | path('add_avoid/', views.add_avoid, name='add-avoid'),
61 | path('remove_avoid/', views.remove_avoid, name='remove-avoid'),
62 | path('get_fees/', views.get_fees, name='get-fees'),
63 | path('opens/', views.opens, name='opens'),
64 | path('unprofitable_channels/', views.unprofitable_channels, name='unprofitable-channels'),
65 | path('actions/', views.actions, name='actions'),
66 | path('fees/', views.fees, name='fees'),
67 | path('keysends/', views.keysends, name='keysends'),
68 | path('channels/', views.channels, name='channels'),
69 | path('autopilot/', views.autopilot, name='autopilot'),
70 | path('autofees/', views.outbound_fee_log, name='outbound-fee-log'),
71 | path('inbound-fee-log/', views.inbound_fee_log, name='inbound-fee-log'),
72 | path('peerevents', views.peerevents, name='peerevents'),
73 | path('advanced/', views.advanced, name='advanced'),
74 | path('logs/', views.logs, name='logs'),
75 | path('addresses/', views.addresses, name='addresses'),
76 | path('reset/', views.reset, name='reset'),
77 | path('api/', include(router.urls), name='api-root'),
78 | path('api-auth/', include('rest_framework.urls'), name='api-auth'),
79 | path('api/connectpeer/', views.connect_peer, name='connect-peer'),
80 | path('api/disconnectpeer/', views.disconnect_peer, name='disconnect-peer'),
81 | path('api/rebalance_stats/', views.rebalance_stats, name='rebalance-stats'),
82 | path('api/openchannel/', views.open_channel, name='open-channel'),
83 | path('api/closechannel/', views.close_channel, name='close-channel'),
84 | path('api/createinvoice/', views.add_invoice, name='add-invoice'),
85 | path('api/newaddress/', views.new_address, name='new-address'),
86 | path('api/consolidate/', views.consolidate_utxos, name='consolidate-utxos'),
87 | path('api/updatealias/', views.update_alias, name='update-alias'),
88 | path('api/getinfo/', views.get_info, name='get-info'),
89 | path('api/balances/', views.api_balances, name='api-balances'),
90 | path('api/income/', views.api_income, name='api-income'),
91 | path('api/pendingchannels/', views.pending_channels, name='pending-channels'),
92 | path('api/bumpfee/', views.bump_fee, name='bump-fee'),
93 | path('api/chart/', views.chart, name='chart'),
94 | path('api/chanpolicy/', views.chan_policy, name='chan-policy'),
95 | path('api/broadcast_tx/', views.broadcast_tx, name='broadcast-tx'),
96 | path('api/node_info/', views.node_info, name='node-info'),
97 | path('api/createtrade/', views.create_trade, name='create-trade'),
98 | path('api/forwards_summary/', views.forwards_summary, name='forwards-summary'),
99 | path('api/sign_message/', views.sign_message, name='sign-message'),
100 | path('api/reset/', views.reset_api, name='reset-api'),
101 | path('lndg-admin/', admin.site.urls),
102 | ]
103 |
--------------------------------------------------------------------------------
/htlc_stream.py:
--------------------------------------------------------------------------------
1 | import django
2 | from datetime import datetime
3 | from gui.lnd_deps import router_pb2 as lnr
4 | from gui.lnd_deps import router_pb2_grpc as lnrouter
5 | from gui.lnd_deps.lnd_connect import lnd_connect
6 | from os import environ
7 | from time import sleep
8 | environ['DJANGO_SETTINGS_MODULE'] = 'lndg.settings'
9 | django.setup()
10 | from gui.models import Channels, FailedHTLCs
11 |
12 | def main():
13 | while True:
14 | try:
15 | print(f"{datetime.now().strftime('%c')} : [HTLC] : Starting failed HTLC stream...")
16 | connection = lnd_connect()
17 | routerstub = lnrouter.RouterStub(connection)
18 | all_forwards = {}
19 | for response in routerstub.SubscribeHtlcEvents(lnr.SubscribeHtlcEventsRequest()):
20 | if response.event_type == 3 and str(response.link_fail_event) != '':
21 | in_chan_id = response.incoming_channel_id
22 | out_chan_id = response.outgoing_channel_id
23 | in_chan = Channels.objects.filter(chan_id=in_chan_id)[0] if Channels.objects.filter(chan_id=in_chan_id).exists() else None
24 | out_chan = Channels.objects.filter(chan_id=out_chan_id)[0] if Channels.objects.filter(chan_id=out_chan_id).exists() else None
25 | in_chan_alias = in_chan.alias if in_chan is not None else None
26 | out_chan_alias = out_chan.alias if out_chan is not None else None
27 | out_chan_liq = max(0, (out_chan.local_balance - out_chan.local_chan_reserve)) if out_chan is not None else None
28 | out_chan_pending = out_chan.pending_outbound if out_chan is not None else None
29 | amount = int(response.link_fail_event.info.outgoing_amt_msat/1000)
30 | wire_failure = response.link_fail_event.wire_failure
31 | failure_detail = response.link_fail_event.failure_detail
32 | missed_fee = (response.link_fail_event.info.incoming_amt_msat - response.link_fail_event.info.outgoing_amt_msat)/1000
33 | FailedHTLCs(amount=amount, chan_id_in=in_chan_id, chan_id_out=out_chan_id, chan_in_alias=in_chan_alias, chan_out_alias=out_chan_alias, chan_out_liq=out_chan_liq, chan_out_pending=out_chan_pending, wire_failure=wire_failure, failure_detail=failure_detail, missed_fee=missed_fee).save()
34 | elif response.event_type == 3 and str(response.forward_event) != '':
35 | # Add forward_event
36 | key = str(response.incoming_channel_id) + str(response.outgoing_channel_id) + str(response.incoming_htlc_id) + str(response.outgoing_htlc_id)
37 | all_forwards[key] = response.forward_event
38 | elif response.event_type == 3 and str(response.settle_event) != '':
39 | # Delete forward_event
40 | key = str(response.incoming_channel_id) + str(response.outgoing_channel_id) + str(response.incoming_htlc_id) + str(response.outgoing_htlc_id)
41 | if key in all_forwards.keys():
42 | del all_forwards[key]
43 | elif response.event_type == 3 and str(response.forward_fail_event) == '':
44 | key = str(response.incoming_channel_id) + str(response.outgoing_channel_id) + str(response.incoming_htlc_id) + str(response.outgoing_htlc_id)
45 | if key in all_forwards.keys():
46 | forward_event = all_forwards[key]
47 | in_chan_id = response.incoming_channel_id
48 | out_chan_id = response.outgoing_channel_id
49 | in_chan = Channels.objects.filter(chan_id=in_chan_id)[0] if Channels.objects.filter(chan_id=in_chan_id).exists() else None
50 | out_chan = Channels.objects.filter(chan_id=out_chan_id)[0] if Channels.objects.filter(chan_id=out_chan_id).exists() else None
51 | in_chan_alias = in_chan.alias if in_chan is not None else None
52 | out_chan_alias = out_chan.alias if out_chan is not None else None
53 | out_chan_liq = max(0, (out_chan.local_balance - out_chan.local_chan_reserve)) if out_chan is not None else None
54 | out_chan_pending = out_chan.pending_outbound if out_chan is not None else None
55 | amount = int(forward_event.info.incoming_amt_msat/1000)
56 | wire_failure = 99
57 | failure_detail = 99
58 | missed_fee = (forward_event.info.incoming_amt_msat - forward_event.info.outgoing_amt_msat)/1000
59 | FailedHTLCs(amount=amount, chan_id_in=in_chan_id, chan_id_out=out_chan_id, chan_in_alias=in_chan_alias, chan_out_alias=out_chan_alias, chan_out_liq=out_chan_liq, chan_out_pending=out_chan_pending, wire_failure=wire_failure, failure_detail=failure_detail, missed_fee=missed_fee).save()
60 | del all_forwards[key]
61 | except Exception as e:
62 | print(f"{datetime.now().strftime('%c')} : [HTLC] : Error while running failed HTLC stream: {str(e)}")
63 | sleep(20)
64 |
65 | if __name__ == '__main__':
66 | main()
--------------------------------------------------------------------------------
/keysend.py:
--------------------------------------------------------------------------------
1 | import argparse
2 | import secrets, time, struct
3 | from hashlib import sha256
4 | from gui.lnd_deps import lightning_pb2 as ln
5 | from gui.lnd_deps import lightning_pb2_grpc as lnrpc
6 | from gui.lnd_deps import router_pb2 as lnr
7 | from gui.lnd_deps import router_pb2_grpc as lnrouter
8 | from gui.lnd_deps import signer_pb2 as lns
9 | from gui.lnd_deps import signer_pb2_grpc as lnsigner
10 | from gui.lnd_deps.lnd_connect import lnd_connect
11 |
12 | def keysend(target_pubkey, msg, amount, fee_limit, timeout, sign):
13 | #Construct and send
14 | try:
15 | routerstub = lnrouter.RouterStub(lnd_connect())
16 | secret = secrets.token_bytes(32)
17 | hashed_secret = sha256(secret).hexdigest()
18 | custom_records = [(5482373484, secret),]
19 | msg = str(msg)
20 | if len(msg) > 0:
21 | custom_records.append((34349334, bytes.fromhex(msg.encode('utf-8').hex())))
22 | if sign == True:
23 | stub = lnrpc.LightningStub(lnd_connect())
24 | signerstub = lnsigner.SignerStub(lnd_connect())
25 | self_pubkey = stub.GetInfo(ln.GetInfoRequest()).identity_pubkey
26 | timestamp = struct.pack(">i", int(time.time()))
27 | signature = signerstub.SignMessage(lns.SignMessageReq(msg=(bytes.fromhex(self_pubkey)+bytes.fromhex(target_pubkey)+timestamp+bytes.fromhex(msg.encode('utf-8').hex())), key_loc=lns.KeyLocator(key_family=6, key_index=0))).signature
28 | custom_records.append((34349337, signature))
29 | custom_records.append((34349339, bytes.fromhex(self_pubkey)))
30 | custom_records.append((34349343, timestamp))
31 | for response in routerstub.SendPaymentV2(lnr.SendPaymentRequest(dest=bytes.fromhex(target_pubkey), dest_custom_records=custom_records, fee_limit_sat=fee_limit, timeout_seconds=timeout, amt=amount, payment_hash=bytes.fromhex(hashed_secret))):
32 | if response.status == 1:
33 | print('In-flight')
34 | if response.status == 2:
35 | print('Succeeded')
36 | if response.status == 3:
37 | if response.failure_reason == 1:
38 | print('Failure - Timeout')
39 | elif response.failure_reason == 2:
40 | print('Failure - No Route')
41 | elif response.failure_reason == 3:
42 | print('Failure - Error')
43 | elif response.failure_reason == 4:
44 | print('Failure - Incorrect Payment Details')
45 | elif response.failure_reason == 5:
46 | print('Failure Insufficient Balance')
47 | if response.status == 0:
48 | print('Unknown Error')
49 | except Exception as e:
50 | error = str(e)
51 | details_index = error.find('details =') + 11
52 | debug_error_index = error.find('debug_error_string =') - 3
53 | error_msg = error[details_index:debug_error_index]
54 | print('Error while sending keysend payment! Error: ' + error_msg)
55 |
56 | def main(pubkey, amount, fee, msg, sign):
57 | print('Sending a %s sats payment to: %s with %s sats max-fee' % (amount, pubkey, fee))
58 | if len(msg) > 0:
59 | print('MESSAGE: %s' % msg)
60 | timeout = 10
61 | keysend(pubkey, msg, amount, fee, timeout, sign)
62 |
63 | if __name__ == '__main__':
64 | argParser = argparse.ArgumentParser(prog="python keysend.py")
65 | argParser.add_argument("-pk", "--pubkey", help='Target public key', required=True)
66 | argParser.add_argument("-a", "--amount", help='Amount in sats (default: 1)', nargs='?', default=1, type=int)
67 | argParser.add_argument("-f", "--fee", help='Max fee to send this keysend (default: 1)', nargs='?', default=1, type=int)
68 | argParser.add_argument("-m", "--msg", help='Message to be sent (default: "")', nargs='?', default='', type=str)
69 | argParser.add_argument("--sign", help='Sign this message (default: send anonymously) - if [MSG] is provided', action='store_true')
70 | args = vars(argParser.parse_args())
71 | main(**args)
--------------------------------------------------------------------------------
/lndg/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cryptosharks131/lndg/fedcbaf48608372ad13c1c257d2292ced0368533/lndg/__init__.py
--------------------------------------------------------------------------------
/lndg/asgi.py:
--------------------------------------------------------------------------------
1 | """
2 | ASGI config for lndg project.
3 |
4 | It exposes the ASGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/
8 | """
9 |
10 | import os
11 |
12 | from django.core.asgi import get_asgi_application
13 |
14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'lndg.settings')
15 |
16 | application = get_asgi_application()
17 |
--------------------------------------------------------------------------------
/lndg/urls.py:
--------------------------------------------------------------------------------
1 | """lndg URL Configuration
2 |
3 | The `urlpatterns` list routes URLs to views. For more information please see:
4 | https://docs.djangoproject.com/en/3.1/topics/http/urls/
5 | Examples:
6 | Function views
7 | 1. Add an import: from my_app import views
8 | 2. Add a URL to urlpatterns: path('', views.home, name='home')
9 | Class-based views
10 | 1. Add an import: from other_app.views import Home
11 | 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
12 | Including another URLconf
13 | 1. Import the include() function: from django.urls import include, path
14 | 2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
15 | """
16 | from django.urls import path, include
17 | from django.views.generic.base import RedirectView
18 | from django.contrib.staticfiles.storage import staticfiles_storage
19 | from django.contrib.auth.views import LogoutView
20 |
21 | urlpatterns = [
22 | path('favicon.ico', RedirectView.as_view(url=staticfiles_storage.url("favicon.ico"))),
23 | path('logout/', LogoutView.as_view(next_page='/'), name='logout'),
24 | path('', include('gui.urls')),
25 | ]
--------------------------------------------------------------------------------
/lndg/wsgi.py:
--------------------------------------------------------------------------------
1 | """
2 | WSGI config for lndg project.
3 |
4 | It exposes the WSGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/
8 | """
9 |
10 | import os
11 |
12 | from django.core.wsgi import get_wsgi_application
13 |
14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'lndg.settings')
15 |
16 | application = get_wsgi_application()
17 |
--------------------------------------------------------------------------------
/manage.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | """Django's command-line utility for administrative tasks."""
3 | import os
4 | import sys
5 |
6 |
7 | def main(args):
8 | """Run administrative tasks."""
9 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'lndg.settings')
10 | try:
11 | from django.core.management import execute_from_command_line
12 | except ImportError as exc:
13 | raise ImportError(
14 | "Couldn't import Django. Are you sure it's installed and "
15 | "available on your PYTHONPATH environment variable? Did you "
16 | "forget to activate a virtual environment?"
17 | ) from exc
18 | execute_from_command_line(args)
19 |
20 |
21 | if __name__ == '__main__':
22 | main(sys.argv)
23 |
--------------------------------------------------------------------------------
/nginx.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | INSTALL_USER=${SUDO_USER:-${USER}}
4 | NODE_IP=$(hostname -I | cut -d' ' -f1)
5 |
6 | if [ "$INSTALL_USER" == 'root' ]; then
7 | HOME_DIR='/root'
8 | else
9 | HOME_DIR="/home/$INSTALL_USER"
10 | fi
11 | LNDG_DIR="$HOME_DIR/lndg"
12 |
13 | function check_path() {
14 | if [ -e $LNDG_DIR/lndg/wsgi.py ]; then
15 | echo "Using LNDg installation found at $LNDG_DIR"
16 | else
17 | echo "LNDg installation not found at $LNDG_DIR/, please provide the correct path:"
18 | read USR_DIR
19 | if [ -e $USR_DIR/lndg/wsgi.py ]; then
20 | LNDG_DIR=$USR_DIR
21 | echo "Using LNDg installation found at $LNDG_DIR"
22 | else
23 | echo "LNDg installation still not found, exiting..."
24 | exit 1
25 | fi
26 | fi
27 | }
28 |
29 | # Ensure the lndg directory exists
30 | mkdir -p $LNDG_DIR
31 | mkdir -p $LNDG_DIR/.venv/bin
32 | mkdir -p /var/log/uwsgi
33 |
34 | function install_deps() {
35 | apt-get update
36 | apt-get install -y python3-dev build-essential python3-pip uwsgi nginx
37 | python3 -m pip install uwsgi
38 | }
39 |
40 | function setup_uwsgi() {
41 | # Creating the lndg.ini file
42 | cat << EOF > $LNDG_DIR/lndg.ini
43 | # lndg.ini file
44 | [uwsgi]
45 | # Django-related settings
46 | chdir = $LNDG_DIR
47 | module = lndg.wsgi
48 | home = $LNDG_DIR/.venv
49 | logto = /var/log/uwsgi/%n.log
50 |
51 | # process-related settings
52 | master = true
53 | processes = 1
54 | socket = $LNDG_DIR/lndg.sock
55 | chmod-socket = 660
56 | vacuum = true
57 | EOF
58 |
59 | # Creating the uwsgi_params file
60 | cat << EOF > $LNDG_DIR/uwsgi_params
61 | uwsgi_param QUERY_STRING \$query_string;
62 | uwsgi_param REQUEST_METHOD \$request_method;
63 | uwsgi_param CONTENT_TYPE \$content_type;
64 | uwsgi_param CONTENT_LENGTH \$content_length;
65 |
66 | uwsgi_param REQUEST_URI "\$request_uri";
67 | uwsgi_param PATH_INFO "\$document_uri";
68 | uwsgi_param DOCUMENT_ROOT "\$document_root";
69 | uwsgi_param SERVER_PROTOCOL "\$server_protocol";
70 | uwsgi_param REQUEST_SCHEME "\$scheme";
71 | uwsgi_param HTTPS "\$https if_not_empty";
72 |
73 | uwsgi_param REMOTE_ADDR "\$remote_addr";
74 | uwsgi_param REMOTE_PORT "\$remote_port";
75 | uwsgi_param SERVER_PORT "\$server_port";
76 | uwsgi_param SERVER_NAME "\$server_name";
77 | EOF
78 |
79 | # Creating the uwsgi.service systemd unit file
80 | cat << EOF > /etc/systemd/system/uwsgi.service
81 | [Unit]
82 | Description=Lndg uWSGI app
83 | After=syslog.target
84 |
85 | [Service]
86 | ExecStart=$LNDG_DIR/.venv/bin/uwsgi --ini $LNDG_DIR/lndg.ini
87 | User=$INSTALL_USER
88 | Group=www-data
89 | Restart=on-failure
90 | KillSignal=SIGQUIT
91 | Type=notify
92 | StandardError=syslog
93 | NotifyAccess=all
94 |
95 | [Install]
96 | WantedBy=multi-user.target
97 | EOF
98 | usermod -a -G www-data $INSTALL_USER
99 | }
100 |
101 | function setup_nginx() {
102 | # Creating the Nginx configuration file
103 | cat << EOF > /etc/nginx/sites-available/lndg
104 | upstream django {
105 | server unix://$LNDG_DIR/lndg.sock; # for a file socket
106 | }
107 |
108 | server {
109 | listen 8889;
110 | server_name _;
111 | charset utf-8;
112 | client_max_body_size 75M;
113 | proxy_read_timeout 180;
114 |
115 | location /static {
116 | alias $LNDG_DIR/gui/static; # your Django project's static files - amend as required
117 | }
118 |
119 | location / {
120 | uwsgi_pass django;
121 | include $LNDG_DIR/uwsgi_params; # the uwsgi_params file
122 | }
123 | }
124 | EOF
125 |
126 | # Remove the default site and link the new site
127 | rm /etc/nginx/sites-enabled/default
128 | ln -sf /etc/nginx/sites-available/lndg /etc/nginx/sites-enabled/
129 | }
130 |
131 | function start_services() {
132 | touch /var/log/uwsgi/lndg.log
133 | touch $LNDG_DIR/lndg.sock
134 | chgrp www-data /var/log/uwsgi/lndg.log
135 | chgrp www-data $LNDG_DIR/lndg.sock
136 | chmod 660 /var/log/uwsgi/lndg.log
137 | systemctl start uwsgi
138 | systemctl restart nginx
139 | systemctl enable uwsgi
140 | systemctl enable nginx
141 | }
142 |
143 | function report_information() {
144 | echo "Nginx and uWSGI have been set up with user $INSTALL_USER at $NODE_IP:8889."
145 | }
146 |
147 | ##### Main #####
148 | echo -e "Setting up, this may take a few minutes..."
149 | check_path
150 | install_deps
151 | setup_uwsgi
152 | setup_nginx
153 | start_services
154 | report_information
--------------------------------------------------------------------------------
/p2p.py:
--------------------------------------------------------------------------------
1 | import django, multiprocessing
2 | from datetime import datetime
3 | from gui.lnd_deps import lightning_pb2_grpc as lnrpc
4 | from gui.lnd_deps.lnd_connect import lnd_connect
5 | from os import environ
6 | from time import sleep
7 | environ['DJANGO_SETTINGS_MODULE'] = 'lndg.settings'
8 | django.setup()
9 | from gui.models import LocalSettings
10 | from trade import serve_trades
11 |
12 | def trade():
13 | stub = lnrpc.LightningStub(lnd_connect())
14 | serve_trades(stub)
15 |
16 | def check_setting():
17 | if LocalSettings.objects.filter(key='LND-ServeTrades').exists():
18 | return int(LocalSettings.objects.filter(key='LND-ServeTrades')[0].value)
19 | else:
20 | LocalSettings(key='LND-ServeTrades', value='0').save()
21 | return 0
22 |
23 | def main():
24 | while True:
25 | current_value = None
26 | try:
27 | while True:
28 | db_value = check_setting()
29 | if current_value != db_value:
30 | if db_value == 1:
31 | print(f"{datetime.now().strftime('%c')} : [P2P] : Starting the p2p service...")
32 | django.db.connections.close_all()
33 | p2p_thread = multiprocessing.Process(target=trade)
34 | p2p_thread.start()
35 | else:
36 | if 'p2p_thread' in locals() and p2p_thread.is_alive():
37 | print(f"{datetime.now().strftime('%c')} : [P2P] : Stopping the p2p service...")
38 | p2p_thread.terminate()
39 | current_value = db_value
40 | sleep(2) # polling interval
41 | except Exception as e:
42 | print(f"{datetime.now().strftime('%c')} : [P2P] : Error running p2p service: {str(e)}")
43 | finally:
44 | if 'p2p_thread' in locals() and p2p_thread.is_alive():
45 | print(f"{datetime.now().strftime('%c')} : [P2P] : Removing any remaining processes...")
46 | p2p_thread.terminate()
47 | sleep(20)
48 |
49 | if __name__ == '__main__':
50 | main()
--------------------------------------------------------------------------------
/postgres.md:
--------------------------------------------------------------------------------
1 | # LNDg Postgres Setup
2 |
3 | - **You will need to fill in the proper password below in the paths marked ``.**
4 |
5 | ## Postgres Installation
6 | Install postgres
7 | `sudo apt install postgresql`
8 |
9 | Switch to postgres user and open the client
10 | `sudo su - postgres`
11 | `psql`
12 |
13 | Create the LNDg Database - Be sure to replace the password with your own
14 | `create user lndg;create database lndg LOCALE 'en_US.UTF-8';alter role lndg with password '';grant all privileges on database lndg to lndg;alter database lndg owner to lndg;`
15 |
16 | Exit the postgres client and user
17 | `\q`
18 | `exit`
19 |
20 | ## Setting up LNDg with postgres
21 | Enter the LNDg installation folder
22 | `cd lndg`
23 |
24 | Upgrade setuptools and get required packages
25 | `.venv/bin/pip install --upgrade setuptools`
26 | `sudo apt install gcc python3-dev libpq-dev`
27 |
28 | Build psycopg2 for postgres connection
29 | `.venv/bin/pip install psycopg2`
30 |
31 | Update the `DATABASES` section of `lndg/lndg/settings.py`, be sure to replace the password
32 | ```
33 | DATABASES = {
34 | 'default': {
35 | 'ENGINE': 'django.db.backends.postgresql_psycopg2',
36 | 'NAME': 'lndg',
37 | 'USER': 'lndg',
38 | 'PASSWORD': '',
39 | 'HOST': 'localhost',
40 | 'PORT': '5432',
41 | }
42 | }
43 | ```
44 | Initialize the postgres database
45 | `.venv/bin/python manage.py migrate`
46 |
47 | ## OPTIONAL: Migrating An Existing Database
48 | Stop the LNDg services controller and web service
49 | `sudo systemctl stop lndg-controller.service`
50 | `sudo systemctl stop uwsgi.service`
51 |
52 | Dump current data to json format
53 | `.venv/bin/python manage.py dumpdata gui.channels gui.peers gui.rebalancer gui.localsettings gui.autopilot gui.autofees gui.failedhtlcs gui.avoidnodes gui.peerevents > dump.json`
54 |
55 | Import the dump
56 | `.venv/bin/python manage.py loaddata dump.json`
57 |
58 | ## Finishing Setup
59 | Recreate a login user - any username and password may be used
60 | `.venv/bin/python manage.py createsuperuser`
61 |
62 | Restart the LNDg controller and web service
63 | `sudo systemctl restart lndg-controller.service`
64 | `sudo systemctl restart uwsgi.service`
--------------------------------------------------------------------------------
/quickstart.md:
--------------------------------------------------------------------------------
1 | # A Quick Start Guide For The AR (Auto-Rebalancer)
2 |
3 | ## Here is a quick thread to get you started with the AR in LNDg. It can take a bit to get the hang of it but once you do, it's very powerful. 💪
4 | 1. In the channels table, identify a good paying and high outflow channel. This is a great channel to start learning with as attempts are based on the enabled or targeted channel. Also check that the peer's fees on the other side is less than yours else it could never rebalance.
5 |
6 | 2. Once you have identified a well earning outflow channel, use the enable button on the right side to start targeting this channel to be refilled with outbound liquidity. We know this channel flows out well and earns sats, lets keep it filled and busy routing! 😎
7 |
8 | 3. Repeat this process for all channels that earn well and you do not want to lose outbound liquidity on (a good example would be LOOP). Don't worry too much about keeping each channel at 50/50 balance but instead keep your focus on putting liquidity back where it earns you sats.
9 |
10 | 4. Now that you have a few channels enabled and targeted, you can drop the iTarget% for each enabled channel down to your desired preference. If you keep the iTarget% at 100 then nothing will ever happen because the inbound liquidity can never go above 100.
11 |
12 | 5. To get the AR working on this channel, the inbound liquidity on the channel must be above the iTarget% and thus the 100 would never do anything. Setting an iTarget% of 60 however would refill this channel with outbound liquidity until the inbound liquidity fell below 60%.
13 |
14 | 6. A tip when entering a new value into the iTarget% bow, you must hit enter afterwards for the value to be saved! Now that we understand how to refill channels, lets talk about where we have to pull the liquidity from in order to refill these channels.
15 |
16 | 7. One setting that will affect which channels can feed others during refilling is AR-Outbound%. This can be found in the AR settings table. If you don't see a particular setting in the table yet, try to set it using the form just below the table. When targeting a channel to be refilled, LNDg will use any channel that is not already enabled AND the outbound liquidity of the channel is greater than the AR-Outbound%. Advanced users may prefer to update the oTarget% for each channel, which overrides this global setting.
17 |
18 | 8. Just to recap, we are enabling channels we want to refill with outbound and those channels will be fed liquidity by channels that are not enabled. We can control how far to push the inbound liquidity down during refilling outbound liquidity of a channel with the iTarget%.
19 |
20 | 9. Now that you have things setup on a channel basis, you can review the global settings a bit and make sure things are to your liking. Lets look at each global setting and how to use it.
21 |
22 | 10. AR-Enabled: This is used to turn the AR on and off. By setting this value to 1 you will allow LNDg to start scheduling rebalances based on your specifications. Think of this as a global on and off switch.
23 |
24 | 11. AR-Target%: This specifies how big the rebalance attempts should be as a function of the channel capacity. This can be overridden in the advanced settings by setting a channel specific target amount. Updating this value will also update all specific channel target amounts.
25 |
26 | 12. AR-Outbound%: This marks how full a channel must be in order to be considered to feed another channels during a rebalance attempt. This can be overridden as well in the advanced settings by setting a channel specific oTarget%.
27 |
28 | 13. AR-MaxCost%: This lets LNDg know what % of the fees you charge on the enabled channel to put towards rebalancing that channel. If you charge 100 ppm out on an enabled channel with a 0.50 (50%) max cost. Then the max you will ever pay for this rebalance attempt will be 50 ppm.
29 |
30 | 14. AR-Time: This determines how long we should search for a route before moving on to the next rebalance attempt. LNDg will not look again for 30 minutes after failing an attempt so try to keep things busy without making rebalances too long. Recommend staying around 3-5 mins.
31 |
32 | 15. AR-MaxFeeRate: This is a fail safe to globally cap the max fee rates on any rebalance attempt. This cap will override the max cost % calculated value if it is lower. In our max cost example, a MaxFeeRate of 40 would have capped that rebalance down to 40 ppm instead of 50.
33 |
34 | 16. AR-Autopilot: This setting will allow LNDg to automatically enable and disable channels based on the flow pattern of your node. This is a pretty great feature but go slow and try things out manually a bit before letting LNDg take over. This will help build more confidence.
35 |
36 | 17. If you want to get an idea of what LNDg thinks you should be enabling or what would LNDg do if you were to turn on AR-Autopilot, then just head over to the Suggested AR Actions page (link right above channels table). If you see things here, this is what AP would do.
37 |
38 | 18. If there are any channels you want to make sure are excluded from all rebalancing, you can either enable it and make sure the iTarget% is set to 100 or set the oTarget% to 100 as well if you want to keep it disabled.
39 |
40 | 19. You should now be all set to fire things up! Go ahead and change the AR-Enabled value to 1 and start watching for rebalances to get scheduled by refreshing the page after a few moments. A new table should appear showing all the rebalances that LNDg has started to schedule.
41 |
42 | 20. That's it! You are now on your way to maximizing your flow and potential earnings! 😎💪
43 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | Django
2 | djangorestframework
3 | django-filter
4 | grpcio
5 | protobuf
6 | pytz
7 | pandas
8 | requests
9 | asyncio
10 | bech32
11 | cryptography
12 | paramiko
--------------------------------------------------------------------------------
/systemd.md:
--------------------------------------------------------------------------------
1 | # Systemd Setup For Backend Tools
2 |
3 | - **You will need to fill in the proper username below in the paths marked ``.**
4 | - **This assumes you have installed lndg on the home directory of the user. For example, user `mynode` will have a home directory of `/home/mynode/`.**
5 |
6 | ## Backend Controller Setup
7 | Create a service file for `controller.py`, copying the contents below to the file and filling in the user you would like this to run under.
8 | `nano /etc/systemd/system/lndg-controller.service`
9 | ```
10 | [Unit]
11 | Description=Backend Controller For Lndg
12 | [Service]
13 | Environment=PYTHONUNBUFFERED=1
14 | User=
15 | Group=
16 | ExecStart=/home//lndg/.venv/bin/python /home//lndg/controller.py
17 | StandardOutput=append:/var/log/lndg-controller.log
18 | StandardError=append:/var/log/lndg-controller.log
19 | Restart=always
20 | RestartSec=60s
21 | [Install]
22 | WantedBy=multi-user.target
23 | ```
24 | Enable and start the service to run the backend controller.
25 | `sudo systemctl enable lndg-controller.service`
26 | `sudo systemctl start lndg-controller.service`
27 |
28 | ## Additional Commands
29 | You can also check on the status, disable or stop the backend controller.
30 | `sudo systemctl status lndg-controller.service`
31 | `sudo systemctl disable lndg-controller.service`
32 | `sudo systemctl stop lndg-controller.service`
33 |
--------------------------------------------------------------------------------
/systemd.sh:
--------------------------------------------------------------------------------
1 | INSTALL_USER=${SUDO_USER:-${USER}}
2 | REFRESH=20
3 | RED='\033[0;31m'
4 | NC='\033[0m'
5 |
6 | if [ "$INSTALL_USER" == 'root' ] >/dev/null 2>&1; then
7 | HOME_DIR='/root'
8 | else
9 | HOME_DIR="/home/$INSTALL_USER"
10 | fi
11 | LNDG_DIR="$HOME_DIR/lndg"
12 |
13 | function check_path() {
14 | if [ -e $LNDG_DIR/lndg/wsgi.py ]; then
15 | echo "Using LNDg installation found at $LNDG_DIR"
16 | else
17 | echo "LNDg installation not found at $LNDG_DIR/, please provide the correct path:"
18 | read USR_DIR
19 | if [ -e $USR_DIR/lndg/wsgi.py ]; then
20 | LNDG_DIR=$USR_DIR
21 | echo "Using LNDg installation found at $LNDG_DIR"
22 | else
23 | echo "LNDg installation still not found, exiting..."
24 | exit 1
25 | fi
26 | fi
27 | }
28 |
29 | function configure_controller() {
30 | cat << EOF > /etc/systemd/system/lndg-controller.service
31 | [Unit]
32 | Description=Run Backend Controller For Lndg
33 | [Service]
34 | Environment=PYTHONUNBUFFERED=1
35 | User=$INSTALL_USER
36 | Group=$INSTALL_USER
37 | ExecStart=$LNDG_DIR/.venv/bin/python $LNDG_DIR/controller.py
38 | StandardOutput=append:/var/log/lndg-controller.log
39 | StandardError=append:/var/log/lndg-controller.log
40 | Restart=always
41 | RestartSec=60s
42 | [Install]
43 | WantedBy=multi-user.target
44 | EOF
45 | }
46 |
47 | function enable_services() {
48 | systemctl daemon-reload
49 | sleep 3
50 | systemctl start lndg-controller.service
51 | systemctl enable lndg-controller.service >/dev/null 2>&1
52 | }
53 |
54 | function report_information() {
55 | echo -e ""
56 | echo -e "================================================================================================================================"
57 | echo -e "Backend services and rebalancer setup for LNDg via systemd using user account $INSTALL_USER and a refresh interval of $REFRESH seconds."
58 | echo -e ""
59 | echo -e "Backend Controller Status: ${RED}sudo systemctl status lndg-controller.service${NC}"
60 | echo -e ""
61 | echo -e "To disable your backend services, use the following commands."
62 | echo -e "Disable Backend Controller: ${RED}sudo systemctl disable lndg-controller.service${NC}"
63 | echo -e "Stop Backend Controller: ${RED}sudo systemctl stop lndg-controller.service${NC}"
64 | echo -e ""
65 | echo -e "To re-enable these services, simply replace the disable/stop commands with enable/start."
66 | echo -e "================================================================================================================================"
67 | }
68 |
69 | ##### Main #####
70 | echo -e "Setting up, this may take a few minutes..."
71 | check_path
72 | configure_controller
73 | enable_services
74 | report_information
--------------------------------------------------------------------------------