From 31880e7a1f9cd5f0d36413f82be649c62dfe8324 Mon Sep 17 00:00:00 2001 From: MMGen Date: Sun, 23 Feb 2020 19:17:28 +0000 Subject: [PATCH] modified: Altcoin-and-Forkcoin-Support.md modified: Getting-Started-with-MMGen.md modified: Home.md modified: Install-MMGen-on-Microsoft-Windows.md --- Altcoin-and-Forkcoin-Support.md | 2 +- Getting-Started-with-MMGen.md | 28 +++++++++++++-------------- Home.md | 10 ++++++++++ Install-MMGen-on-Microsoft-Windows.md | 12 +++++------- Subwallets.md | 12 ++++++++++-- 5 files changed, 40 insertions(+), 24 deletions(-) diff --git a/Altcoin-and-Forkcoin-Support.md b/Altcoin-and-Forkcoin-Support.md index ee3c6c2..14d5ead 100644 --- a/Altcoin-and-Forkcoin-Support.md +++ b/Altcoin-and-Forkcoin-Support.md @@ -68,7 +68,7 @@ Basic operations with ETH, ETC and ERC20 tokens work as described in the argument. After this, the token symbol, e.g. `--token=eos`, is sufficient. * 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 both at the command line and interactive prompt. + Mwei. This works at both the command line and interactive prompt. ##### Transacting example: diff --git a/Getting-Started-with-MMGen.md b/Getting-Started-with-MMGen.md index fc89397..2e77d97 100644 --- a/Getting-Started-with-MMGen.md +++ b/Getting-Started-with-MMGen.md @@ -526,8 +526,10 @@ tutorial][03]. #### Mnemonics, seeds and hexseeds: additional information All MMGen commands that take mnemonic, seed or hexseed data may receive the data -from a prompt instead of a file. Just omit the file name and specify the input -format: +interactively from the user instead of from a file. This feature allows you to +store your seed entirely in your head if you wish and never record it on a +physical medium. To input your seed data at the prompt, just specify an input +format instead of a file name: $ mmgen-addrgen -i words 1-10 ... @@ -536,23 +538,21 @@ format: Enter your 12-word mnemonic, hitting RETURN or SPACE after each word: Enter word #1: -MMGen prompts you for each of the mnemonic’s words individually, checking it for -validity and reprompting if necessary. What you type is not displayed on the -screen of course, being secret data. +Here MMGen prompts you interactively for each word of the seed phrase, checking +it for validity and reprompting if necessary. The words are not displayed on +the screen. -The mnemonic prompt feature allows you to store and use your seed entirely in -your head if you wish, never recording it on a persistent physical medium. - -With the `-S` option, MMGen commands may be requested to print wallet data to -screen instead of a file. To safeguard against over-the-shoulder, Tempest and -other side-channel attacks, you’ll be prompted before this sensitive data is -actually displayed. MMGen never prints decrypted private data to screen unless -you ask it to. +As a safeguard against over-the-shoulder, Tempest and other side-channel +attacks, MMGen never outputs secret data to the screen, unless you ask it to +with the `--stdout` or `-S` option. When using this option, you’ll still be +prompted before the secret data is actually displayed. This safety prompt is +overridden by the `--quiet` option, however, so you must always think twice +before using `--stdout`. The output of any MMGen command may be written to a directory of your choice using the `--outdir` or `-d` option. For example, on a Linux system you can use `--outdir=/dev/shm` to write keys and seeds to volatile memory instead of disk, -ensuring that no traces of your secret data are left once your computer’s been +ensuring that no trace of your secret data remains once your computer’s been powered down. #### Incognito wallets diff --git a/Home.md b/Home.md index 8e49e4d..20f92c9 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,11 @@ +#### This is the main documentation page for the MMGen wallet system. + +For newly-added features that aren’t yet documented here, check the [commit +log][cn], which always documents important new features, usually with helpful +examples. To search the commit log locally, `cd` to the root of your cloned +MMGen repository, ensure that it’s up-to-date by doing a `git checkout master && +git pull`, type `git log` and perform a search using the `/` key. + ### Download/Install > #### [Install on Microsoft Windows](Install-MMGen-on-Microsoft-Windows) @@ -18,3 +26,5 @@ > #### [Altcoin and Forkcoin support (ETH,ETC,XMR,ZEC,LTC,BCH and 144 Bitcoin-derived alts)](Altcoin-and-Forkcoin-Support) > #### [Subwallets](Subwallets) + +[cn]: https://github.com/mmgen/mmgen/commits/master diff --git a/Install-MMGen-on-Microsoft-Windows.md b/Install-MMGen-on-Microsoft-Windows.md index f28ac58..d400283 100644 --- a/Install-MMGen-on-Microsoft-Windows.md +++ b/Install-MMGen-on-Microsoft-Windows.md @@ -186,9 +186,10 @@ Open your shell’s runtime configuration file in a text editor: $ nano ~/.bashrc -Add the following line to the end of the file, save and exit: +Add the following two lines to the end of the file, save and exit: export PATH="/mingw64/bin:$PATH:/c/Program Files/Bitcoin/daemon:/c/Program Files/Litecoin/daemon:/c/Program Files/Bitcoin-abc/daemon" + export PYTHONUTF8=1 Close and reopen the terminal window to update your working environment. @@ -198,12 +199,12 @@ Three of MMGen’s Python dependencies, `ecdsa`, `py_ecc` and `mypy_extensions`, are not provided by MSYS2. If you’re online, you can install them using the pip package installer as follows: - $ pip3 install --no-deps ecdsa==0.13 py_ecc==1.6.0 mypy_extensions==0.4.1 scrypt==0.8.13 + $ pip3 install --no-deps ecdsa==0.13 py_ecc==1.6.0 mypy_extensions==0.4.1 For an offline install, first download the packages on your online machine like this: - $ pip3 download --no-deps ecdsa==0.13 py_ecc==1.6.0 mypy_extensions==0.4.1 scrypt==0.8.13 + $ pip3 download --no-deps ecdsa==0.13 py_ecc==1.6.0 mypy_extensions==0.4.1 Then transfer the `*.whl` files to your offline machine, `cd` to the directory containing the files and install them as follows: @@ -282,10 +283,7 @@ 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 `C:\\msys64\usr\local\bin`. If the target -directory doesn’t exist yet, create it in your terminal like this: - - $ mkdir -p /usr/local/bin +your executable path, preferably `/usr/local/bin`. Typically you’ll wish to launch Parity as follows: diff --git a/Subwallets.md b/Subwallets.md index bfd66ca..569be7f 100644 --- a/Subwallets.md +++ b/Subwallets.md @@ -121,5 +121,13 @@ wallet’s search like this: $ mmgen-txsign --subseeds=144 *.rawtx This is basically all you need to know about subwallets. For live versions of -the above examples that can be run as-is, see commits 7538a94, d1b8aef and -82086c9. +the above examples that can be run as-is, see commits [`7538a94`][c1], +[`d1b8aef`][c2 ]and [`82086c9`][c3]. + +For more detailed usage information, see the [`mmgen-subwalletgen` help +screen][sh]. + +[c1]: https://github.com/mmgen/mmgen/commit/7538a9460e897b9b23d8ac58853c33713334043f +[c2]: https://github.com/mmgen/mmgen/commit/d1b8aefde6d3a13337cbe3147d9913eb09b6765b +[c3]: https://github.com/mmgen/mmgen/commit/82086c9936843dc43c1892b672cdf1680763ee84 +[sh]: https://github.com/mmgen/mmgen/wiki/subwalletgen-[MMGen-command-help].md