blockchain-parser-2 0.1.6__tar.gz

blockchain_parser_2-0.1.6/LICENSE

@@ -0,0 +1,177 @@
+bitcoin-blockchain-parser is free software: you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+bitcoin-blockchain-parser is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+below for more details.
+
+
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

blockchain_parser_2-0.1.6/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+include requirements.txt
+recursive-include blockchain_parser *
+global-exclude __pycache__
+global-exclude *.py[cod]
+prune pip-package
+prune build
+prune dist

blockchain_parser_2-0.1.6/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: blockchain-parser-2
+Version: 0.1.6
+Summary: Bitcoin blockchain parser
+Home-page: https://github.com/chainlaboratory/blockchain-parser-2.0
+Author: Antoine Le Calvez
+Author-email: antoine@p2sh.info
+License: LGPL-3.0-or-later
+Project-URL: Source, https://github.com/chainlaboratory/blockchain-parser-2.0
+Project-URL: Upstream, https://github.com/alecalve/python-bitcoin-blockchain-parser
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-bitcoinlib==0.11.0
+Requires-Dist: plyvel==1.5.1
+Requires-Dist: ripemd-hash==1.0.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# bitcoin-blockchain-parser ![Build Status](https://github.com/alecalve/python-bitcoin-blockchain-parser/actions/workflows/python-package.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/alecalve/python-bitcoin-blockchain-parser/badge.svg?branch=master&service=github)](https://coveralls.io/github/alecalve/python-bitcoin-blockchain-parser?branch=master)
+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 and Taproot
+- Supports ordered block parsing
+
+## Installing
+
+Whether installing using Pip or from source, plyvel requires leveldb development libraries for LevelDB >1.2.X.
+
+On Linux, install libleveldb-dev
+
+```
+sudo apt-get install libleveldb-dev
+```
+
+### Using pip
+
+```
+pip install blockchain-parser-2
+```
+
+### Using source
+
+Requirements : python-bitcoinlib, plyvel, coverage for tests
+
+
+Install dependencies contained in `requirements.txt`:
+```
+pip install -r requirements.txt
+```
+
+Then, just run
+```
+python setup.py install
+```
+
+## Developing
+
+First, setup a virtualenv and install dependencies:
+
+```
+virtualenv -p python3 .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+Run the test suite by lauching
+```
+pytest
+```
+
+## 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:
+
+```python
+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.
+
+```python
+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.
+blockchain = Blockchain(os.path.expanduser('~/.bitcoin/blocks'))
+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.
+
+```python
+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](https://docs.python.org/3.6/library/pickle.html). 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.
+
+```python
+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.
+

blockchain_parser_2-0.1.6/README.md

@@ -0,0 +1,109 @@
+# bitcoin-blockchain-parser ![Build Status](https://github.com/alecalve/python-bitcoin-blockchain-parser/actions/workflows/python-package.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/alecalve/python-bitcoin-blockchain-parser/badge.svg?branch=master&service=github)](https://coveralls.io/github/alecalve/python-bitcoin-blockchain-parser?branch=master)
+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 and Taproot
+- Supports ordered block parsing
+
+## Installing
+
+Whether installing using Pip or from source, plyvel requires leveldb development libraries for LevelDB >1.2.X.
+
+On Linux, install libleveldb-dev
+
+```
+sudo apt-get install libleveldb-dev
+```
+
+### Using pip
+
+```
+pip install blockchain-parser-2
+```
+
+### Using source
+
+Requirements : python-bitcoinlib, plyvel, coverage for tests
+
+
+Install dependencies contained in `requirements.txt`:
+```
+pip install -r requirements.txt
+```
+
+Then, just run
+```
+python setup.py install
+```
+
+## Developing
+
+First, setup a virtualenv and install dependencies:
+
+```
+virtualenv -p python3 .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+Run the test suite by lauching
+```
+pytest
+```
+
+## 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:
+
+```python
+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.
+
+```python
+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.
+blockchain = Blockchain(os.path.expanduser('~/.bitcoin/blocks'))
+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.
+
+```python
+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](https://docs.python.org/3.6/library/pickle.html). 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.
+
+```python
+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.
+

blockchain_parser_2-0.1.6/blockchain_parser/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (C) 2015-2016 The bitcoin-blockchain-parser developers
+#
+# This file is part of bitcoin-blockchain-parser.
+#
+# It is subject to the license terms in the LICENSE file found in the top-level
+# directory of this distribution.
+#
+# No part of bitcoin-blockchain-parser, including this file, may be copied,
+# modified, propagated, or distributed except according to the terms contained
+# in the LICENSE file.
+
+__version__ = "0.1.6"

blockchain_parser_2-0.1.6/blockchain_parser/address.py

@@ -0,0 +1,83 @@
+# Copyright (C) 2015-2016 The bitcoin-blockchain-parser developers
+#
+# This file is part of bitcoin-blockchain-parser.
+#
+# It is subject to the license terms in the LICENSE file found in the top-level
+# directory of this distribution.
+#
+# No part of bitcoin-blockchain-parser, including this file, may be copied,
+# modified, propagated, or distributed except according to the terms contained
+# in the LICENSE file.
+
+from bitcoin import base58
+from bitcoin.bech32 import CBech32Data
+from .utils import btc_ripemd160, double_sha256
+from .utils_taproot import from_taproot
+from binascii import b2a_hex
+
+
+class Address(object):
+    """Represents a bitcoin address"""
+
+    def __init__(self, hash, public_key, address, type, segwit_version):
+        self._hash = hash
+        self.public_key = public_key
+        self._address = address
+        self.type = type
+        self._segwit_version = segwit_version
+
+    def __repr__(self):
+        return "Address(addr=%s)" % self.address
+
+    @classmethod
+    def from_public_key(cls, public_key):
+        """Constructs an Address object from a public key"""
+        return cls(None, public_key, None, "normal", None)
+
+    @classmethod
+    def from_ripemd160(cls, hash, type="normal"):
+        """Constructs an Address object from a RIPEMD-160 hash, it may be a
+        normal address or a P2SH address, the latter is indicated by setting
+        type to 'p2sh'"""
+        return cls(hash, None, None, type, None)
+
+    @classmethod
+    def from_bech32(cls, hash, segwit_version):
+        """Constructs an Address object from a bech32 hash."""
+        return cls(hash, None, None, "bech32", segwit_version)
+
+    @classmethod
+    def from_bech32m(cls, hash, segwit_version):
+        """Constructs an Address object from a bech32m script."""
+        return cls(hash, None, None, "bech32m", segwit_version)
+
+    @property
+    def hash(self):
+        """Returns the RIPEMD-160 hash corresponding to this address"""
+        if self.public_key is not None and self._hash is None:
+            self._hash = btc_ripemd160(self.public_key)
+        return self._hash
+
+    @property
+    def address(self):
+        """Returns the encoded representation of this address.
+        If Taproot, it's encoded using bech32m,
+        if SegWit, it's encoded using bech32,
+        otherwise using base58
+        """
+        if self._address is None:
+            if self.type == "bech32m":
+                tweaked_pubkey = b2a_hex(self.hash).decode("ascii")
+                self._address = from_taproot(tweaked_pubkey)
+            elif self.type != "bech32":
+                version = b'\x00' if self.type == "normal" else b'\x05'
+                checksum = double_sha256(version + self.hash)
+
+                self._address = base58.encode(version + self.hash + checksum[:4])
+            else:
+                bech_encoded = CBech32Data.from_bytes(self._segwit_version, self._hash)
+                self._address = str(bech_encoded)
+        return self._address
+
+    def is_p2sh(self):
+        return self.type == "p2sh"

blockchain_parser_2-0.1.6/blockchain_parser/block.py

@@ -0,0 +1,104 @@
+# Copyright (C) 2015-2016 The bitcoin-blockchain-parser developers
+#
+# This file is part of bitcoin-blockchain-parser.
+#
+# It is subject to the license terms in the LICENSE file found in the top-level
+# directory of this distribution.
+#
+# No part of bitcoin-blockchain-parser, including this file, may be copied,
+# modified, propagated, or distributed except according to the terms contained
+# in the LICENSE file.
+
+from .transaction import Transaction
+from .block_header import BlockHeader
+from .utils import format_hash, decode_compactsize, double_sha256
+
+
+def get_block_transactions(raw_hex):
+    """Given the raw hexadecimal representation of a block,
+    yields the block's transactions
+    """
+    # Skipping the header
+    transaction_data = raw_hex[80:]
+
+    # Decoding the number of transactions, offset is the size of
+    # the varint (1 to 9 bytes)
+    n_transactions, offset = decode_compactsize(transaction_data)
+
+    for i in range(n_transactions):
+        transaction = None
+        # Try from 1024 (1KiB) -> 512MiB slice widths
+        for j in range(0, 20):
+            try:
+                offset_e = offset + (1024 * 2 ** j)
+                transaction = Transaction.from_hex(
+                    transaction_data[offset:offset_e])
+                break
+            except Exception:
+                transaction = None
+        if transaction is None:
+            raise ValueError(
+                "failed to parse transaction %d at offset %d" % (i, offset)
+            )
+
+        yield transaction
+        # Skipping to the next transaction
+        offset += transaction.size
+
+
+class Block(object):
+    """
+    Represents a Bitcoin block, contains its header and its transactions.
+    """
+
+    def __init__(self, raw_hex, height=None, blk_file=None):
+        self.hex = raw_hex
+        self._hash = None
+        self._transactions = None
+        self._header = None
+        self._n_transactions = None
+        self.size = len(raw_hex)
+        self.height = height
+        self.blk_file = blk_file
+
+    def __repr__(self):
+        return "Block(%s)" % self.hash
+
+    @classmethod
+    def from_hex(cls, raw_hex):
+        """Builds a block object from its bytes representation"""
+        return cls(raw_hex)
+
+    @property
+    def hash(self):
+        """Returns the block's hash (double sha256 of its 80 bytes header"""
+        if self._hash is None:
+            self._hash = format_hash(double_sha256(self.hex[:80]))
+        return self._hash
+
+    @property
+    def n_transactions(self):
+        """Return the number of transactions contained in this block,
+        it is faster to use this than to use len(block.transactions)
+        as there's no need to parse all transactions to get this information
+        """
+        if self._n_transactions is None:
+            self._n_transactions = decode_compactsize(self.hex[80:])[0]
+
+        return self._n_transactions
+
+    @property
+    def transactions(self):
+        """Returns a list of the block's transactions represented
+        as Transaction objects"""
+        if self._transactions is None:
+            self._transactions = list(get_block_transactions(self.hex))
+
+        return self._transactions
+
+    @property
+    def header(self):
+        """Returns a BlockHeader object corresponding to this block"""
+        if self._header is None:
+            self._header = BlockHeader.from_hex(self.hex[:80])
+        return self._header