update documentation
This commit is contained in:
parent
04e8296533
commit
4497478bb1
GPG key ID:
3F8B1861E32B7DA2
16 changed files with 310 additions and 96 deletions
|
|
@ -267,20 +267,24 @@ This is now the preferred way to transact XMR, replacing the deprecated
|
|||
in the [**Getting Started**][ct] guide, with the following differences:
|
||||
|
||||
- Manual transacting is not supported, only version 2 [**autosigning**][ax].
|
||||
- XMR compatibility mode must be enabled. Use `--xmrwallet-compat` for online
|
||||
commands, or set `xmrwallet_compat` to `true` in your config file.
|
||||
- The `mmgen-addrgen` script is not used. Instead, addresses are created
|
||||
- XMR compatibility mode must be enabled. Use `--xmrwallet-compat`, or set
|
||||
`xmrwallet_compat` to `true` in your config file.
|
||||
- The `mmgen-addrgen` script is not used. Instead, addresses are generated
|
||||
automatically when `mmgen-autosign setup` is run with the `--xmrwallets`
|
||||
option. Type `mmgen-autosign --help` for more information.
|
||||
- After autosign setup, `mmgen-addrimport --coin=xmr` is run on the online
|
||||
machine with no arguments. This creates the watch-only wallet or wallets
|
||||
that together comprise the user’s tracking wallet. For watch-only wallets
|
||||
that already exist, no action is performed.
|
||||
- `mmgen-txcreate` supports both sweep transactions and send to external
|
||||
address (see `mmgen-txcreate --coin=xmr --help`)
|
||||
machine with no arguments. This creates a watch-only wallet or wallets
|
||||
to match the offline signing wallets created during the autosign setup
|
||||
process. These wallets are permananent and together comprise the user’s
|
||||
tracking wallet. Thus if a watch-only wallet already exists, it’s left
|
||||
untouched.
|
||||
- `mmgen-txcreate` supports both sweep transactions and sends to an external
|
||||
address. Sweeps are created by invoking the script with no arguments. See
|
||||
`mmgen-txcreate --coin=xmr --help` for details.
|
||||
- Tracking wallet views are account-based.
|
||||
- New accounts and addresses may be added to the tracking wallet via
|
||||
`mmgen-tool --coin=xmr listaddresses`.
|
||||
- New accounts and addresses may be added to the tracking wallet by invoking
|
||||
`mmgen-tool --coin=xmr listaddresses interactive=1`. Label editing is also
|
||||
supported.
|
||||
- The `mmgen-xmrwallet` script may be used to list and view sent transactions
|
||||
on the removable device. Type `mmgen-xmrwallet --help` for details.
|
||||
- Compatibility mode is not available for Windows. Windows users must use
|
||||
|
|
@ -350,23 +354,26 @@ relevant commands. With `mmgen-autosign`, add `rune` to the list of coins in
|
|||
the `--coins` parameter.
|
||||
|
||||
Note that MMGen Wallet’s RUNE support requires no locally running node; instead,
|
||||
balances are fetched and transactions sent via a public node at ninerealms.com.
|
||||
As this can compromise your privacy, it’s recommended to proxy all
|
||||
communications via Tor or I2P: refer to the helpscreens of `mmgen-txcreate`,
|
||||
`mmgen-swaptxcreate` and `mmgen-txsend` for more information.
|
||||
balances are fetched and transactions sent via a public node at liquify.com.
|
||||
As this can compromise your privacy, it’s highly recommended to proxy all
|
||||
communications via Tor or I2P. Refer to the helpscreens of `mmgen-txcreate`,
|
||||
`mmgen-swaptxcreate` and `mmgen-txsend` for details.
|
||||
|
||||
The `mmgen-remote` script can be used to retrieve information from the public
|
||||
node before transacting. This script also supports proxying via Tor and I2P.
|
||||
|
||||
### <a id="a_tcswap">Asset swaps via THORChain</a>
|
||||
|
||||
Install the RUNE requirements as shown above.
|
||||
|
||||
21 assets (as of this writing) may be swapped directly within MMGen Wallet via
|
||||
THORChain. Swapping assets is just like normal transacting, except transactions
|
||||
are created using `mmgen-swaptxcreate` instead of `mmgen-txcreate`. Note that
|
||||
coin daemons for both the send and receive assets must be running and synced
|
||||
before carrying out a swap. Depending on your setup, communication with two
|
||||
daemons simultaneously may require the use of *coin-specific options* (see
|
||||
`mmgen-swaptxcreate --longhelp`). For usage information, examples, and a list
|
||||
of supported assets, invoke `mmgen-swaptxcreate --help`.
|
||||
21 assets (as of this writing) may be swapped directly from MMGen Wallet via
|
||||
THORChain. Performing a swap is similar to transacting normally, except that
|
||||
`mmgen-swaptxcreate` is used to create transactions instead of `mmgen-txcreate`.
|
||||
Note that coin daemons for both the send and receive assets must be running and
|
||||
synced before initiating the swap. Depending on your setup, connecting to two
|
||||
daemons simultaneously may require the use of *coin-specific options*, as
|
||||
described in `mmgen-swaptxcreate --longhelp`. Invoke `mmgen-swaptxcreate
|
||||
--help` for usage information, examples, and a list of supported assets.
|
||||
|
||||
### <a id="a_zec">Key/address generation for Zcash (ZEC)</a>
|
||||
|
||||
|
|
|
|||
|
|
@ -16,10 +16,9 @@ $ git clone --depth=1 --branch=3.15 https://github.com/python/cpython.git
|
|||
In this example, we’ll build a free-threaded interpreter. For a single-threaded
|
||||
one you’d omit the `--disable-gil` option.
|
||||
|
||||
Omitting `--enable-optimizations` will also cause the tests to be skipped and
|
||||
thus greatly speed up the build, though this not recommended. Compilation
|
||||
without the tests typically takes around 10 seconds (!) on a modern 12-core
|
||||
computer.
|
||||
Omitting `--enable-optimizations` will cause the tests to be skipped and thus
|
||||
greatly speed up the build, though this is not recommended. Compilation without
|
||||
the tests typically takes around 10 seconds (!) on a modern 12-core computer.
|
||||
|
||||
```bash
|
||||
$ cd cpython
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@
|
|||
* [mmgen-passchg](cmds/command-help-passchg.md)
|
||||
* [mmgen-passgen](cmds/command-help-passgen.md)
|
||||
* [mmgen-regtest](cmds/command-help-regtest.md)
|
||||
* [mmgen-remote](cmds/command-help-remote.md)
|
||||
* [mmgen-seedjoin](cmds/command-help-seedjoin.md)
|
||||
* [mmgen-seedsplit](cmds/command-help-seedsplit.md)
|
||||
* [mmgen-subwalletgen](cmds/command-help-subwalletgen.md)
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
-O, --old-incog-fmt Specify old-format incognito input
|
||||
-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
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-l, --seed-len l Specify wallet seed length of 'l' bits. This option
|
||||
is required only for brainwallet and incognito inputs
|
||||
with non-standard (< 256-bit) seed lengths.
|
||||
|
|
@ -126,5 +126,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-ADDRGEN(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-ADDRGEN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
--longhelp Print help message for long (global) options
|
||||
-A, --no-addresses Print only secret keys, no addresses
|
||||
-A, --no-addresses Generate only secret keys, no addresses
|
||||
-c, --print-checksum Print address list checksum and exit
|
||||
-d, --outdir d Output files to directory 'd' instead of working dir
|
||||
-e, --echo-passphrase Echo passphrase or mnemonic to screen upon entry
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
-O, --old-incog-fmt Specify old-format incognito input
|
||||
-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
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-l, --seed-len l Specify wallet seed length of 'l' bits. This option
|
||||
is required only for brainwallet and incognito inputs
|
||||
with non-standard (< 256-bit) seed lengths.
|
||||
|
|
@ -33,9 +33,9 @@
|
|||
(default: 'L' or 'legacy')
|
||||
-U, --subwallet U Generate keys for subwallet 'U' (see SUBWALLETS
|
||||
below)
|
||||
-V, --viewkeys Print viewkeys, omitting secret keys
|
||||
-V, --viewkeys Generate viewkeys, omitting spend keys
|
||||
-v, --verbose Produce more verbose output
|
||||
-x, --b16 Print secret keys in hexadecimal too
|
||||
-x, --b16 Generate secret keys in hexadecimal too
|
||||
|
||||
|
||||
NOTES FOR THIS COMMAND
|
||||
|
|
@ -131,5 +131,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-KEYGEN(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-KEYGEN(1)
|
||||
```
|
||||
|
|
|
|||
69
doc/wiki/cmds/command-help-remote.md
Normal file
69
doc/wiki/cmds/command-help-remote.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
### [BTC](#a_btc) | [RUNE](#a_rune)
|
||||
|
||||
### <a id="a_btc">mmgen-remote --coin=btc --help</a>
|
||||
|
||||
```text
|
||||
MMGEN-REMOTE: Retrieve data from a remote JSON-RPC server
|
||||
|
||||
USAGE: mmgen-remote [OPTS] COMMAND ARGS
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
--longhelp Print help message for long (global) options
|
||||
-d, --outdir D Output logfile to directory ‘D’ instead of working dir
|
||||
-l, --log Log output to file
|
||||
|
||||
COMMANDS:
|
||||
No configured commands for coin BTC
|
||||
Supported coins: RUNE
|
||||
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-REMOTE(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
### <a id="a_rune">mmgen-remote --coin=rune --help</a>
|
||||
|
||||
```text
|
||||
MMGEN-REMOTE: Retrieve data from a remote JSON-RPC server
|
||||
|
||||
USAGE: mmgen-remote --coin=rune [OPTS] COMMAND ARGS
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
--longhelp Print help message for long (global) options
|
||||
-d, --outdir D Output logfile to directory ‘D’ instead of working dir
|
||||
-l, --log Log output to file
|
||||
-s, --swap-proto Swap protocol to use (Default: thorchain, Choices: 'thorchain')
|
||||
-x, --proxy P Connect to remote server(s) via SOCKS5h proxy P (host:port)
|
||||
Use special value ‘env’ to honor *_PROXY env vars instead.
|
||||
|
||||
Communicating with a remote server can harm your privacy!
|
||||
To improve anonymity, proxy requests via Tor or I2P
|
||||
|
||||
COMMANDS:
|
||||
|
||||
Retrieve data from a remote THORChain JSON-RPC endpoint:
|
||||
|
||||
ping - ping the remote REST endpoint
|
||||
health - check the health of the THORChain network
|
||||
pools - get available pools on the THORChain network
|
||||
lastblock - get last block info for all coins or a given coin
|
||||
mimir - get Mimir constants for the THORChain network
|
||||
actions - get actions for a given address or TxID
|
||||
inbound_addrs - get current inbound (vault) addresses
|
||||
acct_info - get account information for a given address
|
||||
balance - get balance for a given address
|
||||
quote - get a swap quote for a given send asset, receive asset
|
||||
and amount
|
||||
tx_info - get information for a transaction by TxID
|
||||
get_refnum - get reference memo info for a reference request
|
||||
transaction by TxID
|
||||
validate_refnum - check that given asset/reference combination is valid
|
||||
validate_amt - check that given asset/amount combination resolves to a
|
||||
valid reference
|
||||
|
||||
For individual command usage, invoke ‘mmgen-remote --coin=rune help COMMAND’
|
||||
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-REMOTE(1)
|
||||
```
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
```text
|
||||
MMGEN-SWAPTXCREATE: Create a DEX swap transaction from one MMGen tracking wallet to another
|
||||
|
||||
USAGE: mmgen-swaptxcreate [opts] COIN1 [AMT CHG_ADDR] COIN2 [ADDR]
|
||||
USAGE: mmgen-swaptxcreate [opts] COIN1 [AMT CHG_ADDR] COIN2 [DEST_ADDR]
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
|
|
@ -34,9 +34,20 @@
|
|||
-L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
|
||||
-m, --minconf n Minimum number of confirmations required to spend
|
||||
outputs (default: 1)
|
||||
-M, --memoless Perform a memoless swap, creating a reference request
|
||||
TX (activates first pass).
|
||||
-n, --refnum N The memoless reference number obtained after sending
|
||||
the reference request TX (activates second pass).
|
||||
-N, --no-refreq-tx With --memoless, do not create a reference request TX.
|
||||
Instead, display the reference memo and exit.
|
||||
-p, --priority N Specify an integer priority ‘N’ for inclusion of trans-
|
||||
action in blockchain (higher number means higher fee).
|
||||
XMR only. Valid params: 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
|
||||
-Q, --quote Get a swap quote and exit. Do not create transaction
|
||||
-r, --stream-interval N Set block interval for streaming swap (default: 3)
|
||||
-s, --swap-proto Swap protocol to use (Default: thorchain,
|
||||
-s, --swap-proto P Swap protocol to use (Default: thorchain,
|
||||
Choices: 'thorchain')
|
||||
-S, --list-assets List available swap assets
|
||||
-v, --verbose Produce more verbose output
|
||||
|
|
@ -79,16 +90,22 @@
|
|||
order for unused addresses. Note that sending to an unused address may be
|
||||
undesirable for Ethereum, where address (i.e. account) reuse is the norm. In
|
||||
that case, the user should specify a destination address on the command line.
|
||||
Monero tracking wallets are likely to contain no unused addresses in the
|
||||
desired destination account, or even in the entire wallet, in which case the
|
||||
user must create a new address via ‘mmgen-tool --coin=xmr listaddresses
|
||||
interactive=1’.
|
||||
|
||||
If the wallet contains eligible unused addresses with multiple Seed IDs, the
|
||||
user will be presented with a list of the lowest-indexed addresses of
|
||||
preferred type for each Seed ID and prompted to choose from among them.
|
||||
|
||||
Change and destination addresses may also be specified manually with the
|
||||
CHG_ADDR and ADDR arguments. These may be given as full MMGen IDs or in the
|
||||
form ADDRTYPE_CODE or SEED_ID:ADDRTYPE_CODE (see EXAMPLES below and the
|
||||
‘mmgen-txcreate’ help screen for details). For Ethereum, the CHG_ADDR
|
||||
argument is not supported.
|
||||
CHG_ADDR and DEST_ADDR arguments. These are given either as full MMGen IDs
|
||||
or in the form [SEED_ID:]ADDRTYPE_CODE, with the following exceptions: for
|
||||
Ethereum and Monero the CHG_ADDR argument is not supported, and for Monero
|
||||
the DEST_ADDR argument, if given, is replaced by an extended MMGen ID or a
|
||||
specifier in the form WALLET_NUM:ACCT_IDX. See EXAMPLES below and the
|
||||
‘mmgen-txcreate’ help screen for details.
|
||||
|
||||
While discouraged, sending change or swapping to non-wallet addresses is also
|
||||
supported, in which case the signing script (‘mmgen-txsign’ or ‘mmgen-
|
||||
|
|
@ -257,5 +274,48 @@
|
|||
|
||||
$ https_proxy=http://gw1:4444 mmgen-swaptxcreate --proxy=env RUNE 1000 BTC
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SWAPTXCREATE(1)
|
||||
|
||||
MEMOLESS SWAP EXAMPLES:
|
||||
|
||||
The following examples assume --autosign
|
||||
|
||||
Initiate a BTC-to-XMR swap with autoselected destination address. The
|
||||
command produces a THORChain registration transaction:
|
||||
|
||||
$ mmgen-swaptxcreate --memoless BTC 0.1234 XMR
|
||||
|
||||
Send the registration transaction to the THORChain network:
|
||||
|
||||
$ mmgen-txsend
|
||||
=> TxID
|
||||
|
||||
Get the reference number from the THORChain network:
|
||||
|
||||
$ mmgen-remote --coin=rune get_refnum TxID
|
||||
=> REFNUM
|
||||
|
||||
Create a BTC-to-XMR swap transaction using the reference number:
|
||||
|
||||
$ mmgen-swaptxcreate --refnum=REFNUM BTC 0.1234 XMR
|
||||
|
||||
Send the swap transaction:
|
||||
|
||||
$ mmgen-txsend
|
||||
|
||||
Monitor your XMR wallet for the funds:
|
||||
|
||||
$ mmgen-tool --coin=xmr twview
|
||||
|
||||
Initiate a BTC-to-XMR swap with destination argument in the form
|
||||
WALLET_NUM:ACCT_IDX:
|
||||
|
||||
$ mmgen-swaptxcreate --memoless BTC 0.1234 XMR 3:12
|
||||
|
||||
Initiate a BTC-to-XMR swap with destination argument being a specific
|
||||
address denoted by an extended MMGen ID in the form SEED_ID:ADDR_TYPE:
|
||||
WALLET_NUM/ACCT_IDX/ADDR_IDX:
|
||||
|
||||
$ mmgen-swaptxcreate --memoless BTC 0.1234 XMR 4BA5D19B:M:3/12/7
|
||||
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-SWAPTXCREATE(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
```text
|
||||
MMGEN-SWAPTXDO: Create, sign and send a DEX swap transaction from one MMGen tracking wallet to another
|
||||
|
||||
USAGE: mmgen-swaptxdo [opts] COIN1 [AMT CHG_ADDR] COIN2 [ADDR] [addr file ...] [seed source ...]
|
||||
USAGE: mmgen-swaptxdo [opts] COIN1 [AMT CHG_ADDR] COIN2 [DEST_ADDR] [addr file ...] [seed source ...]
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
with non-standard (< 256-bit) seed lengths.
|
||||
-k, --keys-from-file f Provide additional keys for non-MMGen addresses
|
||||
-K, --keygen-backend n Use backend 'n' for public key generation. Options
|
||||
for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-l, --trade-limit L Minimum swap amount, as either percentage or absolute
|
||||
coin amount (see TRADE LIMIT below)
|
||||
-L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
|
||||
|
|
@ -101,16 +101,22 @@
|
|||
order for unused addresses. Note that sending to an unused address may be
|
||||
undesirable for Ethereum, where address (i.e. account) reuse is the norm. In
|
||||
that case, the user should specify a destination address on the command line.
|
||||
Monero tracking wallets are likely to contain no unused addresses in the
|
||||
desired destination account, or even in the entire wallet, in which case the
|
||||
user must create a new address via ‘mmgen-tool --coin=xmr listaddresses
|
||||
interactive=1’.
|
||||
|
||||
If the wallet contains eligible unused addresses with multiple Seed IDs, the
|
||||
user will be presented with a list of the lowest-indexed addresses of
|
||||
preferred type for each Seed ID and prompted to choose from among them.
|
||||
|
||||
Change and destination addresses may also be specified manually with the
|
||||
CHG_ADDR and ADDR arguments. These may be given as full MMGen IDs or in the
|
||||
form ADDRTYPE_CODE or SEED_ID:ADDRTYPE_CODE (see EXAMPLES below and the
|
||||
‘mmgen-txcreate’ help screen for details). For Ethereum, the CHG_ADDR
|
||||
argument is not supported.
|
||||
CHG_ADDR and DEST_ADDR arguments. These are given either as full MMGen IDs
|
||||
or in the form [SEED_ID:]ADDRTYPE_CODE, with the following exceptions: for
|
||||
Ethereum and Monero the CHG_ADDR argument is not supported, and for Monero
|
||||
the DEST_ADDR argument, if given, is replaced by an extended MMGen ID or a
|
||||
specifier in the form WALLET_NUM:ACCT_IDX. See EXAMPLES below and the
|
||||
‘mmgen-txcreate’ help screen for details.
|
||||
|
||||
While discouraged, sending change or swapping to non-wallet addresses is also
|
||||
supported, in which case the signing script (‘mmgen-txsign’ or ‘mmgen-
|
||||
|
|
@ -318,5 +324,48 @@
|
|||
|
||||
$ https_proxy=http://gw1:4444 mmgen-swaptxdo --proxy=env RUNE 1000 BTC
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SWAPTXDO(1)
|
||||
|
||||
MEMOLESS SWAP EXAMPLES:
|
||||
|
||||
The following examples assume --autosign
|
||||
|
||||
Initiate a BTC-to-XMR swap with autoselected destination address. The
|
||||
command produces a THORChain registration transaction:
|
||||
|
||||
$ mmgen-swaptxdo --memoless BTC 0.1234 XMR
|
||||
|
||||
Send the registration transaction to the THORChain network:
|
||||
|
||||
$ mmgen-txsend
|
||||
=> TxID
|
||||
|
||||
Get the reference number from the THORChain network:
|
||||
|
||||
$ mmgen-remote --coin=rune get_refnum TxID
|
||||
=> REFNUM
|
||||
|
||||
Create a BTC-to-XMR swap transaction using the reference number:
|
||||
|
||||
$ mmgen-swaptxdo --refnum=REFNUM BTC 0.1234 XMR
|
||||
|
||||
Send the swap transaction:
|
||||
|
||||
$ mmgen-txsend
|
||||
|
||||
Monitor your XMR wallet for the funds:
|
||||
|
||||
$ mmgen-tool --coin=xmr twview
|
||||
|
||||
Initiate a BTC-to-XMR swap with destination argument in the form
|
||||
WALLET_NUM:ACCT_IDX:
|
||||
|
||||
$ mmgen-swaptxdo --memoless BTC 0.1234 XMR 3:12
|
||||
|
||||
Initiate a BTC-to-XMR swap with destination argument being a specific
|
||||
address denoted by an extended MMGen ID in the form SEED_ID:ADDR_TYPE:
|
||||
WALLET_NUM/ACCT_IDX/ADDR_IDX:
|
||||
|
||||
$ mmgen-swaptxdo --memoless BTC 0.1234 XMR 4BA5D19B:M:3/12/7
|
||||
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-SWAPTXDO(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -3,12 +3,13 @@
|
|||
## Table of Contents
|
||||
* [General string conversion and hashing utilities](#a_1)
|
||||
* [Cryptocoin key/address utilities](#a_2)
|
||||
* [Seed phrase utilities](#a_3)
|
||||
* [Utilities for viewing/checking MMGen address and transaction files](#a_4)
|
||||
* [File encryption and decryption](#a_5)
|
||||
* [File utilities](#a_6)
|
||||
* [Key, address or subseed generation from an MMGen wallet](#a_7)
|
||||
* [Tracking-wallet commands using the JSON-RPC interface](#a_8)
|
||||
* [Coin amount utilities](#a_3)
|
||||
* [Seed phrase utilities](#a_4)
|
||||
* [Utilities for viewing/checking MMGen address and transaction files](#a_5)
|
||||
* [File encryption and decryption](#a_6)
|
||||
* [File utilities](#a_7)
|
||||
* [Key, address or subseed generation from an MMGen wallet](#a_8)
|
||||
* [Tracking-wallet commands using the JSON-RPC interface](#a_9)
|
||||
|
||||
## <a id="a_1">General string conversion and hashing utilities:</a>
|
||||
|
||||
|
|
@ -394,7 +395,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool addr2pubhash`
|
||||
|
||||
```text
|
||||
Convert coin address to public key hash
|
||||
Convert an address to a public key hash
|
||||
|
||||
USAGE: mmgen-tool [OPTS] addr2pubhash ARG
|
||||
|
||||
|
|
@ -406,7 +407,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool addr2pubhex`
|
||||
|
||||
```text
|
||||
Convert coin address to public key
|
||||
Convert an address to a hexadecimal public key
|
||||
|
||||
USAGE: mmgen-tool [OPTS] addr2pubhex ARG
|
||||
|
||||
|
|
@ -418,7 +419,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool addr2scriptpubkey`
|
||||
|
||||
```text
|
||||
Convert coin address to scriptPubKey
|
||||
Convert an address to a scriptPubKey
|
||||
|
||||
USAGE: mmgen-tool [OPTS] addr2scriptpubkey ARG
|
||||
|
||||
|
|
@ -454,7 +455,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool privhex2addr`
|
||||
|
||||
```text
|
||||
Generate a coin address from raw hexadecimal private key data
|
||||
Generate an address from raw hexadecimal private key data
|
||||
|
||||
USAGE: mmgen-tool [OPTS] privhex2addr ARG
|
||||
|
||||
|
|
@ -478,7 +479,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool pubhash2addr`
|
||||
|
||||
```text
|
||||
Convert public key hash to address
|
||||
Convert a hexadecimal public key hash to an address
|
||||
|
||||
USAGE: mmgen-tool [OPTS] pubhash2addr ARG
|
||||
|
||||
|
|
@ -490,7 +491,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool pubhex2addr`
|
||||
|
||||
```text
|
||||
Convert a hexadecimal pubkey to an address
|
||||
Convert a hexadecimal public key to an address
|
||||
|
||||
USAGE: mmgen-tool [OPTS] pubhex2addr ARG
|
||||
|
||||
|
|
@ -554,7 +555,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool scriptpubkey2addr`
|
||||
|
||||
```text
|
||||
Convert scriptPubKey to coin address
|
||||
Convert a scriptPubKey to an address
|
||||
|
||||
USAGE: mmgen-tool [OPTS] scriptpubkey2addr ARG
|
||||
|
||||
|
|
@ -566,7 +567,7 @@ Required ARG (type shown in square brackets):
|
|||
### `mmgen-tool wif2addr`
|
||||
|
||||
```text
|
||||
Generate a coin address from a key in WIF format
|
||||
Generate an address from a key in WIF format
|
||||
|
||||
USAGE: mmgen-tool [OPTS] wif2addr ARG
|
||||
|
||||
|
|
@ -612,7 +613,24 @@ Required ARG (type shown in square brackets):
|
|||
```
|
||||
|
||||
|
||||
## <a id="a_3">Seed phrase utilities:</a>
|
||||
## <a id="a_3">Coin amount utilities:</a>
|
||||
|
||||
### `mmgen-tool memoless_amt`
|
||||
|
||||
```text
|
||||
Create a memoless swap amount from a given asset, amount and reference number
|
||||
|
||||
USAGE: mmgen-tool [OPTS] memoless_amt ARGS
|
||||
|
||||
Required ARGS (type shown in square brackets):
|
||||
|
||||
asset [str]
|
||||
amt [Decimal]
|
||||
refnum [int]
|
||||
```
|
||||
|
||||
|
||||
## <a id="a_4">Seed phrase utilities:</a>
|
||||
|
||||
### `mmgen-tool hex2mn`
|
||||
|
||||
|
|
@ -723,7 +741,7 @@ Optional KEYWORD ARG (type and default value shown in square brackets):
|
|||
```
|
||||
|
||||
|
||||
## <a id="a_4">Utilities for viewing/checking MMGen address and transaction files:</a>
|
||||
## <a id="a_5">Utilities for viewing/checking MMGen address and transaction files:</a>
|
||||
|
||||
### `mmgen-tool addrfile_chksum`
|
||||
|
||||
|
|
@ -793,7 +811,7 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
|
|||
```
|
||||
|
||||
|
||||
## <a id="a_5">File encryption and decryption:</a>
|
||||
## <a id="a_6">File encryption and decryption:</a>
|
||||
|
||||
### `mmgen-tool decrypt`
|
||||
|
||||
|
|
@ -830,7 +848,7 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
|
|||
```
|
||||
|
||||
|
||||
## <a id="a_6">File utilities:</a>
|
||||
## <a id="a_7">File utilities:</a>
|
||||
|
||||
### `mmgen-tool decrypt_keystore`
|
||||
|
||||
|
|
@ -917,7 +935,7 @@ Valid specifiers:
|
|||
```
|
||||
|
||||
|
||||
## <a id="a_7">Key, address or subseed generation from an MMGen wallet:</a>
|
||||
## <a id="a_8">Key, address or subseed generation from an MMGen wallet:</a>
|
||||
|
||||
### `mmgen-tool gen_addr`
|
||||
|
||||
|
|
@ -1019,7 +1037,7 @@ Optional KEYWORD ARG (type and default value shown in square brackets):
|
|||
```
|
||||
|
||||
|
||||
## <a id="a_8">Tracking-wallet commands using the JSON-RPC interface:</a>
|
||||
## <a id="a_9">Tracking-wallet commands using the JSON-RPC interface:</a>
|
||||
|
||||
### `mmgen-tool add_label`
|
||||
|
||||
|
|
@ -1263,5 +1281,5 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
|
|||
```
|
||||
|
||||
```text
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TOOL(DETAIL)(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TOOL(DETAIL)(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ GENERAL USAGE INFORMATION FOR MMGEN-TOOL COMMANDS
|
|||
|
||||
Help/usage commands:
|
||||
|
||||
help command_name [str='']
|
||||
usage command_name [str='']
|
||||
help cmdname [str='']
|
||||
usage cmdname [str='']
|
||||
|
||||
|
||||
General string conversion and hashing utilities:
|
||||
|
|
@ -73,6 +73,11 @@ GENERAL USAGE INFORMATION FOR MMGEN-TOOL COMMANDS
|
|||
wif2segwit_pair wifkey [str or STDIN]
|
||||
|
||||
|
||||
Coin amount utilities:
|
||||
|
||||
memoless_amt asset [str] amt [Decimal] refnum [int]
|
||||
|
||||
|
||||
Seed phrase utilities:
|
||||
|
||||
Supported seed phrase formats: 'mmgen' (default), 'bip39', 'xmrseed'
|
||||
|
|
@ -189,5 +194,5 @@ EXAMPLES:
|
|||
Same as above, but supply input via STDIN:
|
||||
$ echo "deadbeefcafe" | mmgen-tool hexreverse -
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TOOL(USAGE)(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TOOL(USAGE)(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
-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
|
||||
for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-l, --list List available commands
|
||||
-p, --hash-preset p Use the scrypt hash parameters defined by preset 'p'
|
||||
for password hashing (default: '3')
|
||||
|
|
@ -79,17 +79,17 @@
|
|||
mmgen-tool --coin=ltc --type=bech32 wif2addr <wif key>
|
||||
mmgen-tool --coin=zec --type=zcash_z randpair
|
||||
|
||||
addr2pubhash - convert coin address to public key hash
|
||||
addr2pubhex - convert coin address to public key
|
||||
addr2scriptpubkey - convert coin address to scriptPubKey
|
||||
addr2pubhash - convert an address to a public key hash
|
||||
addr2pubhex - convert an address to a hexadecimal public key
|
||||
addr2scriptpubkey - convert an address to a scriptPubKey
|
||||
eth_checksummed_addr - create a checksummed Ethereum address
|
||||
hex2wif - convert a private key from hexadecimal to WIF format
|
||||
privhex2addr - generate a coin address from raw hexadecimal
|
||||
private key data
|
||||
privhex2addr - generate an 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 hexadecimal pubkey to an address
|
||||
pubhash2addr - convert a hexadecimal public key hash to an address
|
||||
pubhex2addr - convert a hexadecimal public key to an address
|
||||
pubhex2redeem_script - convert a hexadecimal pubkey to a Segwit
|
||||
P2SH-P2WPKH redeem script
|
||||
privhex2pair - generate a wifkey/address pair from the provided
|
||||
|
|
@ -98,14 +98,19 @@
|
|||
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
|
||||
scriptpubkey2addr - convert a scriptPubKey to an address
|
||||
wif2addr - generate an address from a key in WIF 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 a Segwit P2SH-P2WPKH redeem script and
|
||||
address from a WIF private key
|
||||
|
||||
Coin amount utilities:
|
||||
|
||||
memoless_amt - create a memoless swap amount from a given asset, amount
|
||||
and reference number
|
||||
|
||||
Seed phrase utilities:
|
||||
|
||||
Supported seed phrase formats: 'mmgen' (default), 'bip39', 'xmrseed'
|
||||
|
|
@ -208,5 +213,5 @@
|
|||
|
||||
Type ‘mmgen-tool help <command>’ for help on a particular command
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TOOL(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TOOL(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
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 [opts] [ADDR,AMT ...] ADDR [DATA_SPEC] [addr file ...] [MMGen TX file] [seed source] ...
|
||||
mmgen-txbump --autosign [opts] [index]
|
||||
mmgen-txbump --autosign [opts] [index] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...]
|
||||
mmgen-txbump --autosign [opts] [index] [ADDR,AMT ...] ADDR [DATA_SPEC] [addr file ...]
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
|
|
@ -34,7 +34,7 @@
|
|||
with non-standard (< 256-bit) seed lengths.
|
||||
-k, --keys-from-file f Provide additional keys for non-MMGen addresses
|
||||
-K, --keygen-backend n Use backend 'n' for public key generation. Options
|
||||
for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-M, --mmgen-keys-from-file f Provide keys for MMGen addresses in a key-
|
||||
address file (output of 'mmgen-keygen'). Permits
|
||||
online signing without an MMGen seed source. The
|
||||
|
|
@ -128,5 +128,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXBUMP(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TXBUMP(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
```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 ...] ADDR [DATA_SPEC] [addr file ...]
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
|
|
@ -131,7 +131,7 @@
|
|||
|
||||
$ mmgen-txcreate B
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXCREATE(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TXCREATE(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
|
@ -219,7 +219,7 @@
|
|||
|
||||
$ mmgen-txcreate --coin=eth 01ABCDEF:E:7,0.123
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXCREATE(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TXCREATE(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
|
@ -268,5 +268,5 @@
|
|||
|
||||
$ mmgen-txcreate --coin=xmr
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXCREATE(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TXCREATE(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
```text
|
||||
MMGEN-TXDO: Create, sign and send an MMGen transaction
|
||||
|
||||
USAGE: mmgen-txdo [opts] [ADDR,AMT ... | DATA_SPEC] ADDR [addr file ...] [addr file ...] [seed source ...]
|
||||
USAGE: mmgen-txdo [opts] [ADDR,AMT ...] ADDR [DATA_SPEC] [addr file ...] [addr file ...] [seed source ...]
|
||||
|
||||
OPTIONS:
|
||||
-h, --help Print this help message
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
with non-standard (< 256-bit) seed lengths.
|
||||
-k, --keys-from-file f Provide additional keys for non-MMGen addresses
|
||||
-K, --keygen-backend n Use backend 'n' for public key generation. Options
|
||||
for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-l, --locktime t Lock time (block height or unix seconds) (default: 0)
|
||||
-L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
|
||||
-m, --minconf n Minimum number of confirmations required to spend
|
||||
|
|
@ -192,5 +192,5 @@
|
|||
|
||||
$ mmgen-txdo B
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXDO(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TXDO(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
-z, --show-hash-presets Show information on available hash presets
|
||||
-k, --keys-from-file f Provide additional keys for non-MMGen addresses
|
||||
-K, --keygen-backend n Use backend 'n' for public key generation. Options
|
||||
for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
|
||||
for BTC: 1:libsecp256k1 [default]
|
||||
-M, --mmgen-keys-from-file f Provide keys for MMGen addresses in a key-
|
||||
address file (output of 'mmgen-keygen'). Permits
|
||||
online signing without an MMGen seed source. The
|
||||
|
|
@ -85,5 +85,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXSIGN(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-TXSIGN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -55,6 +55,7 @@
|
|||
-R, --no-relay Save transaction to file instead of relaying
|
||||
-s, --no-start-wallet-daemon Don’t start the wallet daemon at startup
|
||||
-S, --no-stop-wallet-daemon Don’t stop the wallet daemon at exit
|
||||
-x, --no-restart-wallet-daemon Don’t start wallet daemon if already started
|
||||
-W, --watch-only Create or operate on watch-only wallets
|
||||
-w, --wallet-dir D Output or operate on wallets in directory 'D'
|
||||
instead of the working directory
|
||||
|
|
@ -509,5 +510,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.2.0 August 2026 MMGEN-XMRWALLET(1)
|
||||
MMGEN-WALLET 17.0.0 November 2026 MMGEN-XMRWALLET(1)
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue