mmgen/mmgen-wallet
1
0
Fork 0
Code Issues Pull requests Projects Releases 28 Packages Wiki Activity

documentation updates

Browse source
This commit is contained in:
The MMGen Project 2025-02-27 14:14:05 +00:00
commit 0028c2e42f
Signed by: mmgen
GPG key ID: 3F8B1861E32B7DA2
5 changed files with 27 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/wiki/Altcoin-and-Forkcoin-Support.md
View file

@ -77,7 +77,8 @@ option for more complete information.
#### <a id="a_tx">Transacting and other basic operations</a>
Basic operations with ETH, ETC and ERC20 tokens work as described in the
[Getting Started][bo] guide, with some differences. Please note the following:
[**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` option with the token symbol as parameter for all token

4
doc/wiki/Install-Bitcoind.md
View file

@ -84,7 +84,7 @@ $ bitcoind
# Bitcoin Cash Node:
$ mkdir $APPDATA/Bitcoin-Cash-Node
$ bitcoind-bchn --listen=0 --rpcport=8432 --datadir=$APPDATA/Bitcoin-Cash-Node --usecashaddr=0
$ bitcoind-bchn --listen=0 --rpcport=8432 --datadir=$APPDATA/Bitcoin-Cash-Node
# Litecoin
$ litecoind
@ -105,7 +105,7 @@ $ bitcoind --daemon
$ mkdir ~/.bitcoin-bchn
$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux
$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS
$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --usecashaddr=0 --datadir="$BCH_DATADIR"
$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --datadir="$BCH_DATADIR"
# Litecoin:
$ litecoind --daemon

2
doc/wiki/Install-MMGen-Wallet-on-Linux-or-macOS.md
View file

@ -11,7 +11,7 @@ For computers with no Internet connection, see **Note for offline machines** bel
#### Debian/Ubuntu:
```text
$ sudo apt-get install curl git gcc libtool make autoconf libgmp-dev libssl-dev libpcre3-dev libmpfr-dev libmpc-dev python3-dev python3-pip libsecp256k1-dev
$ sudo apt-get install curl git gcc libtool make autoconf libgmp-dev libssl-dev libpcre2-dev libmpfr-dev libmpc-dev python3-dev python3-pip libsecp256k1-dev
```
#### Arch Linux:

15
doc/wiki/MMGen-Wallet-Quick-Start-with-Regtest-Mode.md
View file

@ -1,9 +1,10 @@
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.
MMGen Wallet’s regtest mode, also known as Bob and Alice mode, uses the
regression test feature of the Bitcoin, Litecoin, and Bitcoin Cash daemons
to create a virtual network of two users who transact on a private blockchain.
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.
All of MMGen Wallet’s functionality for these coins is available in regtest
mode, making it an ideal way to learn to use MMGen Wallet without risking real
assets.
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.
@ -128,7 +129,7 @@ Transaction sent: 78ca853816b55527b42ca8784c887a5f482c752522f914d2f17d6afcd8a3b0
to create, sign and send transactions in one operation. In normal, cold
wallet mode, you’d create the transaction with `mmgen-txcreate`, sign it
offline with `mmgen-txsign` and send it with `mmgen-txsend`. Use of these
commands is explained in detail in the [**Getting Started**][G] guide.
commands is explained in detail in the [**Getting Started**][gs] guide.
13. View the transaction in the mempool:
@ -224,4 +225,4 @@ TOTAL: 510 BTC
$ mmgen-regtest stop
```
[G]: Getting-Started-with-MMGen-Wallet.md#a_ct
[gs]: Getting-Started-with-MMGen-Wallet.md#a_ct

51
doc/wiki/Test-Suite.md
View file

@ -38,20 +38,6 @@ Every time the container is started, you may need to create the files afresh:
### BTC-only testing
Clone the Bitcoin Core repo somewhere on your system:
```text
$ git clone https://github.com/bitcoin/bitcoin
```
Install the Bitcoin Core daemon [(source)][sd] [(binaries)][bd].
Point the test suite to your copy of the Bitcoin Core repo:
```text
$ export CORE_REPO_ROOT=/path/to/bitcoin/core/repo
```
Install Pycoin:
```text
@ -63,12 +49,6 @@ $ python3 -m pip download pycoin # online
$ python3 -m pip install --no-build-isolation pycoin-*.tar.gz # offline
```
Install Pylint:
```text
$ python3 -m pip install pylint
```
CD to the MMGen Wallet repository root and build without installing:
```text
@ -135,10 +115,16 @@ may also be started and stopped manually at the DOS or MSYS2 prompt as follows
#### Monero-Python
```text
$ python3 -m pip install pycryptodomex ipaddress varint
$ python3 -m pip install pycryptodome ipaddress varint
$ python3 -m pip install --no-deps monero
```
#### Eth-Keys
```text
$ python3 -m pip install eth-keys
```
#### Vanitygen PlusPlus (forked from Vanitygen Plus)
```text
@ -157,27 +143,18 @@ $ cd ..
$ sudo apt-get install golang # skip this if Go is already installed
$ git clone https://github.com/FiloSottile/zcash-mini
$ cd zcash-mini
$ sed -e "s@github.com/FiloSottile/@@" -i main.go
$ sed -e "s@github.com/FiloSottile/@@" -i zcash/address.go
$ sed -e "s@github.com/btcsuite@zcash-mini@" -i zcash/address.go
$ sed -e "s@golang.org/x@zcash-mini@" -i zcash/address.go
$ mv vendor/github.com/btcsuite/btcutil .
$ mv vendor/golang.org/x/crypto .
$ go mod init zcash-mini
$ go mod tidy
$ go build -mod=mod # or just ’go build’
$ go build -mod=mod
$ sudo install --strip ./zcash-mini /usr/local/bin
$ cd ..
```
#### Ethkey
On Arch Linux and ArchLinuxArm systems, the ‘ethkey’ utility is included in the
OpenEthereum package:
```text
$ pacman -S openethereum
```
For 64-bit Windows, Linux and macOS systems, ‘ethkey’ can be found in the zip
archives distributed with [this release][oz].
For other systems (i.e. Debian/Ubuntu ARM), tests involving ‘ethkey’ are skipped.
#### Monero note
The Monero test (`test/test-release.sh xmr`) creates a private network and