Skip to content
btclib: a python3 library for 'bitcoin cryptography'
Branch: master
Clone or download
Pull request Compare This branch is 10 commits ahead of fametrano:master.
Latest commit eb4fe45 Jun 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
btclib getting ready for new release Jun 12, 2019
docs added bitcoin compact message signature May 26, 2019
img added smaller code Jun 12, 2019
tests increased code coverage May 26, 2019
.gitignore
.travis.yml specified python versions Jan 4, 2019
AUTHORS.md chenged references to btclib Jan 4, 2019
LICENSE fixed bbt typo Dec 29, 2018
MANIFEST.in moved data files; excluded tests from distribution Jan 4, 2019
README.md
TODO Improved/added Sphinx documentation (#36) May 25, 2019
readthedocs.yml added Sphinx documentation Apr 23, 2019
requirements.txt
setup.py Improved/added Sphinx documentation (#36) May 25, 2019

README.md

btclib: a python3 library for 'bitcoin cryptography'

btclib logo

Build Status Coverage Status PyPI status PyPI pyversions PyPI version GitHub License ReadtheDocs

btclib is a python3 type annotated library intended for teaching and demonstration of the elliptic curve cryptography used in bitcoin.

It does not have external requirements or dependencies; to install (and upgrade) it:

python -m pip install --upgrade btclib

Originally developed for the Bitcoin and Blockchain Technology course at University of Milano-Bicocca and Politecnico di Milano, its algorithms are not intended for production environments: they could be broken using side-channel attacks; moreover, they are often refactored without care for backward compatibility.

The library includes:

  • modulo algebra functions (gcd, inverse, legendre symbol, square root)
  • octets / integer / point conversion functions
  • elliptic curve class
    • fast algebra implemented using Jacobian coordinates
    • double scalar multiplication (Straus's algorithm, also known as Shamir's trick)
    • multi scalar multiplication (Bos-coster's algorithm)
    • point simmetry solution: odd/even, low/high, and quadratic residue
  • available curves: SEC 1 v1 and v2, NIST, Brainpool, and low cardinality test curves
  • DSA signature with (transaction) DER encoding and (message) compact encoding
  • Schnorr signature (according to bip-schnorr bitcoin standardization)
    • batch validation
    • threshold signature (see test-suite)
    • MuSig multi-signature (see test-suite)
  • Borromean ring signature
  • RFC 6979 to make signature schemes deterministic
  • Sign-to-contract commitment
  • Diffie-Hellman
  • Pedersen Committment
  • Base58 encoding, addresses, WIFs
  • BIP32 hierarchical deterministic wallets
  • BIP39 wordlists and mnemonic for generating deterministic keys
  • Electrum standard for mnemonic

A very extensive test suite reproduces results from major official sources and covers 100% of the library code base.

You can’t perform that action at this time.