zycoin 1.0.0__tar.gz

zycoin-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SpaceZ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zycoin-1.0.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: zycoin
+Version: 1.0.0
+Summary: Python client library for BitcoinZ and related Zcoin-family blockchain networks using Electrum and Bitcore APIs.
+Author: BitcoinZ Community
+License: MIT
+Keywords: bitcoinz,btcz,electrum,blockchain,zcash,zycoin
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ecdsa>=0.19.2
+Requires-Dist: pbkdf2>=1.3
+Requires-Dist: pyaes>=1.6.1
+Requires-Dist: aiohttp>=3.14.3; platform_system != "Emscripten"
+Requires-Dist: websockets>=16.1.1; platform_system != "Emscripten"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# zycoin
+
+Python client library for BitcoinZ and related Zcoin-family blockchain networks.
+
+This package exposes lightweight async clients for Electrum and Bitcore-compatible APIs, plus wallet, key, and transaction helpers used to interact with BitcoinZ networks. It is designed for developers who want to query blockchain data, monitor address activity, broadcast transactions, or build wallet tooling around the BTCZ ecosystem.
+
+## Features
+
+- Async connection management for Electrum servers and Bitcore APIs
+- Address, transaction, balance, mempool, and UTXO queries
+- Header and address subscription support
+- Support for BitcoinZ, Zero, Zclassic, and Flux networks
+- Wallet/key primitives and mnemonic support
+- Simple client manager for registering and managing multiple coins
+
+## Installation
+
+```bash
+pip install zycoin
+```
+
+## Quick start
+
+```python
+import asyncio
+from src.manager import ClientManager
+
+async def on_status(status):
+    print("status:", status)
+
+async def on_notification(message):
+    print("notification:", message)
+
+async def main():
+    manager = ClientManager()
+    manager.on_status = on_status
+    manager.on_notification = on_notification
+
+    client = manager.add("btcz", "bitcore")
+    await manager.connect("btcz")
+
+    await client.subscribe_address("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH")
+    print(await client.get_balance("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH"))
+
+    await manager.disconnect("btcz")
+
+asyncio.run(main())
+```
+
+## Using the Electrum client directly
+
+```python
+import asyncio
+from src.constants import BitcoinZ
+from src.clients import ElectrumClient
+
+async def main():
+    client = ElectrumClient(BitcoinZ, protocol="ssl")
+    client.on_status = lambda status: print("status:", status)
+
+    await client.connect()
+    print(await client.server_version())
+    print(await client.get_balance("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH"))
+    await client.close()
+
+asyncio.run(main())
+```
+
+## Using the Bitcore client directly
+
+```python
+import asyncio
+from src.constants import BitcoinZ
+from src.clients import BitcoreClient
+
+async def main():
+    client = BitcoreClient(BitcoinZ)
+    client.on_status = lambda status: print("status:", status)
+
+    await client.connect()
+    print(await client.get_history("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH", limit=5))
+    await client.close()
+
+asyncio.run(main())
+```
+
+## Managing several coins
+
+```python
+import asyncio
+from src.manager import ClientManager
+
+async def main():
+    manager = ClientManager()
+    manager.add("btcz", "bitcore")
+    manager.add("zcl")
+    manager.add("zer")
+    manager.add("flux")
+
+    await manager.connect_all()
+    print({coin: manager[coin].coin.NAME for coin in manager.clients})
+
+    await manager.disconnect_all()
+
+asyncio.run(main())
+```
+
+## Available networks
+
+The following coin definitions are included:
+
+- `btcz` — BitcoinZ
+- `zer` — Zero
+- `zcl` — Zclassic
+- `flux` — Flux
+
+## Notes
+
+- The library uses async IO throughout.
+- For Electrum connections, it selects the fastest reachable server automatically.
+- For Bitcore connections, it communicates with the explorer's WebSocket and REST API.
+
+## License
+
+MIT

zycoin-1.0.0/README.md

@@ -0,0 +1,125 @@
+# zycoin
+
+Python client library for BitcoinZ and related Zcoin-family blockchain networks.
+
+This package exposes lightweight async clients for Electrum and Bitcore-compatible APIs, plus wallet, key, and transaction helpers used to interact with BitcoinZ networks. It is designed for developers who want to query blockchain data, monitor address activity, broadcast transactions, or build wallet tooling around the BTCZ ecosystem.
+
+## Features
+
+- Async connection management for Electrum servers and Bitcore APIs
+- Address, transaction, balance, mempool, and UTXO queries
+- Header and address subscription support
+- Support for BitcoinZ, Zero, Zclassic, and Flux networks
+- Wallet/key primitives and mnemonic support
+- Simple client manager for registering and managing multiple coins
+
+## Installation
+
+```bash
+pip install zycoin
+```
+
+## Quick start
+
+```python
+import asyncio
+from src.manager import ClientManager
+
+async def on_status(status):
+    print("status:", status)
+
+async def on_notification(message):
+    print("notification:", message)
+
+async def main():
+    manager = ClientManager()
+    manager.on_status = on_status
+    manager.on_notification = on_notification
+
+    client = manager.add("btcz", "bitcore")
+    await manager.connect("btcz")
+
+    await client.subscribe_address("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH")
+    print(await client.get_balance("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH"))
+
+    await manager.disconnect("btcz")
+
+asyncio.run(main())
+```
+
+## Using the Electrum client directly
+
+```python
+import asyncio
+from src.constants import BitcoinZ
+from src.clients import ElectrumClient
+
+async def main():
+    client = ElectrumClient(BitcoinZ, protocol="ssl")
+    client.on_status = lambda status: print("status:", status)
+
+    await client.connect()
+    print(await client.server_version())
+    print(await client.get_balance("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH"))
+    await client.close()
+
+asyncio.run(main())
+```
+
+## Using the Bitcore client directly
+
+```python
+import asyncio
+from src.constants import BitcoinZ
+from src.clients import BitcoreClient
+
+async def main():
+    client = BitcoreClient(BitcoinZ)
+    client.on_status = lambda status: print("status:", status)
+
+    await client.connect()
+    print(await client.get_history("t1Rci9gRmkJZ22vH7dToFe2Up6TpZypgimH", limit=5))
+    await client.close()
+
+asyncio.run(main())
+```
+
+## Managing several coins
+
+```python
+import asyncio
+from src.manager import ClientManager
+
+async def main():
+    manager = ClientManager()
+    manager.add("btcz", "bitcore")
+    manager.add("zcl")
+    manager.add("zer")
+    manager.add("flux")
+
+    await manager.connect_all()
+    print({coin: manager[coin].coin.NAME for coin in manager.clients})
+
+    await manager.disconnect_all()
+
+asyncio.run(main())
+```
+
+## Available networks
+
+The following coin definitions are included:
+
+- `btcz` — BitcoinZ
+- `zer` — Zero
+- `zcl` — Zclassic
+- `flux` — Flux
+
+## Notes
+
+- The library uses async IO throughout.
+- For Electrum connections, it selects the fastest reachable server automatically.
+- For Bitcore connections, it communicates with the explorer's WebSocket and REST API.
+
+## License
+
+MIT

zycoin-1.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"

zycoin-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

zycoin-1.0.0/setup.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+from setuptools import setup
+README = Path(__file__).resolve().parent / "README.md"
+
+setup(
+    name="zycoin",
+    version="1.0.0",
+    description="Python client library for BitcoinZ and related Zcoin-family blockchain networks using Electrum and Bitcore APIs.",
+    long_description=README.read_text(encoding="utf-8"),
+    long_description_content_type="text/markdown",
+    author="BitcoinZ Community",
+    license="MIT",
+    packages=["zycoin"],
+    package_dir={"zycoin": "src"},
+    package_data={
+        'zycoin': [
+            'wordlist/*.txt'
+        ]
+    },
+    python_requires=">=3.10",
+    install_requires=[
+        "ecdsa>=0.19.2",
+        "pbkdf2>=1.3",
+        "pyaes>=1.6.1",
+        "aiohttp>=3.14.3; platform_system != 'Emscripten'",
+        "websockets>=16.1.1; platform_system != 'Emscripten'"
+    ],
+    keywords=[
+        "bitcoinz",
+        "btcz",
+        "electrum",
+        "blockchain",
+        "zcash",
+        "zycoin"
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)

zycoin-1.0.0/src/constants.py

@@ -0,0 +1,143 @@
+
+class Coin:
+    NAME = None
+    SYMBOL = None
+
+    WIF_PREFIX = None
+    ADDRTYPE_P2PKH = None
+    ADDRTYPE_P2SH = None
+
+    DEFAULT_PORTS = {}
+    SERVERS = []
+    BITCORE_API = None
+
+    XPUB_HEADERS = {}
+    XPRV_HEADERS = {}
+
+    BRANCH_ID = None
+
+    @classmethod
+    def set_as_network(cls) -> None:
+        global net
+        net = cls
+
+
+class BitcoinZ(Coin):
+
+    NAME = "BitcoinZ"
+    SYMBOL = "BTCZ"
+
+    WIF_PREFIX = 0x80
+    ADDRTYPE_P2PKH = bytes.fromhex('1CB8')
+    ADDRTYPE_P2SH = bytes.fromhex('1CBD')
+    DEFAULT_PORTS = {'t': '50001', 's': '50002', 'w': '50004'}
+
+    SERVERS = [
+        "electrum1.btcz.rocks",
+        "electrum2.btcz.rocks",
+        "electrum4.btcz.rocks"
+    ]
+
+    BITCORE_API = "https://explorer.btcz.rocks/"
+
+    XPRV_HEADERS = {
+        'standard':    0x0488ade4,
+    }
+    XPUB_HEADERS = {
+        'standard':    0x0488b21e,
+    }
+
+    BRANCH_ID = 0xe9ff75a6
+
+
+class ZeroCurrency(Coin):
+
+    NAME = "Zero"
+    SYMBOL = "ZER"
+
+    WIF_PREFIX = 0x80
+    ADDRTYPE_P2PKH = bytes.fromhex('1CB8')
+    ADDRTYPE_P2SH = bytes.fromhex('1CBD')
+    DEFAULT_PORTS = {'t': '50001', 's': '50002', 'w': '50004'}
+
+    SERVERS = []
+
+    BITCORE_API = "https://explorer.zer.zelcore.io/"
+    
+    XPRV_HEADERS = {
+        'standard':    0x0488ade4,
+    }
+    XPUB_HEADERS = {
+        'standard':    0x0488b21e,
+    }
+
+    BRANCH_ID = 0x7361707a
+
+
+
+class Zclassic(Coin):
+
+    NAME = "Zclassic"
+    SYMBOL = "ZCL"
+
+    WIF_PREFIX = 0x80
+    ADDRTYPE_P2PKH = bytes.fromhex('1CB8')
+    ADDRTYPE_P2SH = bytes.fromhex('1CBD')
+    DEFAULT_PORTS = {'t': '50001', 's': '50002', 'w': '50004'}
+    
+    SERVERS = []
+
+    BITCORE_API = "https://explorer.zcl.zelcore.io/"
+
+    XPRV_HEADERS = {
+        'standard':    0x0488ade4,
+    }
+    XPUB_HEADERS = {
+        'standard':    0x0488b21e,
+    }
+
+    BRANCH_ID = 0x930b540d
+
+
+class Flux(Coin):
+
+    NAME = "Flux"
+    SYMBOL = "FLUX"
+
+    WIF_PREFIX = 0x80
+    ADDRTYPE_P2PKH = bytes.fromhex('1CB8')
+    ADDRTYPE_P2SH = bytes.fromhex('1CBD')
+    DEFAULT_PORTS = {'t': '50001', 's': '50002', 'w': '50004'}
+    
+    SERVERS = []
+
+    BITCORE_API = "https://explorer.runonflux.io/"
+
+    XPRV_HEADERS = {
+        'standard':    0x0488ade4,
+    }
+    XPUB_HEADERS = {
+        'standard':    0x0488b21e,
+    }
+
+    BRANCH_ID = 0x76b809bb
+
+
+
+COINS = {
+    BitcoinZ.SYMBOL.lower(): BitcoinZ,
+    ZeroCurrency.SYMBOL.lower(): ZeroCurrency,
+    Zclassic.SYMBOL.lower(): Zclassic,
+    Flux.SYMBOL.lower(): Flux
+}
+
+net = BitcoinZ
+
+def set_coin(coin):
+    global net
+
+    key = coin.strip().lower()
+    if key not in COINS:
+        raise ValueError(f"Unknown coin: {coin}")
+    net = COINS[key]
+    return net