prepare: Automatically set --usetorproxy if use_tor is set in basicswap.json

basicswap/interface/xmr.py

@@ -98,16 +98,17 @@ class XMRInterface(CoinInterface):
         proxy_port = None
         # Connect to the daemon over a proxy if not running locally
         if swap_client:
+            chain_client_settings = swap_client.getChainClientSettings(self.coin_type())
+            manage_daemon: bool = chain_client_settings['manage_daemon']
             if swap_client.use_tor_proxy:
-                chain_client_settings = swap_client.getChainClientSettings(self.coin_type())
-                if chain_client_settings['manage_daemon'] is False:
+                if manage_daemon is False:
                     proxy_host = swap_client.tor_proxy_host
                     proxy_port = swap_client.tor_proxy_port
                     self._log.info(f'Connecting to remote {self.coin_name()} daemon at {rpchost} through proxy at {proxy_host}.')
                 else:
                     self._log.info(f'Not connecting to local {self.coin_name()} daemon through proxy.')
-            elif chain_client_settings['manage_daemon'] is False:
-                self._log.info(f'Connecting to remote {self.coin_name()} daemon at {proxy_host}.')
+            elif manage_daemon is False:
+                self._log.info(f'Connecting to remote {self.coin_name()} daemon at {rpchost}.')
 
         self.rpc = make_xmr_rpc_func(coin_settings['rpcport'], daemon_login, host=rpchost, proxy_host=proxy_host, proxy_port=proxy_port)
         self.rpc2 = make_xmr_rpc2_func(coin_settings['rpcport'], daemon_login, host=rpchost, proxy_host=proxy_host, proxy_port=proxy_port)  # non-json endpoint

bin/basicswap_prepare.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2019-2023 tecnovert
+# Copyright (c) 2019-2024 tecnovert
 # Distributed under the MIT software license, see the accompanying
 # file LICENSE or http://www.opensource.org/licenses/mit-license.php.
 
@@ -196,7 +196,7 @@ BITCOIN_FASTSYNC_FILE = os.getenv('BITCOIN_FASTSYNC_FILE', 'utxo-snapshot-bitcoi
 # Encrypt new wallets with this password, must match the Particl wallet password when adding coins
 WALLET_ENCRYPTION_PWD = os.getenv('WALLET_ENCRYPTION_PWD', '')
 
-use_tor_proxy = False
+use_tor_proxy: bool = False
 
 default_socket = socket.socket
 default_socket_timeout = socket.getdefaulttimeout()
@@ -323,7 +323,7 @@ def urlretrieve(url, filename, reporthook=None, data=None, resume_from=0):
     return result
 
 
-def setConnectionParameters(timeout=5):
+def setConnectionParameters(timeout: int = 5, allow_set_tor: bool = True):
     opener = urllib.request.build_opener()
     opener.addheaders = [('User-agent', 'Mozilla/5.0')]
     urllib.request.install_opener(opener)
@@ -1083,6 +1083,7 @@ def printHelp():
     print('--xmrrestoreheight=n     Block height to restore Monero wallet from, default:{}.'.format(DEFAULT_XMR_RESTORE_HEIGHT))
     print('--noextractover          Prevent extracting cores if files exist.  Speeds up tests')
     print('--usetorproxy            Use TOR proxy during setup.  Note that some download links may be inaccessible over TOR.')
+    print('--notorproxy             Force usetorproxy off, usetorproxy is automatically set when tor is enabled')
     print('--enabletor              Setup Basicswap instance to use TOR.')
     print('--disabletor             Setup Basicswap instance to not use TOR.')
     print('--usebtcfastsync         Initialise the BTC chain with a snapshot from btcpayserver FastSync.\n'
@@ -1355,6 +1356,9 @@ def main():
         if name == 'usetorproxy':
             use_tor_proxy = True
             continue
+        if name == 'notorproxy':
+            extra_opts['no_tor_proxy'] = True
+            continue
         if name == 'enabletor':
             enable_tor = True
             continue
@@ -1419,14 +1423,6 @@ def main():
 
         exitWithError('Unknown argument {}'.format(v))
 
-    setConnectionParameters()
-
-    if use_tor_proxy and TEST_TOR_PROXY:
-        testTorConnection()
-
-    if use_tor_proxy and TEST_ONION_LINK:
-        testOnionLink()
-
     if data_dir is None:
         data_dir = os.path.join(os.path.expanduser(cfg.BASICSWAP_DATADIR))
     if bin_dir is None:
@@ -1446,6 +1442,30 @@ def main():
         os.makedirs(data_dir)
     config_path = os.path.join(data_dir, cfg.CONFIG_FILENAME)
 
+    if use_tor_proxy and extra_opts.get('no_tor_proxy', False):
+        exitWithError('Can\'t use --usetorproxy and --notorproxy together')
+
+    # Check config to see if tor is enabled
+    if not use_tor_proxy and os.path.exists(config_path):
+        settings = load_config(config_path)
+        settings_use_tor = settings.get('use_tor', False)
+        if settings_use_tor:
+            logger.info('use_tor is set in the config')
+            if extra_opts.get('no_tor_proxy', False):
+                use_tor_proxy = False
+                logger.warning('Not automatically setting --usetorproxy as --notorproxy is set')
+            else:
+                use_tor_proxy = True
+                logger.info(f'Automatically setting --usetorproxy')
+
+    setConnectionParameters(allow_set_tor=False)
+
+    if use_tor_proxy and TEST_TOR_PROXY:
+        testTorConnection()
+
+    if use_tor_proxy and TEST_ONION_LINK:
+        testOnionLink()
+
     should_download_btc_fastsync = False
     if extra_opts.get('use_btc_fastsync', False) is True:
         if 'bitcoin' in with_coins or add_coin == 'bitcoin':

tests/basicswap/extended/test_prepare.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2019-2022 tecnovert
+# Copyright (c) 2019-2024 tecnovert
 # Distributed under the MIT software license, see the accompanying
 # file LICENSE or http://www.opensource.org/licenses/mit-license.php.
 
@@ -91,7 +91,6 @@ class Test(unittest.TestCase):
                         prepareSystem.main()
 
             self.assertEqual(cm.exception.code, 1)
-            logger.info('fake_stderr.getvalue() %s', fake_stderr.getvalue())
             self.assertTrue('exists, exiting' in fake_stderr.getvalue())
 
             logger.info('Test addcoin new')
@@ -117,6 +116,17 @@ class Test(unittest.TestCase):
             with open(config_path) as fs:
                 settings = json.load(fs)
                 self.assertTrue(settings['chainclients']['namecoin']['connection_type'] == 'rpc')
+
+            logging.info('notorproxy')
+            testargs = ['basicswap-prepare', '-datadir=' + test_path_plain, '-addcoin=firo', '--usetorproxy', '--notorproxy']
+            with patch('sys.stderr', new=StringIO()) as fake_stderr:
+                with patch.object(sys, 'argv', testargs):
+                    with self.assertRaises(SystemExit) as cm:
+                        prepareSystem.main()
+
+            self.assertEqual(cm.exception.code, 1)
+            self.assertTrue('--usetorproxy and --notorproxy together' in fake_stderr.getvalue())
+
         finally:
             del prepareSystem