From c01452bcdd46ebf0c361399bf6a484c2067b14ac Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Sat, 27 Jun 2020 10:49:20 +0000 Subject: [PATCH] Update documentation for v0.12.1 --- Altcoin-and-Forkcoin-Support.md | 50 +++++++++++----------- Install-MMGen-on-Debian-or-Ubuntu-Linux.md | 27 +++++++----- Install-MMGen-on-Microsoft-Windows.md | 23 +++++----- Test-Suite.md | 15 ++++--- addrgen-[MMGen-command-help].md | 4 +- addrimport-[MMGen-command-help].md | 3 +- autosign-[MMGen-command-help].md | 3 +- keygen-[MMGen-command-help].md | 4 +- passchg-[MMGen-command-help].md | 4 +- passgen-[MMGen-command-help].md | 4 +- regtest-[MMGen-command-help].md | 3 +- seedjoin-[MMGen-command-help].md | 4 +- seedsplit-[MMGen-command-help].md | 4 +- split-[MMGen-command-help].md | 2 +- subwalletgen-[MMGen-command-help].md | 4 +- tool(usage)-[MMGen-command-help].md | 25 +++++------ tool-[MMGen-command-help].md | 23 +++++----- txbump-[MMGen-command-help].md | 6 +-- txcreate-[MMGen-command-help].md | 4 +- txdo-[MMGen-command-help].md | 8 ++-- txsend-[MMGen-command-help].md | 2 +- txsign-[MMGen-command-help].md | 6 +-- walletchk-[MMGen-command-help].md | 4 +- walletconv-[MMGen-command-help].md | 4 +- walletgen-[MMGen-command-help].md | 4 +- 25 files changed, 126 insertions(+), 114 deletions(-) diff --git a/Altcoin-and-Forkcoin-Support.md b/Altcoin-and-Forkcoin-Support.md index a9f5f1f..7ed867f 100644 --- a/Altcoin-and-Forkcoin-Support.md +++ b/Altcoin-and-Forkcoin-Support.md @@ -1,7 +1,7 @@ ## Table of Contents #### [Full support for Ethereum (ETH), Ethereum Classic (ETC) and ERC20 Tokens](#a_eth) -* [Install and run Parity Ethereum](#a_par) +* [Install and run OpenEthereum](#a_oe) * [Install Ethereum dependencies](#a_ed) * [Transacting and other basic operations](#a_tx) * [Creating and deploying ERC20 tokens](#a_dt) @@ -20,31 +20,30 @@ Ethereum, Ethereum Classic and ERC20 tokens are fully supported by MMGen, on the same level as Bitcoin. In addition, ERC20 token creation and deployment are supported via the `create-token.py` script. -#### Install and run Parity Ethereum +#### Install and run OpenEthereum -MMGen uses Parity to communicate with the Ethereum blockchain. For information -on installing Parity on your system, visit the Parity Ethereum [homepage][h] or -[Git repository][g]. [MMGenLive][l] users can install Parity automatically from -signed binaries using the [`mmlive-daemon-upgrade`][U] script. Parity is not -used for transaction signing, so you needn’t install it on your offline machine. +MMGen uses OpenEthereum to communicate with the Ethereum blockchain. For +information on installing OpenEthereum on your system, visit the OpenEthereum +[wiki][ow] or [Git repository][og]. OpenEthereum is not used for transaction +signing, so you needn’t install it on your offline machine. -Parity must be invoked with the `--jsonrpc-apis=all` option so that MMGen can -communicate with it. If you’re running the daemon and MMGen on different +OpenEthereum must be invoked with the `--jsonrpc-apis=all` option so that MMGen +can communicate with it. If you’re running the daemon and MMGen on different machines you’ll also need the following: - --jsonrpc-hosts=all --jsonrpc-interface= + --jsonrpc-hosts=all --jsonrpc-interface= To transact Ethereum Classic, use `--chain=classic --jsonrpc-port=8555` To run the daemon offline, use `--mode=offline`, otherwise `--mode=active`. -MMGen can also be used with Parity’s light client mode, which queries other -nodes on the Ethereum network for blockchain data. Add the `--light` option to -the Parity command line and read the applicable note in the [Transacting](#a_tx) -section below. +MMGen can also be used with OpenEthereum’s light client mode, which queries +other nodes on the Ethereum network for blockchain data. Add the `--light` +option to the OpenEthereum command line and read the applicable note in the +[Transacting](#a_tx) section below. -You may require other options as well. Consult `parity --help` for the full -list. +You may require other options as well. Consult `openethereum --help` for the +full list. #### Install Ethereum dependencies @@ -68,13 +67,13 @@ Basic operations with ETH, ETC and ERC20 tokens work as described in the [Getting Started][bo] guide, with some differences. Please note the following: * Don’t forget to invoke all commands with `--coin=eth` or `--coin=etc`. -* Use the `--token` switch with all token operations. When importing addresses - into your token tracking wallet you must use the token’s address as the - argument. After this, the token symbol, e.g. `--token=eos`, is sufficient. +* Use the `--token` option with the token symbol as parameter for all token + operations. When importing addresses for a new token into your tracking + wallet, use the `--token-addr` option with the token address instead. * Addresses and other hexadecimal values are given without the leading `0x`. * Fees are expressed in Gas price, e.g. `12G` for 12 Gwei or `1000M` for 1000 Mwei. This works at both the command line and interactive prompt. -* When using Parity in light client mode, the `--cached-balances` option +* When using OpenEthereum in light client mode, the `--cached-balances` option will greatly speed up operations of the `mmgen-txcreate`, `mmgen-txdo` and `mmgen-tool twview` commands by reducing network queries to a minimum. If your account balances have changed, they may be refreshed interactively within @@ -92,7 +91,7 @@ Generate some ETH addresses with your default wallet: Create an EOS token tracking wallet and import the addresses into it: - $ mmgen-addrimport --coin=eth --token=86fa049857e0209aa7d9e616f7eb3b3b78ecfdb0 ABCDABCD-ETH[1-5].addrs + $ mmgen-addrimport --coin=eth --token-addr=86fa049857e0209aa7d9e616f7eb3b3b78ecfdb0 ABCDABCD-ETH[1-5].addrs *Unlike the case with BTC and derivatives, ETH and ETC tracking wallets are created and managed by MMGen itself and located under the MMGen data directory. @@ -121,7 +120,7 @@ View your EOS tracking wallet: $ mmgen-tool --coin=eth --token=eos twview -To transact ETH instead of EOS, omit the `--token` arguments. +To transact ETH instead of EOS, omit the `--token` and `--token-addr` arguments. #### Creating and deploying ERC20 tokens @@ -189,7 +188,7 @@ price!* Create an MFT token tracking wallet and import your ETH addresses into it: - $ mmgen-addrimport --coin=eth --token=abcd1234abcd1234abcd1234abcd1234abcd1234 ABCDABCD-ETH[1-5].addrs + $ mmgen-addrimport --coin=eth --token-addr=abcd1234abcd1234abcd1234abcd1234abcd1234 ABCDABCD-ETH[1-5].addrs View your MFT tracking wallet: @@ -318,9 +317,8 @@ received only minimal testing, or no testing at all. At startup you’ll be informed of the level of your selected coin’s support reliability as deemed by the MMGen Project. -[h]: https://www.parity.io/ethereum -[g]: https://github.com/paritytech/parity-ethereum/releases -[l]: https://github.com/mmgen/MMGenLive +[ow]: https://openethereum.github.io/wiki +[og]: https://github.com/openethereum/openethereum/releases [y]: https://github.com/ethereum/pyethereum [P]: https://pypi.org/project/pip [M]: https://getmonero.org/downloads/#linux diff --git a/Install-MMGen-on-Debian-or-Ubuntu-Linux.md b/Install-MMGen-on-Debian-or-Ubuntu-Linux.md index cc88c3a..95cf910 100644 --- a/Install-MMGen-on-Debian-or-Ubuntu-Linux.md +++ b/Install-MMGen-on-Debian-or-Ubuntu-Linux.md @@ -3,11 +3,11 @@ Install required Debian/Ubuntu packages: $ sudo apt-get install autoconf git libgmp-dev libssl-dev libpcre3-dev libtool wipe curl - $ sudo apt-get install python3-dev python3-ecdsa python3-pexpect python3-setuptools python3-cryptography python3-nacl python3-pip python3-gmpy2 python3-sha3 python3-requests + $ sudo apt-get install python3-dev python3-ecdsa python3-pexpect python3-setuptools python3-cryptography python3-nacl python3-pip python3-gmpy2 python3-sha3 python3-requests python3-aiohttp -Using the [pip3][P] installer, install some required Python packages: +Using the [pip3][P] installer, install the scrypt Python package: - $ sudo -H pip3 install scrypt aiohttp + $ sudo -H pip3 install scrypt Install the secp256k1 library: @@ -25,7 +25,8 @@ Install MMGen: $ git clone https://github.com/mmgen/mmgen.git $ cd mmgen $ git checkout stable_linux # see 'Note' below - $ sudo ./setup.py install + $ ./setup.py build + $ sudo ./setup.py install # see 'Testing Note' below $ cd .. **Note:** if you want to use features that have appeared since the latest @@ -36,26 +37,29 @@ security vulnerabilities are more likely to be present in new code than in a stable release. In addition, new code may require dependencies or installation steps not yet covered in the documentation. +**Testing Note:** MMGen may be tested in place prior to installation. Refer to +the [Test Suite][ts] wiki page for details. + Install your coin daemon(s). To install prebuilt binaries, go [here][01]. To install from source, go [here][02]. #### *Note for offline machines:* -> Naturally, your offline machine must be connected to the Internet to retrieve -> and install the above packages as described above. This is normally not a -> problem, as you can simply take the machine offline permanently after the -> install is done, preferably removing or disabling its network interfaces. +> Your offline machine must be connected to the Internet to retrieve and install +> the above packages as described above. This is normally not a problem, as you +> can simply take the machine offline permanently after the install is done, +> preferably removing or disabling its network interfaces. > However, if your machine is already offline and you wish to leave it that way, > or if it lacks a network interface entirely, then you’ll need to take roughly > the following steps: ->> If your offline and offline machines have the same architecture, then just +>> If your offline and offline machines have the same architecture, then you can >> download the Debian/Ubuntu packages and their dependencies on your online ->> machine using `apt-get download`. Otherwise, you must download the packages +>> machine using `apt-get download`. Otherwise, you must retrieve the packages >> manually from `packages.debian.org` or `packages.ubuntu.com`. >> ->> Download the Python packages using `pip3 download`. +>> Download any required Python packages using `pip3 download`. >> >> Transfer the downloaded files and cloned Git repositories to your offline >> computer using a USB stick or other removable medium. Install the @@ -68,6 +72,7 @@ Congratulations, your installation is now complete! You can now proceed to [01]: Install-Bitcoind [02]: Install-Bitcoind-from-Source-on-Debian-or-Ubuntu-Linux +[ts]: Test-Suite [gs]: Getting-Started-with-MMGen [03]: https://pypi.python.org/packages/source/p/pexpect/pexpect-3.1.tar.gz [P]: https://pypi.org/project/pip diff --git a/Install-MMGen-on-Microsoft-Windows.md b/Install-MMGen-on-Microsoft-Windows.md index 130c962..516aeba 100644 --- a/Install-MMGen-on-Microsoft-Windows.md +++ b/Install-MMGen-on-Microsoft-Windows.md @@ -316,16 +316,16 @@ about adding to the Windows path, since your `PATH` variable was taken care of in Step 5. Note that the daemons must be installed on both your online and offline machines. -To transact ETH, ETC or ERC20 tokens you’ll need the latest Windows `parity.exe` -binary from the [Parity Github repository][pg]. Parity, unlike the other coin -daemons, needs to be installed on the online machine only. Copy the binary to -your executable path, preferably `/usr/local/bin`. +To transact ETH, ETC or ERC20 tokens you’ll need the latest Windows +`openethereum.exe` binary from the [OpenEthereum Github repository][og]. +OpenEthereum, unlike the other coin daemons, is installed on the online machine +only. Copy the binary to your executable path, preferably `/usr/local/bin`. -Typically you’ll wish to launch Parity as follows: +Typically you’ll wish to launch OpenEthereum as follows: - $ parity.exe --jsonrpc-apis=all + $ openethereum.exe --jsonrpc-apis=all -More information on Parity’s command-line options can be found [here][pl]. +More information on OpenEthereum’s command-line options can be found [here][pl]. ### 12. You’re done! @@ -335,17 +335,20 @@ MMGen on Linux, except for [autosigning][ax], are now supported on MSYS2 too. Please be aware of the following, however: + Non-ASCII filenames cannot be used with the Monero wallet syncing tool. This - appears to be an issue with the Monero wallet RPC daemon rather than MMGen. + is an issue with the Monero wallet RPC daemon rather than MMGen. + ++ The Bitcoin-ABC daemon cannot handle non-ASCII pathnames. This is an issue + with the Bitcoin-ABC implementation for Windows, not MMGen. [mh]: https://www.msys2.org [mp]: https://sourceforge.net/projects/msys2 [mw]: https://github.com/msys2/msys2/wiki [ov]: https://github.com/mmgen/mmgen/releases/tag/v0.9.8 [sd]: https://download.sysinternals.com/files/SDelete.zip -[pg]: https://github.com/paritytech/parity-ethereum/releases +[og]: https://github.com/openethereum/openethereum/releases [di]: Deprecated-MSWin-Installation [ib]: Install-Bitcoind [gs]: Getting-Started-with-MMGen -[pl]: Altcoin-and-Forkcoin-Support#a_par +[pl]: Altcoin-and-Forkcoin-Support#a_oe [ax]: autosign-[MMGen-command-help] [mc]: Altcoin-and-Forkcoin-Support#a_xmr diff --git a/Test-Suite.md b/Test-Suite.md index c7fedc3..94290a8 100644 --- a/Test-Suite.md +++ b/Test-Suite.md @@ -37,7 +37,7 @@ Run the test suite, skipping altcoin tests: Make sure the [Bitcoin-ABC][ad], [Litecoin][ld] and [Monero][md] daemons are installed on your system. -Install [Parity Ethereum and the Ethereum dependencies][pe] and the [Solidity +Install [OpenEthereum, the Ethereum dependencies][oe] and the [Solidity compiler][sc] as described on the Altcoin-and-Forkcoin-Support page. In addition, you must install the following helper programs and libraries (MSYS2 @@ -76,12 +76,13 @@ users can omit MoneroPy, Zcash-Mini and Ethkey): #### Ethkey -Download a [binary][pb] for your architecture and copy it to `/usr/local/bin`, -or install from source: +Download the ethkey [binary][ekb] for your architecture and copy it to `/usr/local/bin`. + +Alternatively, you may build ethkey from source: $ sudo apt-get install rustc # skip this if Rust is already installed - $ git clone https://github.com/paritytech/parity-ethereum - $ cd parity-ethereum + $ git clone https://github.com/openethereum/openethereum + $ cd openethereum $ git checkout v2.6.6 # this version builds on ARM boards - your mileage may vary $ cargo build -p ethkey-cli --release $ sudo install --strip ./target/release/ethkey /usr/local/bin @@ -125,6 +126,6 @@ commands’ output on the screen as they’re being run. [md]: https://getmonero.org/downloads/#linux [ad]: https://download.bitcoinabc.org/ [ld]: https://download.litecoin.org/litecoin-0.17.1/ -[pe]: Altcoin-and-Forkcoin-Support#a_par +[oe]: Altcoin-and-Forkcoin-Support#a_oe [sc]: Altcoin-and-Forkcoin-Support#a_dt -[pb]: https://vanity-service.parity.io/parity-binaries?format=markdown&version=v2.7.2 +[ekb]: https://vanity-service.parity.io/parity-binaries?format=markdown&version=v2.7.2 diff --git a/addrgen-[MMGen-command-help].md b/addrgen-[MMGen-command-help].md index 7fcbee3..3aca9d1 100644 --- a/addrgen-[MMGen-command-help].md +++ b/addrgen-[MMGen-command-help].md @@ -113,7 +113,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-ADDRGEN(1) + MMGEN v0.12.1 June 2020 MMGEN-ADDRGEN(1) diff --git a/addrimport-[MMGen-command-help].md b/addrimport-[MMGen-command-help].md index e9919df..0d24f9f 100644 --- a/addrimport-[MMGen-command-help].md +++ b/addrimport-[MMGen-command-help].md @@ -10,6 +10,7 @@ -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. + -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 @@ -17,4 +18,4 @@ The --batch and --rescan options cannot be used together. - MMGEN v0.12.0 February 2020 MMGEN-ADDRIMPORT(1) + MMGEN v0.12.1 June 2020 MMGEN-ADDRIMPORT(1) diff --git a/autosign-[MMGen-command-help].md b/autosign-[MMGen-command-help].md index c8fb11d..31c7a43 100644 --- a/autosign-[MMGen-command-help].md +++ b/autosign-[MMGen-command-help].md @@ -7,6 +7,7 @@ -I, --no-insert-check Don't check for device insertion -l, --led Use status LED to signal standby, busy and error -m, --mountpoint m Specify an alternate mountpoint (default: '/mnt/tx') + -n, --no-summary Don't print a transaction summary -s, --stealth-led Stealth LED mode - signal busy and error only, and only after successful authorization. -S, --full-summary Print a full summary of each signed transaction after @@ -65,4 +66,4 @@ This command is currently available only on Linux-based platforms. - MMGEN v0.12.0 February 2020 MMGEN-AUTOSIGN(1) + MMGEN v0.12.1 June 2020 MMGEN-AUTOSIGN(1) diff --git a/keygen-[MMGen-command-help].md b/keygen-[MMGen-command-help].md index f7a81be..26b2484 100644 --- a/keygen-[MMGen-command-help].md +++ b/keygen-[MMGen-command-help].md @@ -117,7 +117,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-KEYGEN(1) + MMGEN v0.12.1 June 2020 MMGEN-KEYGEN(1) diff --git a/passchg-[MMGen-command-help].md b/passchg-[MMGen-command-help].md index 8a73e5e..de26145 100644 --- a/passchg-[MMGen-command-help].md +++ b/passchg-[MMGen-command-help].md @@ -47,7 +47,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-PASSCHG(1) + MMGEN v0.12.1 June 2020 MMGEN-PASSCHG(1) diff --git a/passgen-[MMGen-command-help].md b/passgen-[MMGen-command-help].md index 5bad011..b41ca55 100644 --- a/passgen-[MMGen-command-help].md +++ b/passgen-[MMGen-command-help].md @@ -96,7 +96,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-PASSGEN(1) + MMGEN v0.12.1 June 2020 MMGEN-PASSGEN(1) diff --git a/regtest-[MMGen-command-help].md b/regtest-[MMGen-command-help].md index d63200f..6d77d0a 100644 --- a/regtest-[MMGen-command-help].md +++ b/regtest-[MMGen-command-help].md @@ -24,4 +24,5 @@ mempool - show transaction IDs in mempool cli - execute an RPC call with supplied arguments - MMGEN v0.12.0 February 2020 MMGEN-REGTEST(1) + + MMGEN v0.12.1 June 2020 MMGEN-REGTEST(1) diff --git a/seedjoin-[MMGen-command-help].md b/seedjoin-[MMGen-command-help].md index 3569679..9d8b1ff 100644 --- a/seedjoin-[MMGen-command-help].md +++ b/seedjoin-[MMGen-command-help].md @@ -57,7 +57,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-SEEDJOIN(1) + MMGEN v0.12.1 June 2020 MMGEN-SEEDJOIN(1) diff --git a/seedsplit-[MMGen-command-help].md b/seedsplit-[MMGen-command-help].md index 8b11922..63e4cf9 100644 --- a/seedsplit-[MMGen-command-help].md +++ b/seedsplit-[MMGen-command-help].md @@ -138,7 +138,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-SEEDSPLIT(1) + MMGEN v0.12.1 June 2020 MMGEN-SEEDSPLIT(1) diff --git a/split-[MMGen-command-help].md b/split-[MMGen-command-help].md index 6f26084..7863f98 100644 --- a/split-[MMGen-command-help].md +++ b/split-[MMGen-command-help].md @@ -45,4 +45,4 @@ behind the timelock, protection is contingent on getting the non-timelocked transaction reconfirmed before the timelock expires. Use at your own risk. - MMGEN v0.12.0 February 2020 MMGEN-SPLIT(1) + MMGEN v0.12.1 June 2020 MMGEN-SPLIT(1) diff --git a/subwalletgen-[MMGen-command-help].md b/subwalletgen-[MMGen-command-help].md index ace1671..f052236 100644 --- a/subwalletgen-[MMGen-command-help].md +++ b/subwalletgen-[MMGen-command-help].md @@ -91,7 +91,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-SUBWALLETGEN(1) + MMGEN v0.12.1 June 2020 MMGEN-SUBWALLETGEN(1) diff --git a/tool(usage)-[MMGen-command-help].md b/tool(usage)-[MMGen-command-help].md index 4398671..7c21b4f 100644 --- a/tool(usage)-[MMGen-command-help].md +++ b/tool(usage)-[MMGen-command-help].md @@ -56,20 +56,21 @@ 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')] - 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')] + 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')] 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' (valid options: 'addr','raw')] "filesort" [str='mtime' (valid options: 'mtime','ctime','atime')] File encryption and decryption @@ -94,11 +95,11 @@ add_label mmgen_or_coin_addr [str] label [str] 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='' (valid options: days,confs)] - 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='' (valid options: days,confs)] + 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='days' (valid options: days,confs)] "show_mmid" [bool=True] + 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] Monero wallet utilities @@ -134,4 +135,4 @@ Same as above, but use a pipe: $ echo "deadbeefcafe" | mmgen-tool hexreverse - - MMGEN v0.12.0 February 2020 MMGEN-TOOL(USAGE)(1) + MMGEN v0.12.1 June 2020 MMGEN-TOOL(USAGE)(1) diff --git a/tool-[MMGen-command-help].md b/tool-[MMGen-command-help].md index 2fbc13a..52c23e7 100644 --- a/tool-[MMGen-command-help].md +++ b/tool-[MMGen-command-help].md @@ -103,15 +103,16 @@ to a concrete key/address pair. To manually generate a Monero spendkey, use the 'hex2wif' command. - hex2mn - convert a 16, 24 or 32-byte hexadecimal number to a - mnemonic seed phrase - mn2hex - convert a 12, 18 or 24-word 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 + hex2mn - convert a 16, 24 or 32-byte hexadecimal number to a + mnemonic seed phrase + mn2hex - convert a mnemonic seed phrase to a hexadecimal number + 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 Utilities for viewing/checking MMGen address and transaction files: @@ -166,11 +167,11 @@ Note that the use of these commands requires private data to be exposed on A network-connected machine in order to unlock the Monero wallets. This is - A violation of MMGen's security policy. + A violation of good security practice. keyaddrlist2monerowallets - create Monero wallets from a key-address list syncmonerowallets - sync Monero wallets from a key-address list Type 'mmgen-tool help ' for help on a particular command - MMGEN v0.12.0 February 2020 MMGEN-TOOL(1) + MMGEN v0.12.1 June 2020 MMGEN-TOOL(1) diff --git a/txbump-[MMGen-command-help].md b/txbump-[MMGen-command-help].md index 598e04b..bcd7520 100644 --- a/txbump-[MMGen-command-help].md +++ b/txbump-[MMGen-command-help].md @@ -33,7 +33,7 @@ -O, --old-incog-fmt Specify old-format incognito input -p, --hash-preset p Use the scrypt hash parameters defined by preset 'p' for password hashing (default: '3') - -P, --passwd-file f Get MMGen wallet or bitcoind passphrase from file 'f' + -P, --passwd-file f Get MMGen wallet passphrase from file 'f' -q, --quiet Suppress warnings; overwrite files without prompting -s, --send Sign and send the transaction (the default if seed data is provided) @@ -81,7 +81,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-TXBUMP(1) + MMGEN v0.12.1 June 2020 MMGEN-TXBUMP(1) diff --git a/txcreate-[MMGen-command-help].md b/txcreate-[MMGen-command-help].md index 537ed69..456c015 100644 --- a/txcreate-[MMGen-command-help].md +++ b/txcreate-[MMGen-command-help].md @@ -43,7 +43,7 @@ if specified. Ages of transactions are approximate based on an average block discovery - interval of one per 600 seconds. + interval of one per 582 seconds. All addresses on the command line can be either Bitcoin addresses or MMGen addresses of the form :. @@ -56,4 +56,4 @@ a plain decimal number, or as satoshis per byte, using an integer followed by 's', for satoshi. - MMGEN v0.12.0 February 2020 MMGEN-TXCREATE(1) + MMGEN v0.12.1 June 2020 MMGEN-TXCREATE(1) diff --git a/txdo-[MMGen-command-help].md b/txdo-[MMGen-command-help].md index cb255d2..48ba051 100644 --- a/txdo-[MMGen-command-help].md +++ b/txdo-[MMGen-command-help].md @@ -13,7 +13,7 @@ -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' + 'conservative','economical'. Default: 'conservative' -f, --tx-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 @@ -68,7 +68,7 @@ if specified. Ages of transactions are approximate based on an average block discovery - interval of one per 600 seconds. + interval of one per 582 seconds. All addresses on the command line can be either Bitcoin addresses or MMGen addresses of the form :. @@ -115,7 +115,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-TXDO(1) + MMGEN v0.12.1 June 2020 MMGEN-TXDO(1) diff --git a/txsend-[MMGen-command-help].md b/txsend-[MMGen-command-help].md index 5ff8223..38a47a3 100644 --- a/txsend-[MMGen-command-help].md +++ b/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 v0.12.0 February 2020 MMGEN-TXSEND(1) + MMGEN v0.12.1 June 2020 MMGEN-TXSEND(1) diff --git a/txsign-[MMGen-command-help].md b/txsign-[MMGen-command-help].md index f14c398..2549f07 100644 --- a/txsign-[MMGen-command-help].md +++ b/txsign-[MMGen-command-help].md @@ -27,7 +27,7 @@ online signing without an MMGen seed source. The key-address file is also used to verify MMGen-to-BTC mappings, so the user should record its checksum. - -P, --passwd-file f Get MMGen wallet or bitcoind passphrase from file 'f' + -P, --passwd-file f Get MMGen wallet passphrase from file 'f' -q, --quiet Suppress warnings; overwrite files without prompting -I, --info Display information about the transaction and exit -t, --terse-info Like '--info', but produce more concise output @@ -73,7 +73,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-TXSIGN(1) + MMGEN v0.12.1 June 2020 MMGEN-TXSIGN(1) diff --git a/walletchk-[MMGen-command-help].md b/walletchk-[MMGen-command-help].md index c9a0009..595337a 100644 --- a/walletchk-[MMGen-command-help].md +++ b/walletchk-[MMGen-command-help].md @@ -46,7 +46,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-WALLETCHK(1) + MMGEN v0.12.1 June 2020 MMGEN-WALLETCHK(1) diff --git a/walletconv-[MMGen-command-help].md b/walletconv-[MMGen-command-help].md index e76204d..9d26069 100644 --- a/walletconv-[MMGen-command-help].md +++ b/walletconv-[MMGen-command-help].md @@ -56,7 +56,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-WALLETCONV(1) + MMGEN v0.12.1 June 2020 MMGEN-WALLETCONV(1) diff --git a/walletgen-[MMGen-command-help].md b/walletgen-[MMGen-command-help].md index 8da30da..3a56dfe 100644 --- a/walletgen-[MMGen-command-help].md +++ b/walletgen-[MMGen-command-help].md @@ -49,7 +49,7 @@ MMGenHexSeedFile .mmhex seedhex,hexseed,mmhex MMGenMnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m MMGenSeedFile .mmseed mmseed,seed,s + MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - Wallet .mmdat wallet,w - MMGEN v0.12.0 February 2020 MMGEN-WALLETGEN(1) + MMGEN v0.12.1 June 2020 MMGEN-WALLETGEN(1)