diff --git a/Altcoin-and-Forkcoin-Support.md b/Altcoin-and-Forkcoin-Support.md index b6b5a9e..4c22ab6 100644 --- a/Altcoin-and-Forkcoin-Support.md +++ b/Altcoin-and-Forkcoin-Support.md @@ -10,7 +10,7 @@ #### Enhanced key/address generation support for Monero (XMR) and Zcash (ZEC) -#### Key/address generation support for ETH, ETC and 144 Bitcoin-derived altcoins +#### Key/address generation support for 144 Bitcoin-derived altcoins #### Full support for Ethereum (ETH), Ethereum Classic (ETC) and ERC20 Tokens @@ -49,10 +49,7 @@ This can be done easily with the [pip][P] Python package installer. First install the following dependencies: $ pip install rlp==0.6.0 # the version is important here! - $ pip install pysha3 - $ pip install future - $ pip install PyYAML - $ pip install py_ecc + $ pip install future pysha3 PyYAML py_ecc Now install the library itself. You could try doing this the usual way: @@ -97,8 +94,8 @@ Basic operations with ETH, ETC and ERC20 tokens work as described in the **Transacting example:** -*Note: All addresses in the examples to follow are bogus. You must replace them -with real ones.* +*Note: All addresses and filenames in the examples to follow are bogus. You +must replace them with real ones.* Generate some ETH addresses with your default wallet: @@ -145,6 +142,9 @@ Install the Solidity compiler (`solc`) on your system: **Token creation/deployment example:** +*Note: All addresses and filenames in the examples to follow are bogus. You +must replace them with real ones.* + Create a token 'MFT' with default parameters, owned by `ddeeff...` (`ABCDABCD:E:1`): # Do this in the MMGen repository root: @@ -242,7 +242,7 @@ includes another utility: This command also requires no user interaction, a very handy feature when you have a large batch of wallets requiring long sync times. -#### Key/address generation support for ETH, ETC and 144 Bitcoin-derived altcoins +#### Key/address generation support for 144 Bitcoin-derived altcoins To generate key/address pairs for these coins, just specify the coin's symbol with the `--coin` argument: @@ -287,3 +287,6 @@ Project. [bo]: https://github.com/mmgen/mmgen/wiki/Getting-Started-with-MMGen#a_bo [U]: https://github.com/mmgen/MMGenLive/blob/master/home.mmgen/bin/mmlive-daemon-upgrade [X]: https://github.com/mmgen/mmgen/wiki/man-autosign +[si]: Install-Bitcoind-from-Source-on-Debian-or-Ubuntu-Linux +[bi]: Install-Bitcoind#a_d +[p8]: Install-Bitcoind#a_r diff --git a/Getting-Started-with-MMGen.md b/Getting-Started-with-MMGen.md index 8064221..c9d1c41 100644 --- a/Getting-Started-with-MMGen.md +++ b/Getting-Started-with-MMGen.md @@ -866,9 +866,4 @@ them in turn until you get a confirmation: [01]: https://github.com/mmgen/mmgen/wiki/Tracking-and-spending-ordinary-Bitcoin-addresses [02]: https://tpfaucet.appspot.com [03]: Recovering-Your-Keys-Without-the-MMGen-Software -[04]: https://bitcoin.org/en/developer-examples#testnet -[05]: https://bitcoin.org/en/developer-examples#regtest-mode [06]: https://github.com/mmgen/mmgen/wiki/MMGen-Quick-Start-with-Regtest-Mode -[si]: Install-Bitcoind-from-Source-on-Debian-or-Ubuntu-Linux -[bi]: Install-Bitcoind#a_d -[p8]: Install-Bitcoind#a_r diff --git a/command-help:-autosign.md b/command-help:-autosign.md new file mode 100644 index 0000000..509221b --- /dev/null +++ b/command-help:-autosign.md @@ -0,0 +1,64 @@ + MMGEN-AUTOSIGN: Auto-sign MMGen transactions + USAGE: mmgen-autosign [opts] [command] + OPTIONS: + -h, --help Print this help message + --longhelp Print help message for long options (common options) + -c, --coins c Coins to sign for (comma-separated list) + -l, --led Use status LED to signal standby, busy and error + -m, --mountpoint m Specify an alternate mountpoint (default: '/mnt/tx') + -s, --stealth-led Stealth LED mode - signal busy and error only, and only + after successful authorization. + -q, --quiet Produce quieter output + -v, --verbose Produce more verbose output + + + COMMANDS + + gen_key - generate the wallet encryption key and copy it to '/mnt/tx/tx' + setup - generate the wallet encryption key and wallet + wait - start in loop mode: wait-mount-sign-unmount-wait + + + USAGE NOTES + + If invoked with no command, the program mounts a removable device containing + MMGen transactions, signs any unsigned transactions, unmounts the removable + device and exits. + + 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. + ready for device insertion or removal. + + The removable device must have a partition labeled MMGEN_TX and 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 + must contain the following entry: + + LABEL='MMGEN_TX' /mnt/tx auto noauto,user 0 0 + + Transactions are signed with a wallet on the signing machine (in the directory + '/dev/shm/autosign') encrypted with a 64-character hexadecimal password on the + removable device. + + The password and wallet can be created in one operation by invoking the + command with 'setup' with the removable device inserted. The user will be + prompted for a seed mnemonic. + + Alternatively, the password and wallet can be created separately by first + invoking the command with 'gen_key' and then creating and encrypting the + wallet using the -P (--passwd-file) option: + + $ mmgen-walletconv -r0 -q -iwords -d/dev/shm/autosign -p1 -P/mnt/tx/tx/autosign.key -Llabel + + Note that the hash preset must be '1'. Multiple wallets are permissible. + + For good security, it's advisable to re-generate a new wallet and key for + each signing session. + + This command is currently available only on Linux-based platforms. + + MMGEN v0.9.8 May 2018 MMGEN-AUTOSIGN(1)