# A Python library for 'bitcoin cryptography'
<!-- markdownlint-disable MD013 -->
| | |
| --- | --- |
| Project | [](https://pypi.python.org/pypi/btclib/) [](https://github.com/btclib-org/btclib/blob/master/LICENSE) |
| Package | [](https://calver.org/) [](https://pypi.python.org/pypi/btclib/) [](https://pepy.tech/project/btclib) |
| Supported platforms | [](https://pypi.python.org/pypi/btclib/) |
| Formatting standards | [](https://github.com/PyCQA/isort) [](https://github.com/psf/black) [](<https://github.com/PyCQA/flake8>) [](<https://github.com/asottile/yesqa>) [](https://github.com/DavidAnson/markdownlint-cli2) |
| Coding standards | [](https://github.com/PyCQA/pylint) [](https://github.com/PyCQA/autoflake) [](https://github.com/asottile/pyupgrade) [](https://sourcery.ai) [](https://github.com/PyCQA/bandit) |
| Type checking | [](http://mypy-lang.org/) [](https://github.com/microsoft/pyright) |
| Documentation | [](https://btclib.readthedocs.io) [](https://github.com/PyCQA/docformatter) [](https://github.com/DanielNoord/pydocstringformatter) [](https://github.com/PyCQA/pydocstyle)|
| CI/CD | [](https://github.com/pre-commit/pre-commit) [](https://results.pre-commit.ci/latest/github/btclib-org/btclib/master) [](https://github.com/btclib-org/btclib/actions/workflows/lint.yml) [](https://github.com/btclib-org/btclib/actions/workflows/test.yml) [](https://github.com/btclib-org/btclib/actions/workflows/test-pydev.yml) [](https://coveralls.io/github/btclib-org/btclib) |
| Conversations | [](https://bbt-training.slack.com/messages/C01CCJ85AES) [](https://twitter.com/intent/follow?screen_name=btclib)|
[Browse GitHub Code Repository](https://github.com/btclib-org/btclib/)
---
<!-- markdownlint-enable MD013 -->
[btclib](https://btclib.org) is a
Python3 [type annotated](https://docs.python.org/3/library/typing.html)
library intended for teaching, learning, and using bitcoin;
the focus is on elliptic curve cryptography and bitcoin's blockchain.
It is rigorously and extensively tested: the test suite
[covers 100%](https://coveralls.io/github/btclib-org/btclib)
of the code base and reproduces results from both informal
and major reference sources.
Originally developed for the
_[Bitcoin and Blockchain Technology](https://www.ametrano.net/bbt/)_
course at the University of Milano-Bicocca,
btclib is not intended for production environments:
it is often refactored for improved clarity,
without care for backward compatibility; moreover,
some of its algorithms could be broken using side-channel attacks.
The library is not limited to the bitcon elliptic curve secp256k1;
anyway, FFI bindings to
[libsecp256k1](https://github.com/bitcoin-core/secp256k1)
(the optimized C library used by Bitcoin Core)
are available for this curve and used by default.
Included features are:
- modulo algebra functions (gcd, inverse, legendre symbol, square root)
- octets / integer / point / var_int / var_bytes helper 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
- elliptic curves: SEC 1 v1 and v2, NIST, Brainpool, and
low cardinality test curves
- ECDSA signature with (transaction) DER encoding
- ECDSA signature with (message) compact encoding: standard p2pkh and
[BIP137](https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki)/[Electrum](https://electrum.org/#home)
extensions to p2wpkh and p2wpkh-p2sh
- [RFC 6979](https://tools.ietf.org/html/rfc6979) for deterministic signature
schemes
- EC Schnorr signature (according to
[BIP340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki)
bitcoin standardization)
- batch validation
- threshold signature (see test-suite)
- MuSig multi-signature (see test-suite)
- Borromean ring signature
- Sign-to-contract commitment
- Diffie-Hellman
- Pedersen committment
- Base58 encoding/decoding
- p2pkh/p2sh addresses and WIFs
- Bech32 encoding/decoding
- p2wpkh/p2wsh native SegWit addresses and their legacy p2sh-wrapped versions
- [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
hierarchical deterministic key chains
- [SLIP132](https://github.com/satoshilabs/slips/blob/master/slip-0132.md)
key versions (xprv, yprv, zprv, Yprv, Zprv, tprv, uprv, vprv, and Uprv)
with corresponding mapping to
p2pkh/p2sh, p2wpkh-p2sh, p2wpkh, p2wsh-p2sh, p2wsh and p2tr addresses
- [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
- Script encoding/decoding
- nulldata, p2pk, p2ms, p2pkh, p2sh, p2wpkh, p2wsh and p2tr ScriptPubKeys
- BlockHeader and Block data classes
- OutPoint, TxIn, TxOut, and TX data classes
- legacy, segwit_v0 and taproot transaction hash signatures
- [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki)
partially signed bitcoin transactions (PSBT):
PsbtIn, PbstOut, and Psbt data classes
---
To install (and/or upgrade) btclib:
```shell
python -m pip install --upgrade btclib
```
You might want to install btclib into a
python virtual environment; e.g. from the root folder:
Shell:
```shell
python -m venv venv_btclib
source ./venv_btclib/bin/activate
python -m pip install --upgrade btclib
```
Windows CMD or PowerShell:
```powershell
python -m venv venv_btclib
.\venv_btclib\Scripts\activate
python -m pip install --upgrade btclib
```
Windows Git bash shell:
```bash
python -m venv venv_btclib
cd ./venv_btclib/Scripts
. activate
cd ../..
python -m pip install --upgrade btclib
```
See [CONTRIBUTING](./CONTRIBUTING.md) if you are interested
in btclib develoment.
See [SECURITY](./SECURITY.md) if you have found a security vulnerability.
Raw data
{
"_id": null,
"home_page": "https://btclib.org",
"name": "btclib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "bitcoin cryptography elliptic-curves ecdsa schnorr RFC-6979 bip32 bip39 electrum base58 bech32 segwit message-signing bip340",
"author": "The btclib developers",
"author_email": "devs@btclib.org",
"download_url": "https://files.pythonhosted.org/packages/eb/41/bc908218df0a250fe0afc1e898437d074fc1cd01b37d6d903577e55453b7/btclib-2023.7.12.tar.gz",
"platform": null,
"description": "# A Python library for 'bitcoin cryptography'\n\n<!-- markdownlint-disable MD013 -->\n| | |\n| --- | --- |\n| Project | [](https://pypi.python.org/pypi/btclib/) [](https://github.com/btclib-org/btclib/blob/master/LICENSE) |\n| Package | [](https://calver.org/) [](https://pypi.python.org/pypi/btclib/) [](https://pepy.tech/project/btclib) |\n| Supported platforms | [](https://pypi.python.org/pypi/btclib/) |\n| Formatting standards | [](https://github.com/PyCQA/isort) [](https://github.com/psf/black) [](<https://github.com/PyCQA/flake8>) [](<https://github.com/asottile/yesqa>) [](https://github.com/DavidAnson/markdownlint-cli2) |\n| Coding standards | [](https://github.com/PyCQA/pylint) [](https://github.com/PyCQA/autoflake) [](https://github.com/asottile/pyupgrade) [](https://sourcery.ai) [](https://github.com/PyCQA/bandit) |\n| Type checking | [](http://mypy-lang.org/) [](https://github.com/microsoft/pyright) |\n| Documentation | [](https://btclib.readthedocs.io) [](https://github.com/PyCQA/docformatter) [](https://github.com/DanielNoord/pydocstringformatter) [](https://github.com/PyCQA/pydocstyle)|\n| CI/CD | [](https://github.com/pre-commit/pre-commit) [](https://results.pre-commit.ci/latest/github/btclib-org/btclib/master) [](https://github.com/btclib-org/btclib/actions/workflows/lint.yml) [](https://github.com/btclib-org/btclib/actions/workflows/test.yml) [](https://github.com/btclib-org/btclib/actions/workflows/test-pydev.yml) [](https://coveralls.io/github/btclib-org/btclib) |\n| Conversations | [](https://bbt-training.slack.com/messages/C01CCJ85AES) [](https://twitter.com/intent/follow?screen_name=btclib)|\n\n[Browse GitHub Code Repository](https://github.com/btclib-org/btclib/)\n\n---\n<!-- markdownlint-enable MD013 -->\n\n[btclib](https://btclib.org) is a\nPython3 [type annotated](https://docs.python.org/3/library/typing.html)\nlibrary intended for teaching, learning, and using bitcoin;\nthe focus is on elliptic curve cryptography and bitcoin's blockchain.\n\nIt is rigorously and extensively tested: the test suite\n[covers 100%](https://coveralls.io/github/btclib-org/btclib)\nof the code base and reproduces results from both informal\nand major reference sources.\n\nOriginally developed for the\n_[Bitcoin and Blockchain Technology](https://www.ametrano.net/bbt/)_\ncourse at the University of Milano-Bicocca,\nbtclib is not intended for production environments:\nit is often refactored for improved clarity,\nwithout care for backward compatibility; moreover,\nsome of its algorithms could be broken using side-channel attacks.\n\nThe library is not limited to the bitcon elliptic curve secp256k1;\nanyway, FFI bindings to\n[libsecp256k1](https://github.com/bitcoin-core/secp256k1)\n(the optimized C library used by Bitcoin Core)\nare available for this curve and used by default.\n\nIncluded features are:\n\n- modulo algebra functions (gcd, inverse, legendre symbol, square root)\n- octets / integer / point / var_int / var_bytes helper functions\n- elliptic curve class\n - fast algebra implemented using Jacobian coordinates\n - double scalar multiplication (Straus's algorithm, also known as\n Shamir's trick)\n - multi scalar multiplication (Bos-coster's algorithm)\n - point simmetry solution: odd/even, low/high, and quadratic residue\n - elliptic curves: SEC 1 v1 and v2, NIST, Brainpool, and\n low cardinality test curves\n- ECDSA signature with (transaction) DER encoding\n- ECDSA signature with (message) compact encoding: standard p2pkh and\n [BIP137](https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki)/[Electrum](https://electrum.org/#home)\n extensions to p2wpkh and p2wpkh-p2sh\n- [RFC 6979](https://tools.ietf.org/html/rfc6979) for deterministic signature\n schemes\n- EC Schnorr signature (according to\n [BIP340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki)\n bitcoin standardization)\n - batch validation\n - threshold signature (see test-suite)\n - MuSig multi-signature (see test-suite)\n- Borromean ring signature\n- Sign-to-contract commitment\n- Diffie-Hellman\n- Pedersen committment\n- Base58 encoding/decoding\n- p2pkh/p2sh addresses and WIFs\n- Bech32 encoding/decoding\n- p2wpkh/p2wsh native SegWit addresses and their legacy p2sh-wrapped versions\n- [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)\n hierarchical deterministic key chains\n- [SLIP132](https://github.com/satoshilabs/slips/blob/master/slip-0132.md)\n key versions (xprv, yprv, zprv, Yprv, Zprv, tprv, uprv, vprv, and Uprv)\n with corresponding mapping to\n p2pkh/p2sh, p2wpkh-p2sh, p2wpkh, p2wsh-p2sh, p2wsh and p2tr addresses\n- [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)\n wordlists and mnemonic for generating deterministic keys\n- [Electrum](https://electrum.org/#home) standard for mnemonic\n- Script encoding/decoding\n- nulldata, p2pk, p2ms, p2pkh, p2sh, p2wpkh, p2wsh and p2tr ScriptPubKeys\n- BlockHeader and Block data classes\n- OutPoint, TxIn, TxOut, and TX data classes\n- legacy, segwit_v0 and taproot transaction hash signatures\n- [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki)\n partially signed bitcoin transactions (PSBT):\n PsbtIn, PbstOut, and Psbt data classes\n\n---\n\nTo install (and/or upgrade) btclib:\n\n```shell\npython -m pip install --upgrade btclib\n```\n\nYou might want to install btclib into a\npython virtual environment; e.g. from the root folder:\n\nShell:\n\n```shell\npython -m venv venv_btclib\nsource ./venv_btclib/bin/activate\npython -m pip install --upgrade btclib\n```\n\nWindows CMD or PowerShell:\n\n```powershell\npython -m venv venv_btclib\n.\\venv_btclib\\Scripts\\activate\npython -m pip install --upgrade btclib\n```\n\nWindows Git bash shell:\n\n```bash\npython -m venv venv_btclib\ncd ./venv_btclib/Scripts\n. activate\ncd ../..\npython -m pip install --upgrade btclib\n```\n\nSee [CONTRIBUTING](./CONTRIBUTING.md) if you are interested\nin btclib develoment.\n\nSee [SECURITY](./SECURITY.md) if you have found a security vulnerability.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A library for 'bitcoin cryptography'",
"version": "2023.7.12",
"project_urls": {
"Documentation": "https://btclib.readthedocs.io/",
"Download": "https://github.com/btclib-org/btclib/releases",
"GitHub": "https://github.com/btclib-org/btclib",
"Homepage": "https://btclib.org",
"Issues": "https://github.com/btclib-org/btclib/issues",
"Pull Requests": "https://github.com/btclib-org/btclib/pulls"
},
"split_keywords": [
"bitcoin",
"cryptography",
"elliptic-curves",
"ecdsa",
"schnorr",
"rfc-6979",
"bip32",
"bip39",
"electrum",
"base58",
"bech32",
"segwit",
"message-signing",
"bip340"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c0804de656854592a91e21d55260546bdd89a8bd8f4fd1891b9a5fe9b30ab56",
"md5": "e97ad6423fafb2f77fd77bc3e32a1cb5",
"sha256": "3d790055f9a9ffccb10f867212db08563da6d1fe7bc09df55c822eaab18c9d5a"
},
"downloads": -1,
"filename": "btclib-2023.7.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e97ad6423fafb2f77fd77bc3e32a1cb5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 188600,
"upload_time": "2023-07-12T13:37:03",
"upload_time_iso_8601": "2023-07-12T13:37:03.347896Z",
"url": "https://files.pythonhosted.org/packages/0c/08/04de656854592a91e21d55260546bdd89a8bd8f4fd1891b9a5fe9b30ab56/btclib-2023.7.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb41bc908218df0a250fe0afc1e898437d074fc1cd01b37d6d903577e55453b7",
"md5": "aa5ce0f0cf5b39d0b8054fbff845c461",
"sha256": "f6501d60d24fe9b5548796d31ac7401b79894e48febc82325083c263f46dd125"
},
"downloads": -1,
"filename": "btclib-2023.7.12.tar.gz",
"has_sig": false,
"md5_digest": "aa5ce0f0cf5b39d0b8054fbff845c461",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5436094,
"upload_time": "2023-07-12T13:37:08",
"upload_time_iso_8601": "2023-07-12T13:37:08.878502Z",
"url": "https://files.pythonhosted.org/packages/eb/41/bc908218df0a250fe0afc1e898437d074fc1cd01b37d6d903577e55453b7/btclib-2023.7.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 13:37:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "btclib-org",
"github_project": "btclib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "btclib_libsecp256k1",
"specs": []
}
],
"tox": true,
"lcname": "btclib"
}
JSON
