Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 3.83 KB

README.md

File metadata and controls

88 lines (61 loc) · 3.83 KB
Raw

bitcoin-blockchain-parser Build Status Coverage Status

This Python 3 library provides a parser for the raw data stored by bitcoind.

Features

  • Detects outputs types
  • Detects addresses in outputs
  • Interprets scripts
  • Supports SegWit
  • Supports ordered block parsing

Examples

Below are two basic examples for parsing the blockchain. More examples are available in the examples directory.

Unordered Blocks

This blockchain parser parses raw blocks saved in Bitcoin Core's .blk file format. Bitcoin Core does not guarantee that these blocks are saved in order. If your application does not require that blocks are parsed in order, the Blockchain.get_unordered_blocks(...) method can be used:

import os 
from blockchain_parser.blockchain import Blockchain

# Instantiate the Blockchain by giving the path to the directory 
# containing the .blk files created by bitcoind
blockchain = Blockchain(os.path.expanduser('~/.bitcoin/blocks'))
for block in blockchain.get_unordered_blocks():
    for tx in block.transactions:
        for no, output in enumerate(tx.outputs):
            print("tx=%s outputno=%d type=%s value=%s" % (tx.hash, no, output.type, output.value))

Ordered Blocks

If maintaining block order is necessary for your application, you should use the Blockchain.get_ordered_blocks(...) method. This method uses Bitcoin Core's LevelDB index to locate ordered block data in it's .blk files.

import os 
from blockchain_parser.blockchain import Blockchain

# To get the blocks ordered by height, you need to provide the path of the
# `index` directory (LevelDB index) being maintained by bitcoind. It contains
# .ldb files and is present inside the `blocks` directory.
for block in blockchain.get_ordered_blocks(os.path.expanduser('~/.bitcoin/blocks/index'), end=1000):
    print("height=%d block=%s" % (block.height, block.hash))

Blocks can be iterated in reverse by specifying a start parameter that is greater than the end parameter.

for block in blockchain.get_ordered_blocks(os.path.expanduser('~/.bitcoin/blocks/index'), start=510000, end=0):
    print("height=%d block=%s" % (block.height, block.hash))

Building the LevelDB index can take a while which can make iterative development and debugging challenging. For this reason, Blockchain.get_ordered_blocks(...) supports caching the LevelDB index database using pickle. To use a cache simply pass cache=filename to the ordered blocks method. If the cached file does not exist it will be created for faster parsing the next time the method is run. If the cached file already exists it will be used instead of re-parsing the LevelDB database.

for block in blockchain.get_ordered_blocks(os.path.expanduser('~/.bitcoin/blocks/index'), cache='index-cache.pickle'):
    print("height=%d block=%s" % (block.height, block.hash))

NOTE: You must manually/programmatically delete the cache file in order to rebuild the cache. Don't forget to do this each time you would like to re-parse the blockchain with a higher block height than the first time you saved the cache file as the new blocks will not be included in the cache.

Installing

Requirements : python-bitcoinlib, plyvel, coverage for tests

plyvel requires leveldb development libraries for LevelDB >1.2.X

On Linux, install libleveldb-dev

sudo apt-get install libleveldb-dev

Then, just run

python setup.py install

Tests

Run the test suite by lauching

./tests.sh