blockapi 2.4.0__tar.gz → 2.5.0__tar.gz

{blockapi-2.4.0 → blockapi-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blockapi
-Version: 2.4.0
+Version: 2.5.0
 Summary: BlockAPI library
 Home-page: https://github.com/crypkit/blockapi
 Author: Devmons s.r.o.
@@ -21,6 +21,7 @@ Requires-Dist: pytest-vcr
 Requires-Dist: requests_mock>=1.9.3
 Requires-Dist: attrs<23.0.0,>=17.4.0
 Requires-Dist: solders>=0.22.0
+Requires-Dist: base58>=2.1.0
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type

blockapi-2.5.0/blockapi/test/v2/api/test_blockchain_info.py

@@ -0,0 +1,129 @@
+from decimal import Decimal
+
+import pytest
+
+from blockapi.test.v2.api.conftest import read_file
+
+# noinspection SpellCheckingInspection
+btc_test_address = '35hK24tcLEWcgNA4JxpvbkNkoAcDGqQPsP'
+# noinspection SpellCheckingInspection
+xpub_test_address = 'xpub6CUGRUonZSQ4TWtTMmzXdrXDtypWKiKrhko4egpiMZbpiaQL2jkwSB1icqYh2cfDfVxdx4df189oLKnC5fSwqPfgyP3hooxujYzAu3fDVmz'
+from blockapi.v2.api import BlockchainInfoApi
+from blockapi.v2.base import ApiException
+from blockapi.v2.models import FetchResult
+
+
+def test_fetch_balances(requests_mock, blockchain_info_balance_response):
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        text=blockchain_info_balance_response,
+    )
+
+    api = BlockchainInfoApi()
+    balances = api.get_balance(btc_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('0.00064363')
+
+
+def test_fetch_balances_xpub(requests_mock, blockchain_info_xpub_response):
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        text=blockchain_info_xpub_response,
+    )
+
+    api = BlockchainInfoApi()
+    balances = api.get_balance(xpub_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('0.12706308')
+
+
+def test_fetch_only(requests_mock, blockchain_info_balance_response):
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        text=blockchain_info_balance_response,
+    )
+
+    api = BlockchainInfoApi()
+    result = api.fetch_balances(btc_test_address)
+    assert result.data['wallet']['final_balance'] == 64363
+
+
+def test_parse_only():
+    api = BlockchainInfoApi()
+    fetch_result = FetchResult(data={'wallet': {'final_balance': 64363}})
+    result = api.parse_balances(fetch_result)
+    assert result.data[0].balance == Decimal('0.00064363')
+
+
+def test_parse_zero_balance():
+    api = BlockchainInfoApi()
+    fetch_result = FetchResult(data={'wallet': {'final_balance': 0}})
+    result = api.parse_balances(fetch_result)
+    assert result.data is None
+
+
+def test_parse_empty_wallet():
+    api = BlockchainInfoApi()
+    fetch_result = FetchResult(data={'wallet': {}})
+    result = api.parse_balances(fetch_result)
+    assert result.data is None
+
+
+def test_fetch_invalid_address(requests_mock):
+    invalid_address = 'not-a-valid-btc-address'
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        status_code=400,
+        reason='Bad Request',
+    )
+
+    api = BlockchainInfoApi()
+    result = api.fetch_balances(invalid_address)
+    assert result.errors == ['Bad Request']
+
+
+def test_get_balance_invalid_address_should_raise(requests_mock):
+    invalid_address = 'not-a-valid-btc-address'
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        status_code=400,
+        reason='Bad Request',
+    )
+
+    api = BlockchainInfoApi()
+    with pytest.raises(ApiException, match='Bad Request'):
+        api.get_balance(invalid_address)
+
+
+def test_fetch_error_response(requests_mock):
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        status_code=500,
+        reason='Internal Server Error',
+    )
+
+    api = BlockchainInfoApi()
+    result = api.fetch_balances(btc_test_address)
+    assert result.errors == ['Internal Server Error']
+
+
+def test_get_balance_should_raise(requests_mock):
+    requests_mock.get(
+        'https://blockchain.info/multiaddr',
+        status_code=500,
+        reason='Internal Server Error',
+    )
+
+    api = BlockchainInfoApi()
+    with pytest.raises(ApiException, match='Internal Server Error'):
+        api.get_balance(btc_test_address)
+
+
+@pytest.fixture
+def blockchain_info_balance_response():
+    return read_file('data/blockchain_info_balance_response.json')
+
+
+@pytest.fixture
+def blockchain_info_xpub_response():
+    return read_file('data/blockchain_info_xpub_response.json')

blockapi-2.5.0/blockapi/test/v2/api/test_haskoin.py

@@ -0,0 +1,182 @@
+from decimal import Decimal
+
+import pytest
+
+from blockapi.test.v2.api.conftest import read_file
+from blockapi.v2.api.haskoin import HaskoinApi, _to_xpub
+from blockapi.v2.base import ApiException
+from blockapi.v2.models import FetchResult
+
+# noinspection SpellCheckingInspection
+btc_test_address = '35hK24tcLEWcgNA4JxpvbkNkoAcDGqQPsP'
+# noinspection SpellCheckingInspection
+xpub_test_address = 'xpub6CUGRUonZSQ4TWtTMmzXdrXDtypWKiKrhko4egpiMZbpiaQL2jkwSB1icqYh2cfDfVxdx4df189oLKnC5fSwqPfgyP3hooxujYzAu3fDVmz'
+# noinspection SpellCheckingInspection
+# ypub/zpub derived from xpub_test_address by swapping version bytes
+ypub_test_address = 'ypub6XJXj9Uhi7wYJp5aC8n9qwcj4wxxGLKMcsKHS5ibjZyhmgDZHPvW4Efre3WH2XK9595ShYEDTnWMDcPkoMrxddMHqik8PinQ1H3pHbCYAtS'
+# noinspection SpellCheckingInspection
+zpub_test_address = 'zpub6r8o2p9croV2A7Gh2VZn42iEEv7QCxJrXyqWDUcV7aMapn2nY464gJKzfFTs2Ry4UnCFT1pmvSru6u1KX4GyRs2ti4SYydbtH17Tg8wL57f'
+
+
+def test_fetch_balances(requests_mock, haskoin_balance_response):
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/address/{btc_test_address}/balance',
+        text=haskoin_balance_response,
+    )
+
+    api = HaskoinApi()
+    balances = api.get_balance(btc_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('0.00064363')
+
+
+def test_fetch_balances_xpub(requests_mock, haskoin_xpub_response):
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/xpub/{xpub_test_address}',
+        text=haskoin_xpub_response,
+    )
+
+    api = HaskoinApi()
+    balances = api.get_balance(xpub_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('0.12706308')
+
+
+def test_fetch_only(requests_mock, haskoin_balance_response):
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/address/{btc_test_address}/balance',
+        text=haskoin_balance_response,
+    )
+
+    api = HaskoinApi()
+    result = api.fetch_balances(btc_test_address)
+    assert result.data['confirmed'] == 64363
+
+
+def test_parse_address():
+    api = HaskoinApi()
+    fetch_result = FetchResult(data={'confirmed': 64363})
+    result = api.parse_balances(fetch_result)
+    assert result.data[0].balance == Decimal('0.00064363')
+
+
+def test_parse_xpub():
+    api = HaskoinApi()
+    fetch_result = FetchResult(data={'balance': {'confirmed': 12706308}, 'indices': {}})
+    result = api.parse_balances(fetch_result)
+    assert result.data[0].balance == Decimal('0.12706308')
+
+
+def test_fetch_balances_ypub(requests_mock, haskoin_xpub_response):
+    converted_xpub = _to_xpub(ypub_test_address)
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/xpub/{converted_xpub}',
+        text=haskoin_xpub_response,
+    )
+
+    api = HaskoinApi()
+    balances = api.get_balance(ypub_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('0.12706308')
+
+    # Verify derive=compat was passed
+    assert requests_mock.last_request.qs['derive'] == ['compat']
+
+
+def test_fetch_balances_zpub(requests_mock, haskoin_xpub_response):
+    converted_xpub = _to_xpub(zpub_test_address)
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/xpub/{converted_xpub}',
+        text=haskoin_xpub_response,
+    )
+
+    api = HaskoinApi()
+    balances = api.get_balance(zpub_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('0.12706308')
+
+    # Verify derive=segwit was passed
+    assert requests_mock.last_request.qs['derive'] == ['segwit']
+
+
+def test_to_xpub_roundtrip():
+    """ypub/zpub converted to xpub should start with 'xpub' and be valid base58."""
+    converted = _to_xpub(ypub_test_address)
+    assert converted.startswith('xpub')
+
+    converted = _to_xpub(zpub_test_address)
+    assert converted.startswith('xpub')
+
+
+def test_parse_zero_balance_address():
+    api = HaskoinApi()
+    fetch_result = FetchResult(data={'confirmed': 0})
+    result = api.parse_balances(fetch_result)
+    assert result.data is None
+
+
+def test_parse_zero_balance_xpub():
+    api = HaskoinApi()
+    fetch_result = FetchResult(data={'balance': {'confirmed': 0}, 'indices': {}})
+    result = api.parse_balances(fetch_result)
+    assert result.data is None
+
+
+def test_fetch_invalid_address(requests_mock):
+    invalid_address = 'not-a-valid-btc-address'
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/address/{invalid_address}/balance',
+        status_code=400,
+        reason='Bad Request',
+    )
+
+    api = HaskoinApi()
+    result = api.fetch_balances(invalid_address)
+    assert result.errors == ['Bad Request']
+
+
+def test_get_balance_invalid_address_should_raise(requests_mock):
+    invalid_address = 'not-a-valid-btc-address'
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/address/{invalid_address}/balance',
+        status_code=400,
+        reason='Bad Request',
+    )
+
+    api = HaskoinApi()
+    with pytest.raises(ApiException, match='Bad Request'):
+        api.get_balance(invalid_address)
+
+
+def test_fetch_error_response(requests_mock):
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/address/{btc_test_address}/balance',
+        status_code=500,
+        reason='Internal Server Error',
+    )
+
+    api = HaskoinApi()
+    result = api.fetch_balances(btc_test_address)
+    assert result.errors == ['Internal Server Error']
+
+
+def test_get_balance_should_raise(requests_mock):
+    requests_mock.get(
+        f'https://api.haskoin.com/btc/address/{btc_test_address}/balance',
+        status_code=500,
+        reason='Internal Server Error',
+    )
+
+    api = HaskoinApi()
+    with pytest.raises(ApiException, match='Internal Server Error'):
+        api.get_balance(btc_test_address)
+
+
+@pytest.fixture
+def haskoin_balance_response():
+    return read_file('data/haskoin_balance_response.json')
+
+
+@pytest.fixture
+def haskoin_xpub_response():
+    return read_file('data/haskoin_xpub_response.json')

{blockapi-2.4.0 → blockapi-2.5.0}/blockapi/v2/api/__init__.py

@@ -1,3 +1,4 @@
+from blockapi.v2.api.blockchain_info import BlockchainInfoApi
 from blockapi.v2.api.blockchainos import BlockchainosApi
 from blockapi.v2.api.blockchair import (
     BlockchairApi,
@@ -7,6 +8,7 @@ from blockapi.v2.api.blockchair import (
 )
 from blockapi.v2.api.debank import DebankApi, DebankApp, DebankPrediction
 from blockapi.v2.api.ethplorer import EthplorerApi
+from blockapi.v2.api.haskoin import HaskoinApi
 from blockapi.v2.api.optimistic_etherscan import OptimismEtherscanApi
 from blockapi.v2.api.perpetual import PerpetualApi, perp_contract_address
 from blockapi.v2.api.solana import SolanaApi, SolscanApi

blockapi-2.5.0/blockapi/v2/api/blockchain_info.py

@@ -0,0 +1,67 @@
+from blockapi.v2.base import BalanceMixin, BlockchainApi
+from blockapi.v2.coins import COIN_BTC
+from blockapi.v2.models import (
+    ApiOptions,
+    AssetType,
+    BalanceItem,
+    Blockchain,
+    FetchResult,
+    ParseResult,
+)
+
+
+class BlockchainInfoApi(BlockchainApi, BalanceMixin):
+    """
+    Coin: Bitcoin
+    API docs: https://www.blockchain.com/explorer/api/blockchain_api
+    Explorer: https://www.blockchain.com/explorer
+    """
+
+    coin = COIN_BTC
+    api_options = ApiOptions(
+        blockchain=Blockchain.BITCOIN,
+        base_url='https://blockchain.info',
+        rate_limit=0.2,
+    )
+
+    supported_requests = {
+        'get_balance': '/multiaddr',
+    }
+
+    def fetch_balances(self, address: str) -> FetchResult:
+        return self.get_data(
+            'get_balance',
+            params={'active': address, 'n': 0},
+        )
+
+    def parse_balances(self, fetch_result: FetchResult) -> ParseResult:
+        """Parse balance from blockchain.info ``/multiaddr`` response.
+
+        Note: ``final_balance`` includes **unconfirmed** transactions (0-conf)
+        and may therefore be higher than balances reported by Trezor/Blockbook
+        or Haskoin for high-activity addresses.  There is no blockchain.info
+        endpoint that reliably returns confirmed-only balance (the ``/unspent``
+        endpoint supports ``confirmations=1`` but is capped at 1 000 UTXOs
+        with broken pagination).
+        """
+        if not fetch_result.data:
+            return ParseResult()
+
+        wallet = fetch_result.data.get('wallet', {})
+        if not wallet:
+            return ParseResult()
+
+        balance_raw = wallet.get('final_balance')
+        if not balance_raw:
+            return ParseResult()
+
+        balances = [
+            BalanceItem.from_api(
+                balance_raw=balance_raw,
+                coin=self.coin,
+                asset_type=AssetType.AVAILABLE,
+                raw=fetch_result.data,
+            )
+        ]
+
+        return ParseResult(data=balances)

blockapi-2.5.0/blockapi/v2/api/haskoin.py

@@ -0,0 +1,94 @@
+import base58
+
+from blockapi.v2.base import BalanceMixin, BlockchainApi
+from blockapi.v2.coins import COIN_BTC
+from blockapi.v2.models import (
+    ApiOptions,
+    AssetType,
+    BalanceItem,
+    Blockchain,
+    FetchResult,
+    ParseResult,
+)
+
+# Version bytes for extended public keys (BIP32)
+_XPUB_VERSION = bytes.fromhex('0488B21E')
+_YPUB_VERSION = bytes.fromhex('049D7CB2')
+_ZPUB_VERSION = bytes.fromhex('04B24746')
+
+# Haskoin derive param: ypub -> compat (P2SH), zpub -> segwit (P2WPKH)
+_DERIVE_TYPES = {
+    'ypub': 'compat',
+    'zpub': 'segwit',
+}
+
+
+def _to_xpub(key: str) -> str:
+    """Convert ypub/zpub to xpub by replacing version bytes."""
+    decoded = base58.b58decode_check(key)
+    return base58.b58encode_check(_XPUB_VERSION + decoded[4:]).decode()
+
+
+class HaskoinApi(BlockchainApi, BalanceMixin):
+    """
+    Coin: Bitcoin
+    API docs: https://api.haskoin.com/
+    Source: https://github.com/jprupp/haskoin-store
+
+    Supports xpub, ypub (BIP49, P2SH-segwit), and zpub (BIP84, native segwit).
+    ypub/zpub are converted to xpub and passed with the appropriate derive param.
+    """
+
+    coin = COIN_BTC
+    api_options = ApiOptions(
+        blockchain=Blockchain.BITCOIN,
+        base_url='https://api.haskoin.com/btc/',
+        rate_limit=0.2,
+    )
+
+    supported_requests = {
+        'get_balance': 'address/{address}/balance',
+        'get_balance_xpub': 'xpub/{address}',
+    }
+
+    def fetch_balances(self, address: str) -> FetchResult:
+        prefix = address[:4]
+        derive = _DERIVE_TYPES.get(prefix)
+
+        if derive:
+            xpub = _to_xpub(address)
+            return self.get_data(
+                'get_balance_xpub',
+                params={'derive': derive},
+                address=xpub,
+            )
+
+        if prefix == 'xpub':
+            return self.get_data('get_balance_xpub', address=address)
+
+        return self.get_data('get_balance', address=address)
+
+    def parse_balances(self, fetch_result: FetchResult) -> ParseResult:
+        if not fetch_result.data:
+            return ParseResult()
+
+        # xpub response: {"balance": {"confirmed": ...}, "indices": {...}}
+        # address response: {"address": ..., "confirmed": ..., ...}
+        if 'balance' in fetch_result.data:
+            balance_raw = fetch_result.data['balance'].get('confirmed')
+        else:
+            balance_raw = fetch_result.data.get('confirmed')
+
+        if not balance_raw:
+            return ParseResult()
+
+        balances = [
+            BalanceItem.from_api(
+                balance_raw=balance_raw,
+                coin=self.coin,
+                asset_type=AssetType.AVAILABLE,
+                raw=fetch_result.data,
+            )
+        ]
+
+        return ParseResult(data=balances)

{blockapi-2.4.0 → blockapi-2.5.0}/blockapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blockapi
-Version: 2.4.0
+Version: 2.5.0
 Summary: BlockAPI library
 Home-page: https://github.com/crypkit/blockapi
 Author: Devmons s.r.o.
@@ -21,6 +21,7 @@ Requires-Dist: pytest-vcr
 Requires-Dist: requests_mock>=1.9.3
 Requires-Dist: attrs<23.0.0,>=17.4.0
 Requires-Dist: solders>=0.22.0
+Requires-Dist: base58>=2.1.0
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type

{blockapi-2.4.0 → blockapi-2.5.0}/blockapi.egg-info/SOURCES.txt

@@ -26,12 +26,14 @@ blockapi/test/v2/test_models.py
 blockapi/test/v2/api/__init__.py
 blockapi/test/v2/api/conftest.py
 blockapi/test/v2/api/fake_sleep_provider.py
+blockapi/test/v2/api/test_blockchain_info.py
 blockapi/test/v2/api/test_blockchainos.py
 blockapi/test/v2/api/test_blockchair_btc.py
 blockapi/test/v2/api/test_blockchair_doge.py
 blockapi/test/v2/api/test_blockchair_ltc.py
 blockapi/test/v2/api/test_cosmos.py
 blockapi/test/v2/api/test_ethplorer.py
+blockapi/test/v2/api/test_haskoin.py
 blockapi/test/v2/api/test_multisources.py
 blockapi/test/v2/api/test_optimistic_etherscan.py
 blockapi/test/v2/api/test_solana.py
@@ -62,12 +64,14 @@ blockapi/v2/coin_mapping.py
 blockapi/v2/coins.py
 blockapi/v2/models.py
 blockapi/v2/api/__init__.py
+blockapi/v2/api/blockchain_info.py
 blockapi/v2/api/blockchainos.py
 blockapi/v2/api/blockchair.py
 blockapi/v2/api/cosmos.py
 blockapi/v2/api/debank.py
 blockapi/v2/api/debank_maps.py
 blockapi/v2/api/ethplorer.py
+blockapi/v2/api/haskoin.py
 blockapi/v2/api/optimistic_etherscan.py
 blockapi/v2/api/solana.py
 blockapi/v2/api/subscan.py

{blockapi-2.4.0 → blockapi-2.5.0}/blockapi.egg-info/requires.txt

@@ -12,3 +12,4 @@ pytest-vcr
 requests_mock>=1.9.3
 attrs<23.0.0,>=17.4.0
 solders>=0.22.0
+base58>=2.1.0

{blockapi-2.4.0 → blockapi-2.5.0}/setup.py

@@ -6,7 +6,7 @@ with open("README.md", "r") as f:
 
 PACKAGES = find_packages(where='.')
 
-__version__ = "2.4.0"
+__version__ = "2.5.0"
 
 setuptools.setup(
     name='blockapi',
@@ -32,6 +32,7 @@ setuptools.setup(
         'requests_mock>=1.9.3',
         'attrs>=17.4.0,<23.0.0',
         'solders>=0.22.0',
+        'base58>=2.1.0',
     ],
     url="https://github.com/crypkit/blockapi",
 )