update documentation from wiki
This commit is contained in:
parent
1ff7f3e5ba
commit
fe88ca8ed3
GPG key ID:
3F8B1861E32B7DA2
4 changed files with 68 additions and 62 deletions
|
|
@ -2,10 +2,10 @@
|
|||
|
||||
Install required Debian/Ubuntu packages:
|
||||
|
||||
$ sudo apt-get install autoconf git libgmp-dev libssl-dev libpcre3-dev libtool wipe
|
||||
$ sudo apt-get install python3-dev python3-ecdsa python3-pexpect python3-setuptools python3-cryptography python3-nacl python3-pip python3-gmpy2 python3-sha3
|
||||
$ sudo apt-get install autoconf git libgmp-dev libssl-dev libpcre3-dev libtool wipe curl
|
||||
$ sudo apt-get install python3-dev python3-ecdsa python3-pexpect python3-setuptools python3-cryptography python3-nacl python3-pip python3-gmpy2 python3-sha3 python3-requests python3-aiohttp
|
||||
|
||||
Using the [pip3][P] installer, install the Python scrypt library:
|
||||
Using the [pip3][P] installer, install the scrypt Python package:
|
||||
|
||||
$ sudo -H pip3 install scrypt
|
||||
|
||||
|
|
@ -25,37 +25,41 @@ Install MMGen:
|
|||
$ git clone https://github.com/mmgen/mmgen.git
|
||||
$ cd mmgen
|
||||
$ git checkout stable_linux # see 'Note' below
|
||||
$ sudo ./setup.py install
|
||||
$ ./setup.py build
|
||||
$ sudo ./setup.py install # see 'Testing Note' below
|
||||
$ cd ..
|
||||
|
||||
**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. But though the tip of `master` is always tested on Linux
|
||||
before being pushed to the public repository, please be aware that 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.
|
||||
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.
|
||||
|
||||
**Testing Note:** MMGen may be tested in place prior to installation. Refer to
|
||||
the [Test Suite][ts] wiki page for details.
|
||||
|
||||
Install your coin daemon(s). To install prebuilt binaries, go [here][01]. To
|
||||
install from source, go [here][02].
|
||||
|
||||
#### *Note for offline machines:*
|
||||
|
||||
> Naturally, your offline machine must be connected to the Internet to retrieve
|
||||
> and install the above packages as described above. This is normally not a
|
||||
> problem, as you can simply take the machine offline permanently after the
|
||||
> install is done, preferably removing or disabling its network interfaces.
|
||||
> Your offline machine must be connected to the Internet to retrieve and install
|
||||
> the above packages as described above. This is normally not a problem, as you
|
||||
> can simply take the machine offline permanently after the install is done,
|
||||
> preferably removing or disabling its network interfaces.
|
||||
|
||||
> However, if your machine is already offline and you wish to leave it that way,
|
||||
> or if it lacks a network interface entirely, then you’ll need to take roughly
|
||||
> the following steps:
|
||||
|
||||
>> If your offline and offline machines have the same architecture, then just
|
||||
>> If your offline and offline machines have the same architecture, then you can
|
||||
>> download the Debian/Ubuntu packages and their dependencies on your online
|
||||
>> machine using `apt-get download`. Otherwise, you must download the packages
|
||||
>> machine using `apt-get download`. Otherwise, you must retrieve the packages
|
||||
>> manually from `packages.debian.org` or `packages.ubuntu.com`.
|
||||
>>
|
||||
>> Download the Python packages using `pip3 download`.
|
||||
>> Download any required Python packages using `pip3 download`.
|
||||
>>
|
||||
>> Transfer the downloaded files and cloned Git repositories to your offline
|
||||
>> computer using a USB stick or other removable medium. Install the
|
||||
|
|
@ -63,11 +67,12 @@ install from source, go [here][02].
|
|||
>> install`. Install MMGen and the secp256k1 library from the copied Git
|
||||
>> repositories as described above.
|
||||
|
||||
Congratulations, your installation is now complete! Now proceed to [**Getting
|
||||
Started with MMGen**][gs].
|
||||
Congratulations, your installation is now complete! You can now proceed to
|
||||
[**Getting Started with MMGen**][gs].
|
||||
|
||||
[01]: Install-Bitcoind
|
||||
[02]: Install-Bitcoind-from-Source-on-Debian-or-Ubuntu-Linux
|
||||
[ts]: Test-Suite
|
||||
[gs]: Getting-Started-with-MMGen
|
||||
[03]: https://pypi.python.org/packages/source/p/pexpect/pexpect-3.1.tar.gz
|
||||
[P]: https://pypi.org/project/pip
|
||||
|
|
|
|||
|
|
@ -295,12 +295,12 @@ Enter the directory and install:
|
|||
|
||||
**Note:** if you want to use features that have appeared since the latest
|
||||
`stable_msys2` release, then you can omit the `git checkout` step and remain on
|
||||
the `master` branch. But please be aware that security vulnerabilities are more
|
||||
likely to be present in new code than in a stable release. In addition, while
|
||||
the tip of `master` is always tested on Linux before being pushed to the public
|
||||
repository, it’s not guaranteed to install or run on MSYS2. Installation or
|
||||
runtime issues may also arise due to missing dependencies or installation steps
|
||||
not yet covered in the documentation.
|
||||
the `master` branch. Please bear in mind, however, that security
|
||||
vulnerabilities are more likely to be present in new code than in a stable
|
||||
release. In addition, while the tip of `master` is always tested on Linux
|
||||
before being pushed to the public repository, it’s not guaranteed to install or
|
||||
run on MSYS2. Installation or runtime issues may also arise due to missing
|
||||
dependencies or installation steps not yet covered in the documentation.
|
||||
|
||||
### 11. Install and launch your coin daemons
|
||||
|
||||
|
|
@ -316,16 +316,16 @@ about adding to the Windows path, since your `PATH` variable was taken care of
|
|||
in Step 5. Note that the daemons must be installed on both your online and
|
||||
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 `/usr/local/bin`.
|
||||
To transact ETH, ETC or ERC20 tokens you’ll need the latest Windows
|
||||
`openethereum.exe` binary from the [OpenEthereum Github repository][og].
|
||||
OpenEthereum, unlike the other coin daemons, is installed on the online machine
|
||||
only. Copy the binary to your executable path, preferably `/usr/local/bin`.
|
||||
|
||||
Typically you’ll wish to launch Parity as follows:
|
||||
Typically you’ll wish to launch OpenEthereum as follows:
|
||||
|
||||
$ parity.exe --jsonrpc-apis=all
|
||||
$ openethereum.exe --jsonrpc-apis=all
|
||||
|
||||
More information on Parity’s command-line options can be found [here][pl].
|
||||
More information on OpenEthereum’s command-line options can be found [here][pl].
|
||||
|
||||
### 12. You’re done!
|
||||
|
||||
|
|
@ -335,17 +335,20 @@ MMGen on Linux, except for [autosigning][ax], are now supported on MSYS2 too.
|
|||
Please be aware of the following, however:
|
||||
|
||||
+ Non-ASCII filenames cannot be used with the Monero wallet syncing tool. This
|
||||
appears to be an issue with the Monero wallet RPC daemon rather than MMGen.
|
||||
is an issue with the Monero wallet RPC daemon rather than MMGen.
|
||||
|
||||
+ The Bitcoin-ABC daemon cannot handle non-ASCII pathnames. This is an issue
|
||||
with the Bitcoin-ABC implementation for Windows, not MMGen.
|
||||
|
||||
[mh]: https://www.msys2.org
|
||||
[mp]: https://sourceforge.net/projects/msys2
|
||||
[mw]: https://github.com/msys2/msys2/wiki
|
||||
[ov]: https://github.com/mmgen/mmgen/releases/tag/v0.9.8
|
||||
[sd]: https://download.sysinternals.com/files/SDelete.zip
|
||||
[pg]: https://github.com/paritytech/parity-ethereum/releases
|
||||
[og]: https://github.com/openethereum/openethereum/releases
|
||||
[di]: Deprecated-MSWin-Installation
|
||||
[ib]: Install-Bitcoind
|
||||
[gs]: Getting-Started-with-MMGen
|
||||
[pl]: Altcoin-and-Forkcoin-Support#a_par
|
||||
[pl]: Altcoin-and-Forkcoin-Support#a_oe
|
||||
[ax]: autosign-[MMGen-command-help]
|
||||
[mc]: Altcoin-and-Forkcoin-Support#a_xmr
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
## Table of Contents
|
||||
|
||||
#### [Full support for Ethereum (ETH), Ethereum Classic (ETC) and ERC20 Tokens](#a_eth)
|
||||
* [Install and run Parity Ethereum](#a_par)
|
||||
* [Install and run OpenEthereum](#a_oe)
|
||||
* [Install Ethereum dependencies](#a_ed)
|
||||
* [Transacting and other basic operations](#a_tx)
|
||||
* [Creating and deploying ERC20 tokens](#a_dt)
|
||||
|
|
@ -20,31 +20,30 @@ Ethereum, Ethereum Classic and ERC20 tokens are fully supported by MMGen, on the
|
|||
same level as Bitcoin. In addition, ERC20 token creation and deployment are
|
||||
supported via the `create-token.py` script.
|
||||
|
||||
#### <a name='a_par'>Install and run Parity Ethereum</a>
|
||||
#### <a name='a_oe'>Install and run OpenEthereum</a>
|
||||
|
||||
MMGen uses Parity to communicate with the Ethereum blockchain. For information
|
||||
on installing Parity on your system, visit the Parity Ethereum [homepage][h] or
|
||||
[Git repository][g]. [MMGenLive][l] users can install Parity automatically from
|
||||
signed binaries using the [`mmlive-daemon-upgrade`][U] script. Parity is not
|
||||
used for transaction signing, so you needn’t install it on your offline machine.
|
||||
MMGen uses OpenEthereum to communicate with the Ethereum blockchain. For
|
||||
information on installing OpenEthereum on your system, visit the OpenEthereum
|
||||
[wiki][ow] or [Git repository][og]. OpenEthereum is not used for transaction
|
||||
signing, so you needn’t install it on your offline machine.
|
||||
|
||||
Parity must be invoked with the `--jsonrpc-apis=all` option so that MMGen can
|
||||
communicate with it. If you’re running the daemon and MMGen on different
|
||||
OpenEthereum must be invoked with the `--jsonrpc-apis=all` option so that MMGen
|
||||
can communicate with it. If you’re running the daemon and MMGen on different
|
||||
machines you’ll also need the following:
|
||||
|
||||
--jsonrpc-hosts=all --jsonrpc-interface=<IP of Parity’s host>
|
||||
--jsonrpc-hosts=all --jsonrpc-interface=<IP of OpenEthereum’s host>
|
||||
|
||||
To transact Ethereum Classic, use `--chain=classic --jsonrpc-port=8555`
|
||||
|
||||
To run the daemon offline, use `--mode=offline`, otherwise `--mode=active`.
|
||||
|
||||
MMGen can also be used with Parity’s light client mode, which queries other
|
||||
nodes on the Ethereum network for blockchain data. Add the `--light` option to
|
||||
the Parity command line and read the applicable note in the [Transacting](#a_tx)
|
||||
section below.
|
||||
MMGen can also be used with OpenEthereum’s light client mode, which queries
|
||||
other nodes on the Ethereum network for blockchain data. Add the `--light`
|
||||
option to the OpenEthereum command line and read the applicable note in the
|
||||
[Transacting](#a_tx) section below.
|
||||
|
||||
You may require other options as well. Consult `parity --help` for the full
|
||||
list.
|
||||
You may require other options as well. Consult `openethereum --help` for the
|
||||
full list.
|
||||
|
||||
#### <a name='a_ed'>Install Ethereum dependencies</a>
|
||||
|
||||
|
|
@ -68,13 +67,13 @@ Basic operations with ETH, ETC and ERC20 tokens work as described in the
|
|||
[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` switch with all token operations. When importing addresses
|
||||
into your token tracking wallet you must use the token’s address as the
|
||||
argument. After this, the token symbol, e.g. `--token=eos`, is sufficient.
|
||||
* Use the `--token` option with the token symbol as parameter for all token
|
||||
operations. When importing addresses for a new token into your tracking
|
||||
wallet, use the `--token-addr` option with the token address instead.
|
||||
* 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 at both the command line and interactive prompt.
|
||||
* When using Parity in light client mode, the `--cached-balances` option
|
||||
* When using OpenEthereum in light client mode, the `--cached-balances` option
|
||||
will greatly speed up operations of the `mmgen-txcreate`, `mmgen-txdo` and
|
||||
`mmgen-tool twview` commands by reducing network queries to a minimum. If
|
||||
your account balances have changed, they may be refreshed interactively within
|
||||
|
|
@ -92,7 +91,7 @@ Generate some ETH addresses with your default wallet:
|
|||
|
||||
Create an EOS token tracking wallet and import the addresses into it:
|
||||
|
||||
$ mmgen-addrimport --coin=eth --token=86fa049857e0209aa7d9e616f7eb3b3b78ecfdb0 ABCDABCD-ETH[1-5].addrs
|
||||
$ mmgen-addrimport --coin=eth --token-addr=86fa049857e0209aa7d9e616f7eb3b3b78ecfdb0 ABCDABCD-ETH[1-5].addrs
|
||||
|
||||
*Unlike the case with BTC and derivatives, ETH and ETC tracking wallets are
|
||||
created and managed by MMGen itself and located under the MMGen data directory.
|
||||
|
|
@ -121,7 +120,7 @@ View your EOS tracking wallet:
|
|||
|
||||
$ mmgen-tool --coin=eth --token=eos twview
|
||||
|
||||
To transact ETH instead of EOS, omit the `--token` arguments.
|
||||
To transact ETH instead of EOS, omit the `--token` and `--token-addr` arguments.
|
||||
|
||||
#### <a name='a_dt'>Creating and deploying ERC20 tokens</a>
|
||||
|
||||
|
|
@ -189,7 +188,7 @@ price!*
|
|||
|
||||
Create an MFT token tracking wallet and import your ETH addresses into it:
|
||||
|
||||
$ mmgen-addrimport --coin=eth --token=abcd1234abcd1234abcd1234abcd1234abcd1234 ABCDABCD-ETH[1-5].addrs
|
||||
$ mmgen-addrimport --coin=eth --token-addr=abcd1234abcd1234abcd1234abcd1234abcd1234 ABCDABCD-ETH[1-5].addrs
|
||||
|
||||
View your MFT tracking wallet:
|
||||
|
||||
|
|
@ -318,9 +317,8 @@ received only minimal testing, or no testing at all. At startup you’ll be
|
|||
informed of the level of your selected coin’s support reliability as deemed by
|
||||
the MMGen Project.
|
||||
|
||||
[h]: https://www.parity.io/ethereum
|
||||
[g]: https://github.com/paritytech/parity-ethereum/releases
|
||||
[l]: https://github.com/mmgen/MMGenLive
|
||||
[ow]: https://openethereum.github.io/wiki
|
||||
[og]: https://github.com/openethereum/openethereum/releases
|
||||
[y]: https://github.com/ethereum/pyethereum
|
||||
[P]: https://pypi.org/project/pip
|
||||
[M]: https://getmonero.org/downloads/#linux
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ step 7 will look something like this:
|
|||
|
||||
13. View the transaction in the mempool:
|
||||
|
||||
$ mmgen-regtest show_mempool
|
||||
$ mmgen-regtest mempool
|
||||
['78ca853816b55527b42ca8784c887a5f482c752522f914d2f17d6afcd8a3b076']
|
||||
|
||||
14. Mine a block:
|
||||
|
|
@ -118,7 +118,7 @@ step 7 will look something like this:
|
|||
|
||||
15. Check the mempool again:
|
||||
|
||||
$ mmgen-regtest show_mempool
|
||||
$ mmgen-regtest mempool
|
||||
[]
|
||||
|
||||
16. List Alice’s addresses. Note that Alice has lost a bit to transaction fees:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue