Bitcoin cryptocurrency Library
Project description
The Python BitcoinLib is a library that provides developers with a wide range of tools to work with Bitcoin.
- With BitcoinLib you can:
Create and manage wallets
Use various key-structures for your wallet such as HD (Hierarchical Deterministic) wallets following the BIP32 standard
Interact with the Blockchain, retrieve and decode blockchain data
Build, sign and verify transactions and signatures. This could be a standard segwit transactions but also multisig, nulldata or custom made transactions
Create, analyse and run Bitcoin scripts
Generate Bitcoin addresses and represent them in different address formats like P2PKH, P2SH, Bech32, etc
Create private keys and work with Mnemonic password phrases
Use external Service providers to fetch address, transaction, utxo and blockchain data.
Connect to you local Bitcoin core, Bcoin, Blockbook or ElectrumX node.
Can be extended to support other cryptocurrencies by configuring custom parameters.
At the moment Litecoin, Dogecoin and various test networks are supported out-of-the-box.
Install
Install required packages on Ubuntu or related Linux systems:
$ sudo apt install build-essential python3-dev libgmp3-devThen install using pip
$ pip install bitcoinlibCheck out the more detailed installation instructions to read how to install on other systems or for troubleshooting.
If you are using docker you can check some Dockerfiles to create images in the docker directory.
Documentation
Read the full documentation at: http://bitcoinlib.readthedocs.io/
Example
The bitcoin library contains a wallet implementation using SQLite3 or SQLAlchemy to import, create and manage keys in a Hierarchical Deterministic way.
Example: Create wallet and generate new address (key) to receive bitcoins
>>> from bitcoinlib.wallets import Wallet
>>> w = Wallet.create('Wallet1')
>>> w.get_key().address
'bc1qk25wwkvz3am9smmm3372xct5s7cwf0hmnq8szj'Now send a small transaction to your wallet and use the scan() method to update transactions and UTXO’s
>>> w.scan()
>>> w.info() # Shows wallet information, keys, transactions and UTXO'sWhen your wallet received a payment and has unspent transaction outputs, you can send bitcoins easily. If successful a transaction ID is returned
>>> t = w.send_to('bc1qemtr8ywkzg483g8m34ukz2l4pl3730776vzq54', '0.001 BTC', offline=False)
'b7feea5e7c79d4f6f343b5ca28fa2a1fcacfe9a2b7f44f3d2fd8d6c2d82c4078'
>>> t.info # Shows transaction information and send resultsMore Examples and Use Cases
You can find many more examples in the documentation for instance about the Wallet.create() method.
There are many working examples on how to create wallets, specific transactions, encrypted databases, parse the blockchain, connect to specific service providers in the examples directory in the source code of this library.
Some more specific examples can be found on the Coineva website.
BitcoinLib is used at Blocksmurfer Explorer and many other repositories: https://github.com/1200wd/bitcoinlib/network/dependents
Contact
If you have any questions, encounter a problem or want to share an idea, please use Github Discussions
Implements the following Bitcoin Improvement Proposals
Hierarchical Deterministic Wallets (BIP0032)
Passphrase-protected private key (BIP0038)
Mnemonic code for generating deterministic keys (BIP0039)
Purpose Field for Deterministic Wallets (BIP0043)
Multi-Account Hierarchy for Deterministic Wallets (BIP0044)
Structure for Deterministic P2SH Multisignature Wallets (BIP0045)
Bech32/base32 address format for native v0-16 witness outputs (BIP0173)
Native and P2SH nested Segregated Witness transactions (BIP0141 and BIP0143)
Bech32m format for v1+ witness addresses (BIP0350)
and many more…
Future / Roadmap
Fully support timelocks
Support Taproot and Schnorr signatures
Support advanced scripts
Support for Trezor wallet or other hardware wallets
Allow to scan full blockchain
Integrate simple SPV client
Disclaimer
This library is still in development, please use at your own risk and test sufficiently before using it in a production environment.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bitcoinlib-0.7.5.tar.gz.
File metadata
- Download URL: bitcoinlib-0.7.5.tar.gz
- Upload date:
- Size: 4.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5de91c468e77144d5f3ab530c6a5b44a6e7d5a40970162f00c509861bb640da6
|
|
| MD5 |
9b65533991bd2dbd393d5a097d99d769
|
|
| BLAKE2b-256 |
bc39f002620ac4e42b30f0684c488cba72a162c078e476ddb88c15489be1027f
|
File details
Details for the file bitcoinlib-0.7.5-py3-none-any.whl.
File metadata
- Download URL: bitcoinlib-0.7.5-py3-none-any.whl
- Upload date:
- Size: 4.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3c273f0805d7aa08f292b1d4553c083bf8f1f72f4ec29479df2e05b95965c8d4
|
|
| MD5 |
2b8444ddc22975c5857875ec1a65020e
|
|
| BLAKE2b-256 |
835d07ceccd077f77cf4506668622870f78c5480e620d7f65cc091670f099ce6
|
