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