remove dangling whitespace
[stratum-mining.git] / lib / halfnode.py
1 #!/usr/bin/python
2 # Public Domain
3 # Original author: ArtForz
4 # Twisted integration: slush
5
6 import struct
7 import socket
8 import binascii
9 import time
10 import sys
11 import random
12 import cStringIO
13 from Crypto.Hash import SHA256
14
15 from twisted.internet.protocol import Protocol
16 from util import *
17
18 MY_VERSION = 31402
19 MY_SUBVERSION = ".4"
20
21 class CAddress(object):
22     def __init__(self):
23         self.nTime = 0
24         self.nServices = 1
25         self.pchReserved = "\x00" * 10 + "\xff" * 2
26         self.ip = "0.0.0.0"
27         self.port = 0
28     def deserialize(self, f):
29         #self.nTime = struct.unpack("<I", f.read(4))[0]
30         self.nServices = struct.unpack("<Q", f.read(8))[0]
31         self.pchReserved = f.read(12)
32         self.ip = socket.inet_ntoa(f.read(4))
33         self.port = struct.unpack(">H", f.read(2))[0]
34     def serialize(self):
35         r = ""
36         #r += struct.pack("<I", self.nTime)
37         r += struct.pack("<Q", self.nServices)
38         r += self.pchReserved
39         r += socket.inet_aton(self.ip)
40         r += struct.pack(">H", self.port)
41         return r
42     def __repr__(self):
43         return "CAddress(nServices=%i ip=%s port=%i)" % (self.nServices, self.ip, self.port)
44
45 class CInv(object):
46     typemap = {
47         0: "Error",
48         1: "TX",
49         2: "Block"}
50     def __init__(self):
51         self.type = 0
52         self.hash = 0L
53     def deserialize(self, f):
54         self.type = struct.unpack("<i", f.read(4))[0]
55         self.hash = deser_uint256(f)
56     def serialize(self):
57         r = ""
58         r += struct.pack("<i", self.type)
59         r += ser_uint256(self.hash)
60         return r
61     def __repr__(self):
62         return "CInv(type=%s hash=%064x)" % (self.typemap[self.type], self.hash)
63
64 class CBlockLocator(object):
65     def __init__(self):
66         self.nVersion = MY_VERSION
67         self.vHave = []
68     def deserialize(self, f):
69         self.nVersion = struct.unpack("<i", f.read(4))[0]
70         self.vHave = deser_uint256_vector(f)
71     def serialize(self):
72         r = ""
73         r += struct.pack("<i", self.nVersion)
74         r += ser_uint256_vector(self.vHave)
75         return r
76     def __repr__(self):
77         return "CBlockLocator(nVersion=%i vHave=%s)" % (self.nVersion, repr(self.vHave))
78
79 class COutPoint(object):
80     def __init__(self):
81         self.hash = 0
82         self.n = 0
83     def deserialize(self, f):
84         self.hash = deser_uint256(f)
85         self.n = struct.unpack("<I", f.read(4))[0]
86     def serialize(self):
87         r = ""
88         r += ser_uint256(self.hash)
89         r += struct.pack("<I", self.n)
90         return r
91     def __repr__(self):
92         return "COutPoint(hash=%064x n=%i)" % (self.hash, self.n)
93
94 class CTxIn(object):
95     def __init__(self):
96         self.prevout = COutPoint()
97         self.scriptSig = ""
98         self.nSequence = 0
99     def deserialize(self, f):
100         self.prevout = COutPoint()
101         self.prevout.deserialize(f)
102         self.scriptSig = deser_string(f)
103         self.nSequence = struct.unpack("<I", f.read(4))[0]
104     def serialize(self):
105         r = ""
106         r += self.prevout.serialize()
107         r += ser_string(self.scriptSig)
108         r += struct.pack("<I", self.nSequence)
109         return r
110     def __repr__(self):
111         return "CTxIn(prevout=%s scriptSig=%s nSequence=%i)" % (repr(self.prevout), binascii.hexlify(self.scriptSig), self.nSequence)
112
113 class CTxOut(object):
114     def __init__(self):
115         self.nValue = 0
116         self.scriptPubKey = ""
117     def deserialize(self, f):
118         self.nValue = struct.unpack("<q", f.read(8))[0]
119         self.scriptPubKey = deser_string(f)
120     def serialize(self):
121         r = ""
122         r += struct.pack("<q", self.nValue)
123         r += ser_string(self.scriptPubKey)
124         return r
125     def __repr__(self):
126         return "CTxOut(nValue=%i.%08i scriptPubKey=%s)" % (self.nValue // 100000000, self.nValue % 100000000, binascii.hexlify(self.scriptPubKey))
127
128 class CTransaction(object):
129     def __init__(self):
130         self.nVersion = 1
131         self.vin = []
132         self.vout = []
133         self.nLockTime = 0
134         self.sha256 = None
135     def deserialize(self, f):
136         self.nVersion = struct.unpack("<i", f.read(4))[0]
137         self.vin = deser_vector(f, CTxIn)
138         self.vout = deser_vector(f, CTxOut)
139         self.nLockTime = struct.unpack("<I", f.read(4))[0]
140         self.sha256 = None
141     def serialize(self):
142         r = ""
143         r += struct.pack("<i", self.nVersion)
144         r += ser_vector(self.vin)
145         r += ser_vector(self.vout)
146         r += struct.pack("<I", self.nLockTime)
147         return r
148
149     def calc_sha256(self):
150         if self.sha256 is None:
151             self.sha256 = uint256_from_str(SHA256.new(SHA256.new(self.serialize()).digest()).digest())
152         return self.sha256
153
154     def is_valid(self):
155         self.calc_sha256()
156         for tout in self.vout:
157             if tout.nValue < 0 or tout.nValue > 21000000L * 100000000L:
158                 return False
159         return True
160     def __repr__(self):
161         return "CTransaction(nVersion=%i vin=%s vout=%s nLockTime=%i)" % (self.nVersion, repr(self.vin), repr(self.vout), self.nLockTime)
162
163 class CBlock(object):
164     def __init__(self):
165         self.nVersion = 1
166         self.hashPrevBlock = 0
167         self.hashMerkleRoot = 0
168         self.nTime = 0
169         self.nBits = 0
170         self.nNonce = 0
171         self.vtx = []
172         self.sha256 = None
173     def deserialize(self, f):
174         self.nVersion = struct.unpack("<i", f.read(4))[0]
175         self.hashPrevBlock = deser_uint256(f)
176         self.hashMerkleRoot = deser_uint256(f)
177         self.nTime = struct.unpack("<I", f.read(4))[0]
178         self.nBits = struct.unpack("<I", f.read(4))[0]
179         self.nNonce = struct.unpack("<I", f.read(4))[0]
180         self.vtx = deser_vector(f, CTransaction)
181     def serialize(self):
182         r = []
183         r.append(struct.pack("<i", self.nVersion))
184         r.append(ser_uint256(self.hashPrevBlock))
185         r.append(ser_uint256(self.hashMerkleRoot))
186         r.append(struct.pack("<I", self.nTime))
187         r.append(struct.pack("<I", self.nBits))
188         r.append(struct.pack("<I", self.nNonce))
189         r.append(ser_vector(self.vtx))
190         return ''.join(r)
191     def calc_sha256(self):
192         if self.sha256 is None:
193             r = []
194             r.append(struct.pack("<i", self.nVersion))
195             r.append(ser_uint256(self.hashPrevBlock))
196             r.append(ser_uint256(self.hashMerkleRoot))
197             r.append(struct.pack("<I", self.nTime))
198             r.append(struct.pack("<I", self.nBits))
199             r.append(struct.pack("<I", self.nNonce))
200             self.sha256 = uint256_from_str(SHA256.new(SHA256.new(''.join(r)).digest()).digest())
201         return self.sha256
202
203     def is_valid(self):
204         self.calc_sha256()
205         target = uint256_from_compact(self.nBits)
206         if self.sha256 > target:
207             return False
208         hashes = []
209         for tx in self.vtx:
210             tx.sha256 = None
211             if not tx.is_valid():
212                 return False
213             tx.calc_sha256()
214             hashes.append(ser_uint256(tx.sha256))
215
216         while len(hashes) > 1:
217             newhashes = []
218             for i in xrange(0, len(hashes), 2):
219                 i2 = min(i+1, len(hashes)-1)
220                 newhashes.append(SHA256.new(SHA256.new(hashes[i] + hashes[i2]).digest()).digest())
221             hashes = newhashes
222
223         if uint256_from_str(hashes[0]) != self.hashMerkleRoot:
224             return False
225         return True
226     def __repr__(self):
227         return "CBlock(nVersion=%i hashPrevBlock=%064x hashMerkleRoot=%064x nTime=%s nBits=%08x nNonce=%08x vtx=%s)" % (self.nVersion, self.hashPrevBlock, self.hashMerkleRoot, time.ctime(self.nTime), self.nBits, self.nNonce, repr(self.vtx))
228
229 class msg_version(object):
230     command = "version"
231     def __init__(self):
232         self.nVersion = MY_VERSION
233         self.nServices = 0
234         self.nTime = time.time()
235         self.addrTo = CAddress()
236         self.addrFrom = CAddress()
237         self.nNonce = random.getrandbits(64)
238         self.strSubVer = MY_SUBVERSION
239         self.nStartingHeight = 0
240
241     def deserialize(self, f):
242         self.nVersion = struct.unpack("<i", f.read(4))[0]
243         if self.nVersion == 10300:
244             self.nVersion = 300
245         self.nServices = struct.unpack("<Q", f.read(8))[0]
246         self.nTime = struct.unpack("<q", f.read(8))[0]
247         self.addrTo = CAddress()
248         self.addrTo.deserialize(f)
249         self.addrFrom = CAddress()
250         self.addrFrom.deserialize(f)
251         self.nNonce = struct.unpack("<Q", f.read(8))[0]
252         self.strSubVer = deser_string(f)
253         self.nStartingHeight = struct.unpack("<i", f.read(4))[0]
254     def serialize(self):
255         r = []
256         r.append(struct.pack("<i", self.nVersion))
257         r.append(struct.pack("<Q", self.nServices))
258         r.append(struct.pack("<q", self.nTime))
259         r.append(self.addrTo.serialize())
260         r.append(self.addrFrom.serialize())
261         r.append(struct.pack("<Q", self.nNonce))
262         r.append(ser_string(self.strSubVer))
263         r.append(struct.pack("<i", self.nStartingHeight))
264         return ''.join(r)
265     def __repr__(self):
266         return "msg_version(nVersion=%i nServices=%i nTime=%s addrTo=%s addrFrom=%s nNonce=0x%016X strSubVer=%s nStartingHeight=%i)" % (self.nVersion, self.nServices, time.ctime(self.nTime), repr(self.addrTo), repr(self.addrFrom), self.nNonce, self.strSubVer, self.nStartingHeight)
267
268 class msg_verack(object):
269     command = "verack"
270     def __init__(self):
271         pass
272     def deserialize(self, f):
273         pass
274     def serialize(self):
275         return ""
276     def __repr__(self):
277         return "msg_verack()"
278
279 class msg_addr(object):
280     command = "addr"
281     def __init__(self):
282         self.addrs = []
283     def deserialize(self, f):
284         self.addrs = deser_vector(f, CAddress)
285     def serialize(self):
286         return ser_vector(self.addrs)
287     def __repr__(self):
288         return "msg_addr(addrs=%s)" % (repr(self.addrs))
289
290 class msg_inv(object):
291     command = "inv"
292     def __init__(self):
293         self.inv = []
294     def deserialize(self, f):
295         self.inv = deser_vector(f, CInv)
296     def serialize(self):
297         return ser_vector(self.inv)
298     def __repr__(self):
299         return "msg_inv(inv=%s)" % (repr(self.inv))
300
301 class msg_getdata(object):
302     command = "getdata"
303     def __init__(self):
304         self.inv = []
305     def deserialize(self, f):
306         self.inv = deser_vector(f, CInv)
307     def serialize(self):
308         return ser_vector(self.inv)
309     def __repr__(self):
310         return "msg_getdata(inv=%s)" % (repr(self.inv))
311
312 class msg_getblocks(object):
313     command = "getblocks"
314     def __init__(self):
315         self.locator = CBlockLocator()
316         self.hashstop = 0L
317     def deserialize(self, f):
318         self.locator = CBlockLocator()
319         self.locator.deserialize(f)
320         self.hashstop = deser_uint256(f)
321     def serialize(self):
322         r = []
323         r.append(self.locator.serialize())
324         r.append(ser_uint256(self.hashstop))
325         return ''.join(r)
326     def __repr__(self):
327         return "msg_getblocks(locator=%s hashstop=%064x)" % (repr(self.locator), self.hashstop)
328
329 class msg_tx(object):
330     command = "tx"
331     def __init__(self):
332         self.tx = CTransaction()
333     def deserialize(self, f):
334         self.tx.deserialize(f)
335     def serialize(self):
336         return self.tx.serialize()
337     def __repr__(self):
338         return "msg_tx(tx=%s)" % (repr(self.tx))
339
340 class msg_block(object):
341     command = "block"
342     def __init__(self):
343         self.block = CBlock()
344     def deserialize(self, f):
345         self.block.deserialize(f)
346     def serialize(self):
347         return self.block.serialize()
348     def __repr__(self):
349         return "msg_block(block=%s)" % (repr(self.block))
350
351 class msg_getaddr(object):
352     command = "getaddr"
353     def __init__(self):
354         pass
355     def deserialize(self, f):
356         pass
357     def serialize(self):
358         return ""
359     def __repr__(self):
360         return "msg_getaddr()"
361
362 class msg_ping(object):
363     command = "ping"
364     def __init__(self):
365         pass
366     def deserialize(self, f):
367         pass
368     def serialize(self):
369         return ""
370     def __repr__(self):
371         return "msg_ping()"
372
373 class msg_alert(object):
374     command = "alert"
375     def __init__(self):
376         pass
377     def deserialize(self, f):
378         pass
379     def serialize(self):
380         return ""
381     def __repr__(self):
382         return "msg_alert()"
383
384 class BitcoinP2PProtocol(Protocol):
385     messagemap = {
386         "version": msg_version,
387         "verack": msg_verack,
388         "addr": msg_addr,
389         "inv": msg_inv,
390         "getdata": msg_getdata,
391         "getblocks": msg_getblocks,
392         "tx": msg_tx,
393         "block": msg_block,
394         "getaddr": msg_getaddr,
395         "ping": msg_ping,
396         "alert": msg_alert,
397     }
398
399     def connectionMade(self):
400         peer = self.transport.getPeer()
401         self.dstaddr = peer.host
402         self.dstport = peer.port
403         self.recvbuf = ""
404         self.last_sent = 0
405
406         t = msg_version()
407         t.nStartingHeight = getattr(self, 'nStartingHeight', 0)
408         t.addrTo.ip = self.dstaddr
409         t.addrTo.port = self.dstport
410         t.addrTo.nTime = time.time()
411         t.addrFrom.ip = "0.0.0.0"
412         t.addrFrom.port = 0
413         t.addrFrom.nTime = time.time()
414         self.send_message(t)
415
416     def dataReceived(self, data):
417         self.recvbuf += data
418         self.got_data()
419
420     def got_data(self):
421         while True:
422             if len(self.recvbuf) < 4:
423                 return
424             if self.recvbuf[:4] != "\xf9\xbe\xb4\xd9":
425                 raise ValueError("got garbage %s" % repr(self.recvbuf))
426
427             if len(self.recvbuf) < 4 + 12 + 4 + 4:
428                 return
429             command = self.recvbuf[4:4+12].split("\x00", 1)[0]
430             msglen = struct.unpack("<i", self.recvbuf[4+12:4+12+4])[0]
431             checksum = self.recvbuf[4+12+4:4+12+4+4]
432             if len(self.recvbuf) < 4 + 12 + 4 + 4 + msglen:
433                 return
434             msg = self.recvbuf[4+12+4+4:4+12+4+4+msglen]
435             th = SHA256.new(msg).digest()
436             h = SHA256.new(th).digest()
437             if checksum != h[:4]:
438                 raise ValueError("got bad checksum %s" % repr(self.recvbuf))
439             self.recvbuf = self.recvbuf[4+12+4+4+msglen:]
440
441             if command in self.messagemap:
442                 f = cStringIO.StringIO(msg)
443                 t = self.messagemap[command]()
444                 t.deserialize(f)
445                 self.got_message(t)
446             else:
447                 print "UNKNOWN COMMAND", command, repr(msg)
448
449     def prepare_message(self, message):
450         command = message.command
451         data = message.serialize()
452         tmsg = "\xf9\xbe\xb4\xd9"
453         tmsg += command
454         tmsg += "\x00" * (12 - len(command))
455         tmsg += struct.pack("<I", len(data))
456         th = SHA256.new(data).digest()
457         h = SHA256.new(th).digest()
458         tmsg += h[:4]
459         tmsg += data
460         return tmsg
461
462     def send_serialized_message(self, tmsg):
463         if not self.connected:
464             return
465
466         self.transport.write(tmsg)
467         self.last_sent = time.time()
468
469     def send_message(self, message):
470         if not self.connected:
471             return
472
473         #print message.command
474
475         #print "send %s" % repr(message)
476         command = message.command
477         data = message.serialize()
478         tmsg = "\xf9\xbe\xb4\xd9"
479         tmsg += command
480         tmsg += "\x00" * (12 - len(command))
481         tmsg += struct.pack("<I", len(data))
482         th = SHA256.new(data).digest()
483         h = SHA256.new(th).digest()
484         tmsg += h[:4]
485         tmsg += data
486
487         #print tmsg, len(tmsg)
488         self.transport.write(tmsg)
489         self.last_sent = time.time()
490
491     def got_message(self, message):
492         if self.last_sent + 30 * 60 < time.time():
493             self.send_message(msg_ping())
494
495         mname = 'do_' + message.command
496         #print mname
497         if not hasattr(self, mname):
498             return
499
500         method = getattr(self, mname)
501         method(message)
502
503 #        if message.command == "tx":
504 #            message.tx.calc_sha256()
505 #            sha256 = message.tx.sha256
506 #            pubkey = binascii.hexlify(message.tx.vout[0].scriptPubKey)
507 #            txlock.acquire()
508 #            tx.append([str(sha256), str(time.time()), str(self.dstaddr), pubkey])
509 #            txlock.release()
510
511     def do_version(self, message):
512         #print message
513         self.send_message(msg_verack())
514
515     def do_inv(self, message):
516         want = msg_getdata()
517         for i in message.inv:
518             if i.type == 1:
519                 want.inv.append(i)
520             if i.type == 2:
521                 want.inv.append(i)
522         if len(want.inv):
523             self.send_message(want)