diff --git a/Getting-Started-with-MMGen.md b/Getting-Started-with-MMGen.md index 6fe5060..307fc3f 100644 --- a/Getting-Started-with-MMGen.md +++ b/Getting-Started-with-MMGen.md @@ -1,5 +1,11 @@ ## Table of Contents +#### Preliminaries +* Invocation +* Configuration file +* Test setup and testnet +* Before you begin + #### Basic Operations * Generate a wallet * Generate addresses @@ -14,47 +20,104 @@ * Incognito wallets * Hidden incognito wallets -The following primer presupposes you have MMGen installed on two computers, one -offline and one online. However, if you have an online computer and a few -Bitcoin addresses with small balances, it’s perfectly possible to perform the -operations described below on a single online machine. +#### Advanced Topics +* Hot wallets and key-address files +* Transaction Fees +* BIP 125 replace-by-fee (RBF) transactions + * With an online (hot) wallet + * With an offline (cold storage) wallet -For those who just want to experiment with MMGen: all wallet generation, wallet -format conversion, address and key generation, and address import operations can -be performed on either an online or offline computer with an empty blockchain -and no Bitcoin balance. +### Preliminaries -*NOTE: Beginning with v0.8.7a, MMGen supports testnet, allowing you to perform -the entire set of MMGen operations without risking real funds (free testnet -coins may be obtained at [https://tpfaucet.appspot.com/][02]). To use this -feature, start bitcoind with the -testnet option and sync the testnet blockchain -(about 9GB at this time of writing). To make MMGen use testnet instead of -mainnet, supply the `--testnet=1` option as the first argument to all MMGen -commands you run. To save typing, the option may also be set in the MMGen -configuration file.* +#### Invocation -Note that all the filenames, seed IDs, Bitcoin addresses and so forth used in -this primer are fake and for purposes of illustration only. The up arrow (for -repeating commands) and tab key (or Ctrl-I) (for completing commands and -filenames) will speed up your work at the command line greatly. +The MMGen wallet system is not a single program but a suite of lightweight +commands run from the command line. MMGen's commands all begin, not +surprisingly, with 'mmgen'. To see a list of available commands, type 'mmgen' +followed by the TAB key. Every mmgen commands has a help screen displaying +detailed usage and options information. To view it, type the command name +followed by `--help`. Note that most command options have long and short +versions. For example, the `--help` option may be abbreviated to `-h`. The +exception are the options listed by `--longhelp`, which have no short versions. + +MMGen commands are generally interactive, informing you at every step and +prompting you for input. The `--verbose` or `-v` option requests commands to be +more wordy, while the `--quiet` or `-q` option suppresses all but the most +essential information. These options are available for all MMGen commands. The +`--yes` option (available only for certain commands) suppresses even more +information and can be used to make some commands non-interactive or scriptable. + +Certain options require parameters, such as the `--seed-len` option, for +instance, which takes a parameter of '128', '192' or '256'. Commands may also +take optional or required arguments. For example, `mmgen-addrgen` requires an +address or range of addresses as an argument. Arguments must always follow +options on the command line. + +Sample MMGen command invocations: + + $ mmgen-txcreate --help + $ mmgen-addrgen --verbose 1-10 + $ mmgen-walletgen + $ mmgen-walletgen --quiet --seed-len 128 + +#### Configuration file + +Just like Bitcoin Core, MMGen has its own data directory and configuration file. +The data directory is '.mmgen' in the user's home directory and the config +file is 'mmgen.cfg'. The config file contains global settings which you may +wish to edit at some point to customize MMGen to your needs. These settings +include the maximum transaction fee; the user name, password and hostname +used for communicating with bitcoind; and a number of others. + +#### Test setup and testnet + +If you just want to quickly try out MMGen, it's possible to perform all wallet +generation, wallet format conversion, address and key generation, and address +import operations on an offline computer with no blockchain and no bitcoin +balance. + +If you want to practice creating, signing and sending transactions, however, +as well as tracking balances, you'll need a fully synced blockchain and some +actual bitcoins to play with. To avoid risking real funds, it's *highly +recommended* to practice transaction operations on testnet until you feel +confident you know what you're doing. Testnet is just like the real Bitcoin +network, but testnet coins have no monetary value. Free testnet coins may be +obtained at [https://tpfaucet.appspot.com][02]. + +To use MMGen with testnet, you must first start bitcoind with the `-testnet` +option and sync the testnet blockchain (about 12GB at this time of writing). To +force any MMGen command to use testnet just add the `--testnet=1` option after +the command name. Or just set the `testnet` option to `true` in 'mmgen.cfg' to +make *all* commands use testnet. +With testnet you can safely practice all the operations below, +including the offline ones, on an online computer. + +#### Before you begin + +Before you begin, note that the filenames, seed IDs and Bitcoin addresses used +in this primer are intentionally invalid and are for purposes of illustration +only. As you perform the exercises, you'll naturally substitute real ones in +their place. + +The up arrow (for repeating commands) and tab key (or Ctrl-I) (for completing +commands and filenames) will speed up your work at the command line greatly. ### Basic Operations -#### Generate a wallet (offline computer): +#### Generate a wallet (offline computer) -*NOTE: Beginning with v0.8.8, MMGen supports a “default wallet” feature. After -creating your wallet, MMGen will prompt you to make it your default. If you -answer 'y', the wallet will be stored in your MMGen data directory and used for -all future commands that require a wallet or other seed source.* +*NOTE: MMGen supports a “default wallet” feature. After generating your wallet, +you'll be prompted to make it your default. If you answer 'y', the wallet will +be stored in your MMGen data directory and used for all future commands that +require a wallet or other seed source.* -*You may not want this feature if you plan to store your MMGen wallet in another -location than your MMGen data directory. Otherwise, it's recommended, as it -frees you from having to type your wallet on the command line.* +*You may not want this feature if you plan to store your MMGen wallet in a +location other than your MMGen data directory. Otherwise, it’s recommended, +as it frees you from having to type your wallet file on the command line.* -*The following examples suppose that you've chosen to use a default wallet. -Bear in mind that in the absence of a default wallet, the path to a wallet file -or other seed source needs to be included in all commands where it's -applicable.* +*The following examples suppose that you’ve chosen to use a default wallet. +If you haven't, then you must include the path to a wallet file or other seed +source in all commands where a seed source is required.* On your offline computer, generate a wallet: @@ -73,18 +136,18 @@ wallet’s password or hash preset are changed and is less important. configurable: type `mmgen-walletgen --help` for details. Before moving any funds into your MMGen wallet, you should back it up in several -places and preferably on several media such as paper, flash memory or a CD-ROM. -You’re advised to use a passphrase with your wallet. Otherwise, anyone who -gains physical access to one of your backups can easily steal your coins. Don’t -forget your passphrase. If you do, the coins in your MMGen wallet are gone -forever. +places and preferably on several media such as paper, flash memory or optical +disk. You’re advised to use a passphrase with your wallet. Otherwise, anyone +who gains physical access to one of your backups can easily steal your coins. +Don’t forget your passphrase. If you do, the coins in your MMGen wallet are +gone forever. Since the wallet is a small, humanly readable ASCII file, it can easily be -printed out on paper. It can also be exported to more compact forms, the seed +printed out on paper. It can also be exported to more compact forms: the seed file and mnemonic (discussed below). These formats are short enough to be written out by hand or memorized. -#### Generate addresses (offline computer): +#### Generate addresses (offline computer) Now generate ten addresses with your just-created wallet: @@ -111,15 +174,16 @@ the resulting filename. MMGen addresses consist of the Seed ID followed by ‘: and an index. In this example, ‘89ABCDEF:1’ represents the Bitcoin address ‘16bNmy...’, ‘89ABCDEF:2’ represents ‘1AmkUx...’ and so forth. -To begin moving your Bitcoin holdings into your MMGen wallet, just spend into -any of these addresses. If you run out of addresses, generate more. To -generate a hundred addresses, for example, you’d specify an address range of ‘1-100’. +To fund your MMGen wallet, first import the addresses into your tracking wallet +and then spend some bitcoin into any of them. If you run out of addresses, +generate more. To generate a hundred addresses, for example, specify an address +range of ‘1-100’. Let’s say you’ve decided to spend some BTC into the first four addresses above. -Before doing so, you must import these addresses into the tracking wallet on -your online machine so their balances will be visible. For convenience -of reference, provide the addresses with labels. We’ll use the labels -‘Donations’, ‘Storage 1’, ‘Storage 2’ and ‘Storage 3’. +Begin by importing these addresses into the tracking wallet on your online +machine so their balances will be visible. For convenience of reference, +provide the addresses with labels. We’ll use the labels ‘Donations’, ‘Storage +1’, ‘Storage 2’ and ‘Storage 3’. Make a copy of the address file @@ -150,7 +214,7 @@ of lines as well. Save the file, copy it onto a USB stick and transfer it to your online computer. -#### Import addresses (online computer): +#### Import addresses (online computer) On your online computer, go to your bitcoind data directory and move any existing 'wallet.dat' file out of harm’s way. Start bitcoind and let it @@ -177,9 +241,9 @@ also). *While not covered in this introduction, note that it’s also possible to [import ordinary Bitcoin addresses into your tracking wallet][01]. This allows you to -move funds from another wallet directly to MMGen without having to go through -the network. To use it, you must save the keys corresponding to the addresses -where the funds are stored in a separate file for use during signing.* +track and spend funds from another wallet using MMGen without having to go +through the network. To use it, you must save the keys corresponding to the +addresses where the funds are stored in a separate file to use during signing.* Now that your addresses are being tracked, you may go ahead and send some BTC to them over the Bitcoin network. If you send 0.1, 0.2, 0.3 and 0.4 BTC @@ -194,14 +258,13 @@ after the transactions have been confirmed: 89ABCDEF:4 Storage 3 0.4 TOTAL: 1 BTC -#### Create a transaction (online computer): +#### Create a transaction (online computer) Now that you have some BTC under MMGen’s control, you’re ready to create a transaction. Note that transactions are harmless until they’re signed and broadcast to the network, so feel free to experiment and create transactions with different combinations of inputs and outputs. If you're using testnet, -then even broadcast transactions are harmless, so it's highly recommended you -do so if you want to practice sending transactions. +then you risk nothing even when broadcasting transactions, of course. To send 0.1 BTC to the a third-party address 1AmkUxrfy5dMrfmeYwTxLxfIswUCcpeysc, for example, and send the change back to yourself at address 89ABCDEF:5, you’d @@ -247,23 +310,20 @@ After quitting the menu with 'q', you’ll see the following prompt: Enter a range or space-separated list of outputs to spend: Here you must choose unspent outputs of sufficient value to cover the send -amount of 0.1 BTC, plus the transaction fee. By the way, MMGen calculates fees -automatically using bitcoind’s 'estimatefee' RPC call, which makes things very -convenient. If you want to increase the fee a bit for speedier confirmation, -use the `--tx-fee-adj` option. Type `mmgen-txcreate --help` for details. - -Output #2 is worth 0.2 BTC, which is sufficient, so let’s choose it. After -several more prompts and confirmations, your transaction will be saved: +amount of 0.1 BTC, plus the transaction fee (for more on fees, see 'Transaction +Fees' under 'Advanced Topics' below). Output #2 is worth 0.2 BTC, which is +sufficient, so we’ll choose that. After several more prompts and confirmations, +your transaction will be saved: Transaction written to file 'FEDCBA[0.1].rawtx' -Note that the transaction filename consists of a unique ID plus the spend -amount. +Note that the transaction filename consists of a unique MMGen Transaction ID +plus the non-change spend amount. As you can see, MMGen gives you complete control over your transaction inputs and change addresses. This feature will be appreciated by privacy-conscious users. -#### Sign a transaction (offline computer): +#### Sign a transaction (offline computer) Now transfer the the raw transaction file to your offline computer and sign it using your default wallet: @@ -274,16 +334,21 @@ using your default wallet: Note that the signed transaction file has a new extension, '.sigtx'. -#### Send a transaction (online computer): +#### Send a transaction (online computer) Now you’re ready for the final step: broadcasting the transaction to the network. Copy the signed transaction file to your online computer, start -bitcoind if necessary, and issue the command: +bitcoind if necessary, make sure your blockchain is up-to-date and issue the +command: $ mmgen-txsend FEDCBA[0.1].sigtx + ... + Transaction sent: abcd1234.... Like all MMGen commands, 'mmgen-txsend' is interactive, so you’ll be prompted -before the transaction is actually sent. +before the transaction is actually broadcast. If the send was successful, a +64-character hexadecimal Bitcoin Transaction ID will be displayed ('abcd1234...' +in our case). Once the transaction is broadcast to the network and confirmed, your address listing should look something like this: @@ -300,15 +365,12 @@ Since you’ve sent 0.1 BTC to a third party, your balance has declined by 0.1 B plus the tx fee of 0.0001 BTC. To verify that your transaction’s received its second, third and so on confirmations, increase `minconf` accordingly. -Congratulations! You’ve now mastered the basics of MMGen! - -Some of MMGen’s more advanced features are discussed below. Others are -documented in the help screens of the individual MMGen commands: display these -by invoking the desired command with the `-h` or `--help` switch. +Congratulations! You’ve now mastered the basics of MMGen! To learn about some +of MMGen’s more advanced features, continue reading. ### Additional Features -#### Using the mnemonic, seed and hexseed formats: +#### Using the mnemonic, seed and hexseed formats Continuing our example above, generate a mnemonic from the default wallet: @@ -549,6 +611,194 @@ Transaction signing uses the same syntax: ... Signed transaction written to file 'ABCDEF[0.1].sigtx' +### Advanced Topics + +#### Hot wallets and key-address files + +Chances are you'll want to use MMGen not only for cold storage but for +day-to-day transactions too. For this you'll need to place a portion of your +funds in a “hot wallet” on your online computer. With hot wallet funds you +can use the command `mmgen-txdo` to quickly create, sign and send transactions +in one operation. + +There are two hot wallet strategies you can use. The first is to generate a +separate MMGen wallet on your online computer for use as the hot wallet. The +advantage of this is convenience: you won't have to specify a wallet or seed +source on the command line. In addition, your hot wallet and cold wallet funds +will be easily distinguishable in your tracking wallet by their different Seed +IDs. The drawback of this strategy is that you now have two seeds that need +backing up or memorizing. + +The other strategy, which avoids this drawback, is to partition your cold wallet +by mentally setting aside “hot” and “cold” address ranges. For example, you +might choose to reserve all addresses in the range 1-1000 for cold storage and +everything above that for your hot wallet. + +The next step is to create a key-address file for a sufficient number of “hot” +addresses to cover your day-to-day transaction needs for now. A key-address +file is just like an address file except that it contains keys as well as +addresses. Thus it functions as a hot wallet for a range of addresses. +Assuming your hot address range begins at 1001, you could start by creating a +key-address file for a hundred hot addresses like this: + + $ mmgen-keygen 1001-1100 + ... + Secret keys written to file '89ABCDEF[1001-1100].akeys.mmenc' + +`mmgen-keygen` prompts you for a password to encrypt the key-address file with. +This is a wise precaution, as it provides some security for keys that will be +stored on an online machine. + +Now copy the key-address file to your online machine and import the addresses +into your tracking wallet: + + $ mmgen-addrimport --batch --keyaddr-file '89ABCDEF[1001-1100].akeys.mmenc' + +After funding your hot wallet by spending into some addresses in this range you +can do quickie transactions with these funds using the `mmgen-txdo` command: + + $ mmgen-txdo -M '89ABCDEF[1001-1100].akeys.mmenc' 1AmkUxrfy5dMrfmeYwTxLxfIswUCcpeysc,0.1 89ABCDEF:1010 + ... + Transaction sent: dcea1357.... + +The `--mmgen-keys-from-file` or `-M` option is required when using a key-address +file in place of a default wallet. Note that your change address 89ABCDEF:1010 +is contained in the key-address file, so your change funds will remain “hot +spendable”. + +Using `mmgen-txdo` with a default online hot wallet is even simpler. For a hot +wallet with Seed ID 0FDE89AB, for instance, creating and sending a transaction +looks like this: + + $ mmgen-txdo 1AmkUxrfy5dMrfmeYwTxLxfIswUCcpeysc,0.1 0FDE89AB:10 + + +#### Transaction Fees + +MMGen gives you several options for dealing with transaction fees. + +Firstly, and most simply, you may do nothing, in which case MMGen will calculate +the fee automatically using bitcoind’s 'estimatefee' RPC call. You can adjust +the estimated fee by any factor using the `--tx-fee-adj` option, a handy feature +when you need transactions to confirm a bit more quickly. MMGen has no default +fee, so if network fee estimation fails for any reason, you'll be prompted to +enter the fee manually. + +Secondly, you may specify the fee as an absolute BTC amount (a decimal number). +This can be done either on the command line or at the interactive prompt when +creating transactions with `mmgen-txcreate`, `mmgen-txdo` or `mmgen-txbump`. + +Thirdly, instead of using an absolute BTC amount, you may specify the fee in +satoshis per byte and let MMGen calculate the fee based on the transaction size. +This also works both on the command line and at the interactive prompt. The +satoshis-per-byte specification is an integer followed by the letter 's'. A fee +of 90 satoshis per byte is thus represented as '90s'. + +MMGen has a hard maximum fee (currently 0.01 BTC) which is alterable only in the +config file. Thus MMGen will never create any transaction with a mistakenly or +dangerously high fee, or broadcast it to the network, unless you expressly +permit it to. + +#### BIP 125 replace-by-fee (RBF) transactions + +As of version 0.9.1, MMGen supports creating replaceable and replacement +transactions in accordance with the BIP 125 replace-by-fee (RBF) specification. + +Creating replaceable transactions is easy: First off, make sure bitcoind is +running with the `-walletrbf` option enabled. Then specify the `--rbf` option +when creating your transactions with `mmgen-txcreate` or `mmgen-txdo`. + +Version 0.9.1 also introduces `mmgen-txbump`, a convenient command for creating +replacement transactions based on existing replaceable transactions. +`mmgen-txbump` can create, sign and send transactions in a single operation if +desired. + +Continuing the examples from our primer above, we'll examine two RBF scenarios, +one for a hot wallet and one for a cold storage wallet. In the first scenario, +initial and replacement transactions will be created, signed and sent in one +operation. In the second, a batch of replacement transactions with incremented +fees will created for signing offline. + +#### With an online (hot) wallet + +Create, sign and send a BIP 125 replaceable transaction with a fee of 50 +satoshis per byte: + + $ mmgen-txdo --rbf --tx-fee 50s 1AmkUxrfy5dMrfmeYwTxLxfIswUCcpeysc,0.1 0FDE89AB:5 + ... + Signed transaction written to file 'FEDCBB[0.1,50].sigtx' + ... + Transaction sent: dcba4321.... + +Here you've sent 0.1 BTC to a third-party address and the change back to +yourself at address #5 of your default hot wallet with Seed ID 0FDE89AB. + +Note that the fee is shown in the filename after the send amount. The presence +of the fee in the filename identifies the transaction as replaceable. + +If the transaction fails to confirm as desired, then create, sign and send a +replacement transaction with a higher fee, say 80 satoshis per byte: + + $ mmgen-txbump --send --tx-fee 80s --output-to-reduce c 'FEDCBB[0.1,50].sigtx' + ... + Signed transaction written to file 'DAE123[0.1,80].sigtx' + ... + Transaction sent: eef01357.... + +The `--send` switch instructs `mmgen-txbump` to sign and send the transaction +after creating it. The `--output-to-reduce` switch with an argument of 'c' +requests that the increased fee be deducted from the change ('c') output, which +is usually what is desired. If you want it taken from some other output, +identify the output by number. Note that the resulting replacement transaction +has a different identifier, since it's a new transaction. + +If this transaction also fails to confirm, then repeat the above step as many +times as necessary to get a confirmation, increasing the fee each time. The +only thing you have to modify with each iteration is the argument to `--tx-fee`. +To reduce your typing even further, use the `--yes` switch to skip all +non-essential prompts. + +Note that if you're using a key-address file instead of a default hot wallet, +you'll need to supply it on the command line as a parameter to the `-M` option. + +#### With an offline (cold storage) wallet + +To achieve the same result as in the above example using a cold wallet, just +create the initial transaction with `mmgen-txcreate` instead of `mmgen-txdo`: + + $ mmgen-txcreate --rbf --tx-fee 50s 1AmkUxrfy5dMrfmeYwTxLxfIswUCcpeysc,0.1 89ABCDEF:5 + ... + Transaction written to file 'FEDCBC[0.1,50].rawtx' + +Now create a series of transactions with incrementally increased fees for +offline signing: + + $ mmgen-txbump --tx-fee 80s --output-to-reduce c 'FEDCBC[0.1,50].rawtx' + $ mmgen-txbump --tx-fee 120s --output-to-reduce c 'FEDCBC[0.1,50].rawtx' + $ mmgen-txbump --tx-fee 150s --output-to-reduce c 'FEDCBC[0.1,50].rawtx' + +To speed things up, you may add the `--yes` switch to make `mmgen-txbump` +completely non-interactive. + +The result will be four raw transaction files with increasing fees, like this: + + FEDCBC[0.1,50].rawtx + 3EBB00[0.1,80].rawtx + 124FFF[0.1,120].rawtx + 73DABB[0.1,150].rawtx + +Copy the files to an empty folder, transfer the folder to your offline machine and batch sign them: + + $ mmgen-txsign -d my_folder --yes my_folder/*.rawtx + +Then copy the signed transaction files back to your online machine and broadcast +them in turn until you get a confirmation: + + $ mmgen-txsend FEDCBC[0.1,50].sigtx # ...if this doesn't confirm, then + $ mmgen-txsend 3EBB00[0.1,80].sigtx # ...if this doesn't confirm, then + $ mmgen-txsend 124FFF[0.1,120].sigtx # ...if this doesn't confirm, then + $ mmgen-txsend 73DABB[0.1,150].sigtx + [01]: https://github.com/mmgen/mmgen/wiki/Tracking-and-spending-ordinary-Bitcoin-addresses [02]: https://tpfaucet.appspot.com [03]: Recovering-Keys-Without-MMGen diff --git a/Recovering-Keys-Without-MMGen.md b/Recovering-Keys-Without-MMGen.md index cb25d61..3253170 100644 --- a/Recovering-Keys-Without-MMGen.md +++ b/Recovering-Keys-Without-MMGen.md @@ -66,10 +66,10 @@ A double SHA-256 hash of the link gives us the key of our first address: With 'mmgen-tool', we can easily generate the WIF key and address from this hexadecimal key and see that it's correct: - $ ./mmgen-tool hex2wif 05d7219524b983290138a60ada101370007f59a625c43a46f0f8d92950955e36 + $ mmgen-tool hex2wif 05d7219524b983290138a60ada101370007f59a625c43a46f0f8d92950955e36 5HrrmMdQbELyW7iCns5kvSbN9GCPTqEfG7iP1PZiYk49yDDivTi - ./mmgen-tool wif2addr 5HrrmMdQbELyW7iCns5kvSbN9GCPTqEfG7iP1PZiYk49yDDivTi + $ mmgen-tool wif2addr 5HrrmMdQbELyW7iCns5kvSbN9GCPTqEfG7iP1PZiYk49yDDivTi 1JVi3qcNcjMM7cTR7y9ihKUG1yDLpKRJfL # matches FE3C6545:1 above But since we've lost the MMGen software, we must do the hex-to-WIF conversion diff --git a/man-addrgen.md b/man-addrgen.md index 3e207bb..1a7f697 100644 --- a/man-addrgen.md +++ b/man-addrgen.md @@ -53,4 +53,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-ADDRGEN(1) + MMGEN v0.9.1 May 2017 MMGEN-ADDRGEN(1) diff --git a/man-addrimport.md b/man-addrimport.md index b0d916f..f243efe 100644 --- a/man-addrimport.md +++ b/man-addrimport.md @@ -17,4 +17,4 @@ The --batch and --rescan options cannot be used together. - MMGEN v0.9.0 December 2016 MMGEN-ADDRIMPORT(1) + MMGEN v0.9.1 May 2017 MMGEN-ADDRIMPORT(1) diff --git a/man-keygen.md b/man-keygen.md index 9812d35..48bd561 100644 --- a/man-keygen.md +++ b/man-keygen.md @@ -54,4 +54,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-KEYGEN(1) + MMGEN v0.9.1 May 2017 MMGEN-KEYGEN(1) diff --git a/man-passchg.md b/man-passchg.md index 56bb672..d95142d 100644 --- a/man-passchg.md +++ b/man-passchg.md @@ -43,4 +43,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-PASSCHG(1) + MMGEN v0.9.1 May 2017 MMGEN-PASSCHG(1) diff --git a/man-tool.md b/man-tool.md index 4727bda..4f7269a 100644 --- a/man-tool.md +++ b/man-tool.md @@ -80,4 +80,4 @@ Type 'mmgen-tool help for help on a particular command - MMGEN v0.9.0 December 2016 MMGEN-TOOL(1) + MMGEN v0.9.1 May 2017 MMGEN-TOOL(1) diff --git a/man-txbump.md b/man-txbump.md new file mode 100644 index 0000000..4dd8176 --- /dev/null +++ b/man-txbump.md @@ -0,0 +1,79 @@ + MMGEN-TXBUMP: Increase the fee on a replaceable (RBF) MMGen transaction, creating a new transaction, and optionally sign and send the new transaction + USAGE: mmgen-txbump [opts] [seed source] ... + OPTIONS: + -h, --help Print this help message + --longhelp Print help message for long options (common options) + -b, --brain-params l,p Use seed length 'l' and hash preset 'p' for + brainwallet input + -c, --comment-file f Source the transaction's comment from file 'f' + -d, --outdir d Specify an alternate directory 'd' for output + -e, --echo-passphrase Print passphrase to screen when typing it + -f, --tx-fee f Transaction fee (default: 0.0003 BTC (but see below)) + -H, --hidden-incog-input-params f,o Read hidden incognito data from file + 'f' at offset 'o' (comma-separated) + -i, --in-fmt f Input is from wallet format 'f' (see FMT CODES below) + -l, --seed-len l Specify wallet seed length of 'l' bits. This option + is required only for brainwallet and incognito inputs + with non-standard (< 256-bit) seed lengths. + -k, --keys-from-file f Provide additional keys for non-MMGen addresses + -K, --key-generator m Use method 'm' for public key generation + Options: 1:python-ecdsa 2:keyconv 3:secp256k1 + (default: 3) + -M, --mmgen-keys-from-file f Provide keys for MMGen addresses in a key- + address file (output of 'mmgen-keygen'). Permits + online signing without an MMGen seed source. The + key-address file is also used to verify MMGen-to-BTC + mappings, so the user should record its checksum. + -o, --output-to-reduce o Deduct the fee from output 'o' (an integer, or 'c' + for the transaction's change output, if present) + -O, --old-incog-fmt Specify old-format incognito input + -p, --hash-preset p Use the scrypt hash parameters defined by preset 'p' + for password hashing (default: '3') + -P, --passwd-file f Get MMGen wallet or bitcoind passphrase from file 'f' + -q, --quiet Suppress warnings; overwrite files without prompting + -s, --send Sign and send the transaction (the default if seed + data is provided) + -v, --verbose Produce more verbose output + -y, --yes Answer 'yes' to all prompts, suppress non-essential output + -z, --show-hash-presets Show information on available hash presets + + FEE SPECIFICATION: Transaction fees, both on the command line and at the + interactive prompt, may be specified as either absolute BTC amounts, using a + plain decimal number, or as satoshis per byte, using an integer followed by + the letter 's'. + + Transactions may contain both MMGen or non-MMGen input addresses. + + To sign non-MMGen inputs, a bitcoind wallet dump or flat key list is used + as the key source ('--keys-from-file' option). + + To sign MMGen inputs, key data is generated from a seed as with the + mmgen-addrgen and mmgen-keygen commands. Alternatively, a key-address file + may be used (--mmgen-keys-from-file option). + + Multiple wallets or other seed files can be listed on the command line in + any order. If the seeds required to sign the transaction's inputs are not + found in these files (or in the default wallet), the user will be prompted + for seed data interactively. + + To prevent an attacker from crafting transactions with bogus MMGen-to-Bitcoin + address mappings, all outputs to MMGen addresses are verified with a seed + source. Therefore, seed files or a key-address file for all MMGen outputs + must also be supplied on the command line if the data can't be found in the + default wallet. + + Seed source files must have the canonical extensions listed in the 'FileExt' + column below: + + Format FileExt Valid codes + ------ ------- ----------- + Brainwallet .mmbrain mmbrain,brainwallet,brain,bw,b + HexSeedFile .mmhex seedhex,hexseed,hex,mmhex + IncogWallet .mmincog mmincog,incog,icg,i + IncogWalletHex .mmincox mmincox,incox,incog_hex,xincog,ix,xi + IncogWalletHidden None incog_hidden,hincog,ih,hi + Mnemonic .mmwords mmwords,words,mnemonic,mnem,mn,m + SeedFile .mmseed mmseed,seed,s + Wallet .mmdat wallet,w + + MMGEN v0.9.1 May 2017 MMGEN-TXBUMP(1) diff --git a/man-txcreate.md b/man-txcreate.md index 2b69864..9ea85dc 100644 --- a/man-txcreate.md +++ b/man-txcreate.md @@ -9,18 +9,20 @@ -C, --tx-confs c Desired number of confirmations (default: 3) -d, --outdir d Specify an alternate directory 'd' for output -f, --tx-fee f Transaction fee (default: 0.0003 BTC (but see below)) - -m, --minconf n Minimum number of confirmations required to spend outputs (default: 1) -i, --info Display unspent outputs and exit + -m, --minconf n Minimum number of confirmations required to spend outputs (default: 1) -q, --quiet Suppress warnings; overwrite files without prompting + -r, --rbf Make transaction BIP 125 replaceable (replace-by-fee) -v, --verbose Produce more verbose output + -y, --yes Answer 'yes' to all prompts, suppress non-essential output The transaction's outputs are specified on the command line, while its inputs are chosen from a list of the user's unpent outputs via an interactive menu. - If the transaction fee is not specified by the user, it will be calculated - using bitcoind's "estimatefee" function for the default (or user-specified) - number of confirmations. If "estimatefee" fails, the global default fee of - 0.0003 BTC will be used. + If the transaction fee is not specified by the user (see FEE SPECIFICATION + below), it will be calculated using bitcoind's "estimatefee" function for the + default (or user-specified) number of confirmations. If "estimatefee" fails, + the global default fee of 0.0003 BTC will be used. Dynamic fees will be multiplied by the value of '--tx-fee-adj', if specified. @@ -33,4 +35,9 @@ To send the value of all inputs (minus TX fee) to a single output, specify one address with no amount on the command line. - MMGEN v0.9.0 December 2016 MMGEN-TXCREATE(1) + FEE SPECIFICATION: Transaction fees, both on the command line and at the + interactive prompt, may be specified as either absolute BTC amounts, using a + plain decimal number, or as satoshis per byte, using an integer followed by + the letter 's'. + + MMGEN v0.9.1 May 2017 MMGEN-TXCREATE(1) diff --git a/man-txdo.md b/man-txdo.md index a7694ab..9906254 100644 --- a/man-txdo.md +++ b/man-txdo.md @@ -4,8 +4,8 @@ -h, --help Print this help message --longhelp Print help message for long options (common options) -a, --tx-fee-adj f Adjust transaction fee by factor 'f' (see below) - -b, --brain-params l,p Use seed length 'l' and hash preset 'p' for brainwallet - input + -b, --brain-params l,p Use seed length 'l' and hash preset 'p' for + brainwallet input -B, --no-blank Don't blank screen before displaying unspent outputs -c, --comment-file f Source the transaction's comment from file 'f' -C, --tx-confs c Desired number of confirmations (default: 3) @@ -20,8 +20,10 @@ with non-standard (< 256-bit) seed lengths. -k, --keys-from-file f Provide additional keys for non-MMGen addresses -K, --key-generator m Use method 'm' for public key generation - Options: 1:python-ecdsa 2:keyconv 3:secp256k1 (default: 3) - -m, --minconf n Minimum number of confirmations required to spend outputs (default: 1) + Options: 1:python-ecdsa 2:keyconv 3:secp256k1 + (default: 3) + -m, --minconf n Minimum number of confirmations required to spend + outputs (default: 1) -M, --mmgen-keys-from-file f Provide keys for MMGen addresses in a key- address file (output of 'mmgen-keygen'). Permits online signing without an MMGen seed source. The @@ -30,18 +32,20 @@ -O, --old-incog-fmt Specify old-format incognito input -p, --hash-preset p Use the scrypt hash parameters defined by preset 'p' for password hashing (default: '3') - -P, --passwd-file f Get MMGen wallet or bitcoind passphrase from file 'f' + -P, --passwd-file f Get MMGen wallet passphrase from file 'f' + -r, --rbf Make transaction BIP 125 (replace-by-fee) replaceable -q, --quiet Suppress warnings; overwrite files without prompting -v, --verbose Produce more verbose output + -y, --yes Answer 'yes' to all prompts, suppress non-essential output -z, --show-hash-presets Show information on available hash presets The transaction's outputs are specified on the command line, while its inputs are chosen from a list of the user's unpent outputs via an interactive menu. - If the transaction fee is not specified by the user, it will be calculated - using bitcoind's "estimatefee" function for the default (or user-specified) - number of confirmations. If "estimatefee" fails, the global default fee of - 0.0003 BTC will be used. + If the transaction fee is not specified by the user (see FEE SPECIFICATION + below), it will be calculated using bitcoind's "estimatefee" function for the + default (or user-specified) number of confirmations. If "estimatefee" fails, + the global default fee of 0.0003 BTC will be used. Dynamic fees will be multiplied by the value of '--tx-fee-adj', if specified. @@ -54,6 +58,11 @@ To send the value of all inputs (minus TX fee) to a single output, specify one address with no amount on the command line. + FEE SPECIFICATION: Transaction fees, both on the command line and at the + interactive prompt, may be specified as either absolute BTC amounts, using a + plain decimal number, or as satoshis per byte, using an integer followed by + the letter 's'. + Transactions may contain both MMGen or non-MMGen input addresses. To sign non-MMGen inputs, a bitcoind wallet dump or flat key list is used @@ -88,4 +97,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-TXDO(1) + MMGEN v0.9.1 May 2017 MMGEN-TXDO(1) diff --git a/man-txsend.md b/man-txsend.md index aaa9a2e..1166dfa 100644 --- a/man-txsend.md +++ b/man-txsend.md @@ -5,5 +5,6 @@ --longhelp Print help message for long options (common options) -d, --outdir d Specify an alternate directory 'd' for output -q, --quiet Suppress warnings; overwrite files without prompting + -y, --yes Answer 'yes' to all prompts, suppress non-essential output - MMGEN v0.9.0 December 2016 MMGEN-TXSEND(1) + MMGEN v0.9.1 May 2017 MMGEN-TXSEND(1) diff --git a/man-txsign.md b/man-txsign.md index 4b1bf7f..3d62f25 100644 --- a/man-txsign.md +++ b/man-txsign.md @@ -31,6 +31,7 @@ -I, --info Display information about the transaction and exit -t, --terse-info Like '--info', but produce more concise output -v, --verbose Produce more verbose output + -y, --yes Answer 'yes' to all prompts, suppress non-essential output Transactions may contain both MMGen or non-MMGen input addresses. @@ -66,4 +67,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-TXSIGN(1) + MMGEN v0.9.1 May 2017 MMGEN-TXSIGN(1) diff --git a/man-walletchk.md b/man-walletchk.md index eb49821..839fbd0 100644 --- a/man-walletchk.md +++ b/man-walletchk.md @@ -42,4 +42,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-WALLETCHK(1) + MMGEN v0.9.1 May 2017 MMGEN-WALLETCHK(1) diff --git a/man-walletconv.md b/man-walletconv.md index df2975b..bac8db8 100644 --- a/man-walletconv.md +++ b/man-walletconv.md @@ -9,9 +9,9 @@ -o, --out-fmt f Convert to wallet format 'f' (see FMT CODES below) -H, --hidden-incog-input-params f,o Read hidden incognito data from file 'f' at offset 'o' (comma-separated) - -J, --hidden-incog-output-params f,o Write hidden incognito data to file 'f' - at offset 'o' (comma-separated). File 'f' will be cre- - ated and filled with random data if it doesn't exist. + -J, --hidden-incog-output-params f,o Write hidden incognito data to file + 'f' at offset 'o' (comma-separated). File 'f' will be + created if necessary and filled with random data. -O, --old-incog-fmt Specify old-format incognito input -k, --keep-passphrase Reuse passphrase of input wallet for output wallet -K, --keep-hash-preset Reuse hash preset of input wallet for output wallet @@ -52,4 +52,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-WALLETCONV(1) + MMGEN v0.9.1 May 2017 MMGEN-WALLETCONV(1) diff --git a/man-walletgen.md b/man-walletgen.md index eccc767..22330b9 100644 --- a/man-walletgen.md +++ b/man-walletgen.md @@ -6,9 +6,9 @@ -d, --outdir d Output files to directory 'd' instead of working dir -e, --echo-passphrase Echo passphrases and other user input to screen -o, --out-fmt f Output to wallet format 'f' (see FMT CODES below) - -J, --hidden-incog-output-params f,o Write hidden incognito data to file 'f' - at offset 'o' (comma-separated). File 'f' will be cre- - ated and filled with random data if it doesn't exist. + -J, --hidden-incog-output-params f,o Write hidden incognito data to file + 'f' at offset 'o' (comma-separated). File 'f' will be + created if necessary and filled with random data. -l, --seed-len l Specify wallet seed length of 'l' bits. This option is required only for brainwallet and incognito inputs with non-standard (< 256-bit) seed lengths. @@ -45,4 +45,4 @@ SeedFile .mmseed mmseed,seed,s Wallet .mmdat wallet,w - MMGEN v0.9.0 December 2016 MMGEN-WALLETGEN(1) + MMGEN v0.9.1 May 2017 MMGEN-WALLETGEN(1)