mmgen/mmgen-wallet
1
Fork 0
Code Releases 28 Wiki Activity

doc/wiki: update command help

Browse source
This commit is contained in:
The MMGen Project 2026-05-05 12:07:32 +00:00
commit 2aad5a1118
Signed by: mmgen
GPG key ID: 3F8B1861E32B7DA2
10 changed files with 292 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

86
doc/wiki/cmds/command-help-addrimport.md
View file

@ -1,11 +1,17 @@
### [BTC](#a_btc) | [ETH](#a_eth) | [XMR](#a_xmr)
### <a id="a_btc">mmgen-addrimport --coin=btc --help</a>
```text
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 (global) options
-a, --address a Import the single coin address 'a'
-b, --batch Import all addresses in one RPC call
-A, --address ADDR Import the single coin address ADDR
-b, --batch Import all addresses in one RPC call (where applicable)
-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
@ -13,23 +19,85 @@
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 or balances of
addresses already in the tracking wallet.
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.
It’s recommended to use ‘--rpc-backend=aio’ with ‘--rescan’.
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’.
A full rescan is required if you plan to use ‘mmgen-tool txhist’ or the
automatic change address functionality of ‘mmgen-txcreate’, or wish to see
which addresses in your tracking wallet are used. Without it, all addresses
without balances will be displayed as new.
MMGEN-WALLET 16.0.0 September 2025 MMGEN-ADDRIMPORT(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-ADDRIMPORT(1)
```
<br>
### <a id="a_eth">mmgen-addrimport --coin=eth --help</a>
```text
MMGEN-ADDRIMPORT: Import addresses into an MMGen tracking wallet
USAGE: mmgen-addrimport --coin=eth [opts] [MMGen address file]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
-A, --address ADDR Import the single coin address ADDR
-b, --batch Import all addresses in one RPC call (where applicable)
-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
-t, --token-addr ADDR Import addresses for ERC20 token with address ADDR
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-ADDRIMPORT(1)
```
<br>
### <a id="a_xmr">mmgen-addrimport --coin=xmr --help</a>
```text
MMGEN-ADDRIMPORT: Import addresses into an MMGen tracking wallet
USAGE: mmgen-addrimport --coin=xmr [opts]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
-a, --autosign Import addresses from pre-created key-address file on the
removable device. The removable device is mounted and
unmounted automatically. See notes below.
-q, --quiet Suppress warnings
For Monero, --autosign is required, and a key-address file on the removable
device is used instead of a user-specified address file as with other coins.
When ‘mmgen-autosign setup’ (or ‘xmr_setup’) is run with the --xmrwallets
option, an ephemeral Monero wallet is created for each wallet number listed,
to be used for transaction signing. In addition, a key-address file is created
on the removable device, with an address and viewkey matching the base address
of each signing wallet.
This script uses that file to create an online view-only Monero wallet to
match each offline signing wallet. The set of view-only wallets currently
configured via --xmrwallets comprises the user’s tracking wallet.
If a view-only wallet for a given index already exists, it’s left untouched
and no action is performed. To add view-only wallets to your tracking wallet,
just specify additional wallet indexes via --xmrwallets during the offline
setup process.
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-ADDRIMPORT(1)
```

4
doc/wiki/cmds/command-help-tool(detail).md
View file

@ -1083,7 +1083,7 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
mmgen_addrs [str=''] Hyphenated range or comma-separated list of addresses
showcoinaddrs [bool=True] Display coin addresses in addition to MMGen IDs
showempty [bool=True] Show addresses with no balances
showused [int=1] Show used addresses (tristate: 0=no, 1=yes, 2=all)
showused [int=1] Show used addresses (tristate: 0=no, 1=yes, 2=only)
all_labels [bool=False] Show all addresses with labels
```
@ -1252,5 +1252,5 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
```
```text
MMGEN-WALLET 16.0.0 September 2025 MMGEN-TOOL(DETAIL)(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TOOL(DETAIL)(1)
```

7
doc/wiki/cmds/command-help-tool.md
View file

@ -1,10 +1,13 @@
```text
MMGEN-TOOL: Perform various MMGen- and cryptocoin-related operations
USAGE: mmgen-tool [opts] <command> <command args>
USAGE: mmgen-tool [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 (global) options
-a, --autosign Operate on an autosigned transaction
-e, --echo-passphrase Echo passphrase or mnemonic to screen upon entry
-k, --use-internal-keccak-module Force use of the internal keccak module
-K, --keygen-backend n Use backend 'n' for public key generation. Options
@ -202,5 +205,5 @@
Type ‘mmgen-tool help <command>’ for help on a particular command
MMGEN-WALLET 16.0.0 September 2025 MMGEN-TOOL(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TOOL(1)
```

22
doc/wiki/cmds/command-help-txbump.md
View file

@ -1,8 +1,13 @@
```text
MMGEN-TXBUMP: Create, and optionally send and sign, a replacement transaction
on supporting networks
USAGE: mmgen-txbump [opts] [MMGen TX file] [seed source] ...
mmgen-txbump [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [MMGen TX file] [seed source] ...
on supported networks
USAGE:
mmgen-txbump [opts] [MMGen TX file] [seed source] ...
mmgen-txbump [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...] [MMGen TX file] [seed source] ...
mmgen-txbump --autosign [opts] [index]
mmgen-txbump --autosign [opts] [index] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
@ -56,8 +61,12 @@
-z, --show-hash-presets Show information on available hash presets
With --autosign, the TX file argument is omitted, and the last submitted TX
file on the removable device will be used.
With --autosign, the TX file argument is omitted, and the last submitted
transaction on the removable device will be used. Or, if the first non-option
argument is a non-negative integer, it specifies an index into the list of
submitted transactions, in reverse chronological order, and that transaction
will be bumped. ‘0’ (the default) signifies the last sent transaction, ‘1’
the next-to-last, and so on.
If no outputs are specified, the original outputs will be used for the
replacement transaction, otherwise a new transaction will be created with the
@ -103,7 +112,6 @@
Seed source files must have the canonical extensions listed in the 'FileExt'
column below:
FMT CODES:
Format FileExt Valid codes
@ -120,5 +128,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN-WALLET 16.0.0 September 2025 MMGEN-TXBUMP(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TXBUMP(1)
```

149
doc/wiki/cmds/command-help-txcreate.md
View file

@ -1,6 +1,12 @@
### [BTC](#a_btc) | [ETH](#a_eth) | [XMR](#a_xmr)
### <a id="a_btc">mmgen-txcreate --coin=btc --help</a>
```text
MMGEN-TXCREATE: Create a transaction with outputs to specified coin or MMGen addresses
USAGE: mmgen-txcreate [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...]
USAGE: mmgen-txcreate [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
@ -62,7 +68,7 @@
or "hexdata":DATA. In the first form, DATA is a string in your system’s native
encoding, typically UTF-8. In the second, DATA is a hexadecimal string (with
the leading ‘0x’ omitted) encoding the binary data to be embedded. In both
cases, the resulting byte string must not exceed 80 bytes in length.
cases, the resulting byte string must not exceed 4096 bytes in length.
If the transaction fee is not specified on the command line (see FEE
SPECIFICATION below), it will be calculated dynamically using network fee
@ -124,5 +130,142 @@
$ mmgen-txcreate B
MMGEN-WALLET 16.0.0 September 2025 MMGEN-TXCREATE(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TXCREATE(1)
```
<br>
### <a id="a_eth">mmgen-txcreate --coin=eth --help</a>
```text
MMGEN-TXCREATE: Create a transaction with outputs to specified coin or MMGen addresses
USAGE: mmgen-txcreate --coin=eth [opts] ADDR,AMT [addr file ...]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
-a, --autosign Create a transaction for offline autosigning (see
‘mmgen-autosign’). The removable device is mounted and
unmounted automatically
-A, --fee-adjust f Adjust transaction fee by factor ‘f’ (see below)
-B, --no-blank Don't blank screen before displaying account info
-c, --comment-file f Source the transaction's comment from file 'f'
-d, --outdir d Specify an alternate directory 'd' for output
-D, --contract-data D Path to file containing hex-encoded contract data
-f, --fee f Transaction fee, as a decimal ETH amount or as
gas price (an integer followed by ‘w’,‘K’,‘M’,‘G’,‘s’ or ‘f’).
See FEE SPECIFICATION below. If omitted, fee will be
calculated using network fee estimation.
-g, --gas N Set the gas limit (see GAS LIMIT below)
-i, --info Display account info and exit
-I, --inputs i Specify transaction inputs (comma-separated list of
MMGen IDs or coin addresses). Note that ALL unspent
outputs associated with each address will be included.
-m, --minconf n Minimum number of confirmations required to spend
outputs (default: 1)
-q, --quiet Suppress warnings; overwrite files without prompting
-v, --verbose Produce more verbose output
-y, --yes Answer 'yes' to prompts, suppress non-essential output
-X, --cached-balances Use cached balances
The transaction’s outputs are listed on the command line, while its inputs
are chosen from a list of the wallet’s unspent outputs via an interactive
menu. Alternatively, inputs may be specified using the --inputs option.
Addresses on the command line can be either native coin addresses or MMGen
IDs in the form SEED_ID:ADDRTYPE_CODE:INDEX.
The transaction output is specified in the form ADDRESS,AMOUNT.
If the transaction fee is not specified on the command line (see FEE
SPECIFICATION below), it will be calculated dynamically using network fee
estimation for the default (or user-specified) number of confirmations.
If network fee estimation fails, the user will be prompted for a fee.
Network-estimated fees will be multiplied by the value of --fee-adjust, if
specified.
GAS LIMIT
This option specifies the maximum gas allowance for an Ethereum transaction.
It’s generally of interest only for token transactions or swap transactions
from token assets.
Parameter must be an integer or one of the special values ‘fallback’ (for a
locally computed sane default) or ‘auto’ (for gas estimate via an RPC call,
in the case of a token transaction, or locally computed default, in the case
of a standard transaction). The default is ‘auto’.
FEE SPECIFICATION
Transaction fees, both on the command line and at the interactive prompt, may
be specified as either absolute coin amounts, using a plain decimal number, or
as gas price, using an integer followed by ‘w’,‘K’,‘M’,‘G’,‘s’ or ‘f’, for
wei, Kwei, Mwei, Gwei, szabo and finney, respectively.
EXAMPLES:
Send 0.123 ETH to an external Ethereum address:
$ mmgen-txcreate --coin=eth 22610767a64ed579ed9382e8df2d92c68d3ab0e6,0.123
Send 0.123 ETH to another account in wallet 01ABCDEF:
$ mmgen-txcreate --coin=eth 01ABCDEF:E:7,0.123
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TXCREATE(1)
```
<br>
### <a id="a_xmr">mmgen-txcreate --coin=xmr --help</a>
```text
MMGEN-TXCREATE: Create a transaction with outputs to specified coin or MMGen addresses
USAGE: mmgen-txcreate --coin=xmr [opts] [ADDR,AMT]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
-a, --autosign Create a transaction for offline autosigning (see
‘mmgen-autosign’). The removable device is mounted and
unmounted automatically
-B, --no-blank Don't blank screen before displaying account info
-c, --comment-file f Source the transaction's comment from file 'f'
-d, --outdir d Specify an alternate directory 'd' for output
-i, --info Display account info and exit
-m, --minconf n Minimum number of confirmations required to spend
outputs (default: 1)
-p, --priority N Specify an integer priority ‘N’ for inclusion of trans-
action in blockchain (higher number means higher fee).
Valid parameters: 1=low 2=normal 3=high 4=highest.
If option is omitted, the default priority will be used
-q, --quiet Suppress warnings; overwrite files without prompting
-v, --verbose Produce more verbose output
-y, --yes Answer 'yes' to prompts, suppress non-essential output
The transaction’s output is listed on the command line, while its input
is chosen via an interactive menu.
The transaction output is specified in the form ADDRESS,AMOUNT.
EXAMPLES:
Send 0.123 XMR to an external Monero address:
$ mmgen-txcreate --coin=xmr 42ZNVTWwDcyXkKDQgvatxJZvTYvHCJGLh5NQCbrCrFSHVYaCANXYznaaKgL4qZEPKMP6WRxaB5TGAXCQnNTVzKSp4w4BQcx,0.123
Create a sweep transaction:
$ mmgen-txcreate --coin=xmr
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TXCREATE(1)
```

9
doc/wiki/cmds/command-help-txdo.md
View file

@ -1,6 +1,8 @@
```text
MMGEN-TXDO: Create, sign and send an MMGen transaction
USAGE: mmgen-txdo [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...] [seed source ...]
USAGE: mmgen-txdo [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...] [addr file ...] [seed source ...]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
@ -85,7 +87,7 @@
or "hexdata":DATA. In the first form, DATA is a string in your system’s native
encoding, typically UTF-8. In the second, DATA is a hexadecimal string (with
the leading ‘0x’ omitted) encoding the binary data to be embedded. In both
cases, the resulting byte string must not exceed 80 bytes in length.
cases, the resulting byte string must not exceed 4096 bytes in length.
If the transaction fee is not specified on the command line (see FEE
SPECIFICATION below), it will be calculated dynamically using network fee
@ -142,7 +144,6 @@
Seed source files must have the canonical extensions listed in the 'FileExt'
column below:
FMT CODES:
Format FileExt Valid codes
@ -190,5 +191,5 @@
$ mmgen-txdo B
MMGEN-WALLET 16.0.0 September 2025 MMGEN-TXDO(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TXDO(1)
```

18
doc/wiki/cmds/command-help-txsend.md
View file

@ -1,6 +1,11 @@
```text
MMGEN-TXSEND: Send a signed MMGen cryptocoin transaction
USAGE: mmgen-txsend [opts] [signed transaction file]
USAGE:
mmgen-txsend [opts] <signed transaction file>
mmgen-txsend [opts] --autosign
mmgen-txsend [opts] --autosign (--status | --receipt) [index or range]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
@ -34,5 +39,14 @@
instead.
-y, --yes Answer 'yes' to prompts, suppress non-essential output
MMGEN-WALLET 16.0.0 September 2025 MMGEN-TXSEND(1)
With --autosign, combined with --status or --receipt, the optional index or
range arg represents an index or range into the list of sent transaction files
on the removable device, in reverse chronological order. ‘0’ (the default)
specifies the last sent transaction, ‘1’ the next-to-last, and so on. Hyphen-
separated ranges are also supported. For example, specifying a range ‘0-3’
would output data for the last four sent transactions, beginning with the most
recent.
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-TXSEND(1)
```

38
doc/wiki/cmds/command-help-xmrwallet.md
View file

@ -1,16 +1,19 @@
```text
MMGEN-XMRWALLET: Perform various Monero wallet and transacting operations for
addresses in an MMGen XMR key-address file
USAGE: mmgen-xmrwallet [opts] create | sync | list | view | listview | dump | restore [xmr_keyaddrfile] [wallets]
mmgen-xmrwallet [opts] label [xmr_keyaddrfile] LABEL_SPEC
mmgen-xmrwallet [opts] new [xmr_keyaddrfile] NEW_ADDRESS_SPEC
mmgen-xmrwallet [opts] transfer [xmr_keyaddrfile] TRANSFER_SPEC
mmgen-xmrwallet [opts] sweep | sweep_all [xmr_keyaddrfile] SWEEP_SPEC
mmgen-xmrwallet [opts] submit [TX_file]
mmgen-xmrwallet [opts] relay <TX_file>
mmgen-xmrwallet [opts] resubmit | abort (for use with --autosign only)
mmgen-xmrwallet [opts] txview | txlist [TX_file] ...
mmgen-xmrwallet [opts] export-outputs | export-outputs-sign | import-key-images [wallets]
USAGE:
mmgen-xmrwallet --coin=xmr [opts] create | sync | list | view | listview | dump-json | dump | restore [xmr_keyaddrfile] [wallets]
mmgen-xmrwallet --coin=xmr [opts] label [xmr_keyaddrfile] LABEL_SPEC
mmgen-xmrwallet --coin=xmr [opts] new [xmr_keyaddrfile] NEW_ADDRESS_SPEC
mmgen-xmrwallet --coin=xmr [opts] transfer [xmr_keyaddrfile] TRANSFER_SPEC
mmgen-xmrwallet --coin=xmr [opts] sweep | sweep_all [xmr_keyaddrfile] SWEEP_SPEC
mmgen-xmrwallet --coin=xmr [opts] submit [TX_file]
mmgen-xmrwallet --coin=xmr [opts] relay <TX_file>
mmgen-xmrwallet --coin=xmr [opts] resubmit | abort (for use with --autosign only)
mmgen-xmrwallet --coin=xmr [opts] txview | txlist [TX_file] ...
mmgen-xmrwallet --coin=xmr [opts] export-outputs | export-outputs-sign | import-key-images [wallets]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long (global) options
@ -19,6 +22,10 @@
When this option is in effect, filename argu-
ments must be omitted, as files are located
automatically.
-c, --compat Adjust configuration for compatibility with
the mmgen-tx{create,sign,send} family of
commands. Currently equivalent to
‘-w /home/vbr/.mmgen/altcoins/xmr/tracking-wallets’
-f, --priority N Specify an integer priority ‘N’ for inclusion
of a transaction in the blockchain (higher
number means higher fee). Valid parameters:
@ -88,7 +95,7 @@
specified address
sweep - sweep funds in specified wallet:account to new address in same
account, or new or specified account in another wallet
sweep_all - same as above, but sweep balances of all addresses in the account
sweep-all - same as above, but sweep balances of all addresses in the account
relay - relay a transaction from a transaction file created using ‘sweep’
or ‘transfer’ with the --no-relay option
submit - submit an autosigned transaction to a wallet and the network
@ -98,8 +105,11 @@
transaction may be signed or unsigned
txview - display detailed information about a transaction file or files
txlist - same as above, but display terse information in tabular format
dump - produce JSON dumps of wallet metadata (accounts, addresses and
labels) for a list or range of wallets
dump-json - dump wallet metadata (accounts, addresses, labels), plus address
balances, for a list or range of wallets, to standard output in
JSON format
dump - same as above, but dump metadata only and save the dumps to
separate files for each wallet
restore - same as ‘create’, but additionally restore wallet metadata from
the corresponding JSON dump files created with ‘dump’
export-outputs - export outputs of watch-only wallets for import into
@ -499,5 +509,5 @@
to delete your old hot wallets, make sure to do so securely using ‘shred’,
‘wipe’ or some other secure deletion utility.
MMGEN-WALLET 16.0.0 September 2025 MMGEN-XMRWALLET(1)
MMGEN-WALLET 16.1.dev37 May 2026 MMGEN-XMRWALLET(1)
```

2
mmgen/data/release_date
View file

@ -1 +1 @@
April 2026
May 2026

2
mmgen/data/version
View file

@ -1 +1 @@
16.1.dev36
16.1.dev37