Skip to content

README.md

Latest commit

 

History

History
89 lines (71 loc) · 2.83 KB

README.md

File metadata and controls

89 lines (71 loc) · 2.83 KB

FreeTX

Freecash made easy

Forked from sklayer's BitcashCN library.

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

>>> from freetx import Key
>>>
>>> k = Key()
>>> k.address
'FREEBotD5ZXm9qhwo43RaopKo62Aq3vbAg'
>>>
>>> k.get_balance('usd')
'2'
>>>
>>> # Let's donate a dollar to CoinSpice.io
>>> outputs = [
>>>     ('FREEBotD5ZXm9qhwo43RaopKo62Aq3vbAg', 1, 'fch'),
>>>     # you can add more recipients here
>>> ]
>>>
>>> k.send(outputs)
'6aea7b1c687d976644a430a87e34c93a8a7fd52d77c30e9cc247fc8228b749ff'
>>> tx_id = my_key.sweep("FREEBotD5ZXm9qhwo43RaopKo62Aq3vbAg")
# Sweep your all bch to dest address
>>> print(tx_id)
>>> outputs = [
        ("FREEBotD5ZXm9qhwo43RaopKo62Aq3vbAg",1000, 'c'),
    ]
>>> tx_id = my_key.send(outputs, fee=1, message=f"This is a test TRANSACTION created by FREETX")
>>> print(tx_id)
Let's create a memo! Protocol: https://memo.cash/protocol
Set Username First
>>> tx_id = my_key.send_op_return([bytes.fromhex('6d01'),  # encode hex to bytes
                         'FreeTX!'.encode('utf-8')])
>>> print(tx_id)
Send A Memo
>>> tx_id = my_key.send_op_return([bytes.fromhex('6d02'),  # encode hex to bytes
                         'https://github.com/SKlayer/freetx'.encode('utf-8')])
>>> print(tx_id)
"566e8b90e1c5f02f3717804d73b979e92e8a598616ff5f16e68dd94e48c05ea5"

Done. Here is the transaction: https://explorer.bitcoin.com/bch/tx/6aea7b1c687d976644a430a87e34c93a8a7fd52d77c30e9cc247fc8228b749ff https://memo.cash/explore/tx/566e8b90e1c5f02f3717804d73b979e92e8a598616ff5f16e68dd94e48c05ea5

Features

  • Python's fastest available implementation (100x faster than closest library)
  • Seamless integration with existing server setups
  • Supports keys in cold storage
  • Fully supports 32 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.5+ and PyPy3.5-v5.7.1+. pip >= 8.1.2 is required.

$ python setup.py install

Documentation

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

Read the documentation

Credits