Skip to content

Commit 4e5bb98

Browse files
authored
Update README.md
1 parent 3550b38 commit 4e5bb98

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# bitcoin_core_python_client
2-
Python to analyse bitcoin blockchain, chainstate, blockindex, mempool etc
2+
Contains many useful Programs to parse bitcoin blockchain
3+
4+
## List of programs and their utility
5+
1. blockfile_parser.py : Bitcoin blockchain is stored by default under "~/.bitcoin/blocks". This program parses those blocks to print in json format content of those files.
6+
2. leveldb_parser.py: Bitcoin blockchain indexes are stored in leveldb databases. There are three databases
7+
i. Path ~/.bitcoin/blocks/index : Block index to determine last block and its predecessors in reverse order
8+
ii. Path ~/.bitcoin/chainstate : Metadata related unspent transaction outs
9+
iii. Path ~/.bitcoin/indexes/txindex : Provides offset and block number to reach each transaction
10+
3. traverse_block_indexes.py : This program utilises bitcoin block index database stored under "~/.bitcoin/blocks/index/" to reverse traverse blockchain.
11+
4. random_number_generator.py: This is random number generator which utilizes sound, webcam frames and system random utility to generate high entropy random number.
12+
5. script_parser.py : Parses Bitcoin's reverse polish script
13+
6. pubkey_address.py : Contains utility methods for private key, public key and address
14+
7. mnemonic_code.py : Mnemonic code is a secret consisting of 12/15/18/24 words. The program generates mnemonic code from random number.
15+
8. bitcoin_networkapis.py : Uses blockchain.info APIs to get some useful information
16+
9. bitcoin_localapis.py : Uses bitcoin client RPC calls to implement useful methods
17+
18+
## List of Jupyter Notebook documents
19+
1. BlockFileParser.ipynb : Contains information on structure of blockfile, blocks and transactions
20+
2. BitcoinRPCUtils.ipynb : Contains many utility methods such as target threshold, current block size, actual block reward etc
21+
3. BitcoinEllipticCurveCryptography.ipynb : Detailed information on Bitcoin elliptic curve cryptography
22+
4.

0 commit comments

Comments
 (0)