mmnode-blocks-info 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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-blocks-info: Display information about a block or range of blocks
  20. """
  21. from mmgen.common import *
  22. from mmgen.node_tools.BlocksInfo import BlocksInfo,JSONBlocksInfo
  23. opts_data = {
  24. 'sets': [
  25. ('hashes', True, 'fields', 'block,hash'),
  26. ('hashes', True, 'stats', 'none'),
  27. ('json_raw', True, 'json', True),
  28. ('raw_miner_info',True,'miner_info', True),
  29. ],
  30. 'text': {
  31. 'desc': 'Display information about a block or range of blocks',
  32. 'usage': '[opts] blocknum [blocknum ...] | blocknum-blocknum[+step] | [blocknum|-nBlocks]+nBlocks[+step]',
  33. 'usage2': [
  34. '[opts] blocknum [blocknum ...]',
  35. '[opts] blocknum-blocknum[+step]',
  36. '[opts] [blocknum|-nBlocks]+nBlocks[+step]',
  37. ],
  38. 'options': """
  39. -h, --help Print this help message
  40. --, --longhelp Print help message for long options (common options)
  41. -H, --hashes Display only block numbers and hashes
  42. -j, --json Produce JSON output
  43. -J, --json-raw Produce JSON output with unformatted values
  44. -m, --miner-info Display miner info in coinbase transaction
  45. -M, --raw-miner-info Display miner info in uninterpreted form
  46. -n, --no-header Don’t print the column header
  47. -o, --fields= Display the specified fields (comma-separated list).
  48. See AVAILABLE FIELDS below. Prefix the list with '+'
  49. to add the fields to the defaults, or '-' to remove
  50. them. The special values 'all' and 'none' select all
  51. available fields or none, respectively.
  52. -s, --stats= Display the specified stats (comma-separated list).
  53. See AVAILABLE STATS below. The prefixes and special
  54. values available to the --fields option are recognized.
  55. """,
  56. 'notes': """
  57. If no block number is specified, the current chain tip is assumed.
  58. The special value 'cur' can be used to designate the chain tip wherever a
  59. block number is expected.
  60. If the requested range ends at the current chain tip, an estimate of the next
  61. difficulty adjustment is also displayed. The estimate is based on the average
  62. Block Discovery Interval from the beginning of the current 2016-block period.
  63. All fee fields except for 'totalfee' are in satoshis per virtual byte.
  64. AVAILABLE FIELDS: {f}
  65. AVAILABLE STATS: {s}
  66. EXAMPLES:
  67. Display info for current block:
  68. $ {p}
  69. Display info for the Genesis Block:
  70. $ {p} 0
  71. Display info for the last 20 blocks:
  72. $ {p} +20
  73. Display specified fields for blocks 165-190
  74. $ {p} -o block,date,size,inputs,nTx 165-190
  75. Display info for 10 blocks beginning at block 600000:
  76. $ {p} 600000+10
  77. Display info for every 5th block of 50-block range beginning at 1000
  78. blocks from chain tip:
  79. $ {p} -- -1000+50+5
  80. Display info for block 152817, adding miner field:
  81. $ {p} -o +miner 152817
  82. Display specified fields for listed blocks:
  83. $ {p} -o block,date,hash 245798 170 624044
  84. Display every difficulty adjustment from Genesis Block to chain tip:
  85. $ {p} -o +difficulty 0-cur+2016
  86. Display roughly a block a day over the last two weeks. Note that
  87. multiplication is allowed in the nBlocks spec:
  88. $ {p} +144*14+144
  89. Display only range stats for the last ten blocks:
  90. $ {p} -o none -s range +10
  91. Display data for the last ten blocks, skipping 'size' and 'subsidy'
  92. fields and stats:
  93. $ {p} -o -size,subsidy -s none +10
  94. Display all fields and stats for the last ten blocks:
  95. $ {p} -o all -s all +10
  96. This program requires a txindex-enabled daemon for correct operation.
  97. """.format(
  98. f = fmt_list(BlocksInfo.fields,fmt='bare'),
  99. s = fmt_list(BlocksInfo.all_stats,fmt='bare'),
  100. p = g.prog_name )
  101. }
  102. }
  103. cmd_args = opts.init(opts_data)
  104. async def main():
  105. from mmgen.protocol import init_proto_from_opts
  106. from mmgen.rpc import rpc_init
  107. proto = init_proto_from_opts()
  108. cls = JSONBlocksInfo if opt.json else BlocksInfo
  109. m = cls( cmd_args, opt, await rpc_init(proto) )
  110. if m.fnames and not opt.no_header:
  111. m.print_header()
  112. await m.process_blocks()
  113. if m.last:
  114. for i,sname in enumerate(m.stats):
  115. m.process_stats_pre(i)
  116. await m.process_stats(sname)
  117. m.finalize_output()
  118. run_session(main())