1) MATTERCLOUD_API_KEY environment variable required for Mattercloud api activation

2) sort utxos by confirmations (most confs at top) and value (lower value at top).

Author: AustEcon

bitsv/network/services/__init__.py

@@ -1,5 +1,5 @@
-from .bitindex3 import (
-    BitIndex3, BitIndex3MainNet, BitIndex3TestNet, BitIndex3STN)
+from .mattercloud import (
+    MatterCloud, MatterCloudMainNet, MatterCloudTestNet, MatterCloudSTN)
 from .network import NetworkAPI, set_service_timeout, DEFAULT_TIMEOUT
 from .whatsonchain import WhatsonchainNormalised
 from .bchsvexplorer import BCHSVExplorerAPI

bitsv/network/services/bchsvexplorer.py

@@ -55,20 +55,6 @@ def get_transactions(cls, address):
         r.raise_for_status()  # pragma: no cover
         return r.json()['transactions']
 
-    def woc_tx_to_transaction(response):
-        tx_inputs = []
-        for vin in response['vin']:
-            tx_input = TxInput(txid=vin['txid'], index=vin['vout'])
-            tx_inputs.append(tx_input)
-
-        tx_outputs = []
-        for vout in response['vout']:
-            tx_output = TxOutput(scriptpubkey=vout['scriptPubKey']['hex'], amount=vout['value'])
-            tx_outputs.append(tx_output)
-        tx = Transaction(response['txid'], tx_inputs, tx_outputs)
-
-        return tx
-
     @classmethod
     def get_transaction(cls, txid):
         r = requests.get(cls.MAIN_TX_API.format(txid), timeout=DEFAULT_TIMEOUT)
@@ -99,13 +85,14 @@ def raw_get_transaction(cls, txid):
     def get_unspents(cls, address):
         r = requests.get(cls.MAIN_UNSPENT_API.format(address), timeout=DEFAULT_TIMEOUT)
         r.raise_for_status()  # pragma: no cover
-        return [
-            Unspent(currency_to_satoshi(tx['amount'], 'bsv'),
-                    tx['scriptPubKey'],
-                    tx['txid'],
-                    tx['vout'])
-            for tx in r.json()
+        utxos = [
+            Unspent(amount=currency_to_satoshi(utxo['amount'], 'bsv'),
+                    confirmations=utxo['confirmations'],
+                    txid=utxo['txid'],
+                    txindex=utxo['vout'])
+            for utxo in r.json()
         ]
+        return sorted(utxos, key=lambda utxo: (-utxo.confirmations, utxo.amount))
 
     @classmethod
     def send_transaction(cls, rawtx):  # pragma: no cover

bitsv/network/services/bitindex3.py bitsv/network/services/mattercloud.pybitsv/network/services/bitindex3.py renamed to bitsv/network/services/mattercloud.py

@@ -1,9 +1,12 @@
 import json
+
 import requests
 
 from bitsv.network.meta import Unspent
 from bitsv.network.transaction import Transaction, TxInput, TxOutput
 
+MATTERCLOUD_API_KEY_VARNAME = 'MATTERCLOUD_API_KEY'
+
 
 def woc_tx_to_transaction(response):
     tx_inputs = []
@@ -20,9 +23,9 @@ def woc_tx_to_transaction(response):
     return tx
 
 
-class BitIndex3:
+class MatterCloud:
     """
-    Implements version 3 of the BitIndex API
+    Implements version 3 of the MatterCloud API
 
     :param network: select 'main', 'test', or 'stn'
     :type network: ``str``
@@ -68,12 +71,13 @@ def get_unspents(self, address, sort=False, sort_direction='asc'):
             headers=self.headers,
         )
         r.raise_for_status()
-        return [Unspent(
+        utxos = [Unspent(
             amount=tx['satoshis'],
             confirmations=tx['confirmations'],
             txid=tx['txid'],
             txindex=tx['vout'],
         ) for tx in r.json()]
+        return sorted(utxos, key=lambda utxo: (-utxo.confirmations, utxo.amount))
 
     def get_balance(self, address):
         """
@@ -283,7 +287,7 @@ def get_xpub_addresses(
         :param address: Filter by a specific address in the xpub
         """
         r = requests.get(
-            'https://api.mattercloud.net/api/v3/{self.network}/xpub/{xpub}/addrs'.format(self.network, xpub),
+            'https://api.mattercloud.net/api/v3/{}/xpub/{}/addrs'.format(self.network, xpub),
             params={
                 'offset': offset,
                 'limit': limit,
@@ -393,7 +397,7 @@ def update_webhook_monitored_addresses(self, address):
         return r.json()
 
 
-class BitIndex3MainNet(BitIndex3):
+class MatterCloudMainNet(MatterCloud):
     """
     Implements version 3 of the BitIndex API using the mainnet network
     """
@@ -402,7 +406,7 @@ def __init__(self, *args, **kwargs):
         return super().__init__(*args, **kwargs, network='main')
 
 
-class BitIndex3TestNet(BitIndex3):
+class MatterCloudTestNet(MatterCloud):
     """
     Implements version 3 of the BitIndex API using the testnet network
     """
@@ -411,7 +415,7 @@ def __init__(self, *args, **kwargs):
         return super().__init__(*args, **kwargs, network='test')
 
 
-class BitIndex3STN(BitIndex3):
+class MatterCloudSTN(MatterCloud):
     """
     Implements version 3 of the BitIndex API using the STN network
     """

bitsv/network/services/network.py

@@ -1,3 +1,4 @@
+import os
 from functools import wraps
 
 import requests
@@ -7,7 +8,7 @@
 
 from .whatsonchain import WhatsonchainNormalised
 
-from .bitindex3 import BitIndex3
+from .mattercloud import MatterCloud, MATTERCLOUD_API_KEY_VARNAME
 from .bchsvexplorer import BCHSVExplorerAPI
 
 DEFAULT_TIMEOUT = 30
@@ -77,21 +78,24 @@ def __init__(self, network):
         self.network = network
 
         # Instantiate Normalized apis
-        self.bitindex3 = BitIndex3(api_key=None, network=self.network)
         self.bchsvexplorer = BCHSVExplorerAPI  # classmethods, mainnet only
         self.whatsonchain = WhatsonchainNormalised(network=self.network)
 
         # Allows extra apis for 'main' that may not support testnet (e.g. blockchair)
         if network == 'main':
-            self.list_of_apis = collections.deque([self.whatsonchain, self.bitindex3,
-                                                   self.bchsvexplorer])
+            self.list_of_apis = collections.deque([self.whatsonchain, self.bchsvexplorer])
         elif network == 'test':
-            self.list_of_apis = collections.deque([self.whatsonchain, self.bitindex3])
+            self.list_of_apis = collections.deque([self.whatsonchain])
         elif network == 'stn':
-            self.list_of_apis = collections.deque([self.whatsonchain, self.bitindex3])
+            self.list_of_apis = collections.deque([self.whatsonchain])
         else:
             raise ValueError("network must be either 'main', 'test' or 'stn'")
 
+        mattercloud_api_key = os.environ.get(MATTERCLOUD_API_KEY_VARNAME, None)
+        if mattercloud_api_key:
+            self.bitindex3 = MatterCloud(api_key=mattercloud_api_key, network=self.network)
+            self.list_of_apis.appendleft(self.bitindex3)
+
     @retry_annotation(IGNORED_ERRORS, tries=DEFAULT_RETRY)
     def retry_wrapper_call(self, api_call, param):
         return api_call(param)

bitsv/network/services/whatsonchain.py

@@ -31,7 +31,7 @@ def woc_utxos_to_unspents(woc_utxos, block_height):
                     txid=utxo['tx_hash'],
                     txindex=utxo['tx_pos'])
         utxos.append(u)
-    return utxos
+    return sorted(utxos, key=lambda utxo: (-utxo.confirmations, utxo.amount))
 
 
 class WhatsonchainNormalised(Whatsonchain):