Bugfix: Miscellanous changes (#30)

* version v0.3.0

* No stacktrace for failed ping

* black

* tiny bit of more testing

* fixing logger error issues

* better progress for syncing

Author: k9ert

src/cryptoadvance/spectrum/__main__.py

@@ -1,4 +1,5 @@
 from .cli import entry_point
-import logging 
+import logging
+
 if __name__ == "__main__":
     entry_point()

src/cryptoadvance/spectrum/cli/__init__.py

@@ -8,21 +8,24 @@
 
 from .cli_server import server
 
+
 @click.group()
 @click.option("--debug", is_flag=True, help="Show debug information on errors.")
 def entry_point(debug):
     setup_logging(debug)
 
+
 entry_point.add_command(server)
 
+
 def setup_logging(debug=False):
-    ''' central and early configuring of logging see
-        https://flask.palletsprojects.com/en/1.1.x/logging/#basic-configuration
-        However the dictConfig doesn't work, so let's do something similiar programatically
-    '''
+    """central and early configuring of logging see
+    https://flask.palletsprojects.com/en/1.1.x/logging/#basic-configuration
+    However the dictConfig doesn't work, so let's do something similiar programatically
+    """
     ch = logging.StreamHandler()
     ch.setLevel(logging.DEBUG)
-    logger = logging.getLogger('cryptoadvance')
+    logger = logging.getLogger("cryptoadvance")
     if debug:
         formatter = logging.Formatter("[%(levelname)7s] in %(module)15s: %(message)s")
         logger.setLevel(logging.DEBUG)
@@ -40,10 +43,10 @@ def setup_logging(debug=False):
         )
         logger.setLevel(logging.INFO)
     ch.setFormatter(formatter)
-    
+
     for logger in [
-        #app.logger,
-        #logging.getLogger('sqlalchemy'),
+        # app.logger,
+        # logging.getLogger('sqlalchemy'),
     ]:
         logger.setLevel(logging.DEBUG)
 

src/cryptoadvance/spectrum/cli/cli_server.py

@@ -5,12 +5,14 @@
 
 logger = logging.getLogger(__name__)
 
+
 @click.group()
 def cli():
     pass
 
+
 @cli.command()
-@click.option("--port", default="5000") 
+@click.option("--port", default="5000")
 # set to 0.0.0.0 to make it available outside
 @click.option("--host", default="127.0.0.1")
 # for https:
@@ -21,13 +23,13 @@ def cli():
     default="cryptoadvance.spectrum.config.LocalElectrumConfig",
     help="A class which sets reasonable default values.",
 )
-def server( port, host, cert, key, config):
+def server(port, host, cert, key, config):
     # a hack as the pass_context is broken for some reason
     # we determine debug from what is set in the entry_point via the debug-level.
-    debug=logger.isEnabledFor(logging.DEBUG)
+    debug = logger.isEnabledFor(logging.DEBUG)
     logger.info(f"DEBUG is {debug}")
-    
+
     app = create_app(config)
     init_app(app)
     logger.info("Starting up ...")
-    app.run(debug=debug, port=app.config["PORT"], host=host)
+    app.run(debug=debug, port=app.config["PORT"], host=host)

src/cryptoadvance/spectrum/config.py

@@ -1,4 +1,4 @@
-''' A config module contains static configuration '''
+""" A config module contains static configuration """
 import configparser
 import datetime
 import logging
@@ -10,58 +10,75 @@
 
 logger = logging.getLogger(__name__)
 
+
 class BaseConfig(object):
     """Base configuration."""
-    SECRET_KEY='development key'
-    USERNAME='admin'
-    HOST="127.0.0.1"
-    PORT=8081
-    SPECTRUM_DATADIR="data" # used for sqlite but also for txs-cache
+
+    SECRET_KEY = "development key"
+    USERNAME = "admin"
+    HOST = "127.0.0.1"
+    PORT = 8081
+    SPECTRUM_DATADIR = "data"  # used for sqlite but also for txs-cache
+
 
 # Level 1: How does persistence work?
 # Convention: BlaConfig
 
+
 class LiteConfig(BaseConfig):
-    DATABASE=os.path.abspath(os.path.join(BaseConfig.SPECTRUM_DATADIR, "wallets.sqlite"))
-    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + DATABASE
-    SQLALCHEMY_TRACK_MODIFICATIONS=False
+    DATABASE = os.path.abspath(
+        os.path.join(BaseConfig.SPECTRUM_DATADIR, "wallets.sqlite")
+    )
+    SQLALCHEMY_DATABASE_URI = "sqlite:///" + DATABASE
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+
 
 class PostgresConfig(BaseConfig):
     """Development configuration with Postgres."""
+
     DEBUG = True
-    DB_USERNAME = os.environ.get('DB_USER', default='spectrum')
-    DB_PASSWORD = os.environ.get('DB_PASSWORD')
-    DB_HOST = os.environ.get('DB_HOST', default='127.0.0.1') # will be overridden in docker-compose, but good for dev
-    DB_PORT = os.environ.get('DB_PORT', default='5432')
-    DB_DATABASE = os.environ.get('DB_DATABASE', default='spectrum')
+    DB_USERNAME = os.environ.get("DB_USER", default="spectrum")
+    DB_PASSWORD = os.environ.get("DB_PASSWORD")
+    DB_HOST = os.environ.get(
+        "DB_HOST", default="127.0.0.1"
+    )  # will be overridden in docker-compose, but good for dev
+    DB_PORT = os.environ.get("DB_PORT", default="5432")
+    DB_DATABASE = os.environ.get("DB_DATABASE", default="spectrum")
     SQL_ALCHEMY_TRACK_MODIFICATIONS = False
-    SQLALCHEMY_DATABASE_URI = f'postgresql+psycopg2://{DB_HOST}:{DB_PORT}/{DB_DATABASE}?user={DB_USERNAME}&password={DB_PASSWORD}' # &ssl=true
+    SQLALCHEMY_DATABASE_URI = f"postgresql+psycopg2://{DB_HOST}:{DB_PORT}/{DB_DATABASE}?user={DB_USERNAME}&password={DB_PASSWORD}"  # &ssl=true
+
 
 # Level 2: Where do we get an electrum from ?
 # Convention: Prefix a level 1 config with the electrum solution
 class NigiriLocalElectrumLiteConfig(LiteConfig):
-    ELECTRUM_HOST="127.0.0.1"
-    ELECTRUM_PORT=50000
-    ELECTRUM_USES_SSL=_get_bool_env_var('ELECTRUM_USES_SSL', default="false") # Nigiri doesn't use SSL
+    ELECTRUM_HOST = "127.0.0.1"
+    ELECTRUM_PORT = 50000
+    ELECTRUM_USES_SSL = _get_bool_env_var(
+        "ELECTRUM_USES_SSL", default="false"
+    )  # Nigiri doesn't use SSL
+
 
 class EmzyElectrumLiteConfig(LiteConfig):
-    ELECTRUM_HOST=os.environ.get('ELECTRUM_HOST', default='electrum.emzy.de')
-    ELECTRUM_PORT=int(os.environ.get('ELECTRUM_PORT', default='50002'))
-    ELECTRUM_USES_SSL=_get_bool_env_var('ELECTRUM_USES_SSL', default="true")
+    ELECTRUM_HOST = os.environ.get("ELECTRUM_HOST", default="electrum.emzy.de")
+    ELECTRUM_PORT = int(os.environ.get("ELECTRUM_PORT", default="50002"))
+    ELECTRUM_USES_SSL = _get_bool_env_var("ELECTRUM_USES_SSL", default="true")
+
 
 class EmzyElectrumPostgresConfig(PostgresConfig):
-    ELECTRUM_HOST=os.environ.get('ELECTRUM_HOST', default='electrum.emzy.de')
-    ELECTRUM_PORT=int(os.environ.get('ELECTRUM_PORT', default='50002'))
-    ELECTRUM_USES_SSL=_get_bool_env_var('ELECTRUM_USES_SSL', default="true")
+    ELECTRUM_HOST = os.environ.get("ELECTRUM_HOST", default="electrum.emzy.de")
+    ELECTRUM_PORT = int(os.environ.get("ELECTRUM_PORT", default="50002"))
+    ELECTRUM_USES_SSL = _get_bool_env_var("ELECTRUM_USES_SSL", default="true")
+
 
 # Level 2: Back to the problem-Space.
 # Convention: ProblemConfig where problem is usually one of Test/Production or so
 
+
 class TestConfig(NigiriLocalElectrumLiteConfig):
     pass
 
-class ProductionConfig(EmzyElectrumPostgresConfig):
-    ''' Not sure whether we're production ready, though '''
-    SECRET_KEY = os.getenv("SECRET_KEY", secrets.token_urlsafe(16))
 
+class ProductionConfig(EmzyElectrumPostgresConfig):
+    """Not sure whether we're production ready, though"""
 
+    SECRET_KEY = os.getenv("SECRET_KEY", secrets.token_urlsafe(16))

src/cryptoadvance/spectrum/db.py

@@ -1,8 +1,8 @@
-'''
+"""
 [![](https://mermaid.ink/img/pako:eNp9VMtuwjAQ_BXLpz7gB3Ks4NBTD1CVA1K02Eti4diRHxQU5d_rPAiJA80pnhl7Z8ebVJRpjjShTIK1KwGZgWKvSHh-QEp05G25JCu0zIjSadNR93VLb9rFbNcT-Hu7--rAThCBI-V2N9M1UAe2hnt11UGEvG-cESojCgocsIPWkpRGnMFhesKrTVHBQSKPd1mcY2Wo8qsNTy3Ivpd6bOAeRTUtCMyJc2RCKIdGgYyL8CjfwAQpUXhxqVAcLw8Kd6FUkw0j7air0TXEaA42nzEu5DSAHyL7DCczrY7CFKN8esKrOQWcG7T25XWwPTbeXPXUtrsIPgHO2rsJkKPIchfXhkJ75aYRS81ONyv1jeqesYnt7h8LfRCH5qxJQs-ttFon4qkzWEpg2EzbQKyVLwgLGWfaXJ-3_bjHgDbKI_bn1XRBCzQFCB4-4ranPXU5BiM0Ca8cj-DD4NK9aqS-5KHwmoswajQ5grS4oOCd3lwVo4kzHm-i_l_Qq-o_ZgxJhg)](https://mermaid-js.github.io/mermaid-live-editor/edit#pako:eNp9VMtuwjAQ_BXLpz7gB3Ks4NBTD1CVA1K02Eti4diRHxQU5d_rPAiJA80pnhl7Z8ebVJRpjjShTIK1KwGZgWKvSHh-QEp05G25JCu0zIjSadNR93VLb9rFbNcT-Hu7--rAThCBI-V2N9M1UAe2hnt11UGEvG-cESojCgocsIPWkpRGnMFhesKrTVHBQSKPd1mcY2Wo8qsNTy3Ivpd6bOAeRTUtCMyJc2RCKIdGgYyL8CjfwAQpUXhxqVAcLw8Kd6FUkw0j7air0TXEaA42nzEu5DSAHyL7DCczrY7CFKN8esKrOQWcG7T25XWwPTbeXPXUtrsIPgHO2rsJkKPIchfXhkJ75aYRS81ONyv1jeqesYnt7h8LfRCH5qxJQs-ttFon4qkzWEpg2EzbQKyVLwgLGWfaXJ-3_bjHgDbKI_bn1XRBCzQFCB4-4ranPXU5BiM0Ca8cj-DD4NK9aqS-5KHwmoswajQ5grS4oOCd3lwVo4kzHm-i_l_Qq-o_ZgxJhg)
 
 
-'''
+"""
 
 from flask_sqlalchemy import SQLAlchemy
 from embit.descriptor import Descriptor as EmbitDescriptor
@@ -20,17 +20,19 @@
 class NoNameMeta(BindMetaMixin, DeclarativeMeta):
     pass
 
+
 CustomModel = declarative_base(cls=Model, metaclass=NoNameMeta, name="Model")
 
 db = SQLAlchemy(model_class=CustomModel)
-#db = SQLAlchemy()
+# db = SQLAlchemy()
 
 
 class SpectrumModel(db.Model):
     __abstract__ = True
+
     @declared_attr
     def __tablename__(cls):
-        return 'spectrum_' + snake_case2camelcase(cls.__name__)
+        return "spectrum_" + snake_case2camelcase(cls.__name__)
 
 
 class TxCategory(Enum):
@@ -68,8 +70,11 @@ def get_keypool(self, internal=False):
 
 class Descriptor(SpectrumModel):
     """Descriptors tracked by the wallet"""
+
     id = db.Column(db.Integer, primary_key=True)
-    wallet_id = db.Column(db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False)
+    wallet_id = db.Column(
+        db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False
+    )
     wallet = db.relationship("Wallet", backref=db.backref("descriptors", lazy=True))
     # if we should use this descriptor for new addresses
     active = db.Column(db.Boolean, default=True)
@@ -109,11 +114,16 @@ def get_descriptor(self, index=None):
 # We store script pubkeys instead of addresses as database is chain-agnostic
 class Script(SpectrumModel):
     id = db.Column(db.Integer, primary_key=True)
-    wallet_id = db.Column(db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False)
+    wallet_id = db.Column(
+        db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False
+    )
     wallet = db.relationship("Wallet", backref=db.backref("scripts", lazy=True))
     # this must be nullable as we may need to label external scripts
     descriptor_id = db.Column(
-        db.Integer, db.ForeignKey(f"{Descriptor.__tablename__}.id"), nullable=True, default=None
+        db.Integer,
+        db.ForeignKey(f"{Descriptor.__tablename__}.id"),
+        nullable=True,
+        default=None,
     )
     descriptor = db.relationship("Descriptor", backref=db.backref("scripts", lazy=True))
     # derivation index if it's our address
@@ -138,7 +148,7 @@ def script_pubkey(self):
         return EmbitScript(bytes.fromhex(self.script))
 
 
-class UTXO( SpectrumModel):
+class UTXO(SpectrumModel):
     id = db.Column(db.Integer, primary_key=True)
     txid = db.Column(db.String(64))
     vout = db.Column(db.Integer)
@@ -150,11 +160,13 @@ class UTXO( SpectrumModel):
     # refs
     script_id = db.Column(db.Integer, db.ForeignKey(f"{Script.__tablename__}.id"))
     script = db.relationship("Script", backref=db.backref("utxos", lazy=True))
-    wallet_id = db.Column(db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False)
+    wallet_id = db.Column(
+        db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False
+    )
     wallet = db.relationship("Wallet", backref=db.backref("utxos", lazy=True))
 
 
-class Tx( SpectrumModel):
+class Tx(SpectrumModel):
     id = db.Column(db.Integer, primary_key=True)
     txid = db.Column(db.String(64))
     blockhash = db.Column(db.String(64), default=None)
@@ -168,7 +180,9 @@ class Tx( SpectrumModel):
     # refs
     script_id = db.Column(db.Integer, db.ForeignKey(f"{Script.__tablename__}.id"))
     script = db.relationship("Script", backref=db.backref("txs", lazy=True))
-    wallet_id = db.Column(db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False)
+    wallet_id = db.Column(
+        db.Integer, db.ForeignKey(f"{Wallet.__tablename__}.id"), nullable=False
+    )
     wallet = db.relationship("Wallet", backref=db.backref("txs", lazy=True))
 
     def to_dict(self, blockheight, network):

src/cryptoadvance/spectrum/elsock.py

@@ -12,8 +12,11 @@
 
 logger = logging.getLogger(__name__)
 
+
 class ElectrumSocket:
-    def __init__(self, host="127.0.0.1", port=50001, use_ssl=False, callback=None, timeout=10):
+    def __init__(
+        self, host="127.0.0.1", port=50001, use_ssl=False, callback=None, timeout=10
+    ):
         logger.info(f"Initializing ElectrumSocket with {host}:{port} (ssl: {ssl})")
         self._host = host
         self._port = port
@@ -55,7 +58,7 @@ def write_loop(self):
                     req = self._requests.pop()
                     self._socket.sendall(json.dumps(req).encode() + b"\n")
                 except Exception as e:
-                    logger.error("Error in write", e)
+                    logger.error(f"Error in write: {e}")
                     handle_exception(e)
             time.sleep(0.01)
 
@@ -68,10 +71,11 @@ def ping_loop(self):
                 tries = 0
             except Exception as e:
                 tries = tries + 1
-                logger.error("Error in ping", e)
+                logger.error(f"Error in ping {e}")
                 if tries > 10:
-                    logger.fatal("Ping failure. I guess we lost the connection. What to do now?!")
-                handle_exception(e)
+                    logger.fatal(
+                        "Ping failure. I guess we lost the connection. What to do now?!"
+                    )
 
     def recv_loop(self):
         while self.running:
@@ -85,7 +89,7 @@ def recv_loop(self):
     def recv(self):
         while self.running:
             data = self._socket.recv(2048)
-            while not data.endswith(b"\n"): # b"\n" is the end of the message
+            while not data.endswith(b"\n"):  # b"\n" is the end of the message
                 data += self._socket.recv(2048)
             # data looks like this:
             # b'{"jsonrpc": "2.0", "result": {"hex": "...", "height": 761086}, "id": 2210736436}\n'
@@ -111,7 +115,7 @@ def notify(self, data):
             try:
                 self._callback(data)
             except Exception as e:
-                logger.error("Error in callback:", e)
+                logger.error(f"Error in callback: {e}")
                 handle_exception(e)
         else:
             logger.debug("Notification:", data)
@@ -121,18 +125,19 @@ def call(self, method, params=[]):
         obj = {"jsonrpc": "2.0", "method": method, "params": params, "id": uid}
         self._requests.append(obj)
         start = time.time()
-        
+
         while uid not in self._results:  # wait for response
-            #time.sleep(1)
+            # time.sleep(1)
             time.sleep(0.01)
             if time.time() - start > self._timeout:
-                raise SpectrumException(f"Timeout ({self._timeout} seconds) waiting for {method} on {self._socket}")
+                raise SpectrumException(
+                    f"Timeout ({self._timeout} seconds) waiting for {method} on {self._socket}"
+                )
         res = self._results.pop(uid)
         if "error" in res:
             raise ValueError(res["error"])
         if "result" in res:
             return res["result"]
-        
 
     def wait(self):
         self._waiting = True
@@ -141,12 +146,9 @@ def wait(self):
 
     def ping(self):
         start = time.time()
-        self.call("server.ping") # result None
+        self.call("server.ping")  # result None
         return time.time() - start
 
-
     def __del__(self):
         logger.info("Closing socket ...")
         self._socket.close()
-
-