BitCash logo

BitCash

Bitcoin Cash made easy

BitCash PyPi version Test status Deploy docs Code Coverage Python Versions MIT license CodeFactor

Forked from Ofek’s awesome Bit library.

BitCash is so easy to use, in fact, you can do this:

>>> from bitcash import Key
>>>
>>> k = Key()
>>> k.address
'bitcoincash:qp0hamw9rpyllkmvd8047w9em3yt9fytsunyhutucx'
>>>
>>> k.get_balance('usd')
'2'
>>>
>>> # Let's donate a dollar to CoinSpice.io
>>> outputs = [
>>>     ('bitcoincash:qz69e5y8yrtujhsyht7q9xq5zhu4mrklmv0ap7tq5f', 1, 'usd'),
>>>     # you can add more recipients here
>>> ]
>>>
>>> k.send(outputs)
'6aea7b1c687d976644a430a87e34c93a8a7fd52d77c30e9cc247fc8228b749ff'

Done. Here is the transaction: https://explorer.bitcoin.com/bch/tx/6aea7b1c687d976644a430a87e34c93a8a7fd52d77c30e9cc247fc8228b749ff

Features

  • Python’s fastest available implementation (100x faster than closest library)

  • Seamless integration with existing server setups

  • Supports keys in cold storage

  • Fully supports 29 different currencies

  • First class support for storing data in the blockchain

  • Deterministic signatures via RFC 6979

  • Access to the blockchain (and testnet chain) through multiple APIs for redundancy

  • Exchange rate API, with optional caching

  • Compressed public keys by default

  • Multiple representations of private keys; WIF, PEM, DER, etc.

  • Standard P2PKH transactions

If you are intrigued, continue reading. If not, continue all the same!

Installation

BitCash is distributed on PyPI as a universal wheel and is available on Linux/macOS and Windows and supports Python 3.8+.

pip install bitcash  # pip3 if pip is Python 2 on your system.

Documentation

Docs are hosted by Github Pages and are automatically built and published after every successful commit to BitCash’s master branch.

Read the documentation

User Guide

This section will tell you a little about the project, show how to install it, and will then walk you through how to use bitcash with many examples and explanations of best practices.

Community

Here you will find everything you need to know about the development of bitcash and the community surrounding it.

Dev Guide

Up ahead is bitcash’s API and a few notes about design decisions. Beware the pedantry, or lack thereof.