Implement bitcoin (#12)

* Fix Solana healthcheck

* Catch websocket exceptions for EVM collector since client does not.

* Implement bitcoin

* Update README.md for Bitcoin

Author: namikmesic

README.md

@@ -5,6 +5,7 @@ Exporter currently supports all EVM-compatible chains. In addition, there is lim
 - Cardano
 - Conflux
 - Solana
+- Bitcoin
 
 # Disclaimer
 Please note that this tool is in the early development stage and should not be used to influence critical business decisions.

config/exporter_example/config.yml

@@ -8,7 +8,7 @@ connection_parameters:
   response_timeout: 5 # Timeout when waiting for a websocket message response
   ping_interval: 6 # Liveness ping intervals
   ping_timeout: 3 # Liveness ping timeout
-collector: "evm" # This will load different collectors based on what mode exporter will run with Supported modes are: "evm", "solana", "conflux", "cardano"
+collector: "evm" # This will load different collectors based on what mode exporter will run with Supported modes are: "evm", "solana", "conflux", "cardano", "bitcoin"
 endpoints: # List of endpoints with their metadata.
   - ws_url: wss://example-rpc-1.com/ws # RPC Endpoint websocket endpoint (Must start with wss://)
     https_url: https://example-rpc-1.com/rpc    # RPC Endpoint https endpoint (Must be valid https:// domain)

src/collectors/bitcoin.py

@@ -0,0 +1,32 @@
+import asyncio
+from bitcoinrpc import BitcoinRPC
+from helpers import strip_url
+from time import perf_counter
+from settings import cfg, logger
+
+class bitcoin_collector():
+
+    def __init__(self, https_url, provider):
+        self.https_url = https_url 
+        self.labels = ['https_url', 'provider', 'blockchain', 'network_name', 'network_type']
+        self.labels_values = [
+            https_url, provider, cfg.blockchain, cfg.network_name, cfg.network_type
+        ]
+    
+    async def _probe(self, metrics): 
+        try:
+            async with BitcoinRPC(self.https_url, "admin", "admin") as rpc:
+                start = perf_counter()
+                chain_info = await rpc.getblockchaininfo()
+                latency = (perf_counter() - start) * 1000
+                
+                metrics['ws_rpc_health'].add_metric(self.labels_values, True)
+                metrics['ws_rpc_latency'].add_metric(self.labels_values, latency)
+                metrics['ws_rpc_block_height'].add_metric(self.labels_values, chain_info['headers'])
+                metrics['ws_rpc_total_difficulty'].add_metric(self.labels_values, chain_info['difficulty'])
+        except Exception as exc:
+            logger.error("Failed probing {} with error: {}".format(strip_url(self.url), exc))
+            metrics['ws_rpc_health'].add_metric(self.labels_values, False)
+    
+    def probe(self, metrics):
+        asyncio.run(self._probe(metrics))

src/exporter.py

@@ -7,6 +7,7 @@
 from collectors.solana import solana_collector
 from collectors.cardano import cardano_collector
 from collectors.conflux import conflux_collector
+from collectors.bitcoin import bitcoin_collector
 from settings import logger, cfg
 
 
@@ -24,6 +25,8 @@ def __init__(self):
             self._instantiate_cardano()
         if cfg.isConflux():
             self._instantiate_conflux()
+        if cfg.isBitcoin():
+            self._instantiate_bitcoin()
 
     def _instantiate_evm(self):
         for item in cfg.endpoints:
@@ -49,6 +52,12 @@ def _instantiate_cardano(self):
             self.collectors.append(cardano_collector(item['ws_url'], item['provider']))
             self.labels = self.collectors[0].labels
 
+    def _instantiate_bitcoin(self):
+        for item in cfg.endpoints:
+            logger.info("Initializing bitcoin node {}".format(strip_url(item['https_url'])))
+            self.collectors.append(bitcoin_collector(item['https_url'], item['provider']))
+            self.labels = self.collectors[0].labels
+
     def collect(self):
         metrics = {
             "ws_rpc_health":

src/settings.py

@@ -18,7 +18,7 @@ def __init__(self, config_file_path: str, validation_file_path: str):
         self.configuration = self._load_configuration_file(config_file_path)
         self.blockchain = self.configuration['blockchain']
         # Load chain_id only if evm compatible collector
-        if self.configuration['collector'] not in ['cardano', 'solana']:
+        if self.configuration['collector'] not in ['cardano', 'solana', 'bitcoin']:
             try:
                 self.chain_id = self.configuration['chain_id']
             except KeyError:
@@ -76,6 +76,9 @@ def isCardano(self) -> bool:
     def isConflux(self) -> bool:
         return self.configuration['collector'] == "conflux"
 
+    def isBitcoin(self) -> bool:
+        return self.configuration['collector'] == "bitcoin"
+
     def _load_configuration_file(self, path):
         logger.info('Loading {}'.format(path))
         configuration_file_schema = Schema({
@@ -88,7 +91,7 @@ def _load_configuration_file(self, path):
             'network_type':
             And(str, lambda s: s in ('Testnet', 'Mainnet')),
             'collector':
-            And(str, lambda s: s in ('evm', 'cardano', 'conflux', 'solana')),
+            And(str, lambda s: s in ('evm', 'cardano', 'conflux', 'solana', 'bitcoin')),
             Optional('connection_parameters'): {
                 Optional('open_timeout'): And(int),
                 Optional('close_timeout'): And(int),
@@ -97,7 +100,7 @@ def _load_configuration_file(self, path):
                 Optional('ping_timeout'): And(int),
             },
             'endpoints': [{
-                'ws_url': And(str),
+                Optional('ws_url'): And(str),
                 Optional('https_url'): And(str),
                 'provider': And(str, lambda s: s in self.allowed_providers)
             }]