feat: add Zcash support to Trezor API

Author: galvanizze

blockapi/test/v2/api/data/trezor_zec_balance_response.json

@@ -0,0 +1,15 @@
+{
+  "page": 1,
+  "totalPages": 1,
+  "itemsOnPage": 1000,
+  "address": "t1KstBMLVrYoHN5jrq5hKNGgERC1NodvfnS",
+  "balance": "1234500000",
+  "totalReceived": "5000000000",
+  "totalSent": "3765500000",
+  "unconfirmedBalance": "0",
+  "unconfirmedTxs": 0,
+  "txs": 5,
+  "txids": [
+    "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
+  ]
+}

blockapi/test/v2/api/test_trezor_zec.py

@@ -0,0 +1,43 @@
+from decimal import Decimal
+
+import pytest
+
+from blockapi.test.v2.api.conftest import read_file
+from blockapi.test.v2.test_data import zec_test_address
+from blockapi.v2.api import TrezorZcashApi
+from blockapi.v2.models import FetchResult
+
+
+def test_fetch_balances(requests_mock, trezor_zec_balance_response):
+    requests_mock.get(
+        f'https://blockbook.zec.zelcore.io/api/v2/address/{zec_test_address}',
+        text=trezor_zec_balance_response,
+    )
+
+    api = TrezorZcashApi()
+    balances = api.get_balance(zec_test_address)
+    assert len(balances) == 1
+    assert balances[0].balance == Decimal('12.345')
+
+
+def test_fetch_only(requests_mock, trezor_zec_balance_response):
+    requests_mock.get(
+        f'https://blockbook.zec.zelcore.io/api/v2/address/{zec_test_address}',
+        text=trezor_zec_balance_response,
+    )
+
+    api = TrezorZcashApi()
+    result = api.fetch_balances(zec_test_address)
+    assert result.data['balance'] == '1234500000'
+
+
+def test_parse_only():
+    api = TrezorZcashApi()
+    fetch_result = FetchResult(data=dict(balance='1234500000'))
+    result = api.parse_balances(fetch_result)
+    assert result.data[0].balance == Decimal('12.345')
+
+
+@pytest.fixture
+def trezor_zec_balance_response():
+    return read_file('data/trezor_zec_balance_response.json')

blockapi/test/v2/test_data.py

@@ -66,6 +66,8 @@
 xpub_test_address = 'xpub6CUGRUonZSQ4TWtTMmzXdrXDtypWKiKrhko4egpiMZbpiaQL2jkwSB1icqYh2cfDfVxdx4df189oLKnC5fSwqPfgyP3hooxujYzAu3fDVmz'
 # noinspection SpellCheckingInspection
 ltc_test_address = 'M8T1B2Z97gVdvmfkQcAtYbEepune1tzGua'
+# noinspection SpellCheckingInspection
+zec_test_address = 't1KstBMLVrYoHN5jrq5hKNGgERC1NodvfnS'
 
 
 API_CLASSES = [

blockapi/v2/api/__init__.py

@@ -5,11 +5,7 @@
     BlockchairDogecoinApi,
     BlockchairLitecoinApi,
 )
-from blockapi.v2.api.debank import (
-    DebankApi,
-    DebankApp,
-    DebankPrediction,
-)
+from blockapi.v2.api.debank import DebankApi, DebankApp, DebankPrediction
 from blockapi.v2.api.ethplorer import EthplorerApi
 from blockapi.v2.api.optimistic_etherscan import OptimismEtherscanApi
 from blockapi.v2.api.perpetual import PerpetualApi, perp_contract_address
@@ -21,4 +17,5 @@
     TrezorBitcoin1Api,
     TrezorBitcoin2Api,
     TrezorLitecoinApi,
+    TrezorZcashApi,
 )

blockapi/v2/api/trezor.py

@@ -3,7 +3,7 @@
 
 from blockapi.utils.user_agent import get_random_user_agent
 from blockapi.v2.base import BalanceMixin, BlockchainApi, ITransactions
-from blockapi.v2.coins import COIN_BTC, COIN_LTC
+from blockapi.v2.coins import COIN_BTC, COIN_LTC, COIN_ZEC
 from blockapi.v2.models import (
     ApiOptions,
     AssetType,
@@ -21,7 +21,7 @@
 
 class TrezorApi(BlockchainApi, ITransactions, BalanceMixin, ABC):
     """
-    Coins: Bitcoin, Litecoin
+    Coins: Bitcoin, Litecoin, Zcash
     API docs: https://github.com/trezor/blockbook/blob/master/docs/api.md
     Explorer:
     """
@@ -128,3 +128,12 @@ class TrezorLitecoinApi(TrezorApi):
         base_url='https://ltc1.trezor.io',
         rate_limit=0,
     )
+
+
+class TrezorZcashApi(TrezorApi):
+    coin = COIN_ZEC
+    api_options = ApiOptions(
+        blockchain=Blockchain.ZCASH,
+        base_url='https://blockbook.zec.zelcore.io',
+        rate_limit=1.0,
+    )

blockapi/v2/coins.py

@@ -505,3 +505,11 @@
     address="0x2::sui::SUI",
     info=CoinInfo(coingecko_id=CoingeckoId.SUI),
 )
+
+COIN_ZEC = Coin(
+    symbol='ZEC',
+    name='Zcash',
+    decimals=8,
+    blockchain=Blockchain.ZCASH,
+    info=CoinInfo(coingecko_id=CoingeckoId.ZCASH),
+)

blockapi/v2/models.py

@@ -5,10 +5,10 @@
 from typing import Dict, List, Literal, Optional, Union
 
 import attr
+from pydantic import BaseModel, Field
 
 from blockapi.utils.datetime import parse_dt
 from blockapi.utils.num import raw_to_decimals, to_decimal, to_int
-from pydantic import BaseModel, Field
 
 UNKNOWN = 'unknown'
 
@@ -359,6 +359,7 @@ class Blockchain(str, Enum):
     YOCOIN = 'yocoin'
     ZEDXION = 'zedxion'
     ZERO = 'zero'
+    ZCASH = 'zcash'
     ZETA_CHAIN = 'zetachain'
     ZILLIQA = 'zilliqa'
     ZIRCUIT = 'zircuit'
@@ -465,6 +466,7 @@ class CoingeckoId(str, Enum):
     WANCHAIN = 'wanchain'
     WETH = 'weth'
     XDAI = 'xdai'
+    ZCASH = 'zcash'
 
 
 class NftOfferDirection(str, Enum):