Metadata-Version: 2.1
Name: btclib
Version: 2019.11.28
Summary: A bitcoin cryptography library.
Home-page: http://github.com/dginst/btclib
Author: Digital Gold Institute
License: MIT License
Description: # btclib: a python3 library for 'bitcoin cryptography'
        
        [![btclib logo](/img/btclib-logo-40.jpg)](http://github.com/dginst/btclib)
        
        [![Build Status](https://travis-ci.org/dginst/btclib.svg)](https://travis-ci.org/dginst/btclib)
        [![Coverage Status](https://coveralls.io/repos/github/dginst/btclib/badge.svg)](https://coveralls.io/github/dginst/btclib)
        [![PyPI status](https://img.shields.io/pypi/status/btclib.svg)](https://pypi.python.org/pypi/btclib/)
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/btclib.svg)](https://pypi.python.org/pypi/btclib/)
        [![PyPI version](https://img.shields.io/pypi/v/btclib.svg)](https://pypi.python.org/pypi/btclib/)
        [![GitHub License](https://img.shields.io/github/license/dginst/btclib.svg)](https://github.com/dginst/btclib/blob/master/LICENSE)
        [![ReadtheDocs](https://img.shields.io/readthedocs/btclib.svg)](https://btclib.readthedocs.io)
        
        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:
        
        ```shell
        python -m pip install --upgrade btclib
        ```
        
        Originally developed for the
        [_Bitcoin and Blockchain Technology_](https://www.ametrano.net/bbt/) 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](https://github.com/sipa/bips/blob/bip-schnorr/bip-schnorr.mediawiki)
          bitcoin standardization)
          - batch validation
          - threshold signature (see test-suite)
          - MuSig multi-signature (see test-suite)
        - Borromean ring signature
        - [RFC 6979](https://tools.ietf.org/html/rfc6979:) to make signature
          schemes deterministic
        - Sign-to-contract commitment
        - Diffie-Hellman
        - Pedersen Committment
        - Base58 encoding, addresses, WIFs
        - [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
          hierarchical deterministic wallets
        - [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
          wordlists and mnemonic for generating deterministic keys
        - [Electrum](https://electrum.org/#home) standard for mnemonic
        
        A very extensive test suite reproduces results from major official sources
        and [covers 100%](https://coveralls.io/github/dginst/btclib) of the library
        code base.
        
Keywords: bitcoin cryptography elliptic-curves dsa schnorr RFC-6979 bip32 bip39 electrum base58
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
