Skip to content

Commit

Permalink
more info in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
asood123 committed Apr 1, 2019
1 parent 0c43ce0 commit dbbb45d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Bitcoin peers.dat Reader

This library was inspired by [this](https://raghavsood.com/blog/2018/05/20/demystifying-peers-dat), which uses a library written in Go.
You can use this library to dump your `peers.dat` file from your Bitcoin client. This file keeps track of all your peers and what buckets they are currently in.

I rewrote it in Python and also extracted parts of `peers.dat` that Go version was skipping - bucket data.
I was inspired by [a blogpost](https://raghavsood.com/blog/2018/05/20/demystifying-peers-dat), whose author wrote a similar library in Go.

I rewrote it in Python and also extracted parts of `peers.dat` that the Go-version was skipping, mainly bucket data.

Usage:

Expand All @@ -11,3 +13,5 @@ git clone https://github.com/asood123/bitpeers.git
pip install -r requirements.txt
python bitpeers.py --file=sample_peers.dat --output=json
```

Feel free to suggest changes or leave comments in issues.

0 comments on commit dbbb45d

Please sign in to comment.