mirror of
https://github.com/comit-network/xmr-btc-swap.git
synced 2024-10-31 15:20:15 +00:00
1d62f4916c
Max-buy and spread is not something that one would configure on every run. More convenient to keep this in the config. The max-buy Bitcoin value was adapted to `0.02` which is more reasonable for mainnet. Activated feature `serde-float` to serialize the spread (Decimal) as float instead of string. ``` ... [maker] max_buy_btc = 0.02 ask_spread = 0.02 ```
112 lines
6.1 KiB
Markdown
112 lines
6.1 KiB
Markdown
# 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]
|
|
|
|
### Added
|
|
|
|
- Cancel command for the ASB that allows cancelling a specific swap by id.
|
|
Using the cancel command requires the cancel timelock to be expired, but `--force` can be used to circumvent this check.
|
|
- Refund command for the ASB that allows refunding a specific swap by id.
|
|
Using the refund command to refund the XMR locked by the ASB requires the CLI to first refund the BTC of the swap.
|
|
If the BTC was not refunded yet the command will print an error accordingly.
|
|
The command has a `--force` flag that allows executing the command without checking for cancel constraints.
|
|
- Punish command for the ASB that allows punishing a specific swap by id.
|
|
Includes a `--force` parameter that when set disables the punish timelock check and verifying that the swap is in a cancelled state already.
|
|
- Abort command for the ASB that allows safely aborting a specific swap.
|
|
Only swaps in a state prior to locking XMR can be safely aborted.
|
|
- Redeem command for the ASB that allows redeeming a specific swap.
|
|
Only swaps where we learned the encrypted signature are redeemable.
|
|
The command checks for expired timelocks to ensure redeeming is safe, but the timelock check can be disable using the `--force` flag.
|
|
By default we wait for finality of the redeem transaction; this can be disabled by setting `--do-not-await-finality`.
|
|
- Resume-only mode for the ASB.
|
|
When started with `--resume-only` the ASB does not accept new, incoming swap requests but only finishes swaps that are resumed upon startup.
|
|
|
|
### Fixed
|
|
|
|
- An issue where both the ASB and the CLI point to the same default directory `xmr-btc-swap` for storing data.
|
|
The asb now uses `xmr-btc-swap/asb` and the CLI `xmr-btc-swap/cli` as default directory.
|
|
This is a breaking change.
|
|
If you want to access data created by a previous version you will have to rename the data folder or one of the following:
|
|
1. For the CLI you can use `--data-dir` to point to the old directory.
|
|
2. For the ASB you can change the data-dir in the config file of the ASB.
|
|
- The CLI receives proper Error messages if setting up a swap with the ASB fails.
|
|
This is a breaking change because the spot-price protocol response changed.
|
|
Expected errors scenarios that are now reported back to the CLI:
|
|
1. Balance of ASB too low
|
|
2. Buy amount sent by CLI exceeds maximum buy amount accepted by ASB
|
|
3. ASB is running in resume-only mode and does not accept incoming swap requests
|
|
|
|
### Changed
|
|
|
|
- The ASB's `--max-buy` and `ask-spread` parameter were removed in favour of entries in the config file.
|
|
The initial setup includes setting these two values now.
|
|
|
|
## [0.5.0] - 2021-04-17
|
|
|
|
### Changed
|
|
|
|
- The 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.
|
|
|
|
### Fixed
|
|
|
|
- An issue where concurrent swaps with the same peer would cause the ASB to handle network communication incorrectly.
|
|
To fix this, all messages are now tagged with a unique identifier that is agreed upon at the start of the swap.
|
|
This is a breaking change in the network layer and hence old versions are not compatible with this version.
|
|
We advise to also not resume any swaps that have been created with an older version.
|
|
It is recommended to reset / delete the database after upgrading.
|
|
- An issue where the CLI would not reconnect to the ASB in case the network connection dropped.
|
|
We now attempt to re-establish the connection using an exponential backoff but will give up eventually after 5 minutes.
|
|
|
|
### 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.
|
|
- Tor support as an optional feature.
|
|
If ASB detects that Tor's control port is open, a hidden service is created for
|
|
the network it is listening on (currently 2).
|
|
The Tor control port as well as Tor socks5 proxy port is configurable.
|
|
|
|
## [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.5.0...HEAD
|
|
[0.5.0]: https://github.com/comit-network/xmr-btc-swap/compare/0.4.0...0.5.0
|
|
[0.4.0]: https://github.com/comit-network/xmr-btc-swap/compare/v0.3...0.4.0
|