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
127 from struct import pack, unpack
129 from time import time
130 from util import RejectedShare, dblsha, hash2int, swap32
135 if hasattr(config, 'GotWorkURI'):
136 gotwork = jsonrpc.ServiceProxy(config.GotWorkURI)
138 if not hasattr(config, 'DynamicTargetting'):
139 config.DynamicTargetting = 0
141 config.DynamicTargetGoal *= 2
143 def submitGotwork(info):
145 gotwork.gotwork(info)
147 checkShare.logger.warning('Failed to submit gotwork\n' + traceback.format_exc())
149 def getTarget(username, now):
150 if not config.DynamicTargetting:
152 if username in userStatus:
153 status = userStatus[username]
155 userStatus[username] = [None, now, 0]
157 (targetIn, lastUpdate, work) = status
158 if work <= config.DynamicTargetGoal:
159 if now < lastUpdate + 120 and (targetIn is None or targetIn >= networkTarget):
163 getTarget.logger.debug("No shares from '%s', resetting to minimum target")
164 userStatus[username] = [None, now, 0]
167 deltaSec = now - lastUpdate
168 target = targetIn or config.ShareTarget
169 target = int(target * config.DynamicTargetGoal * deltaSec / 120 / work)
170 if target >= config.ShareTarget:
172 elif target < networkTarget:
173 target = networkTarget
174 if target != targetIn:
175 pfx = 'Retargetting %s' % (repr(username),)
176 getTarget.logger.debug("%s from: %064x" % (pfx, targetIn or config.ShareTarget,))
177 getTarget.logger.debug("%s to: %064x" % (pfx, target or config.ShareTarget,))
178 userStatus[username] = [target, now, 0]
180 getTarget.logger = logging.getLogger('getTarget')
182 def RegisterWork(username, wli, wld):
184 target = getTarget(username, now)
185 wld = tuple(wld) + (target,)
186 workLog.setdefault(username, {})[wli] = (wld, now)
187 return target or config.ShareTarget
189 def getBlockHeader(username):
191 (merkleRoot, merkleTree, coinbase, prevBlock, bits, rollPrevBlk) = MRD[:6]
192 timestamp = pack('<L', int(time()))
193 hdr = b'\2\0\0\0' + prevBlock + merkleRoot + timestamp + bits + b'iolE'
194 workLog.setdefault(username, {})[merkleRoot] = (MRD, time())
195 target = RegisterWork(username, merkleRoot, MRD)
196 return (hdr, workLog[username][merkleRoot], target)
198 def getBlockTemplate(username):
200 (dummy, merkleTree, coinbase, prevBlock, bits) = MC[:5]
201 wliPos = coinbase[0] + 2
202 wliLen = coinbase[wliPos - 1]
203 wli = coinbase[wliPos:wliPos+wliLen]
204 target = RegisterWork(username, wli, MC)
205 return (MC, workLog[username][wli], target)
212 from bitcoin.varlen import varlenEncode, varlenDecode
214 def assembleBlock(blkhdr, txlist):
216 payload += varlenEncode(len(txlist))
221 def blockSubmissionThread(payload, blkhash):
222 myblock = (blkhash, payload[4:36])
223 payload = b2a_hex(payload).decode('ascii')
227 rv = UpstreamBitcoindJSONRPC.submitblock(payload)
231 rv = UpstreamBitcoindJSONRPC.getmemorypool(payload)
241 # FIXME: This will show "Method not found" on pre-BIP22 servers
242 RaiseRedFlags(traceback.format_exc())
244 if MM.currentBlock[0] not in myblock:
245 RaiseRedFlags('Giving up on submitting block upstream')
248 # FIXME: The returned value could be a list of multiple responses
249 RaiseRedFlags('Upstream block submission failed: %s' % (rv,))
251 def checkShare(share):
252 shareTime = share['time'] = time()
256 (prevBlock, height, bits) = MM.currentBlock
257 sharePrevBlock = data[4:36]
258 if sharePrevBlock != prevBlock:
259 if sharePrevBlock == MM.lastBlock[0]:
260 raise RejectedShare('stale-prevblk')
261 raise RejectedShare('bad-prevblk')
264 username = share['username']
265 if username not in workLog:
266 raise RejectedShare('unknown-user')
268 if data[72:76] != bits:
269 raise RejectedShare('bad-diffbits')
271 # Note that we should accept miners reducing version to 1 if they don't understand 2 yet
272 # FIXME: When the supermajority is upgraded to version 2, stop accepting 1!
273 if data[1:4] != b'\0\0\0' or data[0] > 2:
274 raise RejectedShare('bad-version')
276 shareMerkleRoot = data[36:68]
277 if 'blkdata' in share:
278 pl = share['blkdata']
279 (txncount, pl) = varlenDecode(pl)
280 cbtxn = bitcoin.txn.Txn(pl)
281 cbtxn.disassemble(retExtra=True)
282 coinbase = cbtxn.getCoinbase()
283 wliPos = coinbase[0] + 2
284 wliLen = coinbase[wliPos - 1]
285 wli = coinbase[wliPos:wliPos+wliLen]
289 wli = shareMerkleRoot
293 MWL = workLog[username]
295 raise RejectedShare('unknown-work')
296 (wld, issueT) = MWL[wli]
299 if data in DupeShareHACK:
300 raise RejectedShare('duplicate')
301 DupeShareHACK[data] = None
303 blkhash = dblsha(data)
304 if blkhash[28:] != b'\0\0\0\0':
305 raise RejectedShare('H-not-zero')
306 blkhashn = hash2int(blkhash)
309 logfunc = getattr(checkShare.logger, 'info' if blkhashn <= networkTarget else 'debug')
310 logfunc('BLKHASH: %64x' % (blkhashn,))
311 logfunc(' TARGET: %64x' % (networkTarget,))
313 workMerkleTree = wld[1]
314 workCoinbase = wld[2]
317 # NOTE: this isn't actually needed for MC mode, but we're abusing it for a trivial share check...
318 txlist = workMerkleTree.data
319 txlist = [deepcopy(txlist[0]),] + txlist[1:]
321 cbtxn.setCoinbase(workCoinbase)
324 if blkhashn <= networkTarget:
325 logfunc("Submitting upstream")
326 RBDs.append( deepcopy( (data, txlist, share.get('blkdata', None), workMerkleTree) ) )
328 payload = assembleBlock(data, txlist)
330 payload = share['data'] + share['blkdata']
331 logfunc('Real block payload: %s' % (b2a_hex(payload).decode('utf8'),))
333 threading.Thread(target=blockSubmissionThread, args=(payload, blkhash)).start()
334 bcnode.submitBlock(payload)
335 share['upstreamResult'] = True
336 MM.updateBlock(blkhash)
339 if gotwork and blkhashn <= config.GotWorkTarget:
341 coinbaseMrkl = cbtxn.data
342 coinbaseMrkl += blkhash
343 steps = workMerkleTree._steps
344 coinbaseMrkl += pack('B', len(steps))
347 coinbaseMrkl += b"\0\0\0\0"
349 info['hash'] = b2a_hex(blkhash).decode('ascii')
350 info['header'] = b2a_hex(data).decode('ascii')
351 info['coinbaseMrkl'] = b2a_hex(coinbaseMrkl).decode('ascii')
352 thr = threading.Thread(target=submitGotwork, args=(info,))
356 checkShare.logger.warning('Failed to build gotwork request')
358 if workTarget is None:
359 workTarget = config.ShareTarget
360 if blkhashn > workTarget:
361 raise RejectedShare('high-hash')
362 share['target'] = workTarget
363 share['_targethex'] = '%064x' % (workTarget,)
365 shareTimestamp = unpack('<L', data[68:72])[0]
366 if shareTime < issueT - 120:
367 raise RejectedShare('stale-work')
368 if shareTimestamp < shareTime - 300:
369 raise RejectedShare('time-too-old')
370 if shareTimestamp > shareTime + 7200:
371 raise RejectedShare('time-too-new')
373 if config.DynamicTargetting and username in userStatus:
374 # NOTE: userStatus[username] only doesn't exist across restarts
375 status = userStatus[username]
376 target = status[0] or config.ShareTarget
377 if target == workTarget:
378 userStatus[username][2] += 1
380 userStatus[username][2] += float(target) / workTarget
383 cbpre = cbtxn.getCoinbase()
384 cbpreLen = len(cbpre)
385 if coinbase[:cbpreLen] != cbpre:
386 raise RejectedShare('bad-cb-prefix')
388 # Filter out known "I support" flags, to prevent exploits
389 for ff in (b'/P2SH/', b'NOP2SH', b'p2sh/CHV', b'p2sh/NOCHV'):
390 if coinbase.find(ff) > max(-1, cbpreLen - len(ff)):
391 raise RejectedShare('bad-cb-flag')
393 if len(coinbase) > 100:
394 raise RejectedShare('bad-cb-length')
396 cbtxn.setCoinbase(coinbase)
398 if shareMerkleRoot != workMerkleTree.withFirst(cbtxn):
399 raise RejectedShare('bad-txnmrklroot')
401 allowed = assembleBlock(data, txlist)
402 if allowed != share['data'] + share['blkdata']:
403 raise RejectedShare('bad-txns')
404 checkShare.logger = logging.getLogger('checkShare')
406 def receiveShare(share):
407 # TODO: username => userid
410 except RejectedShare as rej:
411 share['rejectReason'] = str(rej)
414 if '_origdata' in share:
415 share['solution'] = share['_origdata']
417 share['solution'] = b2a_hex(swap32(share['data'])).decode('utf8')
418 for i in loggersShare:
421 def newBlockNotification():
422 logging.getLogger('newBlockNotification').info('Received new block notification')
423 MM.updateMerkleTree()
424 # TODO: Force RESPOND TO LONGPOLLS?
427 def newBlockNotificationSIGNAL(signum, frame):
428 # Use a new thread, in case the signal handler is called with locks held
429 thr = threading.Thread(target=newBlockNotification, name='newBlockNotification via signal %s' % (signum,))
433 from signal import signal, SIGUSR1
434 signal(SIGUSR1, newBlockNotificationSIGNAL)
442 from time import sleep
445 SAVE_STATE_FILENAME = 'eloipool.worklog'
448 logger = logging.getLogger('stopServers')
450 if hasattr(stopServers, 'already'):
451 logger.debug('Already tried to stop servers before')
453 stopServers.already = True
455 logger.info('Stopping servers...')
456 global bcnode, server
457 servers = (bcnode, server)
464 logger.error('Failed to stop server %s\n%s' % (s, traceback.format_exc()))
470 sl.append(s.__class__.__name__)
475 logger.error('Servers taking too long to stop (%s), giving up' % (', '.join(sl)))
480 for fd in s._fd.keys():
483 def saveState(t = None):
484 logger = logging.getLogger('saveState')
486 # Then, save data needed to resume work
487 logger.info('Saving work state to \'%s\'...' % (SAVE_STATE_FILENAME,))
491 with open(SAVE_STATE_FILENAME, 'wb') as f:
493 pickle.dump(DupeShareHACK, f)
494 pickle.dump(workLog, f)
499 logger.error('Failed to save work\n' + traceback.format_exc())
501 os.unlink(SAVE_STATE_FILENAME)
503 logger.error(('Failed to unlink \'%s\'; resume may have trouble\n' % (SAVE_STATE_FILENAME,)) + traceback.format_exc())
509 logging.getLogger('exit').info('Goodbye...')
510 os.kill(os.getpid(), signal.SIGTERM)
517 logging.getLogger('restart').info('Restarting...')
519 os.execv(sys.argv[0], sys.argv)
521 logging.getLogger('restart').error('Failed to exec\n' + traceback.format_exc())
524 if not os.path.exists(SAVE_STATE_FILENAME):
527 global workLog, DupeShareHACK
529 logger = logging.getLogger('restoreState')
530 s = os.stat(SAVE_STATE_FILENAME)
531 logger.info('Restoring saved state from \'%s\' (%d bytes)' % (SAVE_STATE_FILENAME, s.st_size))
533 with open(SAVE_STATE_FILENAME, 'rb') as f:
537 # Future formats, not supported here
541 # Old format, from 2012-02-02 to 2012-02-03
546 if isinstance(t, dict):
547 # Old format, from 2012-02-03 to 2012-02-03
551 # Current format, from 2012-02-03 onward
552 DupeShareHACK = pickle.load(f)
554 if t + 120 >= time():
555 workLog = pickle.load(f)
557 logger.debug('Skipping restore of expired workLog')
559 logger.error('Failed to restore state\n' + traceback.format_exc())
561 logger.info('State restored successfully')
563 logger.info('Total downtime: %g seconds' % (time() - t,))
566 from jsonrpcserver import JSONRPCListener, JSONRPCServer
567 import interactivemode
568 from networkserver import NetworkListener
573 if __name__ == "__main__":
574 if not hasattr(config, 'ShareLogging'):
575 config.ShareLogging = ()
576 if hasattr(config, 'DbOptions'):
577 logging.getLogger('backwardCompatibility').warn('DbOptions configuration variable is deprecated; upgrade to ShareLogging var before 2013-03-05')
578 config.ShareLogging = list(config.ShareLogging)
579 config.ShareLogging.append( {
581 'engine': 'postgres',
582 'dbopts': config.DbOptions,
583 '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'))",
585 for i in config.ShareLogging:
586 if not hasattr(i, 'keys'):
588 logging.getLogger('backwardCompatibility').warn('Using short-term backward compatibility for ShareLogging[\'%s\']; be sure to update config before 2012-04-04' % (name,))
589 if name == 'postgres':
592 'engine': 'postgres',
593 'dbopts': parameters,
595 elif name == 'logfile':
597 i['thropts'] = parameters
598 if 'filename' in parameters:
599 i['filename'] = parameters['filename']
600 i['thropts'] = dict(i['thropts'])
601 del i['thropts']['filename']
609 fp, pathname, description = imp.find_module(name, sharelogging.__path__)
610 m = imp.load_module(name, fp, pathname, description)
611 lo = getattr(m, name)(**parameters)
612 loggersShare.append(lo.logShare)
614 logging.getLogger('sharelogging').error("Error setting up share logger %s: %s", name, sys.exc_info())
617 if not hasattr(config, 'BitcoinNodeAddresses'):
618 config.BitcoinNodeAddresses = ()
619 for a in config.BitcoinNodeAddresses:
620 LSbc.append(NetworkListener(bcnode, a))
622 if hasattr(config, 'UpstreamBitcoindNode') and config.UpstreamBitcoindNode:
623 BitcoinLink(bcnode, dest=config.UpstreamBitcoindNode)
625 import jsonrpc_getblocktemplate
626 import jsonrpc_getwork
627 import jsonrpc_setworkaux
629 server = JSONRPCServer()
630 if hasattr(config, 'JSONRPCAddress'):
631 logging.getLogger('backwardCompatibility').warn('JSONRPCAddress configuration variable is deprecated; upgrade to JSONRPCAddresses list before 2013-03-05')
632 if not hasattr(config, 'JSONRPCAddresses'):
633 config.JSONRPCAddresses = []
634 config.JSONRPCAddresses.insert(0, config.JSONRPCAddress)
636 for a in config.JSONRPCAddresses:
637 LS.append(JSONRPCListener(server, a))
638 if hasattr(config, 'SecretUser'):
639 server.SecretUser = config.SecretUser
640 server.aux = MM.CoinbaseAux
641 server.getBlockHeader = getBlockHeader
642 server.getBlockTemplate = getBlockTemplate
643 server.receiveShare = receiveShare
644 server.RaiseRedFlags = RaiseRedFlags
645 server.ShareTarget = config.ShareTarget
647 if hasattr(config, 'TrustedForwarders'):
648 server.TrustedForwarders = config.TrustedForwarders
649 server.ServerName = config.ServerName
655 bcnode_thr = threading.Thread(target=bcnode.serve_forever)
656 bcnode_thr.daemon = True
659 server.serve_forever()