2 # Eloipool - Python Bitcoin pool server
3 # Copyright (C) 2011-2012 Luke Dashjr <luke-jr+eloipool@utopios.org>
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU Affero General Public License for more details.
15 # You should have received a copy of the GNU Affero General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if not hasattr(config, 'ServerName'):
21 config.ServerName = 'Unnamed Eloipool'
23 if not hasattr(config, 'ShareTarget'):
24 config.ShareTarget = 0x00000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffff
29 if len(logging.root.handlers) == 0:
31 format='%(asctime)s\t%(name)s\t%(levelname)s\t%(message)s',
34 for infoOnly in ('checkShare', 'JSONRPCHandler', 'merkleMaker', 'Waker for JSONRPCServer', 'JSONRPCServer'):
35 logging.getLogger(infoOnly).setLevel(logging.INFO)
37 def RaiseRedFlags(reason):
38 logging.getLogger('redflag').critical(reason)
42 from bitcoin.node import BitcoinLink, BitcoinNode
43 bcnode = BitcoinNode(config.UpstreamNetworkId)
44 bcnode.userAgent += b'Eloipool:0.1/'
47 UpstreamBitcoindJSONRPC = jsonrpc.ServiceProxy(config.UpstreamURI)
50 from bitcoin.script import BitcoinScript
51 from bitcoin.txn import Txn
52 from base58 import b58decode
53 from struct import pack
57 def makeCoinbaseTxn(coinbaseValue, useCoinbaser = True):
60 if useCoinbaser and hasattr(config, 'CoinbaserCmd') and config.CoinbaserCmd:
63 cmd = config.CoinbaserCmd
64 cmd = cmd.replace('%d', str(coinbaseValue))
65 p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE)
66 nout = int(p.stdout.readline())
68 amount = int(p.stdout.readline())
69 addr = p.stdout.readline().rstrip(b'\n').decode('utf8')
70 pkScript = BitcoinScript.toAddress(addr)
71 txn.addOutput(amount, pkScript)
74 coinbased = coinbaseValue + 1
75 if coinbased >= coinbaseValue:
76 logging.getLogger('makeCoinbaseTxn').error('Coinbaser failed!')
79 coinbaseValue -= coinbased
81 pkScript = BitcoinScript.toAddress(config.TrackerAddr)
82 txn.addOutput(coinbaseValue, pkScript)
85 # TODO: red flag on dupe coinbase
89 import jsonrpc_getwork
90 from util import Bits2Target
104 jsonrpc_getwork._CheckForDupesHACK = {}
105 global MM, networkTarget, server
106 bits = MM.currentBlock[2]
110 networkTarget = Bits2Target(bits)
115 from merklemaker import merkleMaker
117 MM.__dict__.update(config.__dict__)
118 MM.clearCoinbaseTxn = makeCoinbaseTxn(5000000000, False) # FIXME
119 MM.clearCoinbaseTxn.assemble()
120 MM.makeCoinbaseTxn = makeCoinbaseTxn
121 MM.onBlockChange = blockChanged
122 MM.onBlockUpdate = updateBlocks
125 from binascii import b2a_hex
126 from copy import deepcopy
128 from struct import pack, unpack
130 from time import time
131 from util import RejectedShare, dblsha, hash2int, swap32, target2pdiff
136 if hasattr(config, 'GotWorkURI'):
137 gotwork = jsonrpc.ServiceProxy(config.GotWorkURI)
139 if not hasattr(config, 'DynamicTargetting'):
140 config.DynamicTargetting = 0
142 config.DynamicTargetGoal *= 2
144 def submitGotwork(info):
146 gotwork.gotwork(info)
148 checkShare.logger.warning('Failed to submit gotwork\n' + traceback.format_exc())
150 def getTarget(username, now):
151 if not config.DynamicTargetting:
153 if username in userStatus:
154 status = userStatus[username]
156 userStatus[username] = [None, now, 0]
158 (targetIn, lastUpdate, work) = status
159 if work <= config.DynamicTargetGoal:
160 if now < lastUpdate + 120 and (targetIn is None or targetIn >= networkTarget):
164 getTarget.logger.debug("No shares from '%s', resetting to minimum target")
165 userStatus[username] = [None, now, 0]
168 deltaSec = now - lastUpdate
169 target = targetIn or config.ShareTarget
170 target = int(target * config.DynamicTargetGoal * deltaSec / 120 / work)
171 if target >= config.ShareTarget:
174 if target < networkTarget:
175 target = networkTarget
176 if config.DynamicTargetting == 2:
177 # Round target to a power of two :)
178 target = 2**int(log(target, 2) + 1) - 1
179 if target == config.ShareTarget:
181 if target != targetIn:
182 pfx = 'Retargetting %s' % (repr(username),)
183 tin = targetIn or config.ShareTarget
184 getTarget.logger.debug("%s from: %064x (pdiff %s)" % (pfx, tin, target2pdiff(tin)))
185 tgt = target or config.ShareTarget
186 getTarget.logger.debug("%s to: %064x (pdiff %s)" % (pfx, tgt, target2pdiff(tgt)))
187 userStatus[username] = [target, now, 0]
189 getTarget.logger = logging.getLogger('getTarget')
191 def RegisterWork(username, wli, wld):
193 target = getTarget(username, now)
194 wld = tuple(wld) + (target,)
195 workLog.setdefault(username, {})[wli] = (wld, now)
196 return target or config.ShareTarget
198 def getBlockHeader(username):
200 (merkleRoot, merkleTree, coinbase, prevBlock, bits, rollPrevBlk) = MRD[:6]
201 timestamp = pack('<L', int(time()))
202 hdr = b'\2\0\0\0' + prevBlock + merkleRoot + timestamp + bits + b'iolE'
203 workLog.setdefault(username, {})[merkleRoot] = (MRD, time())
204 target = RegisterWork(username, merkleRoot, MRD)
205 return (hdr, workLog[username][merkleRoot], target)
207 def getBlockTemplate(username):
209 (dummy, merkleTree, coinbase, prevBlock, bits) = MC[:5]
210 wliPos = coinbase[0] + 2
211 wliLen = coinbase[wliPos - 1]
212 wli = coinbase[wliPos:wliPos+wliLen]
213 target = RegisterWork(username, wli, MC)
214 return (MC, workLog[username][wli], target)
221 from bitcoin.varlen import varlenEncode, varlenDecode
223 def assembleBlock(blkhdr, txlist):
225 payload += varlenEncode(len(txlist))
230 def blockSubmissionThread(payload, blkhash):
231 myblock = (blkhash, payload[4:36])
232 payload = b2a_hex(payload).decode('ascii')
236 rv = UpstreamBitcoindJSONRPC.submitblock(payload)
240 rv = UpstreamBitcoindJSONRPC.getmemorypool(payload)
250 # FIXME: This will show "Method not found" on pre-BIP22 servers
251 RaiseRedFlags(traceback.format_exc())
253 if MM.currentBlock[0] not in myblock:
254 RaiseRedFlags('Giving up on submitting block upstream')
257 # FIXME: The returned value could be a list of multiple responses
258 RaiseRedFlags('Upstream block submission failed: %s' % (rv,))
260 def checkShare(share):
261 shareTime = share['time'] = time()
265 (prevBlock, height, bits) = MM.currentBlock
266 sharePrevBlock = data[4:36]
267 if sharePrevBlock != prevBlock:
268 if sharePrevBlock == MM.lastBlock[0]:
269 raise RejectedShare('stale-prevblk')
270 raise RejectedShare('bad-prevblk')
273 username = share['username']
274 if username not in workLog:
275 raise RejectedShare('unknown-user')
277 if data[72:76] != bits:
278 raise RejectedShare('bad-diffbits')
280 # Note that we should accept miners reducing version to 1 if they don't understand 2 yet
281 # FIXME: When the supermajority is upgraded to version 2, stop accepting 1!
282 if data[1:4] != b'\0\0\0' or data[0] > 2:
283 raise RejectedShare('bad-version')
285 shareMerkleRoot = data[36:68]
286 if 'blkdata' in share:
287 pl = share['blkdata']
288 (txncount, pl) = varlenDecode(pl)
289 cbtxn = bitcoin.txn.Txn(pl)
290 cbtxn.disassemble(retExtra=True)
291 coinbase = cbtxn.getCoinbase()
292 wliPos = coinbase[0] + 2
293 wliLen = coinbase[wliPos - 1]
294 wli = coinbase[wliPos:wliPos+wliLen]
298 wli = shareMerkleRoot
302 MWL = workLog[username]
304 raise RejectedShare('unknown-work')
305 (wld, issueT) = MWL[wli]
308 if data in DupeShareHACK:
309 raise RejectedShare('duplicate')
310 DupeShareHACK[data] = None
312 blkhash = dblsha(data)
313 if blkhash[28:] != b'\0\0\0\0':
314 raise RejectedShare('H-not-zero')
315 blkhashn = hash2int(blkhash)
318 logfunc = getattr(checkShare.logger, 'info' if blkhashn <= networkTarget else 'debug')
319 logfunc('BLKHASH: %64x' % (blkhashn,))
320 logfunc(' TARGET: %64x' % (networkTarget,))
322 workMerkleTree = wld[1]
323 workCoinbase = wld[2]
326 # NOTE: this isn't actually needed for MC mode, but we're abusing it for a trivial share check...
327 txlist = workMerkleTree.data
328 txlist = [deepcopy(txlist[0]),] + txlist[1:]
330 cbtxn.setCoinbase(workCoinbase)
333 if blkhashn <= networkTarget:
334 logfunc("Submitting upstream")
335 RBDs.append( deepcopy( (data, txlist, share.get('blkdata', None), workMerkleTree) ) )
337 payload = assembleBlock(data, txlist)
339 payload = share['data'] + share['blkdata']
340 logfunc('Real block payload: %s' % (b2a_hex(payload).decode('utf8'),))
342 threading.Thread(target=blockSubmissionThread, args=(payload, blkhash)).start()
343 bcnode.submitBlock(payload)
344 share['upstreamResult'] = True
345 MM.updateBlock(blkhash)
348 if gotwork and blkhashn <= config.GotWorkTarget:
350 coinbaseMrkl = cbtxn.data
351 coinbaseMrkl += blkhash
352 steps = workMerkleTree._steps
353 coinbaseMrkl += pack('B', len(steps))
356 coinbaseMrkl += b"\0\0\0\0"
358 info['hash'] = b2a_hex(blkhash).decode('ascii')
359 info['header'] = b2a_hex(data).decode('ascii')
360 info['coinbaseMrkl'] = b2a_hex(coinbaseMrkl).decode('ascii')
361 thr = threading.Thread(target=submitGotwork, args=(info,))
365 checkShare.logger.warning('Failed to build gotwork request')
367 if workTarget is None:
368 workTarget = config.ShareTarget
369 if blkhashn > workTarget:
370 raise RejectedShare('high-hash')
371 share['target'] = workTarget
372 share['_targethex'] = '%064x' % (workTarget,)
374 shareTimestamp = unpack('<L', data[68:72])[0]
375 if shareTime < issueT - 120:
376 raise RejectedShare('stale-work')
377 if shareTimestamp < shareTime - 300:
378 raise RejectedShare('time-too-old')
379 if shareTimestamp > shareTime + 7200:
380 raise RejectedShare('time-too-new')
382 if config.DynamicTargetting and username in userStatus:
383 # NOTE: userStatus[username] only doesn't exist across restarts
384 status = userStatus[username]
385 target = status[0] or config.ShareTarget
386 if target == workTarget:
387 userStatus[username][2] += 1
389 userStatus[username][2] += float(target) / workTarget
392 cbpre = cbtxn.getCoinbase()
393 cbpreLen = len(cbpre)
394 if coinbase[:cbpreLen] != cbpre:
395 raise RejectedShare('bad-cb-prefix')
397 # Filter out known "I support" flags, to prevent exploits
398 for ff in (b'/P2SH/', b'NOP2SH', b'p2sh/CHV', b'p2sh/NOCHV'):
399 if coinbase.find(ff) > max(-1, cbpreLen - len(ff)):
400 raise RejectedShare('bad-cb-flag')
402 if len(coinbase) > 100:
403 raise RejectedShare('bad-cb-length')
405 cbtxn.setCoinbase(coinbase)
407 if shareMerkleRoot != workMerkleTree.withFirst(cbtxn):
408 raise RejectedShare('bad-txnmrklroot')
410 allowed = assembleBlock(data, txlist)
411 if allowed != share['data'] + share['blkdata']:
412 raise RejectedShare('bad-txns')
413 checkShare.logger = logging.getLogger('checkShare')
415 def receiveShare(share):
416 # TODO: username => userid
419 except RejectedShare as rej:
420 share['rejectReason'] = str(rej)
423 if '_origdata' in share:
424 share['solution'] = share['_origdata']
426 share['solution'] = b2a_hex(swap32(share['data'])).decode('utf8')
427 for i in loggersShare:
430 def newBlockNotification():
431 logging.getLogger('newBlockNotification').info('Received new block notification')
432 MM.updateMerkleTree()
433 # TODO: Force RESPOND TO LONGPOLLS?
436 def newBlockNotificationSIGNAL(signum, frame):
437 # Use a new thread, in case the signal handler is called with locks held
438 thr = threading.Thread(target=newBlockNotification, name='newBlockNotification via signal %s' % (signum,))
442 from signal import signal, SIGUSR1
443 signal(SIGUSR1, newBlockNotificationSIGNAL)
451 from time import sleep
454 SAVE_STATE_FILENAME = 'eloipool.worklog'
457 logger = logging.getLogger('stopServers')
459 if hasattr(stopServers, 'already'):
460 logger.debug('Already tried to stop servers before')
462 stopServers.already = True
464 logger.info('Stopping servers...')
465 global bcnode, server
466 servers = (bcnode, server)
473 logger.error('Failed to stop server %s\n%s' % (s, traceback.format_exc()))
479 sl.append(s.__class__.__name__)
484 logger.error('Servers taking too long to stop (%s), giving up' % (', '.join(sl)))
489 for fd in s._fd.keys():
492 def saveState(t = None):
493 logger = logging.getLogger('saveState')
495 # Then, save data needed to resume work
496 logger.info('Saving work state to \'%s\'...' % (SAVE_STATE_FILENAME,))
500 with open(SAVE_STATE_FILENAME, 'wb') as f:
502 pickle.dump(DupeShareHACK, f)
503 pickle.dump(workLog, f)
508 logger.error('Failed to save work\n' + traceback.format_exc())
510 os.unlink(SAVE_STATE_FILENAME)
512 logger.error(('Failed to unlink \'%s\'; resume may have trouble\n' % (SAVE_STATE_FILENAME,)) + traceback.format_exc())
518 logging.getLogger('exit').info('Goodbye...')
519 os.kill(os.getpid(), signal.SIGTERM)
526 logging.getLogger('restart').info('Restarting...')
528 os.execv(sys.argv[0], sys.argv)
530 logging.getLogger('restart').error('Failed to exec\n' + traceback.format_exc())
533 if not os.path.exists(SAVE_STATE_FILENAME):
536 global workLog, DupeShareHACK
538 logger = logging.getLogger('restoreState')
539 s = os.stat(SAVE_STATE_FILENAME)
540 logger.info('Restoring saved state from \'%s\' (%d bytes)' % (SAVE_STATE_FILENAME, s.st_size))
542 with open(SAVE_STATE_FILENAME, 'rb') as f:
546 # Future formats, not supported here
550 # Old format, from 2012-02-02 to 2012-02-03
555 if isinstance(t, dict):
556 # Old format, from 2012-02-03 to 2012-02-03
560 # Current format, from 2012-02-03 onward
561 DupeShareHACK = pickle.load(f)
563 if t + 120 >= time():
564 workLog = pickle.load(f)
566 logger.debug('Skipping restore of expired workLog')
568 logger.error('Failed to restore state\n' + traceback.format_exc())
570 logger.info('State restored successfully')
572 logger.info('Total downtime: %g seconds' % (time() - t,))
575 from jsonrpcserver import JSONRPCListener, JSONRPCServer
576 import interactivemode
577 from networkserver import NetworkListener
582 if __name__ == "__main__":
583 if not hasattr(config, 'ShareLogging'):
584 config.ShareLogging = ()
585 if hasattr(config, 'DbOptions'):
586 logging.getLogger('backwardCompatibility').warn('DbOptions configuration variable is deprecated; upgrade to ShareLogging var before 2013-03-05')
587 config.ShareLogging = list(config.ShareLogging)
588 config.ShareLogging.append( {
590 'engine': 'postgres',
591 'dbopts': config.DbOptions,
592 'statement': "insert into shares (rem_host, username, our_result, upstream_result, reason, solution) values ({Q(remoteHost)}, {username}, {YN(not(rejectReason))}, {YN(upstreamResult)}, {rejectReason}, decode({solution}, 'hex'))",
594 for i in config.ShareLogging:
595 if not hasattr(i, 'keys'):
597 logging.getLogger('backwardCompatibility').warn('Using short-term backward compatibility for ShareLogging[\'%s\']; be sure to update config before 2012-04-04' % (name,))
598 if name == 'postgres':
601 'engine': 'postgres',
602 'dbopts': parameters,
604 elif name == 'logfile':
606 i['thropts'] = parameters
607 if 'filename' in parameters:
608 i['filename'] = parameters['filename']
609 i['thropts'] = dict(i['thropts'])
610 del i['thropts']['filename']
618 fp, pathname, description = imp.find_module(name, sharelogging.__path__)
619 m = imp.load_module(name, fp, pathname, description)
620 lo = getattr(m, name)(**parameters)
621 loggersShare.append(lo.logShare)
623 logging.getLogger('sharelogging').error("Error setting up share logger %s: %s", name, sys.exc_info())
626 if not hasattr(config, 'BitcoinNodeAddresses'):
627 config.BitcoinNodeAddresses = ()
628 for a in config.BitcoinNodeAddresses:
629 LSbc.append(NetworkListener(bcnode, a))
631 if hasattr(config, 'UpstreamBitcoindNode') and config.UpstreamBitcoindNode:
632 BitcoinLink(bcnode, dest=config.UpstreamBitcoindNode)
634 import jsonrpc_getblocktemplate
635 import jsonrpc_getwork
636 import jsonrpc_setworkaux
638 server = JSONRPCServer()
639 if hasattr(config, 'JSONRPCAddress'):
640 logging.getLogger('backwardCompatibility').warn('JSONRPCAddress configuration variable is deprecated; upgrade to JSONRPCAddresses list before 2013-03-05')
641 if not hasattr(config, 'JSONRPCAddresses'):
642 config.JSONRPCAddresses = []
643 config.JSONRPCAddresses.insert(0, config.JSONRPCAddress)
645 for a in config.JSONRPCAddresses:
646 LS.append(JSONRPCListener(server, a))
647 if hasattr(config, 'SecretUser'):
648 server.SecretUser = config.SecretUser
649 server.aux = MM.CoinbaseAux
650 server.getBlockHeader = getBlockHeader
651 server.getBlockTemplate = getBlockTemplate
652 server.receiveShare = receiveShare
653 server.RaiseRedFlags = RaiseRedFlags
654 server.ShareTarget = config.ShareTarget
656 if hasattr(config, 'TrustedForwarders'):
657 server.TrustedForwarders = config.TrustedForwarders
658 server.ServerName = config.ServerName
664 bcnode_thr = threading.Thread(target=bcnode.serve_forever)
665 bcnode_thr.daemon = True
668 server.serve_forever()