xmr-btc-swap/CHANGELOG.md
Daniel Karzel c1e993deb2
Json codec for quote protocol
A `RequestResponseCodec` for pull-based protocols where the response is encoded using JSON.
This was added to more properly express the behavior of the quote protocol, where the dialer
doesn't send any message and expects the listener to directly send the response.

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
2021-04-16 16:00:45 +10:00

2.7 KiB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

  • Allow multiple concurrent swaps with the same peer on the ASB. This is a breaking change because the swap ID is now agreed upon between CLI and ASB during swap setup. Resuming swaps started prior to this change can result in unexpected behaviour.
  • Quote protocol returns JSON encoded data instead of CBOR. This is a breaking change in the protocol handling, old CLI versions will not be able to process quote requests of ASBs running this version.

Added

  • Websocket support for the ASB. The ASB is now capable to listen on both TCP and Websocket connections. Default websocket listening port is 9940.

0.4.0 - 2021-04-06

Changed

  • The resume command of the swap CLI no longer require the --seller-peer-id parameter. This information is now saved in the database.

Added

  • A changelog file.
  • Automatic resume of unfinished swaps for the asb upon startup. Unfinished swaps from earlier versions will be skipped.
  • A configurable spread for the ASB that is applied to the asking price received from the Kraken price ticker. The default value is 2% and can be configured using the --ask-spread parameter. See ./asb --help for details.

Changed

  • Require the buyer to specify the connection details of the peer they wish to swap with. Throughout the public demo phase of this project, the CLI traded with us by default if the peer id and multiaddress of the seller were not specified. Having the defaults made it easy for us to give something to the community that can easily be tested, however it is not aligned with our long-term vision of a decentralised network of sellers. We have removed these defaults forcing the user to specify the seller they wish to trade with.

Fixed

  • An issue where the swap CLI would fail on systems that were set to a locale different than English. A bad readiness check when waiting for monero-wallet-rpc to be ready caused the CLI to hang forever, preventing users from perform a swap.

Security

  • Fixed an issue where Alice would not verify if Bob's Bitcoin lock transaction is semantically correct, i.e. pays the agreed upon amount to an output owned by both of them. Fixing this required a breaking change on the network layer and hence old versions are not compatible with this version.