main_feeview.py 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2021 The MMGen Project <mmgen@tuta.io>
  5. #
  6. # This program is free software: you can redistribute it and/or modify it under
  7. # the terms of the GNU General Public License as published by the Free Software
  8. # Foundation, either version 3 of the License, or (at your option) any later
  9. # version.
  10. #
  11. # This program is distributed in the hope that it will be useful, but WITHOUT
  12. # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13. # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  14. # details.
  15. #
  16. # You should have received a copy of the GNU General Public License along with
  17. # this program. If not, see <http://www.gnu.org/licenses/>.
  18. """
  19. mmnode-feeview: Visualize the fee structure of a node’s mempool
  20. """
  21. from mmgen.common import *
  22. min_prec,max_prec,dfl_prec = (0,6,4)
  23. fee_brackets = [
  24. 1, 2, 3, 4, 5, 6,
  25. 8, 10, 12, 14, 16, 18,
  26. 20, 25, 30, 35, 40, 45,
  27. 50, 60, 70, 80, 90,
  28. 100, 120, 140, 160, 180,
  29. 200, 250, 300, 350, 400, 450,
  30. 500, 600, 700, 800, 900,
  31. 1000, 1200, 1400, 1600, 1800,
  32. 2000, 2500, 3000, 3500, 4000, 4500,
  33. 5000, 6000, 7000, 8000, 9000,
  34. 10000, 20000, 30000, 40000, 50000, 60000, 70000, 80000, 90000,
  35. 100000, 1000000, 10000000, 100000000, 1000000000, 10000000000, 2100000000000000,
  36. ]
  37. opts.init({
  38. 'sets': [
  39. ('detail',True,'ranges',True),
  40. ('detail',True,'show_mb_col',True),
  41. ('detail',True,'precision',6),
  42. ],
  43. 'text': {
  44. 'desc': 'Visualize the fee structure of a node’s mempool',
  45. 'usage':'[opts]',
  46. 'options': f"""
  47. -h, --help Print this help message
  48. --, --longhelp Print help message for long options (common options)
  49. -c, --include-current Include current bracket’s TXs in cumulative MB value
  50. -d, --detail Same as --ranges --show-mb-col --precision=6
  51. -e, --show-empty Show all fee brackets, including empty ones
  52. -i, --ignore-below=B Ignore fee brackets with less than 'B' bytes of TXs
  53. -l, --log Log JSON-RPC mempool data to 'mempool.json'
  54. -p, --precision=P Use 'P' decimal points of precision for megabyte amts
  55. (min: {min_prec}, max: {max_prec}, default: {dfl_prec})
  56. -P, --pager Pipe the output to a pager
  57. -r, --ranges Display fee brackets as ranges
  58. -s, --show-mb-col Display column with each fee bracket’s megabyte count
  59. -w, --width=W Force output width of 'W' columns (default: term width)
  60. """,
  61. 'notes': """
  62. + By default, fee bracket row labels include only the top of the range.
  63. + By default, empty fee brackets are not displayed.
  64. + Mempool amounts are shown in decimal megabytes.
  65. + Values in the Total MB column are cumulative and represent megabytes of
  66. transactions in the mempool with fees higher than the TOP of the current
  67. fee bracket. To change this behavior, use the --include-current option.
  68. Note that there is no global mempool in Bitcoin, and your node’s mempool may
  69. differ significantly from those of mining nodes depending on uptime and other
  70. factors.
  71. """
  72. }
  73. })
  74. if opt.ignore_below:
  75. if opt.show_empty:
  76. die(1,'Conflicting options: --ignore-below, --show-empty')
  77. ignore_below = parse_bytespec(opt.ignore_below)
  78. if opt.precision:
  79. precision = check_int_between(opt.precision,min_prec,max_prec,'--precision arg')
  80. else:
  81. precision = dfl_prec
  82. if opt.width:
  83. width = check_int_between(opt.width,40,1024,'--width arg')
  84. else:
  85. from mmgen.term import get_terminal_size
  86. width = get_terminal_size()[0]
  87. class fee_bracket:
  88. def __init__(self,top,bottom):
  89. self.top = top
  90. self.bottom = bottom
  91. self.tx_bytes = 0
  92. self.tx_bytes_cum = 0
  93. self.skip = False
  94. def get_fake_data(fn): # for debugging
  95. import json
  96. from mmgen.rpc import json_encoder
  97. from decimal import Decimal
  98. return json.loads(open(os.path.join(fn)).read(),parse_float=Decimal)
  99. def log(data,fn):
  100. import json
  101. from mmgen.rpc import json_encoder
  102. open(fn,'w').write(json.dumps(data,cls=json_encoder,sort_keys=True,indent=4))
  103. def create_data(coin_amt,mempool):
  104. out = [fee_bracket(fee_brackets[i],fee_brackets[i-1] if i else 0) for i in range(len(fee_brackets))]
  105. # populate fee brackets:
  106. for tx in mempool.values():
  107. fee = coin_amt(tx['fees']['base']).to_unit('satoshi')
  108. vsize = tx['vsize']
  109. for bracket in out:
  110. if fee / vsize < bracket.top:
  111. bracket.tx_bytes += vsize
  112. break
  113. # remove empty top brackets:
  114. while out and out[-1].tx_bytes == 0:
  115. out.pop()
  116. if not out:
  117. die(1,'No data!')
  118. out.reverse() # cumulative totals and display are top-down
  119. # calculate cumulative byte totals, filter rows:
  120. tBytes = 0
  121. for i in out:
  122. if not (i.tx_bytes or opt.show_empty):
  123. i.skip = True
  124. if opt.ignore_below and i.tx_bytes < ignore_below:
  125. i.skip = True
  126. i.tx_bytes_cum = tBytes
  127. tBytes += i.tx_bytes
  128. return out
  129. def gen_header(host,blockcount):
  130. yield('MEMPOOL FEE STRUCTURE ({})\n{} UTC\nBlock {}'.format(
  131. host,
  132. make_timestr(),
  133. blockcount,
  134. ))
  135. if opt.show_empty:
  136. yield('Displaying all fee brackets')
  137. elif opt.ignore_below:
  138. yield('Ignoring fee brackets with less than {} bytes ({})'.format(
  139. ignore_below,
  140. int2bytespec(ignore_below,'MB','0.6'),
  141. ))
  142. if opt.include_current:
  143. yield('Including transactions in current fee bracket in Total MB amounts')
  144. def fmt_mb(n):
  145. return int2bytespec(n,'MB',f'0.{precision}',False)
  146. def gen_body(data):
  147. tx_bytes_max = max(i.tx_bytes for i in data)
  148. top_max = max(i.top for i in data if not i.skip)
  149. bot_max = max(i.bottom for i in data if not i.skip)
  150. col1_w = max(len(f'{bot_max}-{top_max}') if opt.ranges else len(f'{top_max}'),6)
  151. col2_w = len(fmt_mb(tx_bytes_max)) if opt.show_mb_col else 0
  152. col3_w = len(fmt_mb(data[-1].tx_bytes_cum))
  153. col4_w = width - col1_w - col2_w - col3_w - (4 if col2_w else 3)
  154. if opt.show_mb_col:
  155. fs = '{a:<%i} {b:>%i} {c:>%i} {d}' % (col1_w,col2_w,col3_w)
  156. else:
  157. fs = '{a:<%i} {c:>%i} {d}' % (col1_w,col3_w)
  158. yield(
  159. '\n' + fs.format(a='', b='', c=f'{"Total":<{col3_w}}', d='') +
  160. '\n' + fs.format(a='sat/B', b=f'{"MB":<{col2_w}}', c=f'{"MB":<{col3_w}}', d='')
  161. )
  162. for i in data:
  163. if not i.skip:
  164. cum_bytes = i.tx_bytes_cum + i.tx_bytes if opt.include_current else i.tx_bytes_cum
  165. yield(fs.format(
  166. a = '{}-{}'.format(i.bottom,i.top) if opt.ranges else i.top,
  167. b = fmt_mb(i.tx_bytes),
  168. c = fmt_mb(cum_bytes),
  169. d = '-' * int(col4_w * ( i.tx_bytes / tx_bytes_max )) ))
  170. yield(fs.format(
  171. a = 'TOTAL',
  172. b = '',
  173. c = fmt_mb(data[-1].tx_bytes_cum + data[-1].tx_bytes),
  174. d = '' ))
  175. async def main():
  176. from mmgen.protocol import init_proto_from_opts
  177. proto = init_proto_from_opts(need_amt=True)
  178. from mmgen.rpc import rpc_init
  179. c = await rpc_init(proto)
  180. # pmsg(await c.call('getmempoolinfo'))
  181. mempool = await c.call('getrawmempool',True)
  182. # mempool = get_fake_data('test_data/mempool-sample.json')
  183. if opt.log:
  184. log(mempool,'mempool.json')
  185. data = create_data(proto.coin_amt,mempool)
  186. (do_pager if opt.pager else print)(
  187. '\n'.join(gen_header(c.host,await c.call('getblockcount'))) + '\n' +
  188. '\n'.join(gen_body(data))
  189. )
  190. run_session(main())