#2558 deprecated Sphinx-Relay (#4599)

CHANGES.md

@@ -9,6 +9,7 @@
 - Experimental: charge-lnd install script [details](https://github.com/raspiblitz/raspiblitz/discussions/3955)
 - Experimental: config.scripts/lnd.signaddress.sh to easy sign messages on addresses on LND [details](https://github.com/raspiblitz/raspiblitz/issues/4540)
 - Experimental: config.scripts/bonus.elements.sh install elements blockchain platform [details](https://github.com/ElementsProject/elements)
+- Deprecated: Sphinx-Relay [details](https://github.com/raspiblitz/raspiblitz/issues/2558)
 - Remove: AutoPilot & Keysend from SSH menus [details](https://github.com/raspiblitz/raspiblitz/issues/1953#issuecomment-1811553602)
 - Remove: Tallycoin-Connect [see service shutdown](https://x.com/djbooth007/status/1784409117563720082)
 - Remove: IP2Tor Shoplist [details](https://github.com/raspiblitz/raspiblitz/issues/4589)

home.admin/00settingsMenuServices.sh

@@ -63,7 +63,6 @@ if [ "${lightning}" == "lnd" ] || [ "${lnd}" == "on" ]; then
   OPTIONS+=(oa 'LND Balance of Satoshis' ${bos})
   OPTIONS+=(ya 'LND PyBLOCK' ${pyblock})
   OPTIONS+=(ha 'LND ChannelTools (Fund Rescue)' ${chantools})
-  OPTIONS+=(xa 'LND Sphinx-Relay' ${sphinxrelay})
   OPTIONS+=(fa 'LND Helipad Boostagram reader' ${helipad})
   OPTIONS+=(lb 'LND LNDK (experimental BOLT 12)' ${lndk})
 fi
@@ -449,25 +448,6 @@ else
   echo "LNDg unchanged."
 fi
 
-# Sphinx Relay
-choice="off"; check=$(echo "${CHOICES}" | grep -c "xa")
-if [ ${check} -eq 1 ]; then choice="on"; fi
-if [ "${sphinxrelay}" != "${choice}" ]; then
-  echo "Sphinx-Relay Setting changed .."
-  anychange=1
-  sudo -u admin /home/admin/config.scripts/bonus.sphinxrelay.sh ${choice}
-  if [ "${choice}" =  "on" ]; then
-    echo "Giving service 1 minute to start up ... (please wait) ..."
-    sleep 60
-    whiptail --title " Installed Sphinx Server" --msgbox "\
-Sphinx Server was installed.\n
-Use the new 'SPHINX' entry in Main Menu for more info.\n
-" 10 35
-  fi
-else
-  echo "Sphinx Relay unchanged."
-fi
-
 # Helipad
 choice="off"; check=$(echo "${CHOICES}" | grep -c "fa")
 if [ ${check} -eq 1 ]; then choice="on"; fi

home.admin/_provision_.sh

@@ -467,16 +467,6 @@ else
   echo "Provisioning BTCPayServer - keep default" >> ${logFile}
 fi
 
-# deprecated - see: #2031
-# LNDMANAGE
-#if [ "${lndmanage}" = "on" ]; then
-#  echo "Provisioning lndmanage - run config script" >> ${logFile}
-#  /home/admin/_cache.sh set message "Setup lndmanage"
-#  sudo -u admin /home/admin/config.scripts/bonus.lndmanage.sh on >> ${logFile} 2>&1
-#else
-#  echo "Provisioning lndmanage - not active" >> ${logFile}
-#fi
-
 # CUSTOM PORT
 echo "Provisioning LND Port" >> ${logFile}
 if [ ${#lndPort} -eq 0 ]; then
@@ -607,15 +597,6 @@ else
   echo "Provisioning Balance of Satoshis - keep default" >> ${logFile}
 fi
 
-## LNPROXY
-#if [ "${lnproxy}" = "on" ]; then
-#  echo "Provisioning lnproxy - run config script" >> ${logFile}
-#  /home/admin/_cache.sh set message "Setup lnproxy"
-#  sudo -u admin /home/admin/config.scripts/bonus.lnproxy.sh on >> ${logFile} 2>&1
-#else
-#  echo "Provisioning lnproxy - keep default" >> ${logFile}
-#fi
-
 # thunderhub
 if [ "${thunderhub}" = "on" ]; then
   echo "Provisioning ThunderHub - run config script" >> ${logFile}
@@ -688,15 +669,6 @@ else
   echo "Provisioning LNDg - keep default" >> ${logFile}
 fi
 
-# sphinxrelay
-if [ "${sphinxrelay}" = "on" ]; then
-  echo "Sphinx-Relay - run config script" >> ${logFile}
-  /home/admin/_cache.sh set message "Setup Sphinx-Relay"
-  sudo -u admin /home/admin/config.scripts/bonus.sphinxrelay.sh on >> ${logFile} 2>&1
-else
-  echo "Sphinx-Relay - keep default" >> ${logFile}
-fi
-
 # helipad
 if [ "${helipad}" = "on" ]; then
   echo "Helipad - run config script" >> ${logFile}

home.admin/config.scripts/blitz.subscriptions.py

@@ -20,7 +20,6 @@ SERVICE_LND_REST_API = "LND-REST-API"
 SERVICE_LND_GRPC_API = "LND-GRPC-API"
 SERVICE_LNBITS = "LNBITS"
 SERVICE_BTCPAY = "BTCPAY"
-SERVICE_SPHINX = "SPHINX"
 
 # load config 
 cfg = RaspiBlitzConfig()
@@ -209,11 +208,6 @@ The following additional information is available:
             print("# FAIL: unknown subscription type")
             time.sleep(3)
 
-    # trigger restart of relevant services so they can pickup new environment
-    print("# restarting services to pickup new public url (please wait) ...")
-    os.system("sudo systemctl restart sphinxrelay 2>/dev/null")
-    time.sleep(8)
-
     # loop until no more subscriptions or user chooses CANCEL on subscription list
     my_subscriptions()
 
@@ -281,7 +275,6 @@ def main():
         lnd_grpc_api = False
         lnbits = False
         btcpay = False
-        sphinx = False
         try:
             if os.path.isfile(SUBSCRIPTIONS_FILE):
                 os.system("sudo chown admin:admin {0}".format(SUBSCRIPTIONS_FILE))
@@ -297,8 +290,6 @@ def main():
                         lnbits = True
                     if sub['active'] and sub['name'] == SERVICE_BTCPAY:
                         btcpay = True
-                    if sub['active'] and sub['name'] == SERVICE_SPHINX:
-                        sphinx = True
         except Exception as e:
             print(e)
 
@@ -309,17 +300,6 @@ def main():
         if status_data.find("installed=1") > -1:
             btc_pay_server = True
 
-        # check if Sphinx-Relay is installed
-        sphinx_relay = False
-        try:
-            status_data = subprocess.run(['/home/admin/config.scripts/bonus.sphinxrelay.sh', 'status'], 
-                stdout=subprocess.PIPE, timeout=10).stdout.decode('utf-8').strip()
-        except Exception as e:
-            print(e)
-            
-        if status_data.find("installed=1") > -1:
-            sphinx_relay = True
-
         # ask user for which RaspiBlitz service the bridge should be used
         choices = list()
         choices.append(("REST", "LND REST API {0}".format("--> ALREADY BRIDGED" if lnd_rest_api else "")))
@@ -328,8 +308,6 @@ def main():
             choices.append(("LNBITS", "LNbits Webinterface {0}".format("--> ALREADY BRIDGED" if lnbits else "")))
         if btc_pay_server:
             choices.append(("BTCPAY", "BTCPay Server Webinterface {0}".format("--> ALREADY BRIDGED" if btcpay else "")))
-        if sphinx_relay:
-            choices.append(("SPHINX", "Sphinx Relay  {0}".format("--> ALREADY BRIDGED" if sphinx else "")))
         choices.append(("SELF", "Create a custom IP2TOR Bridge"))
 
         d = Dialog(dialog="dialog", autowidgetsize=True)
@@ -369,12 +347,6 @@ def main():
             tor_address = subprocess.run(['sudo', 'cat', '/mnt/hdd/tor/btcpay/hostname'],
                                          stdout=subprocess.PIPE).stdout.decode('utf-8').strip()
             tor_port = 443
-        if tag == "SPHINX":
-            # get TOR address for SPHINX
-            service_name = SERVICE_SPHINX
-            tor_address = subprocess.run(['sudo', 'cat', '/mnt/hdd/tor/sphinxrelay/hostname'],
-                                         stdout=subprocess.PIPE).stdout.decode('utf-8').strip()
-            tor_port = 443
         if tag == "SELF":
             service_name = "CUSTOM"
             try:
@@ -418,12 +390,6 @@ def main():
         print("# running: {0}".format(cmd))
         os.system(cmd)
 
-        # action after possibly new created bride
-        if service_name == SERVICE_SPHINX:
-            print("# restarting services to pickup new public URL (please wait) ...")
-            os.system("sudo systemctl restart sphinxrelay")
-            time.sleep(8)
-
         sys.exit(0)
 
 if __name__ == '__main__':

home.admin/config.scripts/bonus.sphinxrelay.sh

@@ -1,17 +1,21 @@
 #!/bin/bash
 
+# deprecated May 2024
+# see or comment on: https://github.com/raspiblitz/raspiblitz/issues/2558
+
 # https://github.com/stakwork/sphinx-relay
 
 # command info
 if [ $# -eq 0 ] || [ "$1" = "-h" ] || [ "$1" = "-help" ]; then
   echo "config script to switch Sphinx-Relay on,off or update"
+  echo "The Sphinx-Relay is deprecated and may be removed in future versions."
+  echo "Needs to be manual installed manually after every update/recover"
   echo "bonus.sphinxrelay.sh on [?GITHUBUSER] [?BRANCH]"
   echo "bonus.sphinxrelay.sh [off|status|menu|write-environment|update]"
   echo "# DEVELOPMENT: TO SYNC WITH YOUR FORKED GITHUB-REPO"
   echo "bonus.sphinxrelay.sh github sync"
   exit 1
 fi
-
 source /mnt/hdd/raspiblitz.conf
 
 # show info menu