Skip to main content

A bitcoin cryptography library.

Project description

btclib: a bitcoin cryptography library

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

btclib is a python3 type annotated library intended for teaching and demonstration of the cryptography used in bitcoin. It is used for the Bitcoin and Blockchain Technology Course at Milano Bicocca and Politecnico di Milano.

To install (and upgrade) btclib:

python3 -m pip install --upgrade btclib

Algorithms are not to be used in production environments: they could be broken using side-channel attacks. Moreover, they might be subjected to major refactoring without care for backward compatibility.

The library includes:

  • modulo algebra functions (gcd, inverse, legendre symbol, square root)
  • octet / integer / point conversion functions
  • elliptic curve class
    • fast algebra implemented using Jacobian coordinates
    • double scalar multiplication (Shamir's trick)
    • point simmetry solution: odd/even, high/low, and quadratic residue
    • SEC 1 v1 and v2 curves
    • NIST curves
    • low cardinality test curves
  • ECDSA signature and DER encoding
  • Sign-to-contract notarization
  • Schnorr signature (according to bip-schnorr bitcoin standardization)
    • batch validation
    • threshold signature
    • MuSig multi-signature
  • Borromean ring signature
  • RFC-6979 to make signature schemes deterministic
  • EC Diffie-Hellman
  • Pedersen Committment
  • base58 encoding, addresses, WIFs
  • BIP32 hierarchical deterministic wallets
  • BIP39 mnemonic code for generating deterministic keys
  • Electrum standard for mnemonic code

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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for btclib, version 2019.1.7
Filename, size File type Python version Upload date Hashes
Filename, size btclib-2019.1.7-py3-none-any.whl (55.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size btclib-2019.1.7.tar.gz (48.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page