From a14bd9fdfb5ae843a5e1be12321d8857fcf0844f Mon Sep 17 00:00:00 2001 From: MMGen Date: Mon, 14 May 2018 20:06:41 +0000 Subject: [PATCH] Release notes formatting --- doc/release-notes/release-notes-v0.8.3.md | 14 +++---- doc/release-notes/release-notes-v0.8.5.md | 8 ++-- doc/release-notes/release-notes-v0.8.6.md | 12 ++++-- doc/release-notes/release-notes-v0.8.7.md | 22 +++++----- doc/release-notes/release-notes-v0.8.7pre.md | 12 ------ doc/release-notes/release-notes-v0.8.8.md | 40 ++++++++++--------- doc/release-notes/release-notes-v0.8.9.md | 32 +++++++++------ doc/release-notes/release-notes-v0.9.0.md | 17 ++++---- doc/release-notes/release-notes-v0.9.1.md | 42 +++++++++++++------- doc/release-notes/release-notes-v0.9.3.md | 11 +++-- doc/release-notes/release-notes-v0.9.5.md | 5 +-- doc/release-notes/release-notes-v0.9.6.md | 4 +- doc/release-notes/release-notes-v0.9.7.md | 10 +++-- doc/release-notes/release-notes-v0.9.8.md | 34 ++++++++-------- test/test.py | 4 +- 15 files changed, 147 insertions(+), 120 deletions(-) delete mode 100644 doc/release-notes/release-notes-v0.8.7pre.md diff --git a/doc/release-notes/release-notes-v0.8.3.md b/doc/release-notes/release-notes-v0.8.3.md index 9ad65acb..20e9928a 100644 --- a/doc/release-notes/release-notes-v0.8.3.md +++ b/doc/release-notes/release-notes-v0.8.3.md @@ -1,12 +1,12 @@ -MMGen version 0.8.3 +### MMGen version 0.8.3 Release Notes -New features/improvements: +#### New features/improvements: - * New native Bitcoin RPC library. - * Support for cookie-based RPC authentication (new in Bitcoin Core v0.12.0). - * Batch mode available when listing and importing addresses. - * mmgen-tool listaddresses: 'addrs' argument allows you to specify an - address or range of addresses. + - New native Bitcoin RPC library. + - Support for cookie-based RPC authentication (new in Bitcoin Core v0.12.0). + - Batch mode available when listing and importing addresses. + - mmgen-tool listaddresses: 'addrs' argument allows you to specify an + address or range of addresses. NOTE: if MMGen is already installed on your system, you must remove your existing installation by hand before installing this new version. On Linux, diff --git a/doc/release-notes/release-notes-v0.8.5.md b/doc/release-notes/release-notes-v0.8.5.md index a7efb108..fb7a04b7 100644 --- a/doc/release-notes/release-notes-v0.8.5.md +++ b/doc/release-notes/release-notes-v0.8.5.md @@ -1,9 +1,9 @@ -MMGen version 0.8.5 +### MMGen version 0.8.5 Release Notes -New features/improvements: +#### New features/improvements: - * Colored output - * Label editing in mmgen-txcreate + - Colored output + - Label editing in mmgen-txcreate This release includes a major object-oriented rewrite of much of the code. diff --git a/doc/release-notes/release-notes-v0.8.6.md b/doc/release-notes/release-notes-v0.8.6.md index eb26a981..9cd7b6cf 100644 --- a/doc/release-notes/release-notes-v0.8.6.md +++ b/doc/release-notes/release-notes-v0.8.6.md @@ -1,7 +1,11 @@ -**New features/improvements** +### MMGen version 0.8.6 Release Notes -- Address generation using secp256k1 library (Linux only) +#### New features/improvements: -Instructions for installing the secp256k1 library on your system can be found at doc/wiki/install-linux/Install-MMGen-on-Debian-or-Ubuntu-Linux.md + - Address generation using secp256k1 library (Linux only) -If secp256k1 is not installed on the system, MMGen will still be usable. It just falls back to 'keyconv', or failing that, python-ecdsa for generating addresses. +Instructions for installing the secp256k1 library on your system can be found at +doc/wiki/install-linux/Install-MMGen-on-Debian-or-Ubuntu-Linux.md + +If secp256k1 is not installed on the system, MMGen will still be usable. It just +falls back to 'keyconv', or failing that, python-ecdsa for generating addresses. diff --git a/doc/release-notes/release-notes-v0.8.7.md b/doc/release-notes/release-notes-v0.8.7.md index 044d08f7..ff71a268 100644 --- a/doc/release-notes/release-notes-v0.8.7.md +++ b/doc/release-notes/release-notes-v0.8.7.md @@ -1,12 +1,14 @@ -*Assorted fixes/improvements* +### MMGen version 0.8.7 Release Notes -- Importing addresses with `--rescan` working again -- Tracking and spending non-MMGen addresses now fully functional -- `mmgen-txcreate`: improvements in unspent outputs display -- `mmgen-txsign`: use bitcoind wallet dump as keylist fixed +#### Assorted fixes/improvements: -- Testnet support: - - Practice sending transactions without risking funds - (free testnet coins: https://tpfaucet.appspot.com/) - - Test suite fully supported - - To enable, set `MMGEN_TESTNET` environment variable + - Importing addresses with `--rescan` working again + - Tracking and spending non-MMGen addresses now fully functional + - `mmgen-txcreate`: improvements in unspent outputs display + - `mmgen-txsign`: use bitcoind wallet dump as keylist fixed + + - Testnet support: + + Practice sending transactions without risking funds + (free testnet coins: https://tpfaucet.appspot.com/) + + Test suite fully supported + + To enable, set `MMGEN_TESTNET` environment variable diff --git a/doc/release-notes/release-notes-v0.8.7pre.md b/doc/release-notes/release-notes-v0.8.7pre.md deleted file mode 100644 index 98c92330..00000000 --- a/doc/release-notes/release-notes-v0.8.7pre.md +++ /dev/null @@ -1,12 +0,0 @@ -Assorted fixes/improvements: - -- Importing addresses with --rescan working again -- Tracking and spending non-MMGen addresses fully functional -- mmgen-txcreate: improvements in unspent outputs display -- mmgen-txsign: use bitcoind wallet dump as keylist without modification - -- Testnet support: - - Practice sending transactions without risking real funds - (free testnet coins: https://tpfaucet.appspot.com/) - - Test suite fully supported - - To enable, set MMGEN_TESTNET environment variable diff --git a/doc/release-notes/release-notes-v0.8.8.md b/doc/release-notes/release-notes-v0.8.8.md index dae99ed7..30a2a9bd 100644 --- a/doc/release-notes/release-notes-v0.8.8.md +++ b/doc/release-notes/release-notes-v0.8.8.md @@ -1,20 +1,24 @@ -**Data directory, config file and default wallet support** -- Data directory is `~/.mmgen`; config file is `mmgen.cfg`. -- When default wallet is present in data directory, specifying the wallet - on the command line is optional. -- Datadir structure mirrors that of Bitcoin Core: mainnet and testnet share - a common config file, with testnet putting its own files, including the - default wallet, in the subdirectory 'testnet3'. -- Global vars are now overriden in this order: - 1) config file - 2) environmental variables beginning with `MMGEN_` (listed in globalvars.py) - 3) command line -- Long (common) opts added for setting global vars; display with `--longhelp`. +### MMGen version 0.8.8 Release Notes -The test suite has been updated to test these new features. +#### Data directory, config file and default wallet support: -**Other changes** -- Always get user entropy, even for non-critical randomness, unless `-r0`. -- rpcuser,rpcpassword now override cookie authentication, as with Core. -- Communication with remote bitcoind supported with `--rpc-host` option. -- Testnet use can be overridden with the `--testnet=0|1` option. + - Data directory is `~/.mmgen`; config file is `mmgen.cfg`. + - When default wallet is present in data directory, specifying the wallet + on the command line is optional. + - Datadir structure mirrors that of Bitcoin Core: mainnet and testnet share + a common config file, with testnet putting its own files, including the + default wallet, in the subdirectory 'testnet3'. + - Global vars are now overriden in this order: + 1) config file + 2) environmental variables beginning with `MMGEN_` (listed in globalvars.py) + 3) command line + - Long (common) opts added for setting global vars; display with `--longhelp`. + + The test suite has been updated to test these new features. + +#### Other changes: + + - Always get user entropy, even for non-critical randomness, unless `-r0`. + - rpcuser,rpcpassword now override cookie authentication, as with Core. + - Communication with remote bitcoind supported with `--rpc-host` option. + - Testnet use can be overridden with the `--testnet=0|1` option. diff --git a/doc/release-notes/release-notes-v0.8.9.md b/doc/release-notes/release-notes-v0.8.9.md index a9708e04..6e3a6fb6 100644 --- a/doc/release-notes/release-notes-v0.8.9.md +++ b/doc/release-notes/release-notes-v0.8.9.md @@ -1,15 +1,23 @@ -This release brings full functionality and wider testing to the MS Windows port. MMGen now works with both WinXP/MinGW32 and Win7+/MinGW64, and separate, updated installation instructions for both platforms have been added to the wiki. A working MinGW environment is now required to run MMGen. +### MMGen version 0.8.9 Release Notes -New Windows features: -- Full non-interactive test suite support with pexpect (PopenSpawn) -- secp256k1 address generation support -- Secure wallet deletion with sdelete +This release brings full functionality and wider testing to the MS Windows port. +MMGen now works with both WinXP/MinGW32 and Win7+/MinGW64, and separate, updated +installation instructions for both platforms have been added to the wiki. A +working MinGW environment is now required to run MMGen. -Windows bugfixes: -- A critical bug in writing the encrypted keyaddrfile has been fixed. This bug - would have affected only online wallet use and would not have led to the loss - of coins -- Cookie filename fixed; RPC cookie authentication now functional +#### New Windows features: -General features: -- --bitcoin-data-dir, --rpc-port, --rpc-user, and --rpc-password options + - Full non-interactive test suite support with pexpect (PopenSpawn) + - secp256k1 address generation support + - Secure wallet deletion with sdelete + +#### Windows bugfixes: + + - A critical bug in writing the encrypted keyaddrfile has been fixed. This bug + would have affected only online wallet use and would not have led to the loss + of coins + - Cookie filename fixed; RPC cookie authentication now functional + +#### General features: + + - --bitcoin-data-dir, --rpc-port, --rpc-user, and --rpc-password options diff --git a/doc/release-notes/release-notes-v0.9.0.md b/doc/release-notes/release-notes-v0.9.0.md index c6119979..e4690ac6 100644 --- a/doc/release-notes/release-notes-v0.9.0.md +++ b/doc/release-notes/release-notes-v0.9.0.md @@ -1,10 +1,13 @@ -New features: -- New `mmgen-txdo` command creates, signs and sends transactions in one operation -- Exporting seed to hexadecimal (mmhex) format now supported -- Support for 8-color terminals, better default colors on 256-color terminals -- `--force-256-color` option overrides terminfo entry and $TERM environment variable -- Selected commands of `mmgen-tool` now accept stdin input -- Transaction file format change: TXID appended to file after tx is broadcast +### MMGen version 0.9.0 Release Notes + +#### New features: + + - New `mmgen-txdo` command creates, signs and sends transactions in one operation + - Exporting seed to hexadecimal (mmhex) format now supported + - Support for 8-color terminals, better default colors on 256-color terminals + - `--force-256-color` option overrides terminfo entry and $TERM environment variable + - Selected commands of `mmgen-tool` now accept stdin input + - Transaction file format change: TXID appended to file after tx is broadcast A new tutorial, [Recovering Keys Without MMGen][01], has been added to the wiki diff --git a/doc/release-notes/release-notes-v0.9.1.md b/doc/release-notes/release-notes-v0.9.1.md index e52eab8b..11a34d44 100644 --- a/doc/release-notes/release-notes-v0.9.1.md +++ b/doc/release-notes/release-notes-v0.9.1.md @@ -1,24 +1,38 @@ -BIP 125 replace-by-fee (RBF) support: -- Create replaceable transactions using the `--rbf` switch to `mmgen-txcreate` and `mmgen-txdo` -- Create, and optionally sign and send, replacement transactions with the new `mmgen-txbump` command +### MMGen version 0.9.1 Release Notes -Satoshis-per-byte format: -- Tx fees, both on the command line and at the interactive prompt, may be specified either as absolute BTC amounts or in satoshis-per-byte format (an integer followed by the letter 's') +#### BIP 125 replace-by-fee (RBF) support: -Improved fee handling: -- Completely reworked fee-handling code with better fee checking -- default tx fee eliminated, max_tx_fee configurable in mmgen.cfg + - Create replaceable transactions using the `--rbf` switch to `mmgen-txcreate` + and `mmgen-txdo` + - Create, and optionally sign and send, replacement transactions with the new + `mmgen-txbump` command -Command scriptability: -- New `--yes` switch makes `mmgen-txbump` and `mmgen-txsign` fully non-interactive and `mmgen-txcreate` and `mmgen-txsend` mostly non-interactive +#### Satoshis-per-byte format: -Bugfixes and usability improvements: -- 'mmgen-tool listaddresses' now list addresses from multiple seeds correctly -- Improved user interaction with all 'mmgen-tx*' commands + - Tx fees, both on the command line and at the interactive prompt, may be + specified either as absolute BTC amounts or in satoshis-per-byte format (an + integer followed by the letter 's') + +#### Improved fee handling: + + - Completely reworked fee-handling code with better fee checking + - default tx fee eliminated, `max_tx_fee` configurable in mmgen.cfg + +#### Command scriptability: + + - New `--yes` switch makes `mmgen-txbump` and `mmgen-txsign` fully + non-interactive and `mmgen-txcreate` and `mmgen-txsend` mostly + non-interactive. + +#### Bugfixes and usability improvements: + + - 'mmgen-tool listaddresses' now list addresses from multiple seeds correctly + - Improved user interaction with all `mmgen-tx*` commands The RBF and new fee functionality are documented in the [Getting Started][01] guide. -The guide has also been updated with a new [Preliminaries][03] section and a new [Hot wallets and key-address files][02] section. +The guide has also been updated with a new [Preliminaries][03] section and a new +[Hot wallets and key-address files][02] section. [01]: https://github.com/mmgen/mmgen/wiki/Getting-Started-with-MMGen#a_fee [02]: https://github.com/mmgen/mmgen/wiki/Getting-Started-with-MMGen#a_hw diff --git a/doc/release-notes/release-notes-v0.9.3.md b/doc/release-notes/release-notes-v0.9.3.md index 173324aa..91c7dabf 100644 --- a/doc/release-notes/release-notes-v0.9.3.md +++ b/doc/release-notes/release-notes-v0.9.3.md @@ -1,12 +1,11 @@ -**New features:** +### MMGen version 0.9.3 Release Notes -- Bob and Alice regtest mode for testing MMGen in a mock two-user environment. - [Documented](https://github.com/mmgen/mmgen/wiki/MMGen-Quick-Start-with-Regtest-Mode) in the wiki, tests added to test suite +#### New features: + - Bob and Alice regtest mode for testing MMGen in a mock two-user environment. + [Documented](https://github.com/mmgen/mmgen/wiki/MMGen-Quick-Start-with-Regtest-Mode) + in the wiki, tests added to test suite - Compressed P2PKH address support (address type 'C') - - BCH (Bitcoin Cash) support - - Segwit (address type 'S') support deployed after Segwit activation on mainnet - - and, of course, numerous bugfixes and small improvements diff --git a/doc/release-notes/release-notes-v0.9.5.md b/doc/release-notes/release-notes-v0.9.5.md index f76f5647..d125a3dc 100644 --- a/doc/release-notes/release-notes-v0.9.5.md +++ b/doc/release-notes/release-notes-v0.9.5.md @@ -1,8 +1,7 @@ -URL: https://github.com/mmgen/mmgen/releases/tag/v0.9.5 +### MMGen version 0.9.5 Release Notes -**New features:** +#### New features: - Altcoin framework + full Litecoin support [(commit)](https://github.com/mmgen/mmgen/commit/35d10911596c76227b8cd6318681c6ac9dc02a42) - - Offline transaction autosigning [(commit)](https://github.com/mmgen/mmgen/commit/8fb3efd99cc2f62e7f12f0e1f9893dd287064035) [(VIDEO)](https://github.com/mmgen/mmgen/releases/tag/autosign) diff --git a/doc/release-notes/release-notes-v0.9.6.md b/doc/release-notes/release-notes-v0.9.6.md index c010f0a6..e83e0f17 100644 --- a/doc/release-notes/release-notes-v0.9.6.md +++ b/doc/release-notes/release-notes-v0.9.6.md @@ -1,4 +1,6 @@ -**New features:** +### MMGen version 0.9.6 Release Notes + +#### New features: - Key/address generation support for ETH, ETC, ZEC, XMR and 144 Bitcoin-derived altcoins - Zcash z-address support (Linux only) diff --git a/doc/release-notes/release-notes-v0.9.7.md b/doc/release-notes/release-notes-v0.9.7.md index cb938f02..38a1c9f2 100644 --- a/doc/release-notes/release-notes-v0.9.7.md +++ b/doc/release-notes/release-notes-v0.9.7.md @@ -1,6 +1,10 @@ -**New features:** +### MMGen version 0.9.7 Release Notes + +#### New features: - Monero wallet syncing utility (258651a) - - mmgen-tool listaddresses: add 'show_age','show_days' options (f7e54cc) + - mmgen-tool listaddresses: add `show_age`,`show_days` options (f7e54cc) -This release closes a serious exploit (6b9df0e). Upgrading is advised. In particular, the **offline** MMGen installation in an online/offline setup should be upgraded. +This release closes a serious exploit (6b9df0e). Upgrading is advised. In +particular, the **offline** MMGen installation in an online/offline setup should +be upgraded. diff --git a/doc/release-notes/release-notes-v0.9.8.md b/doc/release-notes/release-notes-v0.9.8.md index 86db0608..dfefa237 100644 --- a/doc/release-notes/release-notes-v0.9.8.md +++ b/doc/release-notes/release-notes-v0.9.8.md @@ -1,36 +1,36 @@ ### MMGen Version 0.9.8 Release Notes -**Interesting new features:** +#### Interesting new features: - - Bech32 address support (BTC: e4114ee, LTC: 2cb4df7) - - Stealth mnemonic entry (90ebc94) + - Bech32 address support (BTC: `e4114ee`, LTC: `2cb4df7`) + - Stealth mnemonic entry (`90ebc94`) -**New comprehensive UTF-8 support:** +#### New comprehensive UTF-8 support: - - UTF-8 filenames and paths (896c7fe) - - UTF-8 tracking wallet comments (d49c862) - - UTF-8 wallet labels (2104273) - - Proper formatting of CJK strings (ea6629d) + - UTF-8 filenames and paths (`896c7fe`) + - UTF-8 tracking wallet comments (`d49c862`) + - UTF-8 wallet labels (`2104273`) + - Proper formatting of CJK strings (`ea6629d`) -**Security/bugfixes:** +#### Security/bugfixes: - - `max_tx_file_size` and other TX file checks (cf20311) - - TX size estimation fixes (ed2b94c) - - Require brainwallet and passwords to be UTF-8 encoded (9f2153c) + - `max_tx_file_size` and other TX file checks (`cf20311`) + - TX size estimation fixes (`ed2b94c`) + - Require brainwallet and passwords to be UTF-8 encoded (`9f2153c`) -Coin daemons used for testing: +#### Coin daemons used for testing: - Bitcoin Core v0.16.0 - Litecoin Core v0.16.0rc1 - Bitcoin-ABC v0.17.1 - Monero v0.12.0.0 (Lithium Luna) -Tools used for testing: +#### Tools used for testing: - - Zcash-Mini (a2b3504) + - Zcash-Mini (`a2b3504`) - Pycoin v0.90a - Pyethereum v2.1.2 - - Vanitygen-Plus (5ca3d22) + - Vanitygen-Plus (`5ca3d22`) Note that some features, notably UTF-8 filename and path support, do not work on the MS Windows/MinGW platform. See the file [doc/README.mswin.md][1] for @@ -43,4 +43,4 @@ the case, you must change your wallet password to an ASCII one (or export your brainwallet to another MMGen wallet format) using an older version of MMGen before upgrading. -[1]: ../doc/README.mswin +[1]: ../../doc/README.mswin.md diff --git a/test/test.py b/test/test.py index 798d3b4c..1181f4d6 100755 --- a/test/test.py +++ b/test/test.py @@ -1257,8 +1257,8 @@ def make_brainwallet_file(fn): nwords,ws_list,max_spaces = 10,' \n',5 def rand_ws_seq(): nchars = getrandnum(1) % max_spaces + 1 - return ''.join([ws_list[getrandnum_range(1,200)%len(ws_list)] for i in range(nchars)]) - rand_pairs = [wl[getrandnum(1) % len(wl)] + rand_ws_seq() for i in range(nwords)] + return ''.join([ws_list[getrandnum_range(1,200) % len(ws_list)] for i in range(nchars)]) + rand_pairs = [wl[getrandnum_range(1,200) % len(wl)] + rand_ws_seq() for i in range(nwords)] d = ''.join(rand_pairs).rstrip() + '\n' if opt.verbose: msg_r('Brainwallet password:\n{}'.format(cyan(d))) write_data_to_file(fn,d,'brainwallet password',silent=True)