Merge #648: Suggestion for 0.2.2 release notes and 0.2.2 README. Feel…

… free to add…

db20a59 Suggestion for 0.2.2 release notes and 0.2.2 README. Feel free to add/remove/modify anything. (Alex Cato)

README.md

@@ -15,7 +15,7 @@ Widespread use of JoinMarket could improve bitcoin's fungibility as a commodity.
 ##Installation
 
 #####A NOTE ON UPDATING FROM PRE-0.2 VERSIONS
-The installation is slightly changed, with the secp256k1 python binding no longer being optional, and libnacl now being installed via pip, not locally. The short version is: do follow the below process, for example the secp256k1 binding must be the latest version else you'll get errors. Of course if you already have libsodium you don't need to re-install it. Be sure to read the [release notes](https://github.com/JoinMarket-Org/joinmarket/blob/develop/doc/release-notes-0.2.1.md).
+The installation is slightly changed, with the secp256k1 python binding no longer being optional, and libnacl now being installed via pip, not locally. The short version is: do follow the below process, for example the secp256k1 binding must be the latest version else you'll get errors. Of course if you already have libsodium you don't need to re-install it. Be sure to read the [release notes](https://github.com/JoinMarket-Org/joinmarket/blob/develop/doc/release-notes-0.2.2.md).
 
 #####REQUIRED INSTALLATION DEPENDENCIES (for Linux)
 
@@ -60,8 +60,8 @@ The installation is slightly changed, with the secp256k1 python binding no longe
 ###DEBIAN / UBUNTU QUICK INSTALL FOR USERS:
 
 1. `sudo apt-get update -y && sudo apt-get upgrade -y && sudo apt-get install python libsodium-dev python-pip -y`
-2. Download JoinMarket 0.2.1 source from the [releases page](https://github.com/joinmarket-org/joinmarket/releases/tag/v0.2.1) or [this direct link to v0.2.1](https://github.com/JoinMarket-Org/joinmarket/archive/v0.2.1.tar.gz)
-3. Extract with `tar xzf joinmarket-0.2.1.tar.gz` and then `cd joinmarket-0.2.1`
+2. Download JoinMarket 0.2.2 source from the [releases page](https://github.com/joinmarket-org/joinmarket/releases/tag/v0.2.2) or [this direct link to v0.2.2](https://github.com/JoinMarket-Org/joinmarket/archive/v0.2.2.tar.gz)
+3. Extract with `tar xzf joinmarket-0.2.2.tar.gz` and then `cd joinmarket-0.2.2`
 4. `sudo pip install -r requirements.txt`
 5. Generating your first wallet (`python wallet-tool.py generate`) will populate the configuration file: `joinmarket.cfg`.
    Check if the default settings suit your needs.
@@ -72,9 +72,9 @@ Tested up to TAILS version 2.6, but future versions likely will work as well.
 1. Make sure that you choose 'more options' when booting up tails and set an administrator password.
 2. `sudo apt-get update -y`
 3. `sudo apt-get install build-essential automake libtool pkg-config libffi-dev python-dev python libsodium-dev python-pip -y`
-4. Download JoinMarket 0.2.1 source from the [releases page](https://github.com/joinmarket-org/joinmarket/releases/tag/v0.2.1) or [this direct link to v0.2.1](https://github.com/JoinMarket-Org/joinmarket/archive/v0.2.1.tar.gz):
-   `wget https://github.com/JoinMarket-Org/joinmarket/archive/v0.2.1.tar.gz`
-5. Extract with `tar xzf joinmarket-0.2.1.tar.gz` and then `cd joinmarket-0.2.1`
+4. Download JoinMarket 0.2.2 source from the [releases page](https://github.com/joinmarket-org/joinmarket/releases/tag/v0.2.2) or [this direct link to v0.2.2](https://github.com/JoinMarket-Org/joinmarket/archive/v0.2.2.tar.gz):
+   `wget https://github.com/JoinMarket-Org/joinmarket/archive/v0.2.2.tar.gz`
+5. Extract with `tar xzf joinmarket-0.2.2.tar.gz` and then `cd joinmarket-0.2.2`
 6. `sudo torsocks pip install -r requirements.txt`
 7. `sudo chmod -R ugo+rX /usr/local/lib/python2.7/dist-packages/`
 8. `sudo cp -r /usr/local/lib/python2.7/dist-packages/libnacl .`

doc/release-notes-0.2.2.md

@@ -0,0 +1,54 @@
+JoinMarket 0.2.2:
+================= 
+
+<https://github.com/joinmarket-org/joinmarket/releases/tag/v0.2.2>
+
+This is a minor release with some workarounds to avoid the effect of non-responding makers and fixing bugs in 0.2.1, however there are also several bugfixes, and for some classes of users these bugs may be important, so please update immediately.
+
+Please report bugs using the issue tracker at github: 
+
+<https://github.com/joinmarket-org/joinmarket/issues> 
+
+Upgrading and downgrading 
+========================= 
+
+For users already running version 0.2.x it is only required to update the Joinmarket code, i.e. either `git pull` or download the zip from the release link above.
+
+Users updating from a version pre-0.2.0 **must** carefully follow the instructions for updating in the [previous release notes](https://github.com/JoinMarket-Org/joinmarket/blob/master/doc/release-notes-0.2.0.md)
+
+Bugfixes 
+======== 
+
+The bugfixes are for these specific issues:
+
+* yg-pe.py minsize option was initially not honored
+* crash in tumbler on restart due to index_cache not honoring extra mixdepths
+* wallet unspent explicitly None in AbstractWallet constructor, fixes crash bug in --rpcwallet when commitments cannot be sourced
+* cleaner shutdown when no commitments are available
+* bug in blockr query_utxo_set
+
+0.2.2 Change log
+================= 
+
+- `8d00f9c` Add gaplimit option for yield generators
+- `d40d113` Add agora-irc to config: a second, default irc server to connect to
+- `6210225` Add fast sync option for Core wallets
+- `03fbcfd` Change logging system to only show relevant messages on console by default
+- `c30c4cd` Add direct send feature from mixdepth using -N 0 in sendpayment script; includes sweep
+- `fcc1c5e` Add command dumpprivkey to wallet-tool.py
+- `baefc05` Modify default fee to 0.02% (yg-pe.py) and modify default maker_timeout_sec to 45 from 30 (bigger messages)
+- `???????` Allow fewer maker responses to complete a coinjoin, if some makers do not answer
+
+Credits 
+======= 
+
+Minor bugfixes and improvements by:
+@AdamISZ
+@adlai
+@AlexCato
+@CohibAA
+Martino Salvetti
+Bryan Stitt
+Daniel Kraft
+
+Thanks to those who submitted bug reports and otherwise helped out.