Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/1200wd/bitcoinlib

The Python BitcoinLib provides developers with a wide range of tools to work with Bitcoin: manage wallets, private keys and addresses. Interact with the blockchain. And create complex transactions and scripts.
https://github.com/1200wd/bitcoinlib

bitcoin bitcoin-keys-manager bitcoin-scripts bitcoin-transaction bitcoin-wallet cryptocurrency dogecoin library litecoin mnemonic python wallet

Last synced: 11 days ago
JSON representation

The Python BitcoinLib provides developers with a wide range of tools to work with Bitcoin: manage wallets, private keys and addresses. Interact with the blockchain. And create complex transactions and scripts.

Awesome Lists containing this project

README 

        
Python Bitcoin Library

======================



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

 - Uses external Service providers to fetch address, transaction, utxo and blockchain data. Or connect to you local `Bitcoin core `_, `Bcoin `_ or `Blockbook `_ node.

 - Can be extended to support other cryptocurrencies by configuring custom parameters. At the moment Litecoin and Dogecoin are also supported.



.. image:: https://github.com/1200wd/bitcoinlib/actions/workflows/unittests.yaml/badge.svg

    :target: https://github.com/1200wd/bitcoinlib/actions/workflows/unittests.yaml

    :alt: Unittests

.. image:: https://img.shields.io/pypi/v/bitcoinlib.svg

    :target: https://pypi.org/pypi/bitcoinlib/

    :alt: PyPi

.. image:: https://readthedocs.org/projects/bitcoinlib/badge/?version=latest

    :target: http://bitcoinlib.readthedocs.io/en/latest/?badge=latest

    :alt: RTD

.. image:: https://coveralls.io/repos/github/1200wd/bitcoinlib/badge.svg?branch=installation-documentation-update

    :target: https://coveralls.io/github/1200wd/bitcoinlib?branch=master

    :alt: Coveralls



Install

-------



Install required packages on Ubuntu or related Linux systems:



.. code-block:: bash



    $ sudo apt install build-essential python3-dev libgmp3-dev



Then install using pip



.. code-block:: bash



    $ pip install bitcoinlib



Check 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



.. code-block:: pycon



   >>> 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



.. code-block:: pycon



    >>> w.scan()

    >>> w.info()  # Shows wallet information, keys, transactions and UTXO's



When your wallet received a payment and has unspent transaction outputs, you can send bitcoins easily.

If successful a transaction ID is returned



.. code-block:: pycon



    >>> t = w.send_to('bc1qemtr8ywkzg483g8m34ukz2l4pl3730776vzq54', '0.001 BTC', offline=False)

    'b7feea5e7c79d4f6f343b5ca28fa2a1fcacfe9a2b7f44f3d2fd8d6c2d82c4078'

    >>> t.info  # Shows transaction information and send results



More 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.