From 182e4ddb969672788beeac300d38ceab5245a462 Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Thu, 14 Oct 2021 13:28:15 +0000 Subject: [PATCH] Version 13.0.0 updates --- Altcoin-and-Forkcoin-Support.md | 4 -- Install-MMGen-on-Linux.md | 27 ++++++----- Install-MMGen-on-Microsoft-Windows.md | 65 ++++++++++++++------------ MMGen-Quick-Start-with-Regtest-Mode.md | 3 +- Test-Suite.md | 15 +++--- addrgen-[MMGen-command-help].md | 2 +- addrimport-[MMGen-command-help].md | 2 +- autosign-[MMGen-command-help].md | 8 ++-- keygen-[MMGen-command-help].md | 2 +- passchg-[MMGen-command-help].md | 2 +- passgen-[MMGen-command-help].md | 2 +- regtest-[MMGen-command-help].md | 2 +- seedjoin-[MMGen-command-help].md | 2 +- seedsplit-[MMGen-command-help].md | 2 +- split-[MMGen-command-help].md | 2 +- subwalletgen-[MMGen-command-help].md | 2 +- tool(usage)-[MMGen-command-help].md | 2 +- tool-[MMGen-command-help].md | 2 +- txbump-[MMGen-command-help].md | 2 +- txcreate-[MMGen-command-help].md | 2 +- txdo-[MMGen-command-help].md | 2 +- txsend-[MMGen-command-help].md | 2 +- txsign-[MMGen-command-help].md | 2 +- walletchk-[MMGen-command-help].md | 2 +- walletconv-[MMGen-command-help].md | 2 +- walletgen-[MMGen-command-help].md | 2 +- xmrwallet-[MMGen-command-help].md | 2 +- 27 files changed, 82 insertions(+), 82 deletions(-) diff --git a/Altcoin-and-Forkcoin-Support.md b/Altcoin-and-Forkcoin-Support.md index d0072be..211c0e4 100644 --- a/Altcoin-and-Forkcoin-Support.md +++ b/Altcoin-and-Forkcoin-Support.md @@ -1,9 +1,5 @@ ## Table of Contents -***NOTE: the following instructions apply to the current master branch. If -you’re running the stable version of MMGen, check out the stable tag and -refer to the version of this file located in `doc/wiki/using-mmgen`.*** - #### [Introduction](#a_g) #### [Ethereum (ETH), Ethereum Classic (ETC) and ERC20 Tokens](#a_eth) diff --git a/Install-MMGen-on-Linux.md b/Install-MMGen-on-Linux.md index ac48747..4dc952b 100644 --- a/Install-MMGen-on-Linux.md +++ b/Install-MMGen-on-Linux.md @@ -1,7 +1,3 @@ -***NOTE: the following instructions apply to the current master branch. If -you’re running the stable version of MMGen, check out the stable tag and -refer to the version of this file located in `doc/wiki/install-linux`.*** - *NOTE: the instructions on this page are for a Bitcoin-only setup. For altcoin support, additional installation steps are required. See [**Altcoin and Forkcoin Support**][af] for more information.* @@ -28,15 +24,18 @@ For computers with no Internet connection, see **Note for offline machines** bel $ git clone https://github.com/mmgen/mmgen.git $ cd mmgen + $ git checkout stable_linux # see 'Note' below $ python3 -m build --no-isolation $ python3 -m pip install --user --upgrade dist/*.whl # see 'Testing Note' below $ cd .. -**Note:** Bear in mind that while the tip of `master` is always tested on -Linux before being pushed to the public repository, 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. +**Note:** if you want to use features that have appeared since the latest +`stable_linux` release, then you can omit the `git checkout` step and remain on +the `master` branch. Please bear in mind, however, that while the tip of +`master` is always tested on Linux before being pushed to the public repository, +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. Install your coin daemon(s). To install prebuilt binaries, go [here][01]. To install from source, go [here][02]. @@ -69,11 +68,11 @@ the following steps: > Debian/Ubuntu packages with `sudo dpkg -i` and the Python packages with > `python3 -m pip install --user`. > -> Clone the [secp256k1][ec] repository and copy it to `~/.cache` directory on -> the offline machine (or copy it from your online machine’s `~/.cache`). -> Copy the MMGen repository to the offline machine and install MMGen as -> described above. If your online and offline machines have different -> architecture, then make sure to clean up any build/dist files in the +> Clone the [secp256k1][ec] repository and copy it to `~/.cache/mmgen` +> directory on the offline machine (or copy it from your online machine’s +> `~/.cache/mmgen`). Copy the MMGen repository to the offline machine and +> install MMGen as described above. If your online and offline machines have +> different architecture, make sure to clean up any build/dist files in the > repositories before installing (in `secp256k1` this is accomplished by `make > clean`). diff --git a/Install-MMGen-on-Microsoft-Windows.md b/Install-MMGen-on-Microsoft-Windows.md index 12113bc..ee1995e 100644 --- a/Install-MMGen-on-Microsoft-Windows.md +++ b/Install-MMGen-on-Microsoft-Windows.md @@ -107,7 +107,7 @@ will produce a listing of the same directory. >> >> >> ->> +>> > Copy the files to your offline machine, replacing the originals at > `C:\msys64\var\lib\pacman\sync`. @@ -139,7 +139,7 @@ this folder. > Now reissue the `pacman -Sup` command, which will generate a much longer list > of URLs this time. Repeat the same download/copy/install procedure with the -> new URLs, only using a new `packages2` directory instead of `packages1`. +> new URLs, only using a new `packages2` directory instead of `packages1`. > Your system upgrade is now complete. @@ -198,25 +198,15 @@ path): Save and exit. Close and reopen the terminal window to update your working environment. -### 6. Install MMGen dependencies not provided by MSYS2 +### 6. Install the Python ECDSA library (offline install only) -Four of MMGen’s Python dependencies, `ecdsa`, `py_ecc`, `mypy_extensions` and -`socks`, are not provided by MSYS2. If you’re online, you can install them -using the pip package installer as follows: +On your online machine: - $ pip3 install --no-deps ecdsa==0.13 py_ecc==1.6.0 mypy_extensions==0.4.1 socks + $ pip3 download ecdsa -For an offline install, first download the packages on your online machine like -this: +Copy the downloaded file to your offline machine and install: - $ pip3 download --no-deps ecdsa==0.13 py_ecc==1.6.0 mypy_extensions==0.4.1 socks - -Then transfer the downloaded files to your offline machine, `cd` to the directory -containing the files and install them as follows: - - $ pip3 install --no-deps *.whl - $ tar zxvf socks-0.tar.gz - $ (cd socks-0; python3 setup.py install) + $ pip3 install --user ecdsa-*.whl ### 7. Install the standalone scrypt package (required for strong password hashing) @@ -256,21 +246,18 @@ Save the file and exit the editor. Now build and install: $ python3 setup.py build --compiler=mingw32 $ python3 setup.py install -### 8. Install the secp256k1 library +### 8. Clone and copy the secp256k1 library (offline install only) -On your online machine, clone the repository: +On your online machine, clone the secp256k1 repository from Github: $ git clone https://github.com/bitcoin-core/secp256k1.git -If you’re doing an offline install, copy the cloned secp256k1 directory -to your offline machine. +On your offline machine, create a magic location and copy the cloned secp256k1 +directory into it: -Enter the directory, configure, build and install: - - $ cd secp256k1 - $ ./autogen.sh - $ ./configure --disable-dependency-tracking - $ mingw32-make.exe install MAKE=mingw32-make LIBTOOL=$(which libtool) + $ mkdir -p ~/.cache/mmgen + $ cp -a /path/to/secp256k1/repo/secp256k1 ~/.cache/mmgen + $ ls ~/.cache/mmgen/secp256k1/autogen.sh # check that the location is correct ### 9. Install MMGen @@ -280,8 +267,8 @@ repository: $ git clone https://github.com/mmgen/mmgen Cloning into ’mmgen’... -If you’re doing an offline install, you can then copy the cloned mmgen directory -to your offline machine. +If you’re doing an offline install, then copy the cloned mmgen directory to +your offline machine. Enter the directory and install: @@ -298,7 +285,23 @@ before being pushed to the public repository, it’s not guaranteed to install o run on MSYS2. Installation or runtime issues may also arise due to missing dependencies or installation steps not yet covered in the documentation. -### 10. Install and launch your coin daemons +### 10. Install Python Ethereum dependencies (Ethereum users only) + +If you’ll be using MMGen with Ethereum, then you must install a few +dependencies. From the MMGen repository root, type the following: + + $ pip3 install --no-deps --user -r eth-requirements.txt + +For an offline install, do this instead: + + $ pip3 download --no-deps -r eth-requirements.txt + +Then transfer the downloaded files to your offline machine, `cd` to the +directory containing the files and install them as follows: + + $ pip3 install --no-deps --user *.whl + +### 11. Install and launch your coin daemons At this point your MMGen installation will be able to generate wallets, along with keys and addresses for all supported coins. However, if you intend to do @@ -326,7 +329,7 @@ Typically you’ll wish to launch OpenEthereum as follows: More information on OpenEthereum’s command-line options can be found [here][pl]. -### 11. You’re done! +### 12. You’re done! Congratulations, your installation is now complete, and you can proceed to [**Getting Started with MMGen**][gs]. Note that all features supported by diff --git a/MMGen-Quick-Start-with-Regtest-Mode.md b/MMGen-Quick-Start-with-Regtest-Mode.md index 8a2b64f..b7148cf 100644 --- a/MMGen-Quick-Start-with-Regtest-Mode.md +++ b/MMGen-Quick-Start-with-Regtest-Mode.md @@ -6,8 +6,7 @@ All of MMGen’s functionality is available in regtest mode, making it an ideal way to learn to use the MMGen wallet without risking real coins. To send a transaction or perform any other operation as Bob or Alice, just add -the `--bob` or `--alice` option to the relevant MMGen command. MMGen will start -and stop the Bitcoin daemon automatically as needed. +the `--bob` or `--alice` option to the relevant MMGen command. This tutorial provides a quick, hands-on introduction. diff --git a/Test-Suite.md b/Test-Suite.md index 19db654..b0fe414 100644 --- a/Test-Suite.md +++ b/Test-Suite.md @@ -26,7 +26,7 @@ loop devices. You may enable them in the config file as follows: lxc.cgroup2.devices.allow = b 7:1 rwm # /dev/loop1 lxc.cgroup2.devices.allow = b 7:2 rwm # /dev/loop2 -Every time the container is started, the files must be created afresh: +Every time the container is started, you may need to create the files afresh: # mknod /dev/loop0 b 7 0 # mknod /dev/loop1 b 7 1 @@ -62,21 +62,24 @@ Install [OpenEthereum, Parity, Geth, the Ethereum dependencies][oe] and optionally the [Solidity compiler][sc] as described on the Altcoin-and-Forkcoin-Support page. +The XMR test sets up a local SOCKS proxy to test transaction relaying, so make +sure you can SSH to localhost without a password. Alternatively, you may set +up the proxy yourself with the following command: + + $ ssh -fxN -D localhost:9060 localhost + In addition, you must install the following helper programs and libraries (MSYS2 users can omit MoneroPy and Zcash-Mini): #### Pycoin - $ git clone https://github.com/richardkiss/pycoin - $ cd pycoin - $ sudo python3 ./setup.py install - $ cd .. + $ python3 -m pip install --user pycoin #### MoneroPy $ git clone https://github.com/bigreddmachine/MoneroPy $ cd MoneroPy - $ sudo python3 ./setup.py install + $ sudo python3 setup.py install $ cd .. #### Vanitygen Plus diff --git a/addrgen-[MMGen-command-help].md b/addrgen-[MMGen-command-help].md index 3aca9d1..ea9ee08 100644 --- a/addrgen-[MMGen-command-help].md +++ b/addrgen-[MMGen-command-help].md @@ -116,4 +116,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-ADDRGEN(1) + MMGEN v13.0.0 October 2021 MMGEN-ADDRGEN(1) diff --git a/addrimport-[MMGen-command-help].md b/addrimport-[MMGen-command-help].md index 0d24f9f..ff8d878 100644 --- a/addrimport-[MMGen-command-help].md +++ b/addrimport-[MMGen-command-help].md @@ -18,4 +18,4 @@ The --batch and --rescan options cannot be used together. - MMGEN v0.12.1 June 2020 MMGEN-ADDRIMPORT(1) + MMGEN v13.0.0 October 2021 MMGEN-ADDRIMPORT(1) diff --git a/autosign-[MMGen-command-help].md b/autosign-[MMGen-command-help].md index 5cd78ca..c670e18 100644 --- a/autosign-[MMGen-command-help].md +++ b/autosign-[MMGen-command-help].md @@ -35,11 +35,11 @@ If invoked with 'wait', the program waits in a loop, mounting, signing and unmounting every time the removable device is inserted. - On supported platforms (currently Orange Pi and Raspberry Pi boards), the - status LED indicates whether the program is busy or in standby mode, i.e. + On supported platforms (currently Orange Pi, Rock Pi and Raspberry Pi boards), + the status LED indicates whether the program is busy or in standby mode, i.e. ready for device insertion or removal. - The removable device must have a partition labeled MMGEN_TX and a user- + The removable device must have a partition labeled MMGEN_TX with a user- writable directory '/tx', where unsigned MMGen transactions are placed. On the signing machine the mount point '/mnt/tx' must exist and /etc/fstab @@ -68,4 +68,4 @@ This command is currently available only on Linux-based platforms. - MMGEN v0.12.199 October 2021 MMGEN-AUTOSIGN(1) + MMGEN v13.0.0 October 2021 MMGEN-AUTOSIGN(1) diff --git a/keygen-[MMGen-command-help].md b/keygen-[MMGen-command-help].md index 26b2484..294f253 100644 --- a/keygen-[MMGen-command-help].md +++ b/keygen-[MMGen-command-help].md @@ -120,4 +120,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-KEYGEN(1) + MMGEN v13.0.0 October 2021 MMGEN-KEYGEN(1) diff --git a/passchg-[MMGen-command-help].md b/passchg-[MMGen-command-help].md index de26145..e59f7c4 100644 --- a/passchg-[MMGen-command-help].md +++ b/passchg-[MMGen-command-help].md @@ -50,4 +50,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-PASSCHG(1) + MMGEN v13.0.0 October 2021 MMGEN-PASSCHG(1) diff --git a/passgen-[MMGen-command-help].md b/passgen-[MMGen-command-help].md index b41ca55..649f6d9 100644 --- a/passgen-[MMGen-command-help].md +++ b/passgen-[MMGen-command-help].md @@ -99,4 +99,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-PASSGEN(1) + MMGEN v13.0.0 October 2021 MMGEN-PASSGEN(1) diff --git a/regtest-[MMGen-command-help].md b/regtest-[MMGen-command-help].md index 027218b..e4cdb6c 100644 --- a/regtest-[MMGen-command-help].md +++ b/regtest-[MMGen-command-help].md @@ -24,4 +24,4 @@ is first argument) - MMGEN v0.12.199 October 2021 MMGEN-REGTEST(1) + MMGEN v13.0.0 October 2021 MMGEN-REGTEST(1) diff --git a/seedjoin-[MMGen-command-help].md b/seedjoin-[MMGen-command-help].md index 9d8b1ff..e6d2733 100644 --- a/seedjoin-[MMGen-command-help].md +++ b/seedjoin-[MMGen-command-help].md @@ -60,4 +60,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-SEEDJOIN(1) + MMGEN v13.0.0 October 2021 MMGEN-SEEDJOIN(1) diff --git a/seedsplit-[MMGen-command-help].md b/seedsplit-[MMGen-command-help].md index 63e4cf9..e26eb1b 100644 --- a/seedsplit-[MMGen-command-help].md +++ b/seedsplit-[MMGen-command-help].md @@ -141,4 +141,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-SEEDSPLIT(1) + MMGEN v13.0.0 October 2021 MMGEN-SEEDSPLIT(1) diff --git a/split-[MMGen-command-help].md b/split-[MMGen-command-help].md index b1f9824..43c05ba 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.199 October 2021 MMGEN-SPLIT(1) + MMGEN v13.0.0 October 2021 MMGEN-SPLIT(1) diff --git a/subwalletgen-[MMGen-command-help].md b/subwalletgen-[MMGen-command-help].md index f052236..af76906 100644 --- a/subwalletgen-[MMGen-command-help].md +++ b/subwalletgen-[MMGen-command-help].md @@ -94,4 +94,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-SUBWALLETGEN(1) + MMGEN v13.0.0 October 2021 MMGEN-SUBWALLETGEN(1) diff --git a/tool(usage)-[MMGen-command-help].md b/tool(usage)-[MMGen-command-help].md index 4ecfdc1..dcafae4 100644 --- a/tool(usage)-[MMGen-command-help].md +++ b/tool(usage)-[MMGen-command-help].md @@ -132,4 +132,4 @@ Same as above, but use a pipe: $ echo "deadbeefcafe" | mmgen-tool hexreverse - - MMGEN v0.12.199 October 2021 MMGEN-TOOL(USAGE)(1) + MMGEN v13.0.0 October 2021 MMGEN-TOOL(USAGE)(1) diff --git a/tool-[MMGen-command-help].md b/tool-[MMGen-command-help].md index 7a444be..cbc94e5 100644 --- a/tool-[MMGen-command-help].md +++ b/tool-[MMGen-command-help].md @@ -168,4 +168,4 @@ Type 'mmgen-tool help ' for help on a particular command - MMGEN v0.12.199 October 2021 MMGEN-TOOL(1) + MMGEN v13.0.0 October 2021 MMGEN-TOOL(1) diff --git a/txbump-[MMGen-command-help].md b/txbump-[MMGen-command-help].md index bcd7520..4994b24 100644 --- a/txbump-[MMGen-command-help].md +++ b/txbump-[MMGen-command-help].md @@ -84,4 +84,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-TXBUMP(1) + MMGEN v13.0.0 October 2021 MMGEN-TXBUMP(1) diff --git a/txcreate-[MMGen-command-help].md b/txcreate-[MMGen-command-help].md index 55c4d1b..46f4b08 100644 --- a/txcreate-[MMGen-command-help].md +++ b/txcreate-[MMGen-command-help].md @@ -53,4 +53,4 @@ a plain decimal number, or as satoshis per byte, using an integer followed by 's', for satoshi. - MMGEN v0.12.199 October 2021 MMGEN-TXCREATE(1) + MMGEN v13.0.0 October 2021 MMGEN-TXCREATE(1) diff --git a/txdo-[MMGen-command-help].md b/txdo-[MMGen-command-help].md index 0c8f98c..8f1fc90 100644 --- a/txdo-[MMGen-command-help].md +++ b/txdo-[MMGen-command-help].md @@ -115,4 +115,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.199 October 2021 MMGEN-TXDO(1) + MMGEN v13.0.0 October 2021 MMGEN-TXDO(1) diff --git a/txsend-[MMGen-command-help].md b/txsend-[MMGen-command-help].md index 38a47a3..75f8dea 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.1 June 2020 MMGEN-TXSEND(1) + MMGEN v13.0.0 October 2021 MMGEN-TXSEND(1) diff --git a/txsign-[MMGen-command-help].md b/txsign-[MMGen-command-help].md index 2549f07..6d77f8d 100644 --- a/txsign-[MMGen-command-help].md +++ b/txsign-[MMGen-command-help].md @@ -76,4 +76,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-TXSIGN(1) + MMGEN v13.0.0 October 2021 MMGEN-TXSIGN(1) diff --git a/walletchk-[MMGen-command-help].md b/walletchk-[MMGen-command-help].md index 595337a..d9f0cb2 100644 --- a/walletchk-[MMGen-command-help].md +++ b/walletchk-[MMGen-command-help].md @@ -49,4 +49,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-WALLETCHK(1) + MMGEN v13.0.0 October 2021 MMGEN-WALLETCHK(1) diff --git a/walletconv-[MMGen-command-help].md b/walletconv-[MMGen-command-help].md index 9d26069..e9d176c 100644 --- a/walletconv-[MMGen-command-help].md +++ b/walletconv-[MMGen-command-help].md @@ -59,4 +59,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-WALLETCONV(1) + MMGEN v13.0.0 October 2021 MMGEN-WALLETCONV(1) diff --git a/walletgen-[MMGen-command-help].md b/walletgen-[MMGen-command-help].md index 3a56dfe..46c3581 100644 --- a/walletgen-[MMGen-command-help].md +++ b/walletgen-[MMGen-command-help].md @@ -52,4 +52,4 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v0.12.1 June 2020 MMGEN-WALLETGEN(1) + MMGEN v13.0.0 October 2021 MMGEN-WALLETGEN(1) diff --git a/xmrwallet-[MMGen-command-help].md b/xmrwallet-[MMGen-command-help].md index 1fc9ffb..395a68f 100644 --- a/xmrwallet-[MMGen-command-help].md +++ b/xmrwallet-[MMGen-command-help].md @@ -135,4 +135,4 @@ Relay the created sweep transaction via a host on the Tor network: $ mmgen-xmrwallet --tx-relay-daemon=abcdefghijklmnop.onion:127.0.0.1:9050 relay *XMR*.sigtx - MMGEN v0.12.199 October 2021 MMGEN-XMRWALLET(1) + MMGEN v13.0.0 October 2021 MMGEN-XMRWALLET(1)