xmr-btc-swap/CHANGELOG.md

# Changelog

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

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [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](https://github.com/comit-network/xmr-btc-swap/issues/353) 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.

[Unreleased]: https://github.com/comit-network/xmr-btc-swap/compare/0.4.0...HEAD
[0.4.0]: https://github.com/comit-network/xmr-btc-swap/compare/v0.3...0.4.0
Add CHANGELOG file 2021-03-23 19:40:22 -04:00			`# Changelog`

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

			`The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),`
			`and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`

			`## [Unreleased]`

Prepare release 0.4.0 2021-04-06 04:20:31 -04:00			`## [0.4.0] - 2021-04-06`

Save Alice's peer-id in the db for Bob This allows loading the seller-peer-id from the database upon resuming a swap. Thus, the parameters `--seller-peer-id` is removed for the `resume` command. Other than the peer-id the multi address of a seller can change and thus is still a parameter. This parameter might become optional once we add DHT support. 2021-03-30 00:40:59 -04:00			`### Changed`

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

Add CHANGELOG file 2021-03-23 19:40:22 -04:00			`### Added`

			`- A changelog file.`
Alice resumes swaps 2021-03-26 00:38:30 -04:00			- Automatic resume of unfinished swaps for the `asb` upon startup.
			`Unfinished swaps from earlier versions will be skipped.`
Add a configurable spread to the ASB Fixes #381. 2021-03-31 22:00:15 -04:00			`- 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.
Add CHANGELOG file 2021-03-23 19:40:22 -04:00
Remove default connection details from CLI Connecting buyers to us by default is not consistent with our vision of a decentralised network of sellers. Closes #395 2021-04-01 00:13:29 -04:00			`### 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.`

Use language agnostic heuristic to check if monero_wallet_rpc is ready Our strategy of searching for a english string to determine if monero_wallet_rpc is ready is not compatible with languages other than english. Instead we assume the monero rpc is ready if it has stopped writing to stdout. We make a json rpc request to confirm this. A better solution would have been to configure the monero_wallet_rpc to always output in english but there is not command line argument to configure the language. Closes #353. 2021-03-24 23:03:00 -04:00			`### Fixed`

Re-word changelog entry for bad readiness check of monero-wallet-rpc 2021-03-31 20:31:05 -04:00			- An [issue](https://github.com/comit-network/xmr-btc-swap/issues/353) 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.
Use language agnostic heuristic to check if monero_wallet_rpc is ready Our strategy of searching for a english string to determine if monero_wallet_rpc is ready is not compatible with languages other than english. Instead we assume the monero rpc is ready if it has stopped writing to stdout. We make a json rpc request to confirm this. A better solution would have been to configure the monero_wallet_rpc to always output in english but there is not command line argument to configure the language. Closes #353. 2021-03-24 23:03:00 -04:00
Alice to validate Bob's PSBT for correctness In order for the re-construction of TxLock to be meaningful, we limit `Message2` to the PSBT instead of the full struct. This is a breaking change in the network layer. The PSBT is valid if: - It has at most two outputs (we allow a change output) - One of the outputs pays the agreed upon amount to a shared output script Resolves #260. 2021-03-24 03:30:55 -04:00			`### 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.`

Prepare release 0.4.0 2021-04-06 04:20:31 -04:00			`[Unreleased]: https://github.com/comit-network/xmr-btc-swap/compare/0.4.0...HEAD`
Replace commit hash with old versioning scheme v0.3 2021-04-06 06:09:42 -04:00			`[0.4.0]: https://github.com/comit-network/xmr-btc-swap/compare/v0.3...0.4.0`