Skip to content

Commit

Permalink
Merge #949: add release notes and version for 0.9.0
Browse files Browse the repository at this point in the history
ef69ec0 add release notes and version for 0.9.0 (Adam Gibson)
  • Loading branch information
AdamISZ committed Jul 31, 2021
2 parents 9516cf9 + ef69ec0 commit ebf9e55
Show file tree
Hide file tree
Showing 9 changed files with 153 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/JOINMARKET-QT-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The GUI can be run directly from Python script by doing `./joinmarket-qt.sh` from within `scripts/`, or, if using Microsoft Windows, by running the executable file/binary (**[CLICK HERE](https://github.com/JoinMarket-Org/joinmarket-clientserver/releases)** to download the latest release). If you followed normal installation procedure under Linux, desktop entry of JoinMarketQt should be added to the application menu of your desktop environment.

**LATEST VERSION of JoinMarket-Qt is GUI version 21**. You can check the version via `About` in the menu.
**LATEST VERSION of JoinMarket-Qt is GUI version 22**. You can check the version via `About` in the menu.

No other files / setup should be needed.

Expand Down
144 changes: 144 additions & 0 deletions docs/release-notes/release-notes-0.9.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
Joinmarket-clientserver 0.9.0:
=================

<https://github.com/joinmarket-org/joinmarket-clientserver/releases/tag/v0.9.0>

Please report bugs using the issue tracker at github:

<https://github.com/joinmarket-org/joinmarket-clientserver/issues>

Upgrading
=========

To upgrade:

(If you are upgrading from a version pre-0.6.2 then please see the section "Move user data to home directory" in [the 0.6.2 release notes](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/release-notes/release-notes-0.6.2.md), and follow the instructions there (except the `commitmentlist` file - that can actually be left alone, the previous release notes were wrong on this point).)

(If you are upgrading from a version pre-0.7.0 please read the "Upgrading" section in [the 0.7.0 release notes](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/release-notes/release-notes-0.7.0.md).)

First run the `install.sh` script as mentioned in the README. When prompted to overwrite the directory `jmvenv`, accept.

Note that `./install.sh -?` will show the options for installation.

Notable changes
===============

**Note: this is very much "the fidelity bond release". There are almost no other changes in this release, because it's a big and important change.**

### Fidelity bond for improving sybil attack resistance

From the very beginning of JoinMarket it was possible to attack the system by creating many many maker bots all controlled by the same person. If an unlucky taker came along and created a coinjoin only with those duplicated maker bots then their coinjoins could be easily unmixed by the controller of those maker bots (but still could not be unmixed this way by outside observers). This is called a Sybil attack and until now it was relatively cheap to do against JoinMarket. Some yield generators were already doing this by running multiple bots, because they could earn higher coinjoin fees from their multiple makers.

Fidelity bonds are a new feature intended to resist Sybil attacks by making them a lot more expensive to carry out. It works by allowing JoinMarket makers to lock up bitcoins into time locked addresses. Until now takers have chosen their maker bots randomly. After this update takers will still choose randomly but with a higher probability of choosing makers who have advertised more valuable fidelity bonds. Any Sybil attacker therefore has to lock up many many bitcoins into time locked addresses.

For full details of the scheme see: [Design for improving JoinMarket's resistance to sybil attacks using fidelity bonds](https://gist.github.com/chris-belcher/18ea0e6acdb885a2bfbdee43dcd6b5af/)

This release implements all the features needed to add fidelity bonds to JoinMarket. Takers (via scripts such as `sendpayment.py` or `tumbler.py` or the Joinmarket-Qt app) will automatically give preference to makers who advertise fidelity bonds. Makers can optionally update their wallets to fidelity bond wallets. When a fidelity bond wallet is used with a yield generator script, it will automatically announce its fidelity bond publicly. Makers who don't create fidelity bonds by locking up bitcoins will still be chosen for coinjoins occasionally, but probably much less often than before.

For full user documentation see the file [fidelity-bonds.md](../fidelity-bonds.md) in the repository.

With realistic assumptions we have calculated that an adversary would need to lock up around 50000 bitcoins for 6 months in order to Sybil attack the JoinMarket system with 95% success rate. Now that fidelity bonds are being added to JoinMarket for real we can see how the system behaves in practice.

Fidelity bond coins cannot yet be held in cold storage, but this is easy to add later because the JoinMarket protocol is set up in a way that the change would be backward-compatible.

`199b571` Consider fidelity bonds when choosing makers

`97b8b3b` Show fidelity bonds on orderbook watch html page

`7a50c76` Announce yieldgenerator's fidelity bond

`6b6fc4a` Handle fidelity bonds in client-server protocol

`662f097` Write and update fidelity bond docs

`eb0a738` Add interest rate option to config file

`d4b3f70` Enable creation of fidelity bond wallets on cli

`b9eab6e` Increase max locktime of fidelity bond wallets

`a3b3cd4` Make fidelity bond wallets be native segwit

`a3b775b` Increase default fee by 4x

`9a372fd` Add getblockhash RPC method

`e6c0847` Add calculate fidelity bond value function + tests

`c70b12f` For timelock addrs use new pubkey foreach locktime

`3dc8d86` Fix importprivkey on fidelity bond wallets

`bbd3d1b` Print privacy warning when showing timelocked addr

`1ea62a7` Fix bug with timelocked addrs in receive payjoin

`4868343` Fix showutxos wallettool method for fidelity bonds

`b27659c` Support fidelity bond wallet in Qt

#### Minor Qt changes:

Recent testing indicated that the Qt view update can
be slow and profiling the code showed that this was due to
re-calculation of wallet view hitting the backend python-bitcointx
deserialization routines too hard. The obvious solution is to not
recalculate the wallet view in a polling loop, but only when a change
occurs in the wallet (though this can be optimized further, it's
already much more responsive than before):

`f857e6e` Fix Qt wallet view update to be reactive

`7be5e5d` By default auto-expand mixdepth 0

`0e2850a` Auto expand internal addresses that has non zero balances,
and only auto expand the external addresses of mix depth 0.

#### Documentation updates

`e970a01` Create release notes section for fidelity bonds

`55d1bc9` Update readme.md and yieldgenerator.md for f-bonds

`cea4d95` add hosted obwatcher reference to readme

`17dd296` Add workflow status badge to top of README

### Testing and dev related background fixes

These are almost entirely not related to user functionality.
We have re-instantiated CI via Github Actions (Travis was used a long
time ago), which seems to be working well so far.

`81bade7` Update ygrunner to use fidelity bonds

`6cf4162` Add fidelity bond protocol tests

`940b083` Remove unused imports

`57f4720` Fix payjoin test of lowfeerate

`d9d594c` Allow bitcoin_path both with and without trailing slash

`e25dfda` first GA commit

`e3cc49b` github action test runner

`41a3ae4` make flake verbose and remove comments

Credits
=======

Thanks to everyone who directly contributed to this release -

- @wukong1971
- @kristapsk
- @bisqubutor
- @chris-belcher
- @AdamISZ
- @Evanito
- @undeath

And thanks also to those who submitted bug reports, reviewed and otherwise helped out.


19 changes: 0 additions & 19 deletions docs/release-notes/release-notes-fidelity-bonds.md

This file was deleted.

2 changes: 1 addition & 1 deletion jmbase/jmbase/support.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import urllib.parse as urlparse

# JoinMarket version
JM_CORE_VERSION = '0.9.0dev'
JM_CORE_VERSION = '0.9.0'

# global Joinmarket constants
JM_WALLET_NAME_PREFIX = "joinmarket-wallet-"
Expand Down
2 changes: 1 addition & 1 deletion jmbase/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


setup(name='joinmarketbase',
version='0.9.0dev',
version='0.9.0',
description='Joinmarket client library for Bitcoin coinjoins',
url='http://github.com/Joinmarket-Org/joinmarket-clientserver/jmbase',
author='',
Expand Down
2 changes: 1 addition & 1 deletion jmbitcoin/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


setup(name='joinmarketbitcoin',
version='0.9.0dev',
version='0.9.0',
description='Joinmarket client library for Bitcoin coinjoins',
url='http://github.com/Joinmarket-Org/joinmarket-clientserver/jmbitcoin',
author='',
Expand Down
4 changes: 2 additions & 2 deletions jmclient/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@


setup(name='joinmarketclient',
version='0.9.0dev',
version='0.9.0',
description='Joinmarket client library for Bitcoin coinjoins',
url='http://github.com/Joinmarket-Org/joinmarket-clientserver/jmclient',
author='',
author_email='',
license='GPL',
packages=['jmclient'],
install_requires=['joinmarketbase==0.9.0dev', 'mnemonic', 'argon2_cffi',
install_requires=['joinmarketbase==0.9.0', 'mnemonic', 'argon2_cffi',
'bencoder.pyx>=2.0.0', 'pyaes'],
python_requires='>=3.6',
zip_safe=False)
4 changes: 2 additions & 2 deletions jmdaemon/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@


setup(name='joinmarketdaemon',
version='0.9.0dev',
version='0.9.0',
description='Joinmarket client library for Bitcoin coinjoins',
url='http://github.com/Joinmarket-Org/joinmarket-clientserver/jmdaemon',
author='',
author_email='',
license='GPL',
packages=['jmdaemon'],
install_requires=['txtorcon', 'cryptography==3.3.2', 'pyopenssl', 'libnacl', 'joinmarketbase==0.9.0dev'],
install_requires=['txtorcon', 'cryptography==3.3.2', 'pyopenssl', 'libnacl', 'joinmarketbase==0.9.0'],
python_requires='>=3.6',
zip_safe=False)
2 changes: 1 addition & 1 deletion scripts/joinmarket-qt.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
donation_address_url = "https://bitcoinprivacy.me/joinmarket-donations"

#Version of this Qt script specifically
JM_GUI_VERSION = '22dev'
JM_GUI_VERSION = '22'

from jmbase import get_log, stop_reactor
from jmbase.support import DUST_THRESHOLD, EXIT_FAILURE, utxo_to_utxostr,\
Expand Down

0 comments on commit ebf9e55

Please sign in to comment.