mmgen/mmgen-wallet
1
0
Fork 0
Code Issues Pull requests Projects Releases 28 Packages Wiki Activity

Update manpages

The MMGen Project 2022-08-15 12:36:00 +00:00
commit a9848e76c1
Signed by: mmgen
GPG key ID: 3F8B1861E32B7DA2
24 changed files with 1292 additions and 152 deletions
Download patch file Download diff file Expand all files Collapse all files

2
MMGen-command-help.md

@ -11,6 +11,7 @@
* [mmgen-subwalletgen](subwalletgen-[MMGen-command-help])
* [mmgen-tool](tool-[MMGen-command-help])
* [mmgen-tool (usage)][u]
* [mmgen-tool (detailed usage)][d]
* [mmgen-txbump](txbump-[MMGen-command-help])
* [mmgen-txcreate](txcreate-[MMGen-command-help])
* [mmgen-txdo](txdo-[MMGen-command-help])
@ -22,3 +23,4 @@
* [mmgen-xmrwallet](xmrwallet-[MMGen-command-help])
[u]: tool(usage)-[MMGen-command-help]
[d]: tool(detail)-[MMGen-command-help]

2
addrgen-[MMGen-command-help].md

@ -114,4 +114,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-ADDRGEN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-ADDRGEN(1)

26
addrimport-[MMGen-command-help].md

@ -1,5 +1,5 @@
MMGEN-ADDRIMPORT: Import addresses into an MMGen tracking wallet
USAGE: mmgen-addrimport [opts] [mmgen address file]
USAGE: mmgen-addrimport [opts] [MMGen address file]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long options (common options)
@ -8,14 +8,26 @@
-l, --addrlist Address source is a flat list of non-MMGen coin addresses
-k, --keyaddr-file Address source is a key-address file
-q, --quiet Suppress warnings
-r, --rescan Rescan the blockchain. Required if address to import is
in the blockchain and has a balance. Rescanning is slow.
-r, --rescan Update address balances by selectively rescanning the
blockchain for unspent outputs that include the imported
address(es). Required if any of the imported addresses
are already in the blockchain and have a balance.
-t, --token-addr A Import addresses for ERC20 token with address 'A'
This command can also be used to update the comment fields of addresses
already in the tracking wallet.
This command can also be used to update the comment fields or balances of
addresses already in the tracking wallet.
The --batch and --rescan options cannot be used together.
Rescanning now uses the ‘scantxoutset’ RPC call and a selective scan of
blocks containing the relevant UTXOs for much faster performance than the
previous implementation. The rescan operation typically takes around two
minutes total, independent of the number of addresses imported.
MMGEN v13.1.0 May 2022 MMGEN-ADDRIMPORT(1)
Bear in mind that the UTXO scan will not find historical transactions: to add
them to the tracking wallet, you must perform a full or partial rescan of the
blockchain with the ‘mmgen-tool rescan_blockchain’ utility. A full rescan of
the blockchain may take up to several hours.
It’s recommended to use ‘--rpc-backend=aio’ with ‘--rescan’.
MMGEN v13.2.dev13 August 2022 MMGEN-ADDRIMPORT(1)

2
autosign-[MMGen-command-help].md

@ -71,4 +71,4 @@
This command is currently available only on Linux-based platforms.
MMGEN v13.1.0 May 2022 MMGEN-AUTOSIGN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-AUTOSIGN(1)

2
keygen-[MMGen-command-help].md

@ -118,4 +118,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-KEYGEN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-KEYGEN(1)

2
msg-[MMGen-command-help].md

@ -103,4 +103,4 @@
Verify and display the exported JSON signature data:
$ mmgen-msg verify signatures.json
MMGEN v13.1.0 May 2022 MMGEN-MSG(1)
MMGEN v13.2.dev13 August 2022 MMGEN-MSG(1)

2
passchg-[MMGen-command-help].md

@ -50,4 +50,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-PASSCHG(1)
MMGEN v13.2.dev13 August 2022 MMGEN-PASSCHG(1)

2
passgen-[MMGen-command-help].md

@ -99,4 +99,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-PASSGEN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-PASSGEN(1)

2
regtest-[MMGen-command-help].md

@ -24,4 +24,4 @@
is first argument)
MMGEN v13.1.0 May 2022 MMGEN-REGTEST(1)
MMGEN v13.2.dev13 August 2022 MMGEN-REGTEST(1)

2
seedjoin-[MMGen-command-help].md

@ -60,4 +60,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-SEEDJOIN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-SEEDJOIN(1)

2
seedsplit-[MMGen-command-help].md

@ -141,4 +141,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-SEEDSPLIT(1)
MMGEN v13.2.dev13 August 2022 MMGEN-SEEDSPLIT(1)

2
subwalletgen-[MMGen-command-help].md

@ -94,4 +94,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-SUBWALLETGEN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-SUBWALLETGEN(1)

1037
tool(detail)-[MMGen-command-help].md Normal file

File diff suppressed because it is too large Load diff

165
tool(usage)-[MMGen-command-help].md

@ -1,129 +1,179 @@
USAGE INFORMATION FOR MMGEN-TOOL COMMANDS:
GENERAL USAGE INFORMATION FOR MMGEN-TOOL COMMANDS
Arguments with only type specified in square brackets are required
Arguments with both type and default value specified in square brackets are
optional and must be specified in the form ‘name=value’
For more detailed usage information for a particular tool command, type
‘mmgen-tool help <command name>’
Unquoted arguments are mandatory
Quoted arguments are optional, default values will be used
Argument types and default values are shown in square brackets
Help/usage commands:
help "command_name" [str='']
usage "command_name" [str='']
help command_name [str='']
usage command_name [str='']
General string conversion and hashing utilities:
b32tohex b32num [str or STDIN] "pad" [int=0]
b58chktohex b58chk_num [str or STDIN]
b58tobytes b58num [str or STDIN] "pad" [int=0]
b58tohex b58num [str or STDIN] "pad" [int=0]
b6dtohex b6d_num [str or STDIN] "pad" [int=0]
b32tohex b32_str [str or STDIN] pad [int=0]
b58chktohex b58chk_str [str or STDIN]
b58tobytes b58_str [str or STDIN] pad [int=0]
b58tohex b58_str [str or STDIN] pad [int=0]
b6dtohex b6d_str [str or STDIN] pad [int=0]
bytespec dd_style_byte_specifier [str]
bytestob58 infile [str] "pad" [int=0]
bytestob58 infile [str] pad [int=0]
hash160 hexstr [str or STDIN]
hash256 string_or_bytes [str] "file_input" [bool=False] "hex_input" [bool=False]
hexdump infile [str] "cols" [int=8] "line_nums" [str='hex']
hash256 data [str] file_input [bool=False] hex_input [bool=False]
hexdump infile [str] cols [int=8] line_nums [str='hex']
hexlify infile [str]
hexreverse hexstr [str or STDIN]
hextob32 hexstr [str or STDIN] "pad" [int=0]
hextob58 hexstr [str or STDIN] "pad" [int=0]
hextob32 hexstr [str or STDIN] pad [int=0]
hextob58 hexstr [str or STDIN] pad [int=0]
hextob58chk hexstr [str or STDIN]
hextob6d hexstr [str or STDIN] "pad" [int=0] "add_spaces" [bool=True]
hextob6d hexstr [str or STDIN] pad [int=0] add_spaces [bool=True]
id6 infile [str]
id8 infile [str]
randb58 "nbytes" [int=32] "pad" [int=0]
randhex "nbytes" [str='32']
randb58 nbytes [int=32] pad [int=0]
randhex nbytes [int=32]
str2id6 string [str or STDIN]
to_bytespec n [int] dd_style_byte_specifier [str] "fmt" [str='0.2'] "print_sym" [bool=True]
to_bytespec n [int] dd_style_byte_specifier [str] fmt [str='0.2'] print_sym [bool=True]
unhexdump infile [str]
unhexlify hexstr [str or STDIN]
Cryptocoin key/address utilities:
May require use of the '--coin', '--type' and/or '--testnet' options
Examples:
mmgen-tool --coin=ltc --type=bech32 wif2addr <wif key>
mmgen-tool --coin=zec --type=zcash_z randpair
addr2pubhash addr [str or STDIN]
addr2scriptpubkey addr [str or STDIN]
eth_checksummed_addr addr [str or STDIN]
hex2wif privhex [str or STDIN]
privhex2addr privhex [str or STDIN] "output_pubhex" [bool=False]
privhex2addr privhex [str or STDIN]
privhex2pubhex privhex [str or STDIN]
pubhash2addr pubhashhex [str or STDIN]
pubhex2addr pubkeyhex [str or STDIN]
pubhex2redeem_script pubkeyhex [str or STDIN]
randpair
randwif
redeem_script2addr redeem_scripthex [str or STDIN]
redeem_script2addr redeem_script_hex [str or STDIN]
scriptpubkey2addr hexstr [str or STDIN]
wif2addr wifkey [str or STDIN]
wif2hex wifkey [str or STDIN]
wif2redeem_script wifkey [str or STDIN]
wif2segwit_pair wifkey [str or STDIN]
Seed phrase utilities (valid formats: 'mmgen' (default), 'bip39', 'xmrseed'):
hex2mn hexstr [str or STDIN] "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')]
mn2hex seed_mnemonic [str or STDIN] "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')]
mn2hex_interactive "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')] "mn_len" [int=24] "print_mn" [bool=False]
mn_printlist "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')] "enum" [bool=False] "pager" [bool=False]
mn_rand128 "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')]
mn_rand192 "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')]
mn_rand256 "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')]
mn_stats "fmt" [str='mmgen' (valid options: 'mmgen','bip39','xmrseed')]
Seed phrase utilities:
Supported seed phrase formats: 'mmgen' (default), 'bip39', 'xmrseed'
IMPORTANT NOTE: MMGen’s default seed phrase format uses the Electrum
wordlist, however seed phrases are computed using a different algorithm
and are NOT Electrum-compatible!
BIP39 support is fully compatible with the standard, allowing users to
import and export seed entropy from BIP39-compatible wallets. However,
users should be aware that BIP39 support does not imply BIP32 support!
MMGen uses its own key derivation scheme differing from the one described
by the BIP32 protocol.
For Monero (‘xmrseed’) seed phrases, input data is reduced to a spendkey
before conversion so that a canonical seed phrase is produced. This is
required because Monero seeds, unlike ordinary wallet seeds, are tied
to a concrete key/address pair. To manually generate a Monero spendkey,
use the ‘hex2wif’ command.
hex2mn hexstr [str or STDIN] fmt [str='mmgen']
mn2hex seed_mnemonic [str or STDIN] fmt [str='mmgen']
mn2hex_interactive fmt [str='mmgen'] mn_len [int=24] print_mn [bool=False]
mn_printlist fmt [str='mmgen'] enum [bool=False] pager [bool=False]
mn_rand128 fmt [str='mmgen']
mn_rand192 fmt [str='mmgen']
mn_rand256 fmt [str='mmgen']
mn_stats fmt [str='mmgen']
Utilities for viewing/checking MMGen address and transaction files:
addrfile_chksum mmgen_addrfile [str]
keyaddrfile_chksum mmgen_keyaddrfile [str]
passwdfile_chksum mmgen_passwdfile [str]
txview mmgen_tx_file(s) [str] "pager" [bool=False] "terse" [bool=False] "sort" [str='addr' (valid options: 'addr','raw')] "filesort" [str='mtime' (valid options: 'mtime','ctime','atime')]
txview mmgen_tx_file(s) [str] pager [bool=False] terse [bool=False] sort [str='addr'] filesort [str='mtime']
File encryption and decryption:
decrypt infile [str] "outfile" [str=''] "hash_preset" [str='']
encrypt infile [str] "outfile" [str=''] "hash_preset" [str='']
MMGen encryption suite:
* Key: Scrypt (user-configurable hash parameters, 32-byte salt)
* Enc: AES256_CTR, 16-byte rand IV, sha256 hash + 32-byte nonce + data
* The encrypted file is indistinguishable from random data
decrypt infile [str] outfile [str=''] hash_preset [str='']
encrypt infile [str] outfile [str=''] hash_preset [str='']
File utilities:
extract_key_from_geth_wallet wallet_file [str] "check_addr" [bool=True]
find_incog_data filename [str] incog_id [str] "keep_searching" [bool=False]
rand2file outfile [str] nbytes [str] "threads" [int=4] "silent" [bool=False]
extract_key_from_geth_wallet wallet_file [str] check_addr [bool=True]
find_incog_data filename [str] incog_id [str] keep_searching [bool=False]
rand2file outfile [str] nbytes [str] threads [int=4] silent [bool=False]
Key, address or subseed generation from an MMGen wallet:
gen_addr mmgen_addr [str] "wallet" [str=''] "target" [str='addr']
gen_key mmgen_addr [str] "wallet" [str='']
get_subseed subseed_idx [str] "wallet" [str='']
get_subseed_by_seed_id seed_id [str] "wallet" [str=''] "last_idx" [int=100]
list_shares share_count [int] "id_str" [str='default'] "master_share" [int=0 (min:1, max:1024, 0=no master share)] "wallet" [str='']
list_subseeds subseed_idx_range [str] "wallet" [str='']
gen_addr mmgen_addr [str] wallet [str='']
gen_key mmgen_addr [str] wallet [str='']
get_subseed subseed_idx [str] wallet [str='']
get_subseed_by_seed_id seed_id [str] wallet [str=''] last_idx [int=100]
list_shares share_count [int] id_str [str='default'] master_share [int=0] wallet [str='']
list_subseeds subseed_idx_range [str] wallet [str='']
Tracking wallet commands using the JSON-RPC interface:
add_label mmgen_or_coin_addr [str] label [str]
Tracking-wallet commands using the JSON-RPC interface:
add_label mmgen_or_coin_addr [str] label [str]
daemon_version
getbalance "minconf" [int=1] "quiet" [bool=False] "pager" [bool=False]
listaddress mmgen_addr [str] "minconf" [int=1] "pager" [bool=False] "showempty" [bool=True] "showbtcaddr" [bool=True] "age_fmt" [str='confs' (valid options: 'confs','block','days','date','date_time')]
listaddresses "mmgen_addrs" [str='' (range or list)] "minconf" [int=1] "showempty" [bool=False] "pager" [bool=False] "showbtcaddrs" [bool=True] "all_labels" [bool=False] "sort" [str='' (valid options: 'reverse','age')] "age_fmt" [str='confs' (valid options: 'confs','block','days','date','date_time')]
remove_address mmgen_or_coin_addr [str]
remove_label mmgen_or_coin_addr [str]
twview "pager" [bool=False] "reverse" [bool=False] "wide" [bool=False] "minconf" [int=1] "sort" [str='age'] "age_fmt" [str='confs' (valid options: 'confs','block','days','date','date_time')] "show_mmid" [bool=True] "wide_show_confs" [bool=True]
getbalance minconf [int=1] quiet [bool=False] pager [bool=False]
listaddress mmgen_addr [str] minconf [int=1] showbtcaddr [bool=True] age_fmt [str='confs']
listaddresses mmgen_addrs [str=''] minconf [int=1] pager [bool=False] showbtcaddr [bool=True] showempty [bool=True] all_labels [bool=False] age_fmt [str='confs'] sort [str='']
remove_address mmgen_or_coin_addr [str]
remove_label mmgen_or_coin_addr [str]
rescan_address mmgen_or_coin_addr [str]
rescan_blockchain start_block [int=None] stop_block [int=None]
resolve_address mmgen_or_coin_addr [str]
twexport include_amts [bool=True] pretty [bool=False]
twimport filename [str] ignore_checksum [bool=False] batch [bool=False]
twview pager [bool=False] reverse [bool=False] wide [bool=False] minconf [int=1] sort [str='age'] age_fmt [str='confs'] interactive [bool=False] show_mmid [bool=True]
txhist pager [bool=False] reverse [bool=False] detail [bool=False] sinceblock [int=0] sort [str='age'] age_fmt [str='confs'] interactive [bool=False]
To force a command to read from STDIN instead of file (for commands taking
a filename as their first argument), substitute "-" for the filename.
EXAMPLES:
Generate a random Bech32 public/private keypair for LTC:
Generate a random LTC Bech32 public/private keypair:
$ mmgen-tool -r0 --coin=ltc --type=bech32 randpair
Generate a DASH compressed public key address from the supplied WIF key:
Generate a DASH address with compressed public key from the supplied WIF key:
$ mmgen-tool --coin=dash --type=compressed wif2addr XJkVRC3eGKurc9Uzx1wfQoio3yqkmaXVqLMTa6y7s3M3jTBnmxfw
Generate a well-known burn address:
$ mmgen-tool hextob58chk 000000000000000000000000000000000000000000
Generate a random 12-word seed phrase:
$ mmgen-tool -r0 mn_rand128
$ mmgen-tool -r0 mn_rand128 fmt=bip39
Same as above, but get additional entropy from user:
$ mmgen-tool mn_rand128
$ mmgen-tool mn_rand128 fmt=bip39
Encode bytes from a file to base 58:
$ mmgen-tool bytestob58 /etc/timezone pad=20
@ -131,7 +181,6 @@
Reverse a hex string:
$ mmgen-tool hexreverse "deadbeefcafe"
Same as above, but use a pipe:
Same as above, but supply input via STDIN:
$ echo "deadbeefcafe" | mmgen-tool hexreverse -
MMGEN v13.1.0 May 2022 MMGEN-TOOL(USAGE)(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TOOL(USAGE)(1)

129
tool-[MMGen-command-help].md

@ -8,13 +8,14 @@
-k, --use-internal-keccak-module Force use of the internal keccak module
-K, --keygen-backend n Use backend 'n' for public key generation. Options
for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
-l, --list List available commands
-p, --hash-preset p Use the scrypt hash parameters defined by preset 'p'
for password hashing (default: '3')
-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=10, max=80)
-t, --type t Specify address type (valid options: 'legacy',
-t, --type t Specify address type (valid choices: 'legacy',
'compressed', 'segwit', 'bech32', 'zcash_z')
-v, --verbose Produce more verbose output
-X, --cached-balances Use cached balances (Ethereum only)
@ -26,17 +27,17 @@
Help/usage commands:
help - display usage information for a single command or all commands
usage - display usage information for a single command
usage - display usage information for a single command or all commands
General string conversion and hashing utilities:
b32tohex - convert an MMGen-flavor base 32 number to hexadecimal
b58chktohex - convert a base58-check encoded number to hexadecimal
b58tobytes - convert a base 58 number to bytes (warning: outputs binary
b32tohex - convert an MMGen-flavor base 32 string to hexadecimal
b58chktohex - convert a base58-check encoded string to hexadecimal
b58tobytes - convert a base 58 string to bytes (warning: outputs binary
data)
b58tohex - convert a base 58 number to hexadecimal
b6dtohex - convert a die roll base6 (base6d) number to hexadecimal
bytespec - convert a byte specifier such as '1GB' into an integer
b58tohex - convert a base 58 string to hexadecimal
b6dtohex - convert a die roll base6 (base6d) string to hexadecimal
bytespec - convert a byte specifier such as ‘4GB’ into an integer
bytestob58 - convert bytes to base 58 (supply data via STDIN)
hash160 - compute ripemd160(sha256(data)) (convert hex pubkey to hex
addr)
@ -44,21 +45,23 @@
hexdump - create hexdump of data from file (use '-' for stdin)
hexlify - convert bytes in file to hexadecimal (use '-' for stdin)
hexreverse - reverse bytes of a hexadecimal string
hextob32 - convert a hexadecimal number to MMGen's flavor of base 32
hextob58 - convert a hexadecimal number to base 58
hextob58chk - convert a hexadecimal number to base58-check encoding
hextob6d - convert a hexadecimal number to die roll base6 (base6d)
hextob32 - convert a hexadecimal string to an MMGen-flavor base 32
string
hextob58 - convert a hexadecimal string to base 58
hextob58chk - convert a hexadecimal string to base58-check encoding
hextob6d - convert a hexadecimal string to die roll base6 (base6d)
id6 - generate 6-character MMGen ID for a file (use '-' for stdin)
id8 - generate 8-character MMGen ID for a file (use '-' for stdin)
randb58 - generate random data (default: 32 bytes) and convert it to
base 58
randhex - print 'n' bytes (default 32) of random data in hex format
str2id6 - generate 6-character MMGen ID for a string, ignoring spaces
to_bytespec - convert an integer to a byte specifier such as '1GB'
in string
to_bytespec - convert an integer to a byte specifier such as ‘4GB’
unhexdump - decode hexdump from file (use '-' for stdin) (warning:
outputs binary data)
unhexlify - convert hexadecimal value to bytes (warning: outputs binary
data)
unhexlify - convert a hexadecimal string to bytes (warning: outputs
binary data)
Cryptocoin key/address utilities:
@ -71,29 +74,32 @@
addr2pubhash - convert coin address to public key hash
addr2scriptpubkey - convert coin address to scriptPubKey
eth_checksummed_addr - create a checksummed Ethereum address
hex2wif - convert a private key from hex to WIF format
privhex2addr - generate coin address from raw private key data in
hexadecimal format
privhex2pubhex - generate a hex public key from a hex private key
hex2wif - convert a private key from hexadecimal to WIF format
privhex2addr - generate a coin address from raw hexadecimal
private key data
privhex2pubhex - generate a hexadecimal public key from raw
hexadecimal private key data
pubhash2addr - convert public key hash to address
pubhex2addr - convert a hex pubkey to an address
pubhex2redeem_script - convert a hex pubkey to a Segwit P2SH-P2WPKH redeem
script
pubhex2addr - convert a hexadecimal pubkey to an address
pubhex2redeem_script - convert a hexadecimal pubkey to a Segwit
P2SH-P2WPKH redeem script
randpair - generate a random private key/address pair
randwif - generate a random private key in WIF format
redeem_script2addr - convert a Segwit P2SH-P2WPKH redeem script to an
address
scriptpubkey2addr - convert scriptPubKey to coin address
wif2addr - generate a coin address from a key in WIF format
wif2hex - convert a private key from WIF to hex format
wif2hex - convert a private key from WIF to hexadecimal format
wif2redeem_script - convert a WIF private key to a Segwit P2SH-P2WPKH
redeem script
wif2segwit_pair - generate both a Segwit P2SH-P2WPKH redeem script
and address from WIF
wif2segwit_pair - generate a Segwit P2SH-P2WPKH redeem script and
address from a WIF private key
Seed phrase utilities (valid formats: 'mmgen' (default), 'bip39', 'xmrseed'):
Seed phrase utilities:
IMPORTANT NOTE: MMGen's default seed phrase format uses the Electrum
Supported seed phrase formats: 'mmgen' (default), 'bip39', 'xmrseed'
IMPORTANT NOTE: MMGen’s default seed phrase format uses the Electrum
wordlist, however seed phrases are computed using a different algorithm
and are NOT Electrum-compatible!
@ -103,30 +109,30 @@
MMGen uses its own key derivation scheme differing from the one described
by the BIP32 protocol.
For Monero ('xmrseed') seed phrases, input data is reduced to a spendkey
For Monero (‘xmrseed’) seed phrases, input data is reduced to a spendkey
before conversion so that a canonical seed phrase is produced. This is
required because Monero seeds, unlike ordinary wallet seeds, are tied
to a concrete key/address pair. To manually generate a Monero spendkey,
use the 'hex2wif' command.
use the ‘hex2wif’ command.
hex2mn - convert a 16, 24 or 32-byte hexadecimal number to a
hex2mn - convert a 16, 24 or 32-byte hexadecimal string to a
mnemonic seed phrase
mn2hex - convert a mnemonic seed phrase to a hexadecimal number
mn2hex - convert a mnemonic seed phrase to a hexadecimal string
mn2hex_interactive - convert an interactively supplied mnemonic seed
phrase to a hexadecimal number
mn_printlist - print mnemonic wordlist
mn_rand128 - generate random 128-bit mnemonic seed phrase
mn_rand192 - generate random 192-bit mnemonic seed phrase
mn_rand256 - generate random 256-bit mnemonic seed phrase
mn_stats - show stats for mnemonic wordlist
phrase to a hexadecimal string
mn_printlist - print a mnemonic wordlist
mn_rand128 - generate a random 128-bit mnemonic seed phrase
mn_rand192 - generate a random 192-bit mnemonic seed phrase
mn_rand256 - generate a random 256-bit mnemonic seed phrase
mn_stats - show stats for a mnemonic wordlist
Utilities for viewing/checking MMGen address and transaction files:
addrfile_chksum - compute checksum for MMGen address file
keyaddrfile_chksum - compute checksum for MMGen key-address file
passwdfile_chksum - compute checksum for MMGen password file
txview - show raw/signed MMGen transaction in human-readable
form
txview - display specified raw or signed MMGen transaction
files in human-readable form
File encryption and decryption:
@ -144,15 +150,16 @@
keystore wallet, returning the decrypted key
find_incog_data - Use an Incog ID to find hidden incognito
wallet data
rand2file - write 'n' bytes of random data to specified
file
rand2file - write ‘nbytes’ bytes of random data to
specified file (dd-style byte specifiers
supported)
Key, address or subseed generation from an MMGen wallet:
gen_addr - generate a single MMGen address from default or
specified wallet
gen_key - generate a single MMGen WIF key from default or
specified wallet
gen_key - generate a single WIF key for specified MMGen
address from default or specified wallet
get_subseed - get the Seed ID of a single subseed by Subseed
Index for default or specified wallet
get_subseed_by_seed_id - get the Subseed Index of a single subseed by Seed
@ -162,18 +169,30 @@
list_subseeds - list a range of subseed Seed IDs for default or
specified wallet
Tracking wallet commands using the JSON-RPC interface:
Tracking-wallet commands using the JSON-RPC interface:
add_label - add descriptive label for address in tracking wallet
daemon_version - print coin daemon version
getbalance - list confirmed/unconfirmed, spendable/unspendable
balances in tracking wallet
listaddress - list the specified MMGen address and its balance
listaddresses - list MMGen addresses and their balances
remove_address - remove an address from tracking wallet
remove_label - remove descriptive label for address in tracking wallet
twview - view tracking wallet
add_label - add descriptive label for address in tracking wallet
daemon_version - print coin daemon version
getbalance - list confirmed/unconfirmed, spendable/unspendable
balances in tracking wallet
listaddress - list the specified MMGen address in the tracking
wallet and its balance
listaddresses - list MMGen addresses in the tracking wallet and their
balances
remove_address - remove an address from tracking wallet
remove_label - remove descriptive label for address in tracking wallet
rescan_address - rescan an address in the tracking wallet to update its
balance
rescan_blockchain - rescan the blockchain to update historical
transactions in the tracking wallet
resolve_address - resolve an MMGen address in the tracking wallet to a
coin address or vice-versa
twexport - export a tracking wallet to JSON format
twimport - restore a tracking wallet from a JSON dump created by
‘twexport’
twview - view tracking wallet unspent outputs
txhist - view transaction history of tracking wallet
Type 'mmgen-tool help <command>' for help on a particular command
Type ‘mmgen-tool help <command>’ for help on a particular command
MMGEN v13.1.0 May 2022 MMGEN-TOOL(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TOOL(1)

2
txbump-[MMGen-command-help].md

@ -85,4 +85,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-TXBUMP(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TXBUMP(1)

2
txcreate-[MMGen-command-help].md

@ -53,4 +53,4 @@
a plain decimal number, or as satoshis per byte, using an integer followed by
's', for satoshi.
MMGEN v13.1.0 May 2022 MMGEN-TXCREATE(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TXCREATE(1)

2
txdo-[MMGen-command-help].md

@ -116,4 +116,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-TXDO(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TXDO(1)

2
txsend-[MMGen-command-help].md

@ -8,4 +8,4 @@
-s, --status Get status of a sent transaction
-y, --yes Answer 'yes' to prompts, suppress non-essential output
MMGEN v13.1.0 May 2022 MMGEN-TXSEND(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TXSEND(1)

2
txsign-[MMGen-command-help].md

@ -78,4 +78,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-TXSIGN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-TXSIGN(1)

2
walletchk-[MMGen-command-help].md

@ -49,4 +49,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-WALLETCHK(1)
MMGEN v13.2.dev13 August 2022 MMGEN-WALLETCHK(1)

2
walletconv-[MMGen-command-help].md

@ -59,4 +59,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-WALLETCONV(1)
MMGEN v13.2.dev13 August 2022 MMGEN-WALLETCONV(1)

2
walletgen-[MMGen-command-help].md

@ -52,4 +52,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.1.0 May 2022 MMGEN-WALLETGEN(1)
MMGEN v13.2.dev13 August 2022 MMGEN-WALLETGEN(1)

43
xmrwallet-[MMGen-command-help].md

@ -2,8 +2,10 @@
in an MMGen XMR key-address file
USAGE: mmgen-xmrwallet [opts] create <xmr_keyaddrfile> [wallets]
mmgen-xmrwallet [opts] sync <xmr_keyaddrfile> [wallets]
mmgen-xmrwallet [opts] transfer <xmr_keyaddrfile> <transfer_spec>
mmgen-xmrwallet [opts] sweep <xmr_keyaddrfile> <sweep_spec>
mmgen-xmrwallet [opts] list <xmr_keyaddrfile> [wallets]
mmgen-xmrwallet [opts] new <xmr_keyaddrfile> NEW_ADDRESS_SPEC
mmgen-xmrwallet [opts] transfer <xmr_keyaddrfile> TRANSFER_SPEC
mmgen-xmrwallet [opts] sweep <xmr_keyaddrfile> SWEEP_SPEC
mmgen-xmrwallet [opts] relay <TX_file>
OPTIONS:
-h, --help Print this help message
@ -44,6 +46,8 @@
create - create wallet for all or specified addresses in key-address file
sync - sync wallet for all or specified addresses in key-address file
list - same as 'sync', but also list detailed address info for accounts
new - create a new account in a wallet, or a new address in an account
transfer - transfer specified XMR amount to specified address from specified
wallet:account
sweep - sweep funds in specified wallet:account to new address in same
@ -52,18 +56,29 @@
or 'transfer' with the --do-not-relay option
CREATE AND SYNC OPERATION NOTES
'CREATE', 'SYNC' AND 'LIST' OPERATION NOTES
These operations take an optional `wallets` argument: one or more address
indexes (expressed as a comma-separated list, hyphenated range, or both)
in the specified key-address file, each corresponding to a Monero wallet
to be created or synced. If omitted, all wallets are operated upon.
to be created, synced or listed. If omitted, all wallets are operated upon.
TRANSFER OPERATION NOTES
'NEW' OPERATION NOTES
The transfer operation takes a `transfer specifier` arg with the following
format:
This operation takes a NEW_ADDRESS_SPEC arg with the following format:
WALLET[:ACCOUNT][,"label text"]
where WALLET is a wallet number and ACCOUNT an account index. If ACCOUNT is
omitted, a new account will be created in the wallet, otherwise a new address
will be created in the specified account. An optional label text may be
appended to the spec following a comma.
'TRANSFER' OPERATION NOTES
The transfer operation takes a TRANSFER_SPEC arg with the following format:
SOURCE:ACCOUNT:ADDRESS,AMOUNT
@ -71,9 +86,9 @@
and AMOUNT the destination Monero address and XMR amount, respectively.
SWEEP OPERATION NOTES
'SWEEP' OPERATION NOTES
The sweep operation takes a `sweep specifier` arg with the following format:
The sweep operation takes a SWEEP_SPEC arg with the following format:
SOURCE:ACCOUNT[,DEST]
@ -92,7 +107,7 @@
in an account.
RELAY OPERATION NOTES
'RELAY' OPERATION NOTES
By default, transactions are relayed to a monerod running on localhost at the
default RPC port. To relay transactions to a remote or non-default monerod
@ -138,4 +153,10 @@
Relay the created sweep transaction via a host on the Tor network:
$ mmgen-xmrwallet --tx-relay-daemon=abcdefghijklmnop.onion:127.0.0.1:9050 relay *XMR*.sigtx
MMGEN v13.1.0 May 2022 MMGEN-XMRWALLET(1)
Create a new account in wallet 2:
$ mmgen-xmrwallet new *.akeys.mmenc 2
Create a new address in account 1 of wallet 2, with label:
$ mmgen-xmrwallet new *.akeys.mmenc 2:1,"from ABC exchange"
MMGEN v13.2.dev13 August 2022 MMGEN-XMRWALLET(1)