Skip to main content

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

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

Noticeboard:

Latest Release - 0.8.0 (2019-7-13)

Legacy Addresses:

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.

Planned improvements

  • Improved coverage of testing modules (currently at 84%).

  • Support for use of a local bitcoin full node instead of a Web-API. (paves the way for a RegTest environment for a rapid development cycle)

  • Work on the bsvbip32 library for hierarchical deterministic keys: https://github.com/AustEcon/bsvbip32. Plan for each node to access bitsv functionality so that building apps can be a breeze! (competing implementations welcome. That’s partly why modularity is a good idea!)


Examples

BitSV is so easy to use:

  1. Simple payment:

>>> import bitsv
>>> my_key = bitsv.Key('YourPrivateKeyGoesHere')  # Defaults to "main" network
>>> 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://whatsonchain.com/tx/dec895d1aa0e820984c5748984ba36854163ec3d6847c94e82a921765c5b23e1.

  1. OP_RETURN - 100kb size limit now supported:

>>> import bitsv
>>> my_key = bitsv.Key('YourPrivateKeyGoesHere')
>>> list_of_pushdata = ([bytes.fromhex('6d01'),  # encode hex to bytes
                         'New_Name'.encode('utf-8')])  # encode string to utf-8 encoded bytes
>>> my_key.send_op_return(list_of_pushdata)  # default fee = 1 sat/byte

This sets memo.sv name (linked to this bitcoin address) to “New_Name” (as per https://memo.sv/protocol)

Features

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

  • 100kb OP_RETURN transactions made very simple

  • Fully supports 21 different currencies via exchange rate API

  • First class support for storing data in the blockchain

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

Documentation

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

Credits

Donate

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

  • HandCash: $AustEcon

  • 1PdvVPTzXmo4cSs68HctLUxAdW917UZtC8

Metadata

Release files for bitsv 0.8.0

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.8.0
File Size Uploaded
bitsv-0.8.0.tar.gz 39.9 kB Details

Release files / bitsv-0.8.0.tar.gz

Download URL bitsv-0.8.0.tar.gz
Size 39.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7aabe2f57a73b2e29561b3e64eaacd34fc45347c420265671050684319cb349d
BLAKE2b-256 checksum
How to use checksums
af03cc4b15db2b203443201d75173b79af5deeefba61910726281b5bf474e919
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 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

This release

0.8.0 This release

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

0.5.5

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