compensate expected payout amount for donation percentage
[p2pool.git] / p2pool / web.py
1 from __future__ import division
2
3 import errno
4 import json
5 import os
6 import sys
7 import time
8
9 from twisted.internet import defer, task
10 from twisted.python import log
11 from twisted.web import resource, static
12
13 import p2pool
14 from bitcoin import data as bitcoin_data
15 from . import data as p2pool_data
16 from util import deferred_resource, graph, math, pack
17
18 def _atomic_read(filename):
19     try:
20         with open(filename, 'rb') as f:
21             return f.read()
22     except IOError, e:
23         if e.errno != errno.ENOENT:
24             raise
25     try:
26         with open(filename + '.new', 'rb') as f:
27             return f.read()
28     except IOError, e:
29         if e.errno != errno.ENOENT:
30             raise
31     return None
32
33 def _atomic_write(filename, data):
34     with open(filename + '.new', 'wb') as f:
35         f.write(data)
36         f.flush()
37         try:
38             os.fsync(f.fileno())
39         except:
40             pass
41     try:
42         os.rename(filename + '.new', filename)
43     except: # XXX windows can't overwrite
44         os.remove(filename)
45         os.rename(filename + '.new', filename)
46
47 def get_web_root(tracker, bitcoind_work, get_current_txouts, datadir_path, net, get_stale_counts, my_pubkey_hash, local_rate_monitor, worker_fee, p2p_node, my_share_hashes, pseudoshare_received, share_received, best_share_var, bitcoin_warning_var, traffic_happened, donation_percentage):
48     start_time = time.time()
49     
50     web_root = resource.Resource()
51     
52     def get_users():
53         height, last = tracker.get_height_and_last(best_share_var.value)
54         weights, total_weight, donation_weight = tracker.get_cumulative_weights(best_share_var.value, min(height, 720), 65535*2**256)
55         res = {}
56         for script in sorted(weights, key=lambda s: weights[s]):
57             res[bitcoin_data.script2_to_address(script, net.PARENT)] = weights[script]/total_weight
58         return res
59     
60     def get_current_scaled_txouts(scale, trunc=0):
61         txouts = get_current_txouts()
62         total = sum(txouts.itervalues())
63         results = dict((script, value*scale//total) for script, value in txouts.iteritems())
64         if trunc > 0:
65             total_random = 0
66             random_set = set()
67             for s in sorted(results, key=results.__getitem__):
68                 if results[s] >= trunc:
69                     break
70                 total_random += results[s]
71                 random_set.add(s)
72             if total_random:
73                 winner = math.weighted_choice((script, results[script]) for script in random_set)
74                 for script in random_set:
75                     del results[script]
76                 results[winner] = total_random
77         if sum(results.itervalues()) < int(scale):
78             results[math.weighted_choice(results.iteritems())] += int(scale) - sum(results.itervalues())
79         return results
80     
81     def get_patron_sendmany(total=None, trunc='0.01'):
82         if total is None:
83             return 'need total argument. go to patron_sendmany/<TOTAL>'
84         total = int(float(total)*1e8)
85         trunc = int(float(trunc)*1e8)
86         return json.dumps(dict(
87             (bitcoin_data.script2_to_address(script, net.PARENT), value/1e8)
88             for script, value in get_current_scaled_txouts(total, trunc).iteritems()
89             if bitcoin_data.script2_to_address(script, net.PARENT) is not None
90         ))
91     
92     def get_local_rates():
93         miner_hash_rates = {}
94         miner_dead_hash_rates = {}
95         datums, dt = local_rate_monitor.get_datums_in_last()
96         for datum in datums:
97             miner_hash_rates[datum['user']] = miner_hash_rates.get(datum['user'], 0) + datum['work']/dt
98             if datum['dead']:
99                 miner_dead_hash_rates[datum['user']] = miner_dead_hash_rates.get(datum['user'], 0) + datum['work']/dt
100         return miner_hash_rates, miner_dead_hash_rates
101     
102     def get_global_stats():
103         # averaged over last hour
104         if tracker.get_height(best_share_var.value) < 10:
105             return None
106         lookbehind = min(tracker.get_height(best_share_var.value), 3600//net.SHARE_PERIOD)
107         
108         nonstale_hash_rate = p2pool_data.get_pool_attempts_per_second(tracker, best_share_var.value, lookbehind)
109         stale_prop = p2pool_data.get_average_stale_prop(tracker, best_share_var.value, lookbehind)
110         return dict(
111             pool_nonstale_hash_rate=nonstale_hash_rate,
112             pool_hash_rate=nonstale_hash_rate/(1 - stale_prop),
113             pool_stale_prop=stale_prop,
114             min_difficulty=bitcoin_data.target_to_difficulty(tracker.items[best_share_var.value].max_target),
115         )
116     
117     def get_local_stats():
118         if tracker.get_height(best_share_var.value) < 10:
119             return None
120         lookbehind = min(tracker.get_height(best_share_var.value), 3600//net.SHARE_PERIOD)
121         
122         global_stale_prop = p2pool_data.get_average_stale_prop(tracker, best_share_var.value, lookbehind)
123         
124         my_unstale_count = sum(1 for share in tracker.get_chain(best_share_var.value, lookbehind) if share.hash in my_share_hashes)
125         my_orphan_count = sum(1 for share in tracker.get_chain(best_share_var.value, lookbehind) if share.hash in my_share_hashes and share.share_data['stale_info'] == 'orphan')
126         my_doa_count = sum(1 for share in tracker.get_chain(best_share_var.value, lookbehind) if share.hash in my_share_hashes and share.share_data['stale_info'] == 'doa')
127         my_share_count = my_unstale_count + my_orphan_count + my_doa_count
128         my_stale_count = my_orphan_count + my_doa_count
129         
130         my_stale_prop = my_stale_count/my_share_count if my_share_count != 0 else None
131         
132         my_work = sum(bitcoin_data.target_to_average_attempts(share.target)
133             for share in tracker.get_chain(best_share_var.value, lookbehind - 1)
134             if share.hash in my_share_hashes)
135         actual_time = (tracker.items[best_share_var.value].timestamp -
136             tracker.items[tracker.get_nth_parent_hash(best_share_var.value, lookbehind - 1)].timestamp)
137         share_att_s = my_work / actual_time
138         
139         miner_hash_rates, miner_dead_hash_rates = get_local_rates()
140         (stale_orphan_shares, stale_doa_shares), shares, _ = get_stale_counts()
141         
142         return dict(
143             my_hash_rates_in_last_hour=dict(
144                 note="DEPRECATED",
145                 nonstale=share_att_s,
146                 rewarded=share_att_s/(1 - global_stale_prop),
147                 actual=share_att_s/(1 - my_stale_prop) if my_stale_prop is not None else 0, # 0 because we don't have any shares anyway
148             ),
149             my_share_counts_in_last_hour=dict(
150                 shares=my_share_count,
151                 unstale_shares=my_unstale_count,
152                 stale_shares=my_stale_count,
153                 orphan_stale_shares=my_orphan_count,
154                 doa_stale_shares=my_doa_count,
155             ),
156             my_stale_proportions_in_last_hour=dict(
157                 stale=my_stale_prop,
158                 orphan_stale=my_orphan_count/my_share_count if my_share_count != 0 else None,
159                 dead_stale=my_doa_count/my_share_count if my_share_count != 0 else None,
160             ),
161             miner_hash_rates=miner_hash_rates,
162             miner_dead_hash_rates=miner_dead_hash_rates,
163             efficiency_if_miner_perfect=(1 - stale_orphan_shares/shares)/(1 - global_stale_prop) if shares else None, # ignores dead shares because those are miner's fault and indicated by pseudoshare rejection
164             efficiency=(1 - (stale_orphan_shares+stale_doa_shares)/shares)/(1 - global_stale_prop) if shares else None,
165             peers=dict(
166                 incoming=sum(1 for peer in p2p_node.peers.itervalues() if peer.incoming),
167                 outgoing=sum(1 for peer in p2p_node.peers.itervalues() if not peer.incoming),
168             ),
169             shares=dict(
170                 total=shares,
171                 orphan=stale_orphan_shares,
172                 dead=stale_doa_shares,
173             ),
174             uptime=time.time() - start_time,
175             attempts_to_share=bitcoin_data.target_to_average_attempts(tracker.items[best_share_var.value].max_target),
176             attempts_to_block=bitcoin_data.target_to_average_attempts(bitcoind_work.value['bits'].target),
177             block_value=bitcoind_work.value['subsidy']*1e-8,
178             warnings=p2pool_data.get_warnings(tracker, best_share_var.value, net, bitcoin_warning_var.value, bitcoind_work.value),
179             donation_proportion=donation_percentage/100,
180         )
181     
182     class WebInterface(deferred_resource.DeferredResource):
183         def __init__(self, func, mime_type='application/json', args=()):
184             deferred_resource.DeferredResource.__init__(self)
185             self.func, self.mime_type, self.args = func, mime_type, args
186         
187         def getChild(self, child, request):
188             return WebInterface(self.func, self.mime_type, self.args + (child,))
189         
190         @defer.inlineCallbacks
191         def render_GET(self, request):
192             request.setHeader('Content-Type', self.mime_type)
193             request.setHeader('Access-Control-Allow-Origin', '*')
194             res = yield self.func(*self.args)
195             defer.returnValue(json.dumps(res) if self.mime_type == 'application/json' else res)
196     
197     web_root.putChild('rate', WebInterface(lambda: p2pool_data.get_pool_attempts_per_second(tracker, best_share_var.value, 720)/(1-p2pool_data.get_average_stale_prop(tracker, best_share_var.value, 720))))
198     web_root.putChild('difficulty', WebInterface(lambda: bitcoin_data.target_to_difficulty(tracker.items[best_share_var.value].max_target)))
199     web_root.putChild('users', WebInterface(get_users))
200     web_root.putChild('user_stales', WebInterface(lambda: dict((bitcoin_data.pubkey_hash_to_address(ph, net.PARENT), prop) for ph, prop in
201         p2pool_data.get_user_stale_props(tracker, best_share_var.value, tracker.get_height(best_share_var.value)).iteritems())))
202     web_root.putChild('fee', WebInterface(lambda: worker_fee))
203     web_root.putChild('current_payouts', WebInterface(lambda: dict((bitcoin_data.script2_to_address(script, net.PARENT), value/1e8) for script, value in get_current_txouts().iteritems())))
204     web_root.putChild('patron_sendmany', WebInterface(get_patron_sendmany, 'text/plain'))
205     web_root.putChild('global_stats', WebInterface(get_global_stats))
206     web_root.putChild('local_stats', WebInterface(get_local_stats))
207     web_root.putChild('peer_addresses', WebInterface(lambda: ['%s:%i' % (peer.transport.getPeer().host, peer.transport.getPeer().port) for peer in p2p_node.peers.itervalues()]))
208     web_root.putChild('pings', WebInterface(defer.inlineCallbacks(lambda: defer.returnValue(
209         dict([(a, (yield b)) for a, b in
210             [(
211                 '%s:%i' % (peer.transport.getPeer().host, peer.transport.getPeer().port),
212                 defer.inlineCallbacks(lambda peer=peer: defer.returnValue(
213                     min([(yield peer.do_ping().addCallback(lambda x: x/0.001).addErrback(lambda fail: None)) for i in xrange(3)])
214                 ))()
215             ) for peer in list(p2p_node.peers.itervalues())]
216         ])
217     ))))
218     web_root.putChild('peer_versions', WebInterface(lambda: dict(('%s:%i' % peer.addr, peer.other_sub_version) for peer in p2p_node.peers.itervalues())))
219     web_root.putChild('payout_addr', WebInterface(lambda: bitcoin_data.pubkey_hash_to_address(my_pubkey_hash, net.PARENT)))
220     web_root.putChild('recent_blocks', WebInterface(lambda: [dict(
221         ts=s.timestamp,
222         hash='%064x' % s.header_hash,
223         number=pack.IntType(24).unpack(s.share_data['coinbase'][1:4]),
224         share='%064x' % s.hash,
225     ) for s in tracker.get_chain(best_share_var.value, min(tracker.get_height(best_share_var.value), 24*60*60//net.SHARE_PERIOD)) if s.pow_hash <= s.header['bits'].target]))
226     web_root.putChild('uptime', WebInterface(lambda: time.time() - start_time))
227     web_root.putChild('stale_rates', WebInterface(lambda: p2pool_data.get_stale_counts(tracker, best_share_var.value, 720, rates=True)))
228     
229     new_root = resource.Resource()
230     web_root.putChild('web', new_root)
231     
232     stat_log = []
233     if os.path.exists(os.path.join(datadir_path, 'stats')):
234         try:
235             with open(os.path.join(datadir_path, 'stats'), 'rb') as f:
236                 stat_log = json.loads(f.read())
237         except:
238             log.err(None, 'Error loading stats:')
239     def update_stat_log():
240         while stat_log and stat_log[0]['time'] < time.time() - 24*60*60:
241             stat_log.pop(0)
242         
243         lookbehind = 3600//net.SHARE_PERIOD
244         if tracker.get_height(best_share_var.value) < lookbehind:
245             return None
246         
247         global_stale_prop = p2pool_data.get_average_stale_prop(tracker, best_share_var.value, lookbehind)
248         (stale_orphan_shares, stale_doa_shares), shares, _ = get_stale_counts()
249         miner_hash_rates, miner_dead_hash_rates = get_local_rates()
250         
251         stat_log.append(dict(
252             time=time.time(),
253             pool_hash_rate=p2pool_data.get_pool_attempts_per_second(tracker, best_share_var.value, lookbehind)/(1-global_stale_prop),
254             pool_stale_prop=global_stale_prop,
255             local_hash_rates=miner_hash_rates,
256             local_dead_hash_rates=miner_dead_hash_rates,
257             shares=shares,
258             stale_shares=stale_orphan_shares + stale_doa_shares,
259             stale_shares_breakdown=dict(orphan=stale_orphan_shares, doa=stale_doa_shares),
260             current_payout=get_current_txouts().get(bitcoin_data.pubkey_hash_to_script2(my_pubkey_hash), 0)*1e-8,
261             peers=dict(
262                 incoming=sum(1 for peer in p2p_node.peers.itervalues() if peer.incoming),
263                 outgoing=sum(1 for peer in p2p_node.peers.itervalues() if not peer.incoming),
264             ),
265             attempts_to_share=bitcoin_data.target_to_average_attempts(tracker.items[best_share_var.value].max_target),
266             attempts_to_block=bitcoin_data.target_to_average_attempts(bitcoind_work.value['bits'].target),
267             block_value=bitcoind_work.value['subsidy']*1e-8,
268         ))
269         
270         with open(os.path.join(datadir_path, 'stats'), 'wb') as f:
271             f.write(json.dumps(stat_log))
272     task.LoopingCall(update_stat_log).start(5*60)
273     new_root.putChild('log', WebInterface(lambda: stat_log))
274     
275     def get_share(share_hash_str):
276         if int(share_hash_str, 16) not in tracker.items:
277             return None
278         share = tracker.items[int(share_hash_str, 16)]
279         
280         return dict(
281             parent='%064x' % share.previous_hash,
282             children=['%064x' % x for x in sorted(tracker.reverse.get(share.hash, set()), key=lambda sh: -len(tracker.reverse.get(sh, set())))], # sorted from most children to least children
283             local=dict(
284                 verified=share.hash in tracker.verified.items,
285                 time_first_seen=start_time if share.time_seen == 0 else share.time_seen,
286                 peer_first_received_from=share.peer.addr if share.peer is not None else None,
287             ),
288             share_data=dict(
289                 timestamp=share.timestamp,
290                 target=share.target,
291                 max_target=share.max_target,
292                 payout_address=bitcoin_data.script2_to_address(share.new_script, net.PARENT),
293                 donation=share.share_data['donation']/65535,
294                 stale_info=share.share_data['stale_info'],
295                 nonce=share.share_data['nonce'],
296                 desired_version=share.share_data['desired_version'],
297             ),
298             block=dict(
299                 hash='%064x' % share.header_hash,
300                 header=dict(
301                     version=share.header['version'],
302                     previous_block='%064x' % share.header['previous_block'],
303                     merkle_root='%064x' % share.header['merkle_root'],
304                     timestamp=share.header['timestamp'],
305                     target=share.header['bits'].target,
306                     nonce=share.header['nonce'],
307                 ),
308                 gentx=dict(
309                     hash='%064x' % share.gentx_hash,
310                     coinbase=share.share_data['coinbase'].ljust(2, '\x00').encode('hex'),
311                     value=share.share_data['subsidy']*1e-8,
312                 ),
313                 txn_count_range=[len(share.other_txs), len(share.other_txs)] if share.other_txs is not None else 1 if len(share.merkle_link['branch']) == 0 else [2**len(share.merkle_link['branch'])//2+1, 2**len(share.merkle_link['branch'])],
314             ),
315         )
316     new_root.putChild('share', WebInterface(lambda share_hash_str: get_share(share_hash_str)))
317     new_root.putChild('heads', WebInterface(lambda: ['%064x' % x for x in tracker.heads]))
318     new_root.putChild('verified_heads', WebInterface(lambda: ['%064x' % x for x in tracker.verified.heads]))
319     new_root.putChild('tails', WebInterface(lambda: ['%064x' % x for t in tracker.tails for x in tracker.reverse.get(t, set())]))
320     new_root.putChild('verified_tails', WebInterface(lambda: ['%064x' % x for t in tracker.verified.tails for x in tracker.verified.reverse.get(t, set())]))
321     new_root.putChild('best_share_hash', WebInterface(lambda: '%064x' % best_share_var.value))
322     def get_share_data(share_hash_str):
323         if int(share_hash_str, 16) not in tracker.items:
324             return ''
325         share = tracker.items[int(share_hash_str, 16)]
326         return p2pool_data.share_type.pack(share.as_share1a())
327     new_root.putChild('share_data', WebInterface(lambda share_hash_str: get_share_data(share_hash_str), 'application/octet-stream'))
328     new_root.putChild('currency_info', WebInterface(lambda: dict(
329         symbol=net.PARENT.SYMBOL,
330         block_explorer_url_prefix=net.PARENT.BLOCK_EXPLORER_URL_PREFIX,
331         address_explorer_url_prefix=net.PARENT.ADDRESS_EXPLORER_URL_PREFIX,
332     )))
333     new_root.putChild('version', WebInterface(lambda: p2pool.__version__))
334     
335     hd_path = os.path.join(datadir_path, 'graph_db')
336     hd_data = _atomic_read(hd_path)
337     hd_obj = {}
338     if hd_data is not None:
339         try:
340             hd_obj = json.loads(hd_data)
341         except Exception:
342             log.err(None, 'Error reading graph database:')
343     dataview_descriptions = {
344         'last_hour': graph.DataViewDescription(150, 60*60),
345         'last_day': graph.DataViewDescription(300, 60*60*24),
346         'last_week': graph.DataViewDescription(300, 60*60*24*7),
347         'last_month': graph.DataViewDescription(300, 60*60*24*30),
348         'last_year': graph.DataViewDescription(300, 60*60*24*365.25),
349     }
350     def build_pool_rates(ds_name, ds_desc, dv_name, dv_desc, obj):
351         if not obj:
352             last_bin_end = 0
353             bins = dv_desc.bin_count*[{}]
354         else:
355             pool_rate = obj['pool_rate'][dv_name]
356             pool_stale_rate = obj['pool_stale_rate'][dv_name]
357             last_bin_end = max(pool_rate['last_bin_end'], pool_stale_rate['last_bin_end'])
358             bins = dv_desc.bin_count*[{}]
359             def get_value(obj, t):
360                 n = int((obj['last_bin_end'] - t)/dv_desc.bin_width)
361                 if n < 0 or n >= dv_desc.bin_count:
362                     return None, 0
363                 total, count = obj['bins'][n].get('null', [0, 0])
364                 if count == 0:
365                     return None, 0
366                 return total/count, count
367             def get_bin(t):
368                 total, total_count = get_value(pool_rate, t)
369                 bad, bad_count = get_value(pool_stale_rate, t)
370                 if total is None or bad is None:
371                     return {}
372                 count = int((total_count+bad_count)/2+1/2)
373                 return dict(good=[(total-bad)*count, count], bad=[bad*count, count], null=[0, count])
374             bins = [get_bin(last_bin_end - (i+1/2)*dv_desc.bin_width) for i in xrange(dv_desc.bin_count)]
375         return graph.DataView(dv_desc, ds_desc, last_bin_end, bins)
376     hd = graph.HistoryDatabase.from_obj({
377         'local_hash_rate': graph.DataStreamDescription(dataview_descriptions, is_gauge=False),
378         'local_dead_hash_rate': graph.DataStreamDescription(dataview_descriptions, is_gauge=False),
379         'local_share_hash_rate': graph.DataStreamDescription(dataview_descriptions, is_gauge=False),
380         'local_dead_share_hash_rate': graph.DataStreamDescription(dataview_descriptions, is_gauge=False),
381         'pool_rates': graph.DataStreamDescription(dataview_descriptions, multivalues=True,
382             multivalue_undefined_means_0=True, default_func=build_pool_rates),
383         'current_payout': graph.DataStreamDescription(dataview_descriptions),
384         'current_payouts': graph.DataStreamDescription(dataview_descriptions, multivalues=True),
385         'incoming_peers': graph.DataStreamDescription(dataview_descriptions),
386         'outgoing_peers': graph.DataStreamDescription(dataview_descriptions),
387         'miner_hash_rates': graph.DataStreamDescription(dataview_descriptions, is_gauge=False, multivalues=True),
388         'miner_dead_hash_rates': graph.DataStreamDescription(dataview_descriptions, is_gauge=False, multivalues=True),
389         'desired_versions': graph.DataStreamDescription(dataview_descriptions, multivalues=True,
390             multivalue_undefined_means_0=True),
391         'traffic_rate': graph.DataStreamDescription(dataview_descriptions, is_gauge=False, multivalues=True),
392     }, hd_obj)
393     task.LoopingCall(lambda: _atomic_write(hd_path, json.dumps(hd.to_obj()))).start(100)
394     @pseudoshare_received.watch
395     def _(work, dead, user):
396         t = time.time()
397         hd.datastreams['local_hash_rate'].add_datum(t, work)
398         if dead:
399             hd.datastreams['local_dead_hash_rate'].add_datum(t, work)
400         if user is not None:
401             hd.datastreams['miner_hash_rates'].add_datum(t, {user: work})
402             if dead:
403                 hd.datastreams['miner_dead_hash_rates'].add_datum(t, {user: work})
404     @share_received.watch
405     def _(work, dead):
406         t = time.time()
407         hd.datastreams['local_share_hash_rate'].add_datum(t, work)
408         if dead:
409             hd.datastreams['local_dead_share_hash_rate'].add_datum(t, work)
410     @traffic_happened.watch
411     def _(name, bytes):
412         hd.datastreams['traffic_rate'].add_datum(time.time(), {name: bytes})
413     def add_point():
414         if tracker.get_height(best_share_var.value) < 10:
415             return None
416         lookbehind = min(net.CHAIN_LENGTH, 60*60//net.SHARE_PERIOD, tracker.get_height(best_share_var.value))
417         t = time.time()
418         
419         hd.datastreams['pool_rates'].add_datum(t, p2pool_data.get_stale_counts(tracker, best_share_var.value, lookbehind, rates=True))
420         
421         current_txouts = get_current_txouts()
422         hd.datastreams['current_payout'].add_datum(t, current_txouts.get(bitcoin_data.pubkey_hash_to_script2(my_pubkey_hash), 0)*1e-8)
423         miner_hash_rates, miner_dead_hash_rates = get_local_rates()
424         current_txouts_by_address = dict((bitcoin_data.script2_to_address(script, net.PARENT), amount) for script, amount in current_txouts.iteritems())
425         hd.datastreams['current_payouts'].add_datum(t, dict((user, current_txouts_by_address[user]*1e-8) for user in miner_hash_rates if user in current_txouts_by_address))
426         
427         hd.datastreams['incoming_peers'].add_datum(t, sum(1 for peer in p2p_node.peers.itervalues() if peer.incoming))
428         hd.datastreams['outgoing_peers'].add_datum(t, sum(1 for peer in p2p_node.peers.itervalues() if not peer.incoming))
429         
430         vs = p2pool_data.get_desired_version_counts(tracker, best_share_var.value, lookbehind)
431         vs_total = sum(vs.itervalues())
432         hd.datastreams['desired_versions'].add_datum(t, dict((str(k), v/vs_total) for k, v in vs.iteritems()))
433     task.LoopingCall(add_point).start(5)
434     new_root.putChild('graph_data', WebInterface(lambda source, view: hd.datastreams[source].dataviews[view].get_data(time.time())))
435     
436     web_root.putChild('static', static.File(os.path.join(os.path.dirname(sys.argv[0]), 'web-static')))
437     
438     return web_root