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

modified: tool(detail)-[MMGen-command-help].md 

modified:   tool(usage)-[MMGen-command-help].md
modified:   txbump-[MMGen-command-help].md
modified:   txcreate-[MMGen-command-help].md
modified:   txdo-[MMGen-command-help].md
The MMGen Project 2022-11-26 18:57:28 +00:00
commit 1c2064e28a
Signed by: mmgen
GPG key ID: 3F8B1861E32B7DA2
5 changed files with 154 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

31
tool(detail)-[MMGen-command-help].md

@ -883,9 +883,10 @@
Optional KEYWORD ARGS (type and default value shown in square brackets):
minconf [int=1] Minimum number of confirmations
showbtcaddr [bool=True] Display coin address in addition to MMGen ID
age_fmt [str='confs'] Format for the Age/Date column (valid choices: 'confs','block','days','date','date_time')
wide [bool=False] Display data in wide tabular format
minconf [int=1] Minimum number of confirmations
showcoinaddr [bool=True] Display coin address in addition to MMGen ID
age_fmt [str='confs'] Format for the Age/Date column (valid choices: 'confs','block','days','date','date_time')
### `mmgen-tool listaddresses`
@ -895,14 +896,18 @@
Optional KEYWORD ARGS (type and default value shown in square brackets):
mmgen_addrs [str=''] Hyphenated range or comma-separated list of addresses
minconf [int=1] Minimum number of confirmations
pager [bool=False] Send output to pager
showbtcaddrs [bool=True] Display coin addresses in addition to MMGen IDs
showempty [bool=True] Show addresses with no balances
all_labels [bool=False] Show all addresses with labels
age_fmt [str='confs'] Format for the Age/Date column (valid choices: 'confs','block','days','date','date_time')
sort [str=''] Address sort order (valid choices: 'reverse','age')
pager [bool=False] Send output to pager
reverse [bool=False] Reverse order of unspent outputs
wide [bool=False] Display data in wide tabular format
minconf [int=1] Minimum number of confirmations
sort [str=''] Address sort order (valid choices: 'reverse','mmid','addr','amt')
age_fmt [str='confs'] Format for the Age/Date column (valid choices: 'confs','block','days','date','date_time')
interactive [bool=False] Enable interactive operation
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)
all_labels [bool=False] Show all addresses with labels
### `mmgen-tool remove_address`
@ -1038,4 +1043,6 @@
age_fmt [str='confs'] Format for the Age/Date column (valid choices: 'confs','block','days','date','date_time')
interactive [bool=False] Enable interactive operation
MMGEN v13.3.dev16 November 2022
### ~~~
MMGEN v13.3.dev23 November 2022

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

@ -141,8 +141,8 @@
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] showbtcaddr [bool=True] age_fmt [str='confs']
listaddresses mmgen_addrs [str=''] minconf [int=1] pager [bool=False] showbtcaddrs [bool=True] showempty [bool=True] all_labels [bool=False] age_fmt [str='confs'] sort [str='']
listaddress mmgen_addr [str] wide [bool=False] minconf [int=1] showcoinaddr [bool=True] age_fmt [str='confs']
listaddresses pager [bool=False] reverse [bool=False] wide [bool=False] minconf [int=1] sort [str=''] age_fmt [str='confs'] interactive [bool=False] mmgen_addrs [str=''] showcoinaddrs [bool=True] showempty [bool=True] showused [int=1] all_labels [bool=False]
remove_address mmgen_or_coin_addr [str]
remove_label mmgen_or_coin_addr [str]
rescan_address mmgen_or_coin_addr [str]
@ -184,4 +184,4 @@
Same as above, but supply input via STDIN:
$ echo "deadbeefcafe" | mmgen-tool hexreverse -
MMGEN v13.3.dev16 November 2022 MMGEN-TOOL(USAGE)(1)
MMGEN v13.3.dev23 November 2022 MMGEN-TOOL(USAGE)(1)

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

@ -10,7 +10,7 @@
-c, --comment-file f Source the transaction's comment from file 'f'
-d, --outdir d Specify an alternate directory 'd' for output
-e, --echo-passphrase Print passphrase to screen when typing it
-f, --tx-fee f Transaction fee, as a decimal BTC amount or as
-f, --fee f Transaction fee, as a decimal BTC amount or as
satoshis per byte (an integer followed by 's').
See FEE SPECIFICATION below.
-H, --hidden-incog-input-params f,o Read hidden incognito data from file
@ -41,10 +41,11 @@
-z, --show-hash-presets Show information on available hash presets
FEE SPECIFICATION: Transaction fees, both on the command line and at the
interactive prompt, may be specified as either absolute BTC amounts, using
a plain decimal number, or as satoshis per byte, using an integer followed by
's', for satoshi.
FEE SPECIFICATION
Transaction fees, both on the command line and at the interactive prompt, may
be specified as either absolute BTC amounts, using a plain decimal number, or
as satoshis per byte, using an integer followed by 's', for satoshi.
Transactions may contain both MMGen or non-MMGen input addresses.
@ -85,4 +86,4 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.2.0 August 2022 MMGEN-TXBUMP(1)
MMGEN v13.3.dev23 November 2022 MMGEN-TXBUMP(1)

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

@ -1,21 +1,22 @@
MMGEN-TXCREATE: Create a transaction with outputs to specified coin or MMGen addresses
USAGE: mmgen-txcreate [opts] <addr,amt> ... [change addr] [addr file] ...
USAGE: mmgen-txcreate [opts] [<addr,amt> ...] <change addr, addrlist ID or addr type> [addr file ...]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long options (common options)
-a, --tx-fee-adj f Adjust transaction fee by factor 'f' (see below)
-a, --fee-adjust f Adjust transaction fee by factor 'f' (see below)
-B, --no-blank Don't blank screen before displaying unspent outputs
-c, --comment-file f Source the transaction's comment from file 'f'
-C, --tx-confs c Desired number of confirmations (default: 3)
-C, --fee-estimate-confs c Desired number of confirmations for fee estimation
(default: 3)
-d, --outdir d Specify an alternate directory 'd' for output
-D, --contract-data D Path to hex-encoded contract data (ETH only)
-E, --fee-estimate-mode M Specify the network fee estimate mode. Choices:
'conservative','economical'. Default: 'conservative'
-f, --tx-fee f Transaction fee, as a decimal BTC amount or as
-f, --fee f Transaction fee, as a decimal BTC amount or as
satoshis per byte (an integer followed by 's').
See FEE SPECIFICATION below. If omitted, fee will be
calculated using network fee estimation.
-g, --tx-gas g Specify start gas amount in Wei (ETH only)
-g, --gas g Specify start gas amount in Wei (ETH only)
-i, --info Display unspent outputs and exit
-I, --inputs i Specify transaction inputs (comma-separated list of
MMGen IDs or coin addresses). Note that ALL unspent
@ -31,26 +32,68 @@
-X, --cached-balances Use cached balances (Ethereum only)
The transaction's outputs are specified on the command line, while its inputs
are chosen from a list of the user's unspent outputs via an interactive menu.
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.
All addresses on the command line can be either Bitcoin addresses or MMGen
IDs in the form <seed ID>:<address type letter>:<index>.
Outputs are specified in the form <address>,<amount>, with the change output
specified by address only. Alternatively, the change output may be an
addrlist ID in the form <seed ID>:<address type letter>, in which case the
first unused address in the tracking wallet matching the requested ID will
be automatically selected as the change output.
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 '--tx-fee-adj',
if specified.
All addresses on the command line can be either Bitcoin addresses or MMGen
addresses of the form <seed ID>:<index>.
Network-estimated fees will be multiplied by the value of --fee-adjust, if
specified.
To send the value of all inputs (minus TX fee) to a single output, specify
one address with no amount on the command line.
a single address with no amount on the command line. Alternatively, an
addrlist ID may be specified, and the address will be chosen automatically
as described above for the change output.
FEE SPECIFICATION: Transaction fees, both on the command line and at the
interactive prompt, may be specified as either absolute BTC amounts, using
a plain decimal number, or as satoshis per byte, using an integer followed by
's', for satoshi.
MMGEN v13.2.0 August 2022 MMGEN-TXCREATE(1)
FEE SPECIFICATION
Transaction fees, both on the command line and at the interactive prompt, may
be specified as either absolute BTC amounts, using a plain decimal number, or
as satoshis per byte, using an integer followed by 's', for satoshi.
EXAMPLES:
Send 0.123 BTC to an external Bitcoin address, returning the change to a
specific MMGen address in the tracking wallet:
$ mmgen-txcreate 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 01ABCDEF:S:7
Same as above, but select the change address automatically:
$ mmgen-txcreate 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 01ABCDEF:S
Same as above, but select the change address automatically by address type:
$ mmgen-txcreate 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 S
Same as above, but reduce verbosity and specify fee of 20 satoshis
per byte:
$ mmgen-txcreate -q -f 20s 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 S
Send entire balance of selected inputs minus fee to an external Bitcoin
address:
$ mmgen-txcreate 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB
Send entire balance of selected inputs minus fee to first unused wallet
address of specified type:
$ mmgen-txcreate S
MMGEN v13.3.dev23 November 2022 MMGEN-TXCREATE(1)

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

@ -1,24 +1,25 @@
MMGEN-TXDO: Create, sign and send an MMGen transaction
USAGE: mmgen-txdo [opts] <addr,amt> ... [change addr] [addr file] ... [seed source] ...
USAGE: mmgen-txdo [opts] [<addr,amt> ...] <change addr, addrlist ID or addr type> [addr file ...] [seed source ...]
OPTIONS:
-h, --help Print this help message
--longhelp Print help message for long options (common options)
-a, --tx-fee-adj f Adjust transaction fee by factor 'f' (see below)
-a, --fee-adjust f Adjust transaction fee by factor 'f' (see below)
-b, --brain-params l,p Use seed length 'l' and hash preset 'p' for
brainwallet input
-B, --no-blank Don't blank screen before displaying unspent outputs
-c, --comment-file f Source the transaction's comment from file 'f'
-C, --tx-confs c Desired number of confirmations (default: 3)
-C, --fee-estimate-confs c Desired number of confirmations for fee estimation
(default: 3)
-d, --outdir d Specify an alternate directory 'd' for output
-D, --contract-data D Path to hex-encoded contract data (ETH only)
-e, --echo-passphrase Print passphrase to screen when typing it
-E, --fee-estimate-mode M Specify the network fee estimate mode. Choices:
'conservative','economical'. Default: 'conservative'
-f, --tx-fee f Transaction fee, as a decimal BTC amount or as
-f, --fee f Transaction fee, as a decimal BTC amount or as
satoshis per byte (an integer followed by 's').
See FEE SPECIFICATION below. If omitted, fee will be
calculated using network fee estimation.
-g, --tx-gas g Specify start gas amount in Wei (ETH only)
-g, --gas g Specify start gas amount in Wei (ETH only)
-H, --hidden-incog-input-params f,o Read hidden incognito data from file
'f' at offset 'o' (comma-separated)
-i, --in-fmt f Input is from wallet format 'f' (see FMT CODES below)
@ -55,27 +56,41 @@
-z, --show-hash-presets Show information on available hash presets
The transaction's outputs are specified on the command line, while its inputs
are chosen from a list of the user's unspent outputs via an interactive menu.
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.
All addresses on the command line can be either Bitcoin addresses or MMGen
IDs in the form <seed ID>:<address type letter>:<index>.
Outputs are specified in the form <address>,<amount>, with the change output
specified by address only. Alternatively, the change output may be an
addrlist ID in the form <seed ID>:<address type letter>, in which case the
first unused address in the tracking wallet matching the requested ID will
be automatically selected as the change output.
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 '--tx-fee-adj',
if specified.
All addresses on the command line can be either Bitcoin addresses or MMGen
addresses of the form <seed ID>:<index>.
Network-estimated fees will be multiplied by the value of --fee-adjust, if
specified.
To send the value of all inputs (minus TX fee) to a single output, specify
one address with no amount on the command line.
a single address with no amount on the command line. Alternatively, an
addrlist ID may be specified, and the address will be chosen automatically
as described above for the change output.
FEE SPECIFICATION: Transaction fees, both on the command line and at the
interactive prompt, may be specified as either absolute BTC amounts, using
a plain decimal number, or as satoshis per byte, using an integer followed by
's', for satoshi.
FEE SPECIFICATION
Transaction fees, both on the command line and at the interactive prompt, may
be specified as either absolute BTC amounts, using a plain decimal number, or
as satoshis per byte, using an integer followed by 's', for satoshi.
SIGNING NOTES
Transactions may contain both MMGen or non-MMGen input addresses.
@ -116,4 +131,35 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v13.2.0 August 2022 MMGEN-TXDO(1)
EXAMPLES:
Send 0.123 BTC to an external Bitcoin address, returning the change to a
specific MMGen address in the tracking wallet:
$ mmgen-txdo 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 01ABCDEF:S:7
Same as above, but select the change address automatically:
$ mmgen-txdo 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 01ABCDEF:S
Same as above, but select the change address automatically by address type:
$ mmgen-txdo 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 S
Same as above, but reduce verbosity and specify fee of 20 satoshis
per byte:
$ mmgen-txdo -q -f 20s 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB,0.123 S
Send entire balance of selected inputs minus fee to an external Bitcoin
address:
$ mmgen-txdo 35N9FntsNwy98TmjFHyCpsBVDVUs5wDPfB
Send entire balance of selected inputs minus fee to first unused wallet
address of specified type:
$ mmgen-txdo S
MMGEN v13.3.dev23 November 2022 MMGEN-TXDO(1)