bitcoinwatcher 1.0.1__tar.gz → 1.1.0__tar.gz

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bitcoinwatcher
-Version: 1.0.1
+Version: 1.1.0
 Summary: bitcoinwatcher is a Python library that implements a ZMQ subscriber and provides abstractions to build custom address watchers. This library is designed to make it easy for developers to monitor Bitcoin addresses and react to changes in their state.
 Author: twosatsmaxi
 License:                                  Apache License
@@ -227,6 +227,7 @@ Requires-Dist: six==1.16.0
 Requires-Dist: urllib3==2.2.1
 Requires-Dist: bitcoinlib==0.6.14
 Requires-Dist: ordipool==1.2.0
+Requires-Dist: python-bitcoinrpc==1.0
 
 # bitcoinwatcher
 

bitcoinwatcher-1.1.0/bitcoin/address_listener/address_listener.py

@@ -0,0 +1,51 @@
+import os
+from abc import ABC, abstractmethod
+
+from bitcoinlib.transactions import Transaction
+from ordipool.ordipool.mempoolio import Mempool
+
+from bitcoin.models.address_tx_data import AddressTxData
+from bitcoin.tx_listener.abstract_tx_listener import AbstractTxListener
+from bitcoin.utils.constants import default_host
+from bitcoin.utils.tx_address_data_extractor import DefaultTxAddressDataExtractor, MempoolTxAddressDataExtractor
+
+
+class AbstractAddressListener(AbstractTxListener, ABC):
+    DECIMAL_SCALE = 5
+    host = os.environ.get("RPC_HOST", default_host)
+    base_url = f"http://{host}:3006/api"
+    mempool = Mempool(base_url=base_url)
+    default_tx_extractor = DefaultTxAddressDataExtractor()
+    mempool_tx_extractor = MempoolTxAddressDataExtractor(mempool)
+
+    def __init__(self, addresses_to_listen: {str}):
+        self.addresses_to_listen = addresses_to_listen
+
+    @abstractmethod
+    def consume(self, subscribed_address, address_tx_data: [AddressTxData]):
+        pass
+
+    def filter_address_tx_data(self, address_tx_data: [AddressTxData]) -> [str]:
+        filtered_address_tx_data = list(filter(lambda x: x.address in self.addresses_to_listen and x.address != "",
+                                               address_tx_data))
+        # get all address
+        return list(set((map(lambda x: x.address, filtered_address_tx_data))))
+
+    def on_tx(self, tx: Transaction):
+        # get all address in the inputs and outputs along with the amount
+        if tx.coinbase:
+            return
+        address_tx_data = self.default_tx_extractor.extract(tx)
+        # filter the address we are interested in
+        addresses_for_events = self.filter_address_tx_data(address_tx_data)
+        if len(addresses_for_events) == 0:
+            return
+        # get the address tx data from mempool for full details if any address matches
+        try:
+            address_tx_data = self.mempool_tx_extractor.extract(tx)
+        except Exception as e:
+            print(f"Error in getting mempool tx data, taking defaults: {e}")
+            address_tx_data = address_tx_data
+
+        for address in addresses_for_events:
+            self.consume(subscribed_address=address, address_tx_data=address_tx_data)

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/bitcoin/address_listener/simple_address_listener.py

@@ -1,4 +1,5 @@
-from bitcoin.address_listener.address_listener import AbstractAddressListener, AddressTxData, AddressTxType
+from bitcoin.address_listener.address_listener import AbstractAddressListener, AddressTxData
+from bitcoin.models.address_tx_data import AddressTxType
 from bitcoin.tx_listener.zmq_listener import ZMQTXListener
 
 
@@ -11,6 +12,7 @@ class SimpleAddressListener(AbstractAddressListener):
                                 address_tx_data))
         total_amount_in_input = sum(map(lambda x: x.amount_in_btc(), all_input))
         # scale ito 4 decimal places
+        print("Transaction status: ", address_tx_data[0].tx_status)
         total_amount_in_output = round(total_amount_in_output, self.DECIMAL_SCALE)
         print(f"Address {subscribed_address} received {total_amount_in_output} BTC in tx {address_tx_data[0].tx_id}")
         print(f"Address {subscribed_address} spent {total_amount_in_input} BTC in tx {address_tx_data[0].tx_id}")

bitcoinwatcher-1.1.0/bitcoin/models/address_tx_data.py

@@ -0,0 +1,36 @@
+import dataclasses
+from enum import Enum
+
+
+class AddressTxType(Enum):
+    INPUT = "input"
+    OUTPUT = "output"
+
+
+class AddressTxSource(Enum):
+    MEMPOOL = "mempool"
+    DEFAULT = "default"
+
+
+class TransactionStatus(Enum):
+    UNCONFIRMED = "unconfirmed"
+    CONFIRMED = "confirmed"
+
+
+@dataclasses.dataclass
+class AddressTxData:
+    tx_id: str
+    address: str
+    type: AddressTxType
+    # figure out the way to get amount in vin
+    _amount: int = 0
+    tx_status: str = "unconfirmed"
+
+
+    def get_amount(self):
+        return self._amount
+
+    def amount_in_btc(self):
+        if self.type == AddressTxType.INPUT:
+            return "Amount is not supported for input type, yet"
+        return self._amount / 100000000

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/bitcoin/tests/test_address_listener.py

@@ -1,10 +1,12 @@
 from unittest import TestCase
 
-from bitcoin.address_listener.address_listener import AbstractAddressListener, AddressTxData, AddressTxType
+from bitcoin.address_listener.address_listener import AbstractAddressListener, AddressTxData
+from bitcoin.models.address_tx_data import AddressTxType
 
 
 class DummyAddressListener(AbstractAddressListener):
-    def consume(self, address_tx_data):
+
+    def consume(self, subscribed_address, address_tx_data: [AddressTxData]):
         pass
 
     def __init__(self, address_to_listen: [str]):

bitcoinwatcher-1.1.0/bitcoin/utils/benchmark.py

@@ -0,0 +1,33 @@
+# benchmark between mempool and bitcoinrcp get transaction info
+import os
+import time
+import requests
+from ordipool.ordipool.mempoolio import Mempool
+
+from bitcoin.utils.bitcoin_rpc import BitcoinRPC
+from bitcoin.utils.constants import default_host
+
+host = os.environ.get("RPC_HOST", default_host)
+base_url = f"http://{host}:3006/api"
+
+mempool = Mempool(base_url)
+bitcoinrpc = BitcoinRPC()
+
+if __name__ == '__main__':
+
+    txid = 'a6293e898b056fbea0329d071b1b237e4449ff464cdbc7a9ed8a770b97aafd4c'
+    times = 1000
+    start = time.time()
+    print("mempool starting")
+    for i in range(times):
+        print(i)
+        mempool.get_transaction(txid)
+    end = time.time()
+    print(f"mempool took: {end - start}")
+
+    start = time.time()
+    for i in range(times):
+        bitcoinrpc.get_transaction(txid)
+    end = time.time()
+    print(f"bitcoinrpc took: {end - start}")
+

bitcoinwatcher-1.1.0/bitcoin/utils/bitcoin_rpc.py

@@ -0,0 +1,31 @@
+import os
+
+from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
+
+from bitcoin.utils.constants import default_host
+
+
+class BitcoinRPC:
+    rpc_user = os.environ.get("RPC_USER")
+    rpc_password = os.environ.get("RPC_PASSWORD")
+    rpc_host = os.environ.get("RPC_HOST", default_host)
+    rpc_port = os.environ.get("RPC_PORT", 8332)
+    rpc_connection: AuthServiceProxy
+
+    def __init__(self):
+        rpc_string = f"http://{self.rpc_user}:{self.rpc_password}@{self.rpc_host}:{self.rpc_port}"
+        print("rpc_string: ", rpc_string)
+        self.rpc_connection = AuthServiceProxy(rpc_string)
+
+    def get_transaction(self, txid: str) -> dict:
+        return self.rpc_connection.getrawtransaction(txid, True)
+
+
+if __name__ == '__main__':
+    rpc = BitcoinRPC()
+    txid = 'a6293e898b056fbea0329d071b1b237e4449ff464cdbc7a9ed8a770b97aafd4c'
+    try:
+        transaction = rpc.get_transaction(txid)
+        print(transaction)
+    except JSONRPCException as e:
+        print(f"An error occurred: {e}")

bitcoinwatcher-1.1.0/bitcoin/utils/tx_address_data_extractor.py

@@ -0,0 +1,70 @@
+from abc import ABC, abstractmethod
+
+from bitcoinlib.transactions import Transaction
+from ordipool.ordipool.mempoolio import Mempool
+
+from bitcoin.address_listener.address_listener import AddressTxData
+from bitcoin.models.address_tx_data import AddressTxType, TransactionStatus
+
+
+class AbstractTxAddressDataExtractor(ABC):
+    @abstractmethod
+    def extract(self, tx: Transaction) -> [AddressTxData]:
+        pass
+
+
+class MempoolTxAddressDataExtractor(AbstractTxAddressDataExtractor):
+    mempool: Mempool
+
+    def __init__(self, mempool: Mempool):
+        self.mempool = mempool
+
+    def extract(self, tx: Transaction) -> [AddressTxData]:
+        outputs = tx.outputs
+        tx_id = tx.txid
+        tx = self.mempool.get_transaction(tx_id)
+        tx_status = TransactionStatus.CONFIRMED if tx.confirmed else TransactionStatus.UNCONFIRMED
+        address_tx_data = []
+        # getting inputs data separately from mempool
+        # as current library doesn't provide rich data like previous outputs and its value
+        for vin in tx.vins:
+            address = vin.prev_out.address
+            amount = vin.prev_out.value
+            address_tx_data.append(AddressTxData(tx_status=tx_status.value,
+                                                 address=address,
+                                                 type=AddressTxType.INPUT,
+                                                 _amount=amount,
+                                                 tx_id=tx_id))
+        for output in outputs:
+            amount = output.value
+            address_tx_data.append(AddressTxData(tx_status=tx_status.value,
+                                                 address=output.address,
+                                                 _amount=amount,
+                                                 type=AddressTxType.OUTPUT,
+                                                 tx_id=tx_id))
+
+        return address_tx_data
+
+
+class DefaultTxAddressDataExtractor(AbstractTxAddressDataExtractor):
+    def extract(self, tx: Transaction) -> [AddressTxData]:
+        outputs = tx.outputs
+        address_tx_data = []
+        inputs = tx.inputs
+        tx_status = tx.status
+        for input in inputs:
+            address = input.address
+            amount = 0
+            address_tx_data.append(AddressTxData(tx_status=tx_status,
+                                                 address=address,
+                                                 type=AddressTxType.INPUT,
+                                                 _amount=amount,
+                                                 tx_id=tx.txid))
+        for output in outputs:
+            amount = output.value
+            address_tx_data.append(AddressTxData(tx_status=tx_status,
+                                                 address=output.address,
+                                                 _amount=amount,
+                                                 type=AddressTxType.OUTPUT,
+                                                 tx_id=tx.txid))
+        return address_tx_data

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/bitcoinwatcher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bitcoinwatcher
-Version: 1.0.1
+Version: 1.1.0
 Summary: bitcoinwatcher is a Python library that implements a ZMQ subscriber and provides abstractions to build custom address watchers. This library is designed to make it easy for developers to monitor Bitcoin addresses and react to changes in their state.
 Author: twosatsmaxi
 License:                                  Apache License
@@ -227,6 +227,7 @@ Requires-Dist: six==1.16.0
 Requires-Dist: urllib3==2.2.1
 Requires-Dist: bitcoinlib==0.6.14
 Requires-Dist: ordipool==1.2.0
+Requires-Dist: python-bitcoinrpc==1.0
 
 # bitcoinwatcher
 

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/bitcoinwatcher.egg-info/SOURCES.txt

@@ -5,15 +5,20 @@ bitcoin/__init__.py
 bitcoin/address_listener/__init__.py
 bitcoin/address_listener/address_listener.py
 bitcoin/address_listener/simple_address_listener.py
+bitcoin/models/__init__.py
+bitcoin/models/address_tx_data.py
 bitcoin/tests/__init__.py
 bitcoin/tests/test_address_listener.py
 bitcoin/tx_listener/__init__.py
 bitcoin/tx_listener/abstract_tx_listener.py
 bitcoin/tx_listener/zmq_listener.py
 bitcoin/utils/__init__.py
+bitcoin/utils/benchmark.py
+bitcoin/utils/bitcoin_rpc.py
 bitcoin/utils/bitcoin_utils.py
 bitcoin/utils/constants.py
 bitcoin/utils/inscription_utils.py
+bitcoin/utils/tx_address_data_extractor.py
 bitcoinwatcher.egg-info/PKG-INFO
 bitcoinwatcher.egg-info/SOURCES.txt
 bitcoinwatcher.egg-info/dependency_links.txt

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/bitcoinwatcher.egg-info/requires.txt

@@ -8,3 +8,4 @@ six==1.16.0
 urllib3==2.2.1
 bitcoinlib==0.6.14
 ordipool==1.2.0
+python-bitcoinrpc==1.0

{bitcoinwatcher-1.0.1 → bitcoinwatcher-1.1.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bitcoinwatcher"
-version = "1.0.1"
+version = "1.1.0"
 description = "bitcoinwatcher is a Python library that implements a ZMQ subscriber and provides abstractions to build custom address watchers. This library is designed to make it easy for developers to monitor Bitcoin addresses and react to changes in their state."
 readme = "README.md"
 authors = [{name = "twosatsmaxi"}]
@@ -32,7 +32,8 @@ dependencies = [
     "six==1.16.0",
     "urllib3==2.2.1",
     "bitcoinlib==0.6.14",
-    "ordipool==1.2.0"
+    "ordipool==1.2.0",
+    "python-bitcoinrpc==1.0",
 ]
 requires-python = ">=3.10"
 [project.urls]

bitcoinwatcher-1.0.1/bitcoin/address_listener/address_listener.py

@@ -1,81 +0,0 @@
-import dataclasses
-import os
-from abc import ABC, abstractmethod
-from enum import Enum
-
-from bitcoinlib.transactions import Transaction
-from ordipool.ordipool.mempoolio import Mempool
-
-from bitcoin.tx_listener.abstract_tx_listener import AbstractTxListener
-from bitcoin.utils.constants import default_host
-
-
-class AddressTxType(Enum):
-    INPUT = "input"
-    OUTPUT = "output"
-
-
-@dataclasses.dataclass
-class AddressTxData:
-    tx_id: str
-    address: str
-    type: AddressTxType
-    # figure out the way to get amount in vin
-    _amount: int = 0
-
-    def get_amount(self):
-        return self._amount
-
-    def amount_in_btc(self):
-        if self.type == AddressTxType.INPUT:
-            return "Amount is not supported for input type, yet"
-        return self._amount / 100000000
-
-
-class AbstractAddressListener(AbstractTxListener, ABC):
-    DECIMAL_SCALE = 5
-    host = os.environ.get("RPC_HOST", default_host)
-    base_url = f"http://{host}:3006/api"
-    mempool = Mempool(base_url=base_url)
-
-    def __init__(self, addresses_to_listen: {str}):
-        self.addresses_to_listen = addresses_to_listen
-
-    @abstractmethod
-    def consume(self, subscribed_address, address_tx_data: [AddressTxData]):
-        pass
-
-    def filter_address_tx_data(self, address_tx_data: [AddressTxData]) -> [str]:
-        filtered_address_tx_data = list(filter(lambda x: x.address in self.addresses_to_listen and x.address != "",
-                                               address_tx_data))
-        # get all address
-        return list(set((map(lambda x: x.address, filtered_address_tx_data))))
-
-    def on_tx(self, tx: Transaction):
-        # get all address in the inputs and outputs along with the amount
-        if tx.coinbase:
-            return
-        outputs = tx.outputs
-        tx_id = tx.txid
-        tx = self.mempool.get_transaction(tx_id)
-        address_tx_data = []
-        # getting inputs data separately from mempool
-        # as current library doesn't provide rich data like previous outputs and its value
-        for input in tx.vins:
-            address = input.prev_out.address
-            amount = input.prev_out.value
-            address_tx_data.append(AddressTxData(address=address,
-                                                 type=AddressTxType.INPUT,
-                                                 _amount=amount,
-                                                 tx_id=tx_id))
-        for output in outputs:
-            amount = output.value
-            address_tx_data.append(AddressTxData(address=output.address,
-                                                 _amount=amount,
-                                                 type=AddressTxType.OUTPUT,
-                                                 tx_id=tx_id))
-
-        # filter the address we are interested in
-        addresses_for_events = self.filter_address_tx_data(address_tx_data)
-        for address in addresses_for_events:
-            self.consume(subscribed_address=address, address_tx_data=address_tx_data)