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