Mercurial > public > bitcaviar-plus

comparison README.md @ 13:4bbe48c95079

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add instructions
author Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
date Tue, 26 Oct 2021 09:38:46 +0200
parents e7a84094bf07
children feae0cd7fea1
comparison
equal deleted inserted replaced
12:6a0a8cce058e 13:4bbe48c95079
1 # puppy 1 # bitcaviar-plus
2 A Bitcoin blockchain parser written in Python. 2 A Bitcoin blockchain parser written in Python.
3
4 ## Installation
5 Clone repository
6 ```bash
7 pip install bitcaviar-plus
8 ```
9
10 ## Usage
11 ### Deserialize first block from file `blk00000.dat`
12 ```python
13 from bitcaviar_plus.block import deserialize_block
14
15
16 def parse_genesis_block():
17 with open('path/to/file/blk00000.dat', 'rb') as f:
18 block = deserialize_block(f)
19 print(block)
20 ```
21
22 ### Deserialize entire blockchain
23 ```python
24 import os
25 from bitcaviar_plus.block import deserialize_block
26
27
28 def parse_entire_blockchain():
29 file_counter = -1
30 while True:
31 file_counter += 1
32 file_name = '/Users/dennis/Bitcoin/blocks/blk{}.dat'.format(str(file_counter).zfill(5))
33 with open(file_name, 'rb') as f:
34 file_size = os.path.getsize(file_name)
35 while f.tell() < file_size:
36 block = deserialize_block(f)
37 ```
38
39 ### Example output
40 ```json
41 {
42 "magic_number": "f9beb4d9",
43 "size": "0000011d",
44 "id": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
45 "transaction_count": "01",
46 "header":
47 {
48 "version": "00000001",
49 "previous_block_id": "0000000000000000000000000000000000000000000000000000000000000000",
50 "merkle_root": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
51 "time": "495fab29",
52 "bits": "1d00ffff",
53 "nonce": "7c2bac1d"
54 },
55 "transactions":
56 [
57 {
58 "version": "00000001",
59 "input_count": "01",
60 "output_count": "01",
61 "lock_time": "00000000",
62 "id": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
63 "inputs":
64 [
65 {
66 "id": "0000000000000000000000000000000000000000000000000000000000000000",
67 "vout": "ffffffff",
68 "script_sig_size": "4d",
69 "script_sig": "04ffff001d0104455468652054696d65732030332f4a616e2f32303039204368616e63656c6c6f72206f6e206272696e6b206f66207365636f6e64206261696c6f757420666f722062616e6b73",
70 "sequence": "ffffffff"
71 }
72 ],
73 "outputs":
74 [
75 {
76 "value": "000000012a05f200",
77 "script_pub_key_size": "43",
78 "script_pub_key": "4104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5fac"
79 }
80 ]
81 }
82 ]
83 }
84 ```
3 85
4 ## Attribution 86 ## Attribution
5 - [blockchain-parser](https://github.com/ragestack/blockchain-parser/blob/master/blockchain-parser.py) 87 - [blockchain-parser](https://github.com/ragestack/blockchain-parser/blob/master/blockchain-parser.py)
6 - [bitcoinbook](https://github.com/bitcoinbook/bitcoinbook) 88 - [bitcoinbook](https://github.com/bitcoinbook/bitcoinbook)
7 - [LearnMeABitcoin.com](https://learnmeabitcoin.com) 89 - [LearnMeABitcoin.com](https://learnmeabitcoin.com)