Skip to content

Commit 27b3df2

Browse files
authored
Merge pull request #29 from ragestack/release/v2
Release v2.0.0: new license, docs, and parser updates
2 parents 4c7ec42 + 1cb3302 commit 27b3df2

File tree

9 files changed

+525773
-47616
lines changed

9 files changed

+525773
-47616
lines changed

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog
2+
3+
## 2.0.0
4+
5+
### Licensing
6+
- License changed to a source-available model.
7+
- Free for non-commercial use with attribution.
8+
- Commercial use and any SaaS / cloud / hosted use require a paid license.
9+
- Added a limited compatibility warranty related to block-format updates.
10+
11+
### Technical changes
12+
- Added support for XOR-key handling when parsing `blocksdir` `*.dat` files.
13+
- The parser now detects whether an XOR key applies to the block files.
14+
- If no XOR key is present, or if the key is effectively zero, block files
15+
are parsed directly without decryption.
16+
- Compatible with existing `blocksdir` layouts and newly initialized ones
17+
using `blocksxor` (default: enabled).
18+
19+
- Improved incremental parsing behavior.
20+
- The parser now detects already processed block files in the `./result/`
21+
directory and processes only new block files.
22+
- If an incomplete or partially written `.dat` file is detected (typically
23+
the last file in the blocks directory), the parser reports an error and
24+
terminates execution without processing that file to avoid corrupted output.

COMMERCIAL.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Commercial licensing
2+
3+
This project is **source-available**.
4+
5+
Free for **non-commercial** use with attribution.
6+
7+
## Commercial use
8+
Commercial use requires a paid license from the author.
9+
10+
Commercial use includes (but is not limited to):
11+
- use in a for-profit company (internal or external)
12+
- use in paid products or services
13+
- monetized analytics or consulting deliverables built on the Software
14+
15+
## SaaS / cloud / hosted use
16+
SaaS / cloud / hosted / API use is not permitted without a paid license,
17+
even if the service is offered free of charge.
18+
19+
## Contact
20+
21+
To obtain a commercial license or clarify licensing terms, please contact:
22+
23+
**Denis Leonov**
24+
Email: **[email protected]**
25+
26+
Additional contact information:
27+
https://aaris.ru/DL

LICENSE

Lines changed: 166 additions & 674 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 98 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,111 @@
1-
# Blockchain parser
1+
# Blockchain Scalpel
2+
(formerly: Blockchain parser / Russian scalpel)
23

3-
## Russian scalpel
44
## Русский скальпель
55

6-
**Author:** Denis Leonov <[email protected]>
6+
**Author:** Denis Leonov (ragestack)
7+
**Contact:** [email protected]
78

8-
Simple script for parsing **blkXXXXX.dat** files of Bitcoin blockchain database.
9+
Blockchain Scalpel is a lightweight script for parsing raw **blkXXXXX.dat**
10+
files of the Bitcoin blockchain database.
911

10-
This script also compatible with most of altcoins, after making some tiny tricks.
12+
The tool provides direct access to blockchain data stored on disk and allows
13+
exploring the main database as close as possible to its original binary
14+
representation.
1115

12-
**The one realisation of blockchain parser that allows you to explore the main database as close as possible.**
16+
The parser is also compatible with many altcoins with minimal adjustments.
1317

14-
![blockchain parser](https://hsto.org/getpro/habr/post_images/dad/899/889/dad89988966ca08db3223bbc9b2afc90.jpg)
18+
---
1519

16-
Don't worry to email me your questions or suggestions about this parser.
20+
## Overview
1721

18-
No dependencies, no third-parties modules or libs needed. Just install Python standart release and run.
22+
Blockchain Scalpel is a low-level blockchain data parser designed for research,
23+
analysis, and infrastructure-level processing.
1924

20-
Make sure you change the paths for **blkXXXXX.dat** files and for the parsing results to yours.
25+
The project focuses on:
26+
- transparent and deterministic parsing
27+
- minimal dependencies
28+
- direct work with raw blockchain data
29+
- long-term maintainability
2130

22-
This script convert the full blockchain raw database that is stored in **blkXXXXX.dat** files to the simple **txt** view.
31+
No third-party modules or libraries are required.
32+
A standard Python installation is sufficient.
2333

24-
**If this was helpfull for you, don't hesistate to make a donations!!!**
34+
---
2535

26-
Bitcoin (BTC): 1FvssyzXNnmgHbJg2DYwb7rkzTrtT8adcL
36+
## Typical Usage
37+
38+
- academic and scientific research
39+
- grant-funded university projects
40+
- blockchain data analysis and forensics
41+
- internal analytics and data processing pipelines
42+
43+
The script converts the raw blockchain database stored in **blkXXXXX.dat**
44+
files into a simple, human-readable format.
45+
46+
Make sure to configure the paths for:
47+
- input **blkXXXXX.dat** files
48+
- output directory for parsing results
49+
50+
---
51+
52+
## Source Code
53+
54+
Repository:
55+
https://github.com/ragestack/blockchain-parser
56+
57+
---
58+
59+
## License
60+
61+
### Important: License by version
62+
63+
- Versions **up to and including `v1.0.0-gpl`** are licensed under **GPL-3.0**
64+
- Versions **starting from `v2.0.0`** are distributed under the
65+
**Blockchain Scalpel License** (source-available)
66+
67+
### License summary (v2.0.0 and later)
68+
69+
- Free for **non-commercial use** with mandatory attribution
70+
- Academic and grant-funded research is permitted
71+
- **Commercial use requires a paid license**
72+
- **SaaS / cloud / hosted use is not permitted without a commercial license**
73+
74+
See the full license text in the `LICENSE` file.
75+
76+
---
77+
78+
## Commercial Licensing
79+
80+
Commercial licenses, including licenses permitting use in commercial
81+
organizations or SaaS / cloud / hosted environments, are available under
82+
negotiated terms.
83+
84+
For commercial licensing inquiries, contact:
85+
86+
**Denis Leonov**
87+
88+
89+
---
90+
91+
## Warranty
92+
93+
A limited compatibility warranty is provided for changes introduced by the
94+
author related to new or updated blockchain block formats.
95+
96+
This warranty is limited in scope and does not constitute an SLA.
97+
98+
See `WARRANTY.md` for details.
99+
100+
---
101+
102+
## Notes
103+
104+
If this project is useful for your research or work, attribution to the author
105+
is required.
106+
107+
Questions and licensing inquiries are welcome via email.
108+
109+
---
110+
111+
© Denis Leonov. All rights reserved.

WARRANTY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Limited compatibility warranty (block format changes)
2+
3+
The author provides a limited warranty related to changes introduced
4+
by the author for new/updated block formats.
5+
6+
If a released version contains a material parsing error for a supported
7+
block format due to such changes, the author will make reasonable efforts
8+
to provide a fix in a subsequent release.
9+
10+
This is not an SLA and does not cover forks, undocumented protocol changes,
11+
external data corruption, or third-party modifications.

0 commit comments

Comments
 (0)