Skip to content

Commit 4f31bfa

Browse files
Jeff GarzikJeff Garzik
authored andcommitted
Add simple README
1 parent 54c1300 commit 4f31bfa

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
This python script (node.py) is a client node for the bitcoin network.
3+
It is based on ArtForz' half-a-node at http://pastebin.com/ZSM7iHZw
4+
5+
In its current form, node.py does nothing more than listen for new
6+
transactions and blocks, perform some simple verification checks on
7+
the data, and store them in a database. It does not handle script
8+
verification or chain reorg, and is therefore not safe for general use.
9+
10+
It might be useful as the base for a P2P monitoring node, or similar
11+
tasks.
12+
13+
Command line usage:
14+
15+
./node.py my-config-file
16+
17+
The configuration file is a key=value text file, with the following settings:
18+
19+
# hostname or IP address of network node to connect to
20+
host=127.0.0.1
21+
22+
# port of network node to connect to (default: 8333)
23+
port=8333
24+
25+
# database directory
26+
db=/tmp/chaindb
27+
28+
# log filename, or '-' or no-value for standard output
29+
log=/tmp/chaindb/node.log
30+
31+
# if present, import these blocks into the block database
32+
loadblock=/tmp/blk0001.dat
33+
34+
node.py connects to a single remote node, and does not accept incoming
35+
P2P connections. If the connection is lost, node.py exits.
36+

0 commit comments

Comments
 (0)