update documentation
This commit is contained in:
parent
58e4bfc8b2
commit
414d2ce021
29 changed files with 63 additions and 36 deletions
|
|
@ -73,7 +73,7 @@ that widespread standard.
|
|||
[ETH][E], [ETC][E], [ERC20 tokens][E] and [RUNE][rx].
|
||||
- **[Native asset swaps via THORChain][tc]** (21 assets currently supported).
|
||||
- **[Address generation support][ag]** for the above coins, plus [Zcash][zx]
|
||||
(t and z addresses) and [144 Bitcoin-derived altcoins][ax].
|
||||
(t and z addresses), Nostr and [144 Bitcoin-derived altcoins][ax].
|
||||
- Support for **Segwit-P2SH** and **Bech32** Bitcoin address types.
|
||||
- **Independent key derivation for each address type:** No two addresses ever
|
||||
share the same private key. Certain wallets in wide use today regrettably
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ $ brew install python bash autoconf coreutils gcc libmpc libtool readline secp25
|
|||
```
|
||||
|
||||
On RISC-V machines, you may additionally need to install the `libffi-dev` package and [Rust][rs]
|
||||
(requirements for the Python `cryptography` package).
|
||||
|
||||
You may wish to use a [virtual environment][vv] to keep your MMGen Wallet
|
||||
installation isolated from the rest of your Python packages.
|
||||
|
|
|
|||
|
|
@ -44,6 +44,9 @@ Source [here][sd], binaries [here][bd].
|
|||
|
||||
#### Install the `pycoin`, `ecdsa` and `pexpect` Python packages:
|
||||
|
||||
*Note: MSYS users need to install `pycoin` only, as `ecdsa` and `pexpect` are
|
||||
already installed by pacman.*
|
||||
|
||||
##### Online install:
|
||||
|
||||
```text
|
||||
|
|
|
|||
|
|
@ -104,6 +104,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -125,5 +126,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-ADDRGEN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-ADDRGEN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@
|
|||
which addresses in your tracking wallet are used. Without it, all addresses
|
||||
without balances will be displayed as new.
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-ADDRIMPORT(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-ADDRIMPORT(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
|
@ -60,7 +60,7 @@
|
|||
-q, --quiet Suppress warnings
|
||||
-t, --token-addr ADDR Import addresses for ERC20 token with address ADDR
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-ADDRIMPORT(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-ADDRIMPORT(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
|
@ -99,5 +99,5 @@
|
|||
just specify additional wallet indexes via --xmrwallets during the offline
|
||||
setup process.
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-ADDRIMPORT(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-ADDRIMPORT(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -269,5 +269,5 @@
|
|||
$ mount /mnt/mmgen_autosign
|
||||
$ mmgen-addrgen -P /mnt/mmgen_autosign/autosign.key --coin=ltc --type=B /dev/shm/autosign/*.mmdat 1-10
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-AUTOSIGN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-AUTOSIGN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -33,5 +33,5 @@
|
|||
'[{"txid":"832f5aa9af55dc453314e26869c8f96db1f2a9acac9f23ae18d396903971e0c6","vout":0}]' \
|
||||
'[{"1111111111111111111114oLvT2":0.001}]'
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-CLI(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-CLI(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -109,6 +109,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -130,5 +131,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-KEYGEN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-KEYGEN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -49,6 +49,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -110,5 +111,5 @@
|
|||
Verify and display the exported JSON signature data:
|
||||
$ mmgen-msg verify signatures.json
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-MSG(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-MSG(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -55,5 +55,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-PASSCHG(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-PASSCHG(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -106,5 +106,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-PASSGEN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-PASSGEN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -11,11 +11,14 @@
|
|||
-n, --setup-no-stop-daemon Don't stop daemon after setup is finished
|
||||
-q, --quiet Produce quieter output
|
||||
-v, --verbose Produce more verbose output
|
||||
-w, --wallet-src DIR Initialize miner and tracking wallets from wallets in
|
||||
DIR instead of creating new ones
|
||||
|
||||
|
||||
AVAILABLE COMMANDS
|
||||
|
||||
setup - set up Bob and Alice regtest mode
|
||||
create_wallets - create Miner wallet and Bob and Alice’s tracking wallets
|
||||
start - start the regtest coin daemon
|
||||
stop - stop the regtest coin daemon
|
||||
generate N - mine N blocks (defaults to 1)
|
||||
|
|
@ -27,5 +30,5 @@
|
|||
wallet_cli - execute a wallet RPC call with supplied arguments (wallet
|
||||
is first argument)
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-REGTEST(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-REGTEST(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -65,5 +65,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-SEEDJOIN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SEEDJOIN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -148,5 +148,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-SEEDSPLIT(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SEEDSPLIT(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -101,5 +101,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-SUBWALLETGEN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SUBWALLETGEN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -146,6 +146,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -256,5 +257,5 @@
|
|||
|
||||
$ https_proxy=http://gw1:4444 mmgen-swaptxcreate --proxy=env RUNE 1000 BTC
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-SWAPTXCREATE(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SWAPTXCREATE(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -168,6 +168,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -317,5 +318,5 @@
|
|||
|
||||
$ https_proxy=http://gw1:4444 mmgen-swaptxdo --proxy=env RUNE 1000 BTC
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-SWAPTXDO(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-SWAPTXDO(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -403,6 +403,18 @@ Required ARG (type shown in square brackets):
|
|||
addr [str] (use '-' to read from STDIN)
|
||||
```
|
||||
|
||||
### `mmgen-tool addr2pubhex`
|
||||
|
||||
```text
|
||||
Convert coin address to public key
|
||||
|
||||
USAGE: mmgen-tool [OPTS] addr2pubhex ARG
|
||||
|
||||
Required ARG (type shown in square brackets):
|
||||
|
||||
addr [str] (use '-' to read from STDIN)
|
||||
```
|
||||
|
||||
### `mmgen-tool addr2scriptpubkey`
|
||||
|
||||
```text
|
||||
|
|
@ -874,17 +886,16 @@ Optional KEYWORD ARG (type and default value shown in square brackets):
|
|||
```text
|
||||
Write ‘nbytes’ bytes of random data to specified file (dd-style byte specifiers supported)
|
||||
|
||||
USAGE: mmgen-tool [OPTS] rand2file ARGS [KEYWORD ARGS]
|
||||
USAGE: mmgen-tool [OPTS] rand2file ARGS [KEYWORD ARG]
|
||||
|
||||
Required ARGS (type shown in square brackets):
|
||||
|
||||
outfile [str]
|
||||
nbytes [str]
|
||||
|
||||
Optional KEYWORD ARGS (type and default value shown in square brackets):
|
||||
Optional KEYWORD ARG (type and default value shown in square brackets):
|
||||
|
||||
threads [int=4]
|
||||
silent [bool=False]
|
||||
silent [bool=False]
|
||||
|
||||
Valid specifiers:
|
||||
|
||||
|
|
@ -1252,5 +1263,5 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
|
|||
```
|
||||
|
||||
```text
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TOOL(DETAIL)(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TOOL(DETAIL)(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -53,6 +53,7 @@ GENERAL USAGE INFORMATION FOR MMGEN-TOOL COMMANDS
|
|||
mmgen-tool --coin=zec --type=zcash_z randpair
|
||||
|
||||
addr2pubhash addr [str or STDIN]
|
||||
addr2pubhex addr [str or STDIN]
|
||||
addr2scriptpubkey addr [str or STDIN]
|
||||
eth_checksummed_addr addr [str or STDIN]
|
||||
hex2wif privhex [str or STDIN]
|
||||
|
|
@ -127,7 +128,7 @@ GENERAL USAGE INFORMATION FOR MMGEN-TOOL COMMANDS
|
|||
decrypt_keystore wallet_file [str] output_hex [bool=False]
|
||||
decrypt_geth_keystore 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]
|
||||
rand2file outfile [str] nbytes [str] silent [bool=False]
|
||||
|
||||
|
||||
Key, address or subseed generation from an MMGen wallet:
|
||||
|
|
@ -188,5 +189,5 @@ EXAMPLES:
|
|||
Same as above, but supply input via STDIN:
|
||||
$ echo "deadbeefcafe" | mmgen-tool hexreverse -
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TOOL(USAGE)(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TOOL(USAGE)(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -80,6 +80,7 @@
|
|||
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
|
||||
eth_checksummed_addr - create a checksummed Ethereum address
|
||||
hex2wif - convert a private key from hexadecimal to WIF format
|
||||
|
|
@ -207,5 +208,5 @@
|
|||
|
||||
Type ‘mmgen-tool help <command>’ for help on a particular command
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TOOL(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TOOL(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -128,5 +128,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXBUMP(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXBUMP(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -88,6 +88,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -130,7 +131,7 @@
|
|||
|
||||
$ mmgen-txcreate B
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXCREATE(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXCREATE(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
|
@ -218,7 +219,7 @@
|
|||
|
||||
$ mmgen-txcreate --coin=eth 01ABCDEF:E:7,0.123
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXCREATE(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXCREATE(1)
|
||||
```
|
||||
|
||||
<br>
|
||||
|
|
@ -267,5 +268,5 @@
|
|||
|
||||
$ mmgen-txcreate --coin=xmr
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXCREATE(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXCREATE(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -107,6 +107,7 @@
|
|||
‘S’ segwit - Segwit P2SH-P2WPKH address
|
||||
‘B’ bech32 - Native Segwit (Bech32) address
|
||||
‘X’ bech32x - Cross-chain Bech32 address
|
||||
‘K’ bech32pk - Cross-chain pubkey Bech32 address
|
||||
‘E’ ethereum - Ethereum address
|
||||
‘Z’ zcash_z - Zcash z-address
|
||||
‘M’ monero - Monero address
|
||||
|
|
@ -191,5 +192,5 @@
|
|||
|
||||
$ mmgen-txdo B
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXDO(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXDO(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -48,5 +48,5 @@
|
|||
would output data for the last four sent transactions, beginning with the most
|
||||
recent.
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXSEND(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXSEND(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -85,5 +85,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-TXSIGN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-TXSIGN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -54,5 +54,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-WALLETCHK(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-WALLETCHK(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -65,5 +65,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-WALLETCONV(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-WALLETCONV(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -57,5 +57,5 @@
|
|||
MMGenWallet .mmdat wallet,w
|
||||
PlainHexSeedFile .hex hex,rawhex,plainhex
|
||||
|
||||
MMGEN-WALLET 16.1.0 May 2026 MMGEN-WALLETGEN(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-WALLETGEN(1)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -509,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.1.0 May 2026 MMGEN-XMRWALLET(1)
|
||||
MMGEN-WALLET 16.2.0 August 2026 MMGEN-XMRWALLET(1)
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue