Browse Source

minor help screen fixes, update docs from wiki

The MMGen Project 5 months ago
parent
commit
0b214922c4

+ 62 - 0
doc/release-notes/release-notes-v14.0.0.md

@@ -0,0 +1,62 @@
+### MMGen Wallet Version 14.0.0 Release Notes
+
+This special release marks the MMGen Project’s 10th anniversary on Github.
+
+Though only one new noteworthy feature has appeared in MMGen Wallet since
+v13.3.0, users can benefit from numerous bugfixes, code cleanups, and
+installation and testing improvements, along with updated coin daemon support.
+Upgrading is therefore highly recommended:
+
+    $ pip3 install --upgrade mmgen-wallet
+
+Note that the code repository and package have been renamed to `mmgen-wallet`
+while the package toplevel currently remains `mmgen`.
+
+#### Notable new feature:
+
+ - b51868a5: support multiple loaded coin daemon wallets
+
+#### Other important changes:
+
+ - 159e1c8a, 5eb3eb84: build dynamically linked secp256k1 extension module
+ - 11b131fd, 01783f63: Pylint integration, Github workflows
+
+#### Minor changes and additions:
+
+ - 7135744d: use `pycryptodomex` instead of `pysha3` for `keccak_256` function
+ - efb3a3ff: new script `examples/whitepaper.py`: extract the Bitcoin whitepaper
+   from the blockchain
+
+Python requirement: >= 3.8 (tested on 3.8, 3.9 and 3.11)
+
+This release has been tested on the following platforms:
+
+    Debian 11 (Bullseye) / x86_64
+    Debian 12 (Bookworm) / x86_64
+    Ubuntu 20.04 (Focal) / x86_64
+    Ubuntu 22.04 (Jammy) / x86_64
+    Arch Linux 2023-11-20 (Python 3.11) / x86_64
+    ArchLinuxArm 2023-11-20 [userspace] (Python 3.11) / Rock Pi 4 (armv8)
+    Debian 11 (Bullseye) [Armbian] / Rock Pi 4 (armv8)
+    Debian 11 (Bullseye) [Armbian] / Orange Pi PC2 (armv8) [BTC + XMR autosign]
+    Windows 10 Enterprise / MSYS2 2023-10-26 / x86_64 [qemu]
+
+and with the following coin daemon versions:
+
+    Bitcoin Core 25.1.0
+    Bitcoin-Cash-Node 26.1.0
+    Litecoin Core 0.21.2.2
+    Monerod 0.18.3.1
+    Go-Ethereum (Geth) 1.13.4
+    Parity Ethereum 2.7.2
+
+Solc v0.8.7 is required for ERC20 token contract creation
+
+Altcoin address generation has been additionally tested using the following
+reference tools:
+
+    zcash-mini a2b3504 (https://github.com/FiloSottile/zcash-mini)
+    pycoin-0.92.20230326 (https://github.com/richardkiss/pycoin)
+    vanitygen-plusplus e7858035 (https://github.com/10gic/vanitygen-plusplus)
+    monero-python 1.1.1 (https://github.com/monero-ecosystem/monero-python)
+    ethkey (OpenEthereum 3.3.5)

+ 9 - 8
doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md

@@ -20,13 +20,14 @@ $ sudo apt-get install curl git gcc libtool make autoconf libgmp-dev libssl-dev
 $ sudo pacman -S curl git gcc libtool make autoconf automake autogen pcre python-pip libsecp256k1
 ```
 
-To keep your MMGen Wallet installation isolated from the rest of your Python
-packages, you may wish to use a [virtual environment][ve].  If you choose not to
-do this, you may get an ‘externally-managed-environment’ error when installing
-packages with `pip`.  In this case, you must add `--break-system-packages`
-to the `pip` command line.  Note that this will not in fact break any system
-packages, as pip installs all packages under the user’s home directory when
-invoked as user.
+You may wish to use a [virtual environment][vv] to keep your MMGen Wallet
+installation isolated from the rest of your Python packages.
+
+If you choose not to use a virtual environment, then you may need to add
+`--break-system-packages` to the `pip install` command line, depending on your
+Python version and Linux distribution.  Note that this will not in fact break
+any system packages, as pip installs all packages under the user’s home
+directory when invoked as user.
 
 ### Upgrade the Python build tools:
 
@@ -102,4 +103,4 @@ Congratulations, your installation is now complete!  You can now proceed to
 [pi]: https://pypi.org
 [af]: Altcoin-and-Forkcoin-Support
 [ec]: https://github.com/bitcoin-core/secp256k1.git
-[ve]: https://docs.python.org/3/library/venv.html
+[vv]: https://docs.python.org/3/library/venv.html

+ 3 - 4
doc/wiki/using-mmgen-wallet/Test-Suite.md

@@ -1,10 +1,9 @@
 ## Introduction
 
 In addition to low-level subsystems, the suite tests the overall operation of
-the MMGen Wallet’s commands by running them interactively as a user would.  Thus
-the test suite is useful not only for ensuring the MMGen Wallet system is
-correctly installed and working on your platform but also for demonstrating how
-it works.
+MMGen Wallet’s commands by running them interactively as a user would.  Thus the
+test suite is useful not only for ensuring the MMGen Wallet system is correctly
+installed and working on your platform but also for demonstrating how it works.
 
 BTC-only testing requires installation of Bitcoin Core and pycoin only, while
 altcoin testing requires additional helper programs and libraries, installation

+ 1 - 1
mmgen/data/version

@@ -1 +1 @@
-14.0.dev24
+14.0.dev25

+ 1 - 1
mmgen/main_autosign.py

@@ -57,7 +57,7 @@ opts_data = {
                                OPERATIONS
 
 gen_key - generate the wallet encryption key and copy it to the mountpoint
-          {asi.mountpoint!r} (as currently configured)
+          {asi.mountpoint} (as currently configured)
 setup   - generate both wallet encryption key and temporary signing wallet
 wait    - start in loop mode: wait-mount-sign-unmount-wait
 

+ 1 - 1
test/cmdtest.py

@@ -127,7 +127,7 @@ opts_data = {
 		('demo',True,'pexpect_spawn',True),
 	],
 	'text': {
-		'desc': 'Test suite for the MMGen suite',
+		'desc': 'High-level tests for the MMGen Wallet suite',
 		'usage':'[options] [command [..command]] | [command_group[.command_subgroup][:command]]',
 		'options': """
 -h, --help           Print this help message