Skip to main content

BitSV: Bitcoin SV made easy

Forked from Ofek’s awesome Bit library: https://github.com/ofek/bit

https://img.shields.io/pypi/v/bitcash.svg?style=flat-square https://img.shields.io/travis/sporestack/bitcash.svg?branch=master&style=flat-square https://img.shields.io/codecov/c/github/sporestack/bitcash.svg?style=flat-square https://img.shields.io/pypi/pyversions/bitcash.svg?style=flat-square https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square

Note: Legacy Addresses

Bitcoin SV will be reinstating legacy address format as the default standard for ease of use. However, “cashaddress” is a great tool for conversions if needed. https://github.com/oskyk/cashaddress/

Note: Default Fee = 1 sat/byte

The capacity of the Bitcoin SV network is such that 1 sat/byte virtually guarantees that your transaction will be included in the next block. This is therefore the default. However, it is trivial to specify a higher transaction fee by including this as an additional parameter to any of the transaction related functions.

What needs fixing

  • Testing modules / coverage

  • Testnet api

  • Documentation page and examples


Examples

BitSV is so easy to use:

  1. Simple payment:

>>> import bitsv
>>> my_key = bitsv.Key('YourPrivateKeyGoesHere')
>>> my_key.get_balance()
10000000  # satoshis
>>> # Can include a long list of tuples as outputs
>>> outputs = [
>>>     # Donate to AustEcon! (Currency conversion via api)
>>>     ('1PdvVPTzXmo4cSs68HctLUxAdW917UZtC8', 0.10, 'usd')  # $USD 0.10 as bsv
>>>     ('1PdvVPTzXmo4cSs68HctLUxAdW917UZtC8', 0.0001, 'bsv')
>>> ]
>>> my_key.send(outputs)
'dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1'

Here’s the transaction https://bchsvexplorer.com/tx/dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1.

  1. OP_RETURN - 100kb size limit now supported:

>>> # One example usecase for OP_RETURN metadata (3 lines of code)
>>> import bitsv
>>> my_key = bitsv.Key('YourPrivateKeyGoesHere')
>>> # input a list of tuples (data, encoding) pairs ("utf-8" or "hex" encoding)
>>> # each tuple in the list is a pushdata element within the OP_RETURN.
>>> lst_of_pushdata = [('6d01', 'hex'), ('new_name', 'utf-8')]
>>> # This sets memo.sv name (linked to this bitcoin address) to "new_name"
>>> # (as per https://memo.sv/protocol)
>>> my_key.send_op_return(lst_of_pushdata)  # default fee = 1 sat/byte

Features

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

  • 100kb OP_RETURN transactions made very simple

  • Seamless integration with existing server setups

  • Supports keys in cold storage

  • Fully supports 21 different currencies via exchange rate API

  • First class support for storing data in the blockchain

  • Optimal transaction fee API

  • Compressed public keys by default

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

  • Standard P2PKH transactions

Installation

BitSV 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.

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

Credits

Donate

  • If you have found this library useful, please consider donating. It really helps.

  • HandCash: $AustEcon

  • 1HvuVG6TJ3uVyNHpWuDD59mFT9j23cabXj

Metadata

Release files for bitsv 0.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bitsv 0.5.5
File Size Uploaded
bitsv-0.5.5.tar.gz 33.2 kB Details

Release files / bitsv-0.5.5.tar.gz

Download URL bitsv-0.5.5.tar.gz
Size 33.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1c3d7b07743acf3dae6d777afb0af7cb6d5d20f2148112bb2be3f0a7bc429f5a
BLAKE2b-256 checksum
How to use checksums
d87e6eac359f52b32a2f1f0ff5fef7d3bc6be490fe074a69ae8cfb107a1a08b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.7.1

Release history Release notifications | RSS feed

0.11.5

1 release file

0.11.4

1 release file

0.11.3

1 release file

0.11.2

1 release file

0.11.1

1 release file

0.11.0

1 release file

0.10.4

1 release file

0.10.3

1 release file

0.10.2

1 release file

0.10.1

1 release file

0.10.0

2 release files

0.9.0

2 release files

0.8.0

1 release file

0.7.1

2 release files

0.6.1

1 release file

0.6.0

1 release file

0.5.6

1 release file

This release

0.5.5 This release

1 release file

0.5.4

1 release file

0.5.3

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page