added testcase for node+work that simulates mining 100 shares
[p2pool.git] / p2pool / work.py
1 from __future__ import division
2
3 import base64
4 import random
5 import sys
6 import time
7
8 from twisted.internet import defer
9 from twisted.python import log
10
11 import bitcoin.getwork as bitcoin_getwork, bitcoin.data as bitcoin_data
12 from bitcoin import helper, script, worker_interface
13 from util import forest, jsonrpc, variable, deferral, math, pack
14 import p2pool, p2pool.data as p2pool_data
15
16 class WorkerBridge(worker_interface.WorkerBridge):
17     def __init__(self, node, my_pubkey_hash, donation_percentage, merged_urls, worker_fee):
18         worker_interface.WorkerBridge.__init__(self)
19         self.recent_shares_ts_work = []
20         
21         self.node = node
22         self.my_pubkey_hash = my_pubkey_hash
23         self.donation_percentage = donation_percentage
24         self.worker_fee = worker_fee
25         
26         self.pseudoshare_received = variable.Event()
27         self.share_received = variable.Event()
28         self.local_rate_monitor = math.RateMonitor(10*60)
29         
30         self.removed_unstales_var = variable.Variable((0, 0, 0))
31         self.removed_doa_unstales_var = variable.Variable(0)
32         
33         
34         self.my_share_hashes = set()
35         self.my_doa_share_hashes = set()
36         
37         self.tracker_view = forest.TrackerView(self.node.tracker, forest.get_attributedelta_type(dict(forest.AttributeDelta.attrs,
38             my_count=lambda share: 1 if share.hash in self.my_share_hashes else 0,
39             my_doa_count=lambda share: 1 if share.hash in self.my_doa_share_hashes else 0,
40             my_orphan_announce_count=lambda share: 1 if share.hash in self.my_share_hashes and share.share_data['stale_info'] == 'orphan' else 0,
41             my_dead_announce_count=lambda share: 1 if share.hash in self.my_share_hashes and share.share_data['stale_info'] == 'doa' else 0,
42         )))
43         
44         @self.node.tracker.verified.removed.watch
45         def _(share):
46             if share.hash in self.my_share_hashes and self.node.tracker.is_child_of(share.hash, self.node.best_share_var.value):
47                 assert share.share_data['stale_info'] in [None, 'orphan', 'doa'] # we made these shares in this instance
48                 self.removed_unstales_var.set((
49                     self.removed_unstales_var.value[0] + 1,
50                     self.removed_unstales_var.value[1] + (1 if share.share_data['stale_info'] == 'orphan' else 0),
51                     self.removed_unstales_var.value[2] + (1 if share.share_data['stale_info'] == 'doa' else 0),
52                 ))
53             if share.hash in self.my_doa_share_hashes and self.node.tracker.is_child_of(share.hash, self.node.best_share_var.value):
54                 self.removed_doa_unstales_var.set(self.removed_doa_unstales_var.value + 1)
55         
56         # MERGED WORK
57         
58         self.merged_work = variable.Variable({})
59         
60         @defer.inlineCallbacks
61         def set_merged_work(merged_url, merged_userpass):
62             merged_proxy = jsonrpc.Proxy(merged_url, dict(Authorization='Basic ' + base64.b64encode(merged_userpass)))
63             while True:
64                 auxblock = yield deferral.retry('Error while calling merged getauxblock:', 30)(merged_proxy.rpc_getauxblock)()
65                 self.merged_work.set(dict(self.merged_work.value, **{auxblock['chainid']: dict(
66                     hash=int(auxblock['hash'], 16),
67                     target='p2pool' if auxblock['target'] == 'p2pool' else pack.IntType(256).unpack(auxblock['target'].decode('hex')),
68                     merged_proxy=merged_proxy,
69                 )}))
70                 yield deferral.sleep(1)
71         for merged_url, merged_userpass in merged_urls:
72             set_merged_work(merged_url, merged_userpass)
73         
74         @self.merged_work.changed.watch
75         def _(new_merged_work):
76             print 'Got new merged mining work!'
77         
78         # COMBINE WORK
79         
80         self.current_work = variable.Variable(None)
81         def compute_work():
82             t = self.node.bitcoind_work.value
83             bb = self.node.best_block_header.value
84             if bb is not None and bb['previous_block'] == t['previous_block'] and self.node.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(bb)) <= t['bits'].target:
85                 print 'Skipping from block %x to block %x!' % (bb['previous_block'],
86                     bitcoin_data.hash256(bitcoin_data.block_header_type.pack(bb)))
87                 t = dict(
88                     version=bb['version'],
89                     previous_block=bitcoin_data.hash256(bitcoin_data.block_header_type.pack(bb)),
90                     bits=bb['bits'], # not always true
91                     coinbaseflags='',
92                     height=t['height'] + 1,
93                     time=bb['timestamp'] + 600, # better way?
94                     transactions=[],
95                     merkle_link=bitcoin_data.calculate_merkle_link([None], 0),
96                     subsidy=self.node.net.PARENT.SUBSIDY_FUNC(self.node.bitcoind_work.value['height']),
97                     last_update=self.node.bitcoind_work.value['last_update'],
98                 )
99             
100             self.current_work.set(t)
101         self.node.bitcoind_work.changed.watch(lambda _: compute_work())
102         self.node.best_block_header.changed.watch(lambda _: compute_work())
103         compute_work()
104         
105         self.new_work_event = variable.Event()
106         @self.current_work.transitioned.watch
107         def _(before, after):
108             # trigger LP if version/previous_block/bits changed or transactions changed from nothing
109             if any(before[x] != after[x] for x in ['version', 'previous_block', 'bits']) or (not before['transactions'] and after['transactions']):
110                 self.new_work_event.happened()
111         self.merged_work.changed.watch(lambda _: self.new_work_event.happened())
112         self.node.best_share_var.changed.watch(lambda _: self.new_work_event.happened())
113     
114     def get_stale_counts(self):
115         '''Returns (orphans, doas), total, (orphans_recorded_in_chain, doas_recorded_in_chain)'''
116         my_shares = len(self.my_share_hashes)
117         my_doa_shares = len(self.my_doa_share_hashes)
118         delta = self.tracker_view.get_delta_to_last(self.node.best_share_var.value)
119         my_shares_in_chain = delta.my_count + self.removed_unstales_var.value[0]
120         my_doa_shares_in_chain = delta.my_doa_count + self.removed_doa_unstales_var.value
121         orphans_recorded_in_chain = delta.my_orphan_announce_count + self.removed_unstales_var.value[1]
122         doas_recorded_in_chain = delta.my_dead_announce_count + self.removed_unstales_var.value[2]
123         
124         my_shares_not_in_chain = my_shares - my_shares_in_chain
125         my_doa_shares_not_in_chain = my_doa_shares - my_doa_shares_in_chain
126         
127         return (my_shares_not_in_chain - my_doa_shares_not_in_chain, my_doa_shares_not_in_chain), my_shares, (orphans_recorded_in_chain, doas_recorded_in_chain)
128     
129     def get_user_details(self, request):
130         user = request.getUser() if request.getUser() is not None else ''
131         
132         desired_pseudoshare_target = None
133         if '+' in user:
134             user, desired_pseudoshare_difficulty_str = user.rsplit('+', 1)
135             try:
136                 desired_pseudoshare_target = bitcoin_data.difficulty_to_target(float(desired_pseudoshare_difficulty_str))
137             except:
138                 pass
139         
140         desired_share_target = 2**256 - 1
141         if '/' in user:
142             user, min_diff_str = user.rsplit('/', 1)
143             try:
144                 desired_share_target = bitcoin_data.difficulty_to_target(float(min_diff_str))
145             except:
146                 pass
147         
148         if random.uniform(0, 100) < self.worker_fee:
149             pubkey_hash = self.my_pubkey_hash
150         else:
151             try:
152                 pubkey_hash = bitcoin_data.address_to_pubkey_hash(user, self.node.net.PARENT)
153             except: # XXX blah
154                 pubkey_hash = self.my_pubkey_hash
155         
156         return user, pubkey_hash, desired_share_target, desired_pseudoshare_target
157     
158     def preprocess_request(self, request):
159         user, pubkey_hash, desired_share_target, desired_pseudoshare_target = self.get_user_details(request)
160         return pubkey_hash, desired_share_target, desired_pseudoshare_target
161     
162     def get_work(self, pubkey_hash, desired_share_target, desired_pseudoshare_target):
163         if (self.node.p2p_node is None or len(self.node.p2p_node.peers) == 0) and self.node.net.PERSIST:
164             raise jsonrpc.Error_for_code(-12345)(u'p2pool is not connected to any peers')
165         if self.node.best_share_var.value is None and self.node.net.PERSIST:
166             raise jsonrpc.Error_for_code(-12345)(u'p2pool is downloading shares')
167         if time.time() > self.current_work.value['last_update'] + 60:
168             raise jsonrpc.Error_for_code(-12345)(u'lost contact with bitcoind')
169         
170         if self.merged_work.value:
171             tree, size = bitcoin_data.make_auxpow_tree(self.merged_work.value)
172             mm_hashes = [self.merged_work.value.get(tree.get(i), dict(hash=0))['hash'] for i in xrange(size)]
173             mm_data = '\xfa\xbemm' + bitcoin_data.aux_pow_coinbase_type.pack(dict(
174                 merkle_root=bitcoin_data.merkle_hash(mm_hashes),
175                 size=size,
176                 nonce=0,
177             ))
178             mm_later = [(aux_work, mm_hashes.index(aux_work['hash']), mm_hashes) for chain_id, aux_work in self.merged_work.value.iteritems()]
179         else:
180             mm_data = ''
181             mm_later = []
182         
183         tx_hashes = [bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx)) for tx in self.current_work.value['transactions']]
184         tx_map = dict(zip(tx_hashes, self.current_work.value['transactions']))
185         
186         share_type = p2pool_data.NewShare
187         if self.node.best_share_var.value is not None:
188             previous_share = self.node.tracker.items[self.node.best_share_var.value]
189             if isinstance(previous_share, p2pool_data.Share):
190                 # Share -> NewShare only valid if 85% of hashes in [net.CHAIN_LENGTH*9//10, net.CHAIN_LENGTH] for new version
191                 if self.node.tracker.get_height(previous_share.hash) < self.node.net.CHAIN_LENGTH:
192                     share_type = p2pool_data.Share
193                 elif time.time() < 1351383661 and self.node.net.NAME == 'bitcoin':
194                     share_type = p2pool_data.Share
195                 else:
196                     counts = p2pool_data.get_desired_version_counts(self.node.tracker,
197                         self.node.tracker.get_nth_parent_hash(previous_share.hash, self.node.net.CHAIN_LENGTH*9//10), self.node.net.CHAIN_LENGTH//10)
198                     if counts.get(p2pool_data.NewShare.VERSION, 0) < sum(counts.itervalues())*95//100:
199                         share_type = p2pool_data.Share
200         
201         if True:
202             share_info, gentx, other_transaction_hashes, get_share = share_type.generate_transaction(
203                 tracker=self.node.tracker,
204                 share_data=dict(
205                     previous_share_hash=self.node.best_share_var.value,
206                     coinbase=(script.create_push_script([
207                         self.current_work.value['height'],
208                         ] + ([mm_data] if mm_data else []) + [
209                     ]) + self.current_work.value['coinbaseflags'])[:100],
210                     nonce=random.randrange(2**32),
211                     pubkey_hash=pubkey_hash,
212                     subsidy=self.current_work.value['subsidy'],
213                     donation=math.perfect_round(65535*self.donation_percentage/100),
214                     stale_info=(lambda (orphans, doas), total, (orphans_recorded_in_chain, doas_recorded_in_chain):
215                         'orphan' if orphans > orphans_recorded_in_chain else
216                         'doa' if doas > doas_recorded_in_chain else
217                         None
218                     )(*self.get_stale_counts()),
219                     desired_version=7,
220                 ),
221                 block_target=self.current_work.value['bits'].target,
222                 desired_timestamp=int(time.time() + 0.5),
223                 desired_target=desired_share_target,
224                 ref_merkle_link=dict(branch=[], index=0),
225                 desired_other_transaction_hashes=tx_hashes,
226                 net=self.node.net,
227                 known_txs=tx_map,
228             )
229         
230         transactions = [gentx] + [tx_map[tx_hash] for tx_hash in other_transaction_hashes]
231         
232         mm_later = [(dict(aux_work, target=aux_work['target'] if aux_work['target'] != 'p2pool' else share_info['bits'].target), index, hashes) for aux_work, index, hashes in mm_later]
233         
234         if desired_pseudoshare_target is None:
235             target = 2**256-1
236             if len(self.recent_shares_ts_work) == 50:
237                 hash_rate = sum(work for ts, work in self.recent_shares_ts_work[1:])//(self.recent_shares_ts_work[-1][0] - self.recent_shares_ts_work[0][0])
238                 if hash_rate:
239                     target = min(target, int(2**256/hash_rate))
240         else:
241             target = desired_pseudoshare_target
242         target = max(target, share_info['bits'].target)
243         for aux_work, index, hashes in mm_later:
244             target = max(target, aux_work['target'])
245         target = math.clip(target, self.node.net.PARENT.SANE_TARGET_RANGE)
246         
247         getwork_time = time.time()
248         lp_count = self.new_work_event.times
249         merkle_link = bitcoin_data.calculate_merkle_link([bitcoin_data.hash256(bitcoin_data.tx_type.pack(tx)) for tx in transactions], 0)
250         
251         print 'New work for worker! Difficulty: %.06f Share difficulty: %.06f Total block value: %.6f %s including %i transactions' % (
252             bitcoin_data.target_to_difficulty(target),
253             bitcoin_data.target_to_difficulty(share_info['bits'].target),
254             self.current_work.value['subsidy']*1e-8, self.node.net.PARENT.SYMBOL,
255             len(self.current_work.value['transactions']),
256         )
257         
258         ba = bitcoin_getwork.BlockAttempt(
259             version=min(self.current_work.value['version'], 2),
260             previous_block=self.current_work.value['previous_block'],
261             merkle_root=bitcoin_data.check_merkle_link(bitcoin_data.hash256(bitcoin_data.tx_type.pack(transactions[0])), merkle_link),
262             timestamp=self.current_work.value['time'],
263             bits=self.current_work.value['bits'],
264             share_target=target,
265         )
266         
267         received_header_hashes = set()
268         
269         def got_response(header, request):
270             header_hash = bitcoin_data.hash256(bitcoin_data.block_header_type.pack(header))
271             pow_hash = self.node.net.PARENT.POW_FUNC(bitcoin_data.block_header_type.pack(header))
272             try:
273                 if pow_hash <= header['bits'].target or p2pool.DEBUG:
274                     helper.submit_block(dict(header=header, txs=transactions), False, self.node.factory, self.node.bitcoind, self.node.bitcoind_work, self.node.net)
275                     if pow_hash <= header['bits'].target:
276                         print
277                         print 'GOT BLOCK FROM MINER! Passing to bitcoind! %s%064x' % (self.node.net.PARENT.BLOCK_EXPLORER_URL_PREFIX, header_hash)
278                         print
279             except:
280                 log.err(None, 'Error while processing potential block:')
281             
282             user, _, _, _ = self.get_user_details(request)
283             assert header['previous_block'] == ba.previous_block
284             assert header['merkle_root'] == ba.merkle_root
285             assert header['bits'] == ba.bits
286             
287             on_time = self.new_work_event.times == lp_count
288             
289             for aux_work, index, hashes in mm_later:
290                 try:
291                     if pow_hash <= aux_work['target'] or p2pool.DEBUG:
292                         df = deferral.retry('Error submitting merged block: (will retry)', 10, 10)(aux_work['merged_proxy'].rpc_getauxblock)(
293                             pack.IntType(256, 'big').pack(aux_work['hash']).encode('hex'),
294                             bitcoin_data.aux_pow_type.pack(dict(
295                                 merkle_tx=dict(
296                                     tx=transactions[0],
297                                     block_hash=header_hash,
298                                     merkle_link=merkle_link,
299                                 ),
300                                 merkle_link=bitcoin_data.calculate_merkle_link(hashes, index),
301                                 parent_block_header=header,
302                             )).encode('hex'),
303                         )
304                         @df.addCallback
305                         def _(result, aux_work=aux_work):
306                             if result != (pow_hash <= aux_work['target']):
307                                 print >>sys.stderr, 'Merged block submittal result: %s Expected: %s' % (result, pow_hash <= aux_work['target'])
308                             else:
309                                 print 'Merged block submittal result: %s' % (result,)
310                         @df.addErrback
311                         def _(err):
312                             log.err(err, 'Error submitting merged block:')
313                 except:
314                     log.err(None, 'Error while processing merged mining POW:')
315             
316             if pow_hash <= share_info['bits'].target and header_hash not in received_header_hashes:
317                 share = get_share(header, transactions)
318                 
319                 print 'GOT SHARE! %s %s prev %s age %.2fs%s' % (
320                     request.getUser(),
321                     p2pool_data.format_hash(share.hash),
322                     p2pool_data.format_hash(share.previous_hash),
323                     time.time() - getwork_time,
324                     ' DEAD ON ARRIVAL' if not on_time else '',
325                 )
326                 self.my_share_hashes.add(share.hash)
327                 if not on_time:
328                     self.my_doa_share_hashes.add(share.hash)
329                 
330                 self.node.tracker.add(share)
331                 if not p2pool.DEBUG:
332                     self.node.tracker.verified.add(share)
333                 self.node.set_best_share()
334                 
335                 try:
336                     if pow_hash <= header['bits'].target or p2pool.DEBUG:
337                         self.node.p2p_node.broadcast_share(share.hash)
338                 except:
339                     log.err(None, 'Error forwarding block solution:')
340                 
341                 self.share_received.happened(bitcoin_data.target_to_average_attempts(share.target), not on_time)
342             
343             if pow_hash > target:
344                 print 'Worker %s submitted share with hash > target:' % (request.getUser(),)
345                 print '    Hash:   %56x' % (pow_hash,)
346                 print '    Target: %56x' % (target,)
347             elif header_hash in received_header_hashes:
348                 print >>sys.stderr, 'Worker %s @ %s submitted share more than once!' % (request.getUser(), request.getClientIP())
349             else:
350                 received_header_hashes.add(header_hash)
351                 
352                 self.pseudoshare_received.happened(bitcoin_data.target_to_average_attempts(target), not on_time, user)
353                 self.recent_shares_ts_work.append((time.time(), bitcoin_data.target_to_average_attempts(target)))
354                 while len(self.recent_shares_ts_work) > 50:
355                     self.recent_shares_ts_work.pop(0)
356                 self.local_rate_monitor.add_datum(dict(work=bitcoin_data.target_to_average_attempts(target), dead=not on_time, user=user))
357             
358             return on_time
359         
360         return ba, got_response