Metadata-Version: 2.1
Name: xchainpy-bitcoin
Version: 0.1.2
Summary: Bitcoin Module for XChainPy Clients
Home-page: https://github.com/xchainjs/xchainpy-lib
Author: THORChain
Author-email: 
License: MIT
Keywords: THORChain,XChainpy,XChainpy_bitcoin,BTC,Bitcoin
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
Requires-Dist: bitcoinlib (==0.5.2)
Requires-Dist: pytest (==6.2.2)
Requires-Dist: http3 (==0.6.7)
Requires-Dist: xchainpy-client (==0.1)
Requires-Dist: xchainpy-crypto (==0.1.1)
Requires-Dist: xchainpy-util (==0.1.4)

# `xchainpy/xchainpy_bitcoin`

Bitcoin Module for XChainPy Clients

## Modules

- `client` - Custom client for communicating with bitcoinlib
- `models` - model wrapper for bitcoin required types
- `util` - Utitilies for using bitcoinlib and bitcoin chain

Following dependencies have to be installed into your project

```
bitcoinlib , http3 , xchainpy_client , xchainpy_crypto , xchainpy_util
```

## Service Providers

This package uses the following service providers:

| Function                    | Service     | Notes                                                                            |
| --------------------------- | ----------- | -------------------------------------------------------------------------------- |
| Balances                    | Sochain     | https://sochain.com/api#get-balance                                              |
| Transaction history         | Sochain     | https://sochain.com/api#get-display-data-address, https://sochain.com/api#get-tx |
| Transaction details by hash | Sochain     | https://sochain.com/api#get-tx                                                   |
| Transaction fees            | bitcoinfees | https://bitcoinfees.earn.com/api/v1/fees/recommended                             |
| Transaction broadcast       | Sochain     | https://sochain.com/api#send-transaction                                         |
| Explorer                    | Blockstream | https://blockstream.info                                                         |

Sochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minute)


## Tests

These packages needed to run tests:

- pytest `pip install pytest`
- pytest-asyncio `pip install pytest-asyncio`

How to run test ?

```bash
$ python -m pytest xchainpy/xchainpy_bitcoin/tests/test_bitcoin_clients.py
```



