mmgen-wallet/mmgen/main_tool.py

#!/usr/bin/env python3
#
# mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
# Copyright (C)2013-2022 The MMGen Project <mmgen@tuta.io>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""
mmgen-tool:  Perform various MMGen- and cryptocoin-related operations.
             Part of the MMGen suite
"""

from .common import *

def make_cmd_help():
	import mmgen.tool
	def do():
		for bc in mmgen.tool.MMGenToolCmds.classes.values():
			cls_doc = bc.__doc__.strip().split('\n')
			for l in cls_doc:
				if l is cls_doc[0]:
					l += ':'
				l = l.replace('\t','',1)
				if l:
					l = l.replace('\t','  ')
					yield l[0].upper() + l[1:]
				else:
					yield ''
			yield ''

			max_w = max(map(len,bc.user_commands))
			for name,code in sorted(bc.user_commands.items()):
				if code.__doc__:
					yield '  {:{}} - {}'.format(
						name,
						max_w,
						pretty_format(
							code.__doc__.strip().replace('\n\t\t',' '),
							width = 79-(max_w+7),
							pfx   = ' '*(max_w+5)).lstrip()
					)
			yield ''

	return '\n'.join(do())

opts_data = {
	'text': {
		'desc':    f'Perform various {g.proj_name}- and cryptocoin-related operations',
		'usage':   '[opts] <command> <command args>',
		'options': """
-d, --outdir=       d Specify an alternate directory 'd' for output
-h, --help            Print this help message
--, --longhelp        Print help message for long options (common options)
-k, --use-internal-keccak-module Force use of the internal keccak module
-p, --hash-preset= p  Use the scrypt hash parameters defined by preset 'p'
                      for password hashing (default: '{g.dfl_hash_preset}')
-P, --passwd-file= f  Get passphrase from file 'f'.
-q, --quiet           Produce quieter output
-r, --usr-randchars=n Get 'n' characters of additional randomness from
                      user (min={g.min_urandchars}, max={g.max_urandchars})
-t, --type=t          Specify address type (valid options: 'legacy',
                      'compressed', 'segwit', 'bech32', 'zcash_z')
-v, --verbose         Produce more verbose output
-X, --cached-balances Use cached balances (Ethereum only)
-y, --yes             Answer 'yes' to prompts, suppress non-essential output
""",
	'notes': """

                               COMMANDS

{ch}
Type '{pn} help <command>' for help on a particular command
"""
	},
	'code': {
		'options': lambda s: s.format(g=g),
		'notes': lambda s: s.format(
			ch=make_cmd_help(),
			pn=g.prog_name)
	}
}

cmd_args = opts.init(opts_data,add_opts=['hidden_incog_input_params','in_fmt'])

if len(cmd_args) < 1:
	opts.usage()

cmd = cmd_args.pop(0)

import mmgen.tool as tool

if cmd in ('help','usage') and cmd_args:
	cmd_args[0] = 'command_name=' + cmd_args[0]

if cmd not in tool.MMGenToolCmds:
	die(1,f'{cmd!r}: no such command')

args,kwargs = tool._process_args(cmd,cmd_args)

ret = tool.MMGenToolCmds.call(cmd,*args,**kwargs)

if type(ret).__name__ == 'coroutine':
	ret = run_session(ret)

tool._process_result(ret,pager='pager' in kwargs and kwargs['pager'],print_result=True)