From fa0c266aaf9c76681905e5b2f2575e889cdf9b36 Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Wed, 22 Nov 2023 10:38:48 +0000 Subject: [PATCH] update documentation from wiki --- README.md | 4 ++-- .../Install-MMGen-Wallet-on-Linux.md | 6 +++--- .../Getting-Started-with-MMGen-Wallet.md | 10 ++++----- ...en-Wallet-Quick-Start-with-Regtest-Mode.md | 6 +++--- ...Keys-Without-the-MMGen-Wallet-Software.md} | 17 ++++++++------- doc/wiki/using-mmgen-wallet/Test-Suite.md | 21 ++++++++++--------- .../XOR-Seed-Splitting-Theory-and-Practice.md | 4 ++-- mmgen/data/version | 2 +- 8 files changed, 37 insertions(+), 33 deletions(-) rename doc/wiki/using-mmgen-wallet/{Recovering-Your-Keys-Without-the-MMGen-Software.md => Recovering-Your-Keys-Without-the-MMGen-Wallet-Software.md} (96%) diff --git a/README.md b/README.md index 7dfeceac..431bd1a1 100644 --- a/README.md +++ b/README.md @@ -202,8 +202,8 @@ Donate: [8]: https://github.com/mmgen/MMGenLive [9]: https://mmgen.org/images/rxvt-txcreate.jpg [Q]: ../../wiki/MMGen-Wallet-Quick-Start-with-Regtest-Mode -[K]: ../../wiki/Recovering-Your-Keys-Without-the-MMGen-Software -[S]: ../../wiki/Recovering-Your-Keys-Without-the-MMGen-Software#a_mh +[K]: ../../wiki/Recovering-Your-Keys-Without-the-MMGen-Wallet-Software +[S]: ../../wiki/Recovering-Your-Keys-Without-the-MMGen-Wallet-Software#a_mh [F]: ../../wiki/Altcoin-and-Forkcoin-Support [W]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki [ew]: https://github.com/spesmilo/electrum/blob/1.9.5/lib/mnemonic.py diff --git a/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md b/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md index 76aded82..a3f17d8a 100644 --- a/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md +++ b/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md @@ -54,8 +54,8 @@ If not running in a virtual environment, make sure that `~/.local/bin` is in `/usr` or `/usr/local`. ```text -$ git clone https://github.com/mmgen/mmgen.git -$ cd mmgen +$ git clone https://github.com/mmgen/mmgen-wallet.git +$ cd mmgen-wallet $ python3 -m build --no-isolation $ python3 -m pip install --upgrade dist/*.whl # see 'Install Note' below $ cd .. @@ -93,7 +93,7 @@ following steps: > -i` and the Python packages with `python3 -m pip install`. Congratulations, your installation is now complete! You can now proceed to -[**Getting Started with MMGen**][gs]. +[**Getting Started with MMGen Wallet**][gs]. [01]: Install-Bitcoind [02]: Install-Bitcoind-from-Source-on-Linux diff --git a/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md b/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md index 6fd3d515..73aac302 100644 --- a/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md +++ b/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md @@ -1114,16 +1114,16 @@ If you’ve deleted or lost your local copy of the MMGen Wallet repository, clon it again from Github, Gitlab or mmgen.org: ```text -$ git clone https://github.com/mmgen/mmgen.git -$ git clone https://gitlab.com/mmgen/mmgen.git -$ git clone https://mmgen.org/project/mmgen/mmgen.git +$ git clone https://github.com/mmgen/mmgen-wallet.git +$ git clone https://gitlab.com/mmgen/mmgen-wallet.git +$ git clone https://mmgen.org/project/mmgen/mmgen-wallet.git ``` Enter the repository and check out the master branch. Pull the latest changes from the remote repository: ```text -$ cd mmgen +$ cd mmgen-wallet $ git checkout master $ git pull ``` @@ -1142,7 +1142,7 @@ $ python3 -m pip install user --upgrade dist/*.whl [01]: Tracking-and-spending-ordinary-Bitcoin-addresses [02]: https://tpfaucet.appspot.com -[03]: Recovering-Your-Keys-Without-the-MMGen-Software +[03]: Recovering-Your-Keys-Without-the-MMGen-Wallet-Software [04]: MMGen-Wallet-Quick-Start-with-Regtest-Mode [05]: Key-address-files [06]: Subwallets diff --git a/doc/wiki/using-mmgen-wallet/MMGen-Wallet-Quick-Start-with-Regtest-Mode.md b/doc/wiki/using-mmgen-wallet/MMGen-Wallet-Quick-Start-with-Regtest-Mode.md index 9150a670..eee7c508 100644 --- a/doc/wiki/using-mmgen-wallet/MMGen-Wallet-Quick-Start-with-Regtest-Mode.md +++ b/doc/wiki/using-mmgen-wallet/MMGen-Wallet-Quick-Start-with-Regtest-Mode.md @@ -1,9 +1,9 @@ -MMGen’s regtest mode, also known as Bob and Alice mode, uses the Bitcoin +MMGen Wallet’s regtest mode, also known as Bob and Alice mode, uses the Bitcoin daemon’s regression test feature to create a virtual network of two users who transact on a private blockchain. -All of MMGen’s functionality is available in regtest mode, making it an ideal -way to learn to use MMGen Wallet without risking real coins. +All of MMGen Wallet’s functionality is available in regtest mode, making it an +ideal way to learn to use 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 applicable MMGen Wallet command. diff --git a/doc/wiki/using-mmgen-wallet/Recovering-Your-Keys-Without-the-MMGen-Software.md b/doc/wiki/using-mmgen-wallet/Recovering-Your-Keys-Without-the-MMGen-Wallet-Software.md similarity index 96% rename from doc/wiki/using-mmgen-wallet/Recovering-Your-Keys-Without-the-MMGen-Software.md rename to doc/wiki/using-mmgen-wallet/Recovering-Your-Keys-Without-the-MMGen-Wallet-Software.md index a09768ed..b55157d8 100644 --- a/doc/wiki/using-mmgen-wallet/Recovering-Your-Keys-Without-the-MMGen-Software.md +++ b/doc/wiki/using-mmgen-wallet/Recovering-Your-Keys-Without-the-MMGen-Wallet-Software.md @@ -18,11 +18,12 @@ mind: “What if I have funds in MMGen Wallet and I lose the software? How do I recover my coins?” Let’s take this scenario to its logical extreme and assume you’ve lost all -backup copies of the software, MMGen’s project page has disappeared from both -[Github][04] and [Gitlab][05] (or been hacked) and no other repositories or -copies are available on the Internet. The following tutorial will show you how -to recover the private keys for your coin addresses in the event this unlikely -combination of circumstances ever occurs. +backup copies of the software, the MMGen Wallet project page has disappeared +from all of [Github][04], [Gitlab][05], [Gitflic][06] and [mmgen.org][07] (or +been hacked), and no other verifiable repositories or copies are available on +the Internet. The following tutorial will show you how to recover the private +keys for your coin addresses in the event this very unlikely combination of +circumstances ever occurs. In addition to private keys, this tutorial can also be used to recover passwords generated with the `mmgen-passgen` command. @@ -503,5 +504,7 @@ False [01]: https://github.com/casascius/Bitcoin-Address-Utility [02]: https://github.com/matja/bitcoin-tool [03]: https://github.com/spesmilo/electrum/blob/1.9.5/lib/mnemonic.py -[04]: https://github.com/mmgen/mmgen -[05]: https://gitlab.com/mmgen/mmgen +[04]: https://github.com/mmgen/mmgen-wallet +[05]: https://gitlab.com/mmgen/mmgen-wallet +[06]: https://gitflic.ru/project/mmgen/mmgen-wallet +[07]: https://mmgen.org/project/mmgen/mmgen-wallet diff --git a/doc/wiki/using-mmgen-wallet/Test-Suite.md b/doc/wiki/using-mmgen-wallet/Test-Suite.md index 9705405b..0cf68f07 100644 --- a/doc/wiki/using-mmgen-wallet/Test-Suite.md +++ b/doc/wiki/using-mmgen-wallet/Test-Suite.md @@ -1,9 +1,10 @@ ## Introduction In addition to low-level subsystems, the suite tests the overall operation of -MMGen’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. +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. BTC-only testing requires installation of Bitcoin Core and pycoin only, while altcoin testing requires additional helper programs and libraries, installation @@ -56,17 +57,17 @@ Install Pycoin: ```text # online install: -$ python3 -m pip install --user pycoin +$ python3 -m pip install pycoin # offline install: $ python3 -m pip download pycoin # online -$ python3 -m pip install --user --no-build-isolation pycoin-*.tar.gz # offline +$ python3 -m pip install --no-build-isolation pycoin-*.tar.gz # offline ``` Install Pylint: ```text -$ python3 -m pip install --user pylint +$ python3 -m pip install pylint ``` CD to the MMGen Wallet repository root and build without installing: @@ -135,8 +136,8 @@ may also be started and stopped manually at the DOS or MSYS2 prompt as follows #### Monero-Python ```text -$ python3 -m pip install --user pycryptodomex ipaddress varint -$ python3 -m pip install --user --no-deps monero +$ python3 -m pip install pycryptodomex ipaddress varint +$ python3 -m pip install --no-deps monero ``` #### Vanitygen PlusPlus (forked from Vanitygen Plus) @@ -195,8 +196,8 @@ $ test/test-release.sh -F `test/test-release.sh` is just a simple shell script that invokes the test scripts with various options and arguments to ensure complete coverage of -MMGen’s functionality. Launch the script with the `-t` option to view the -invocations without running them. +MMGen Wallet’s functionality. Launch the script with the `-t` option to view +the invocations without running them. The test scripts themselves are all located in the `test/` directory and bear the `.py` extension. They may be run individually if desired. Options and diff --git a/doc/wiki/using-mmgen-wallet/XOR-Seed-Splitting-Theory-and-Practice.md b/doc/wiki/using-mmgen-wallet/XOR-Seed-Splitting-Theory-and-Practice.md index 6574e026..71212220 100644 --- a/doc/wiki/using-mmgen-wallet/XOR-Seed-Splitting-Theory-and-Practice.md +++ b/doc/wiki/using-mmgen-wallet/XOR-Seed-Splitting-Theory-and-Practice.md @@ -4,7 +4,7 @@ - [Deterministic Shares](#a_ds) - [Named Splits](#a_ns) - [Master Shares](#a_ms) -+ [Seed Splitting with MMGen](#a_ss) ++ [Seed Splitting with MMGen Wallet](#a_ss) ### XOR Seed Splitting: A Theoretical Introduction @@ -235,7 +235,7 @@ Also note that an additional field, `master`, has been appended to the share identifiers. This is to ensure that the shares of each master share split are unique, and differ from their non-master-share counterparts. -### Seed Splitting with MMGen +### Seed Splitting with MMGen Wallet MMGen Wallet implements the seed splitting and joining functionality described above via the commands [`mmgen-seedsplit`][SS] and [`mmgen-seedjoin`][SJ]. diff --git a/mmgen/data/version b/mmgen/data/version index 107f3ae6..cc684fd0 100644 --- a/mmgen/data/version +++ b/mmgen/data/version @@ -1 +1 @@ -14.0.dev23 +14.0.dev24