Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-10-01 01:45:40 -04:00
Code Issues Packages Projects Releases Wiki Activity
debug-remodel-tor
xmr-btc-swap/CHANGELOG.md

154 lines
8.9 KiB
Markdown
Raw Permalink Normal View History

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]
Print the Bitcoin address to the terminal as a QR code
2021-05-30 07:53:43 -04:00
### Added
- Printing the deposit address to the terminal as a QR code.
To not break automated scripts or integrations with other software, this behaviour is disabled if `--json` is passed to the application.
Changelog entry for price guarantee changes
2021-06-23 01:42:15 -04:00
### Fixed
- An issue where the ASB gives long price guarantees when setting up a swap.
Now, after sending a spot price the ASB will wait for one minute for the CLI's to trigger the execution setup, and three minutes to see the BTC lock transaction of the CLI in mempool after the swap started.
If the first timeout is triggered the execution setup will be aborted, if the second timeout is triggered the swap will be safely aborted.
Refactor transports to construct them specific for each application Instead of splitting up the transports into capabilities, we compose them directly for each application. This allows us to remove the websocket transport for the CLI which is really only needed for the ASB to allow retrieval of quotes via the browser.
2021-06-08 22:13:29 -04:00
### Removed
- The websocket transport from the CLI.
Websockets were only ever intended to be used for the ASB side to allow websites to retrieve quotes.
The CLI can use regular TCP connections and having both - TCP and websockets - causes problems and unnecessary overhead.
Prepare release 0.7.0
2021-05-28 03:17:26 -04:00
## [0.7.0] - 2021-05-28
Add ping protocol to ensure connection is alive Adds the ping behaviour to both ASB and CLI behaviour that periodically pings a connected party to ensure that the underlying network connection is still alive. This fixes problems with long-running connections that become dead without a connection closure being reported back to the swarm.
2021-05-25 21:40:55 -04:00
### Fixed
- An issue where long-running connections are dead without a connection closure being reported back to the swarm.
Adding a periodic ping ensures that the connection is kept alive, and a broken connection is reported back resulting in a close event on the swarm.
This fixes the error of the ASB being unable to send a transfer proof to the CLI.
Bitcoin network check when building PSBT This ensures that funds are not sent to an address on the wrong network.
2021-05-24 21:36:24 -04:00
- An issue where ASB Bitcoin withdrawal can be done to an address on the wrong network.
A network check was added that compares the wallet's network against the network of the given address when building the transaction.
Add ping protocol to ensure connection is alive Adds the ping behaviour to both ASB and CLI behaviour that periodically pings a connected party to ensure that the underlying network connection is still alive. This fixes problems with long-running connections that become dead without a connection closure being reported back to the swarm.
2021-05-25 21:40:55 -04:00
Prepare release 0.6.0
2021-05-23 23:46:07 -04:00
## [0.6.0] - 2021-05-24
Add resume-only mode for the ASB Resume-only is a maintenance mode where no swaps are accepted but unfinished swaps are resumed. This is achieve by ignoring incoming spot-price requests (that would lead to execution setup) in the event-loop.
2021-04-29 05:26:19 -04:00
### Added
ASB manual recovery commands Adds `cancel`, `refund`, `punish`, `redeem` and `safely-abort` commands to the ASB that can be used to trigger the specific scenario for the swap by ID.
2021-04-27 00:51:53 -04:00
- 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.
Move recovery commands in dedicated module Less clutter in the folder structure.
2021-04-28 02:13:04 -04:00
- 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`.
Add resume-only mode for the ASB Resume-only is a maintenance mode where no swaps are accepted but unfinished swaps are resumed. This is achieve by ignoring incoming spot-price requests (that would lead to execution setup) in the event-loop.
2021-04-29 05:26:19 -04:00
- 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.
Introduce a minimum buy amount Introduces a minimum buy Bitcoin amount similar to the maximum amount already present. For the CLI the minimum amount is enforced by waiting until at least the minimum is available as max-giveable amount.
2021-05-07 05:06:58 -04:00
- A minimum accepted Bitcoin amount for the ASB similar to the maximum amount already present.
For the CLI the minimum amount is enforced by waiting until at least the minimum is available as max-giveable amount.
Toggle json logs using commandline flag.
2021-05-09 22:03:43 -04:00
- Added a new argument to ASB: `--json` or `-j`. If set, log messages will be printed in JSON format.
Add resume-only mode for the ASB Resume-only is a maintenance mode where no swaps are accepted but unfinished swaps are resumed. This is achieve by ignoring incoming spot-price requests (that would lead to execution setup) in the event-loop.
2021-04-29 05:26:19 -04:00
Different default directories for CLI and ASB Using the same default directory as data-/config-dir has caused unwanted side effects when running both applications on the same machine. Use these directory names: - ASB: xmr-btc-swap-asb - CLI: xmr-btc-swap-cli Since the functionality is now application specific the respective functions were moved into the appropriate module of the application.
2021-04-29 04:50:49 -04:00
### Fixed
- An issue where both the ASB and the CLI point to the same default directory `xmr-btc-swap` for storing data.
!fixup Different default directories for CLI and ASB Using the same default directory as data-/config-dir has caused unwanted side effects when running both applications on the same machine. Use these directory names: - ASB: xmr-btc-swap/asb - CLI: xmr-btc-swap/cli Since the functionality is now application specific the respective functions were moved into the appropriate module of the application.
2021-04-29 21:01:30 -04:00
The asb now uses `xmr-btc-swap/asb` and the CLI `xmr-btc-swap/cli` as default directory.
Different default directories for CLI and ASB Using the same default directory as data-/config-dir has caused unwanted side effects when running both applications on the same machine. Use these directory names: - ASB: xmr-btc-swap-asb - CLI: xmr-btc-swap-cli Since the functionality is now application specific the respective functions were moved into the appropriate module of the application.
2021-04-29 04:50:49 -04:00
This is a breaking change.
!fixup Different default directories for CLI and ASB Using the same default directory as data-/config-dir has caused unwanted side effects when running both applications on the same machine. Use these directory names: - ASB: xmr-btc-swap/asb - CLI: xmr-btc-swap/cli Since the functionality is now application specific the respective functions were moved into the appropriate module of the application.
2021-04-29 21:01:30 -04:00
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.
Return proper error to CLI for all expected scenarios When a CLI requests a spot price have some errors that are expected, where we can provide a proper error message for the CLI: - Balance of ASB too low - Buy amount sent by CLI exceeds maximum buy amount accepted by ASB - ASB is running in maintenance mode and does not accept incoming swap requests All of these errors returns a proper error to the CLI and prints a warning in the ASB logs. Any other unexpected error will result in closing the channel with the CLI and printing an error in the ASB logs.
2021-04-29 22:36:26 -04:00
- 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
Explicitly specify `monero-wallet-rpc` deamon port In order to allow people to plug into public nodes / be more flexible with their own setup we now enforce specifying the monero daemon port to be used by the `monero-wallet-rpc`.
2021-05-10 22:37:13 -04:00
- An issue where the monero daemon port used by the `monero-wallet-rpc` could not be specified.
The CLI parameter `--monero-daemon-host` was changed to `--monero-daemon-address` where host and port have to be specified.
Bitcoin transaction published state This improves the error handling on the ASB. Once the Bitcoin redeem transaction is seen in mempool, the state machine cannot transition to a cancel scenario anymore because at that point the CLI will have redeemed the Monero. The additional state then waits for transaction finality.
2021-05-22 22:59:21 -04:00
- An issue where an ASB redeem scenario can transition to a cancel and publish scenario that will fail.
This is a breaking change for the ASB, because it introduces a new state into the database.
Different default directories for CLI and ASB Using the same default directory as data-/config-dir has caused unwanted side effects when running both applications on the same machine. Use these directory names: - ASB: xmr-btc-swap-asb - CLI: xmr-btc-swap-cli Since the functionality is now application specific the respective functions were moved into the appropriate module of the application.
2021-04-29 04:50:49 -04:00
Move `max_buy` and `ask_spread` into config 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 ```
2021-05-06 23:25:25 -04:00
### Changed
Introduce a minimum buy amount Introduces a minimum buy Bitcoin amount similar to the maximum amount already present. For the CLI the minimum amount is enforced by waiting until at least the minimum is available as max-giveable amount.
2021-05-07 05:06:58 -04:00
- The ASB's `--max-buy` and `ask-spread` parameter were removed in favour of entries in the config file.
Move `max_buy` and `ask_spread` into config 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 ```
2021-05-06 23:25:25 -04:00
The initial setup includes setting these two values now.
Mainnet changelog entry
2021-05-11 08:30:48 -04:00
- From this version on the CLI and ASB run on **mainnet** by default!
When running either application with `--testnet` Monero network defaults to `stagenet` and Bitcoin network to `testnet3`.
This is a breaking change.
It is recommended to run the applications with `--testnet` first and not just run the application on `mainnet` without experience.
Move `max_buy` and `ask_spread` into config 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 ```
2021-05-06 23:25:25 -04:00
Prepare release 0.5.0
2021-04-17 03:23:09 -04:00
## [0.5.0] - 2021-04-17
Add changelog entry for redial fix
2021-04-14 20:16:34 -04:00
### Changed
Better wording
2021-04-17 02:51:41 -04:00
- The quote protocol returns JSON encoded data instead of CBOR.
Add changelog entry for redial fix
2021-04-14 20:16:34 -04:00
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.
Rewrite changelog entry as fix rather than a change
2021-04-14 20:15:11 -04:00
### Fixed
Multiple swaps with the same peer - Swap-id is exchanged during execution setup. CLI (Bob) sends the swap-id to be used in his first message. - Transfer poof and encryption signature messages include the swap-id so it can be properly associated with the correct swap. - ASB: Encryption signatures are associated with swaps by swap-id, not peer-id. - ASB: Transfer proofs are still associated to peer-ids (because they have to be sent to the respective peer), but the ASB can buffer multiple - CLI: Incoming transfer proofs are checked for matching swap-id. If a transfer proof with a different swap-id than the current executing swap is received it will be ignored. We can change this to saving into the database. Includes concurrent swap tests with the same Bob. - One test that pauses and starts an additional swap after the transfer proof was received. Results in both swaps being redeemed after resuming the first swap. - One test that pauses and starts an additional swap before the transfer proof is sent (just after BTC locked). Results in the second swap redeeming and the first swap being refunded (because the transfer proof on Bob's side is lost). Once we store transfer proofs that we receive during executing a different swap into the database both swaps should redeem. Note that the monero harness was adapted to allow creating wallets with multiple outputs, which is needed for Alice.
2021-04-08 04:56:26 -04:00
Rewrite changelog entry as fix rather than a change
2021-04-14 20:15:11 -04:00
- 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.
Add changelog entry for redial fix
2021-04-14 20:16:34 -04:00
- 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.
Multiple swaps with the same peer - Swap-id is exchanged during execution setup. CLI (Bob) sends the swap-id to be used in his first message. - Transfer poof and encryption signature messages include the swap-id so it can be properly associated with the correct swap. - ASB: Encryption signatures are associated with swaps by swap-id, not peer-id. - ASB: Transfer proofs are still associated to peer-ids (because they have to be sent to the respective peer), but the ASB can buffer multiple - CLI: Incoming transfer proofs are checked for matching swap-id. If a transfer proof with a different swap-id than the current executing swap is received it will be ignored. We can change this to saving into the database. Includes concurrent swap tests with the same Bob. - One test that pauses and starts an additional swap after the transfer proof was received. Results in both swaps being redeemed after resuming the first swap. - One test that pauses and starts an additional swap before the transfer proof is sent (just after BTC locked). Results in the second swap redeeming and the first swap being refunded (because the transfer proof on Bob's side is lost). Once we store transfer proofs that we receive during executing a different swap into the database both swaps should redeem. Note that the monero harness was adapted to allow creating wallets with multiple outputs, which is needed for Alice.
2021-04-08 04:56:26 -04:00
Listen on tcp and websocket transports - Listen on both tcp and websockets as default - Listening addresses in config as array - Configure fallback transport using `or_transport` - if listening on a given address fails on WS, we fall back to TCP.
2021-04-07 20:02:13 -04:00
### 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.
Add support for swapping through Tor. This PR does a few things. * It adds a TorTransport which either dials through Tor's socks5 proxy or via clearnet. * It enables ASB to register hidden services for each network it is listening on. We assume that we only care about different ports and re-use the same onion-address for all of them. The ASB requires to have access to Tor's control port. * It adds support to dial through a local Tor socks5 proxy. We assume that Tor is always available on localhost. Swap cli only requires Tor to be running so that it can send messages via Tor's socks5 proxy. * It adds a new e2e test which swaps through Tor. For this we assume that Tor is currently running on localhost. All other tests are running via clear net.
2021-04-21 21:33:36 -04:00
- Tor support as an optional feature.
Apply suggestions from code review Co-authored-by: Daniel Karzel <daniel.karzel@coblox.tech>
2021-04-28 02:04:25 -04:00
If ASB detects that Tor's control port is open, a hidden service is created for
the network it is listening on (currently 2).
Add support for swapping through Tor. This PR does a few things. * It adds a TorTransport which either dials through Tor's socks5 proxy or via clearnet. * It enables ASB to register hidden services for each network it is listening on. We assume that we only care about different ports and re-use the same onion-address for all of them. The ASB requires to have access to Tor's control port. * It adds support to dial through a local Tor socks5 proxy. We assume that Tor is always available on localhost. Swap cli only requires Tor to be running so that it can send messages via Tor's socks5 proxy. * It adds a new e2e test which swaps through Tor. For this we assume that Tor is currently running on localhost. All other tests are running via clear net.
2021-04-21 21:33:36 -04:00
The Tor control port as well as Tor socks5 proxy port is configurable.
Listen on tcp and websocket transports - Listen on both tcp and websockets as default - Listening addresses in config as array - Configure fallback transport using `or_transport` - if listening on a given address fails on WS, we fall back to TCP.
2021-04-07 20:02:13 -04:00
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.7.0
2021-05-28 03:17:26 -04:00
[Unreleased]: https://github.com/comit-network/xmr-btc-swap/compare/0.7.0...HEAD
[0.7.0]: https://github.com/comit-network/xmr-btc-swap/compare/0.6.0...0.7.0
Prepare release 0.6.0
2021-05-23 23:46:07 -04:00
[0.6.0]: https://github.com/comit-network/xmr-btc-swap/compare/0.5.0...0.6.0
Prepare release 0.5.0
2021-04-17 03:23:09 -04:00
[0.5.0]: https://github.com/comit-network/xmr-btc-swap/compare/0.4.0...0.5.0
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
Reference in New Issue Copy Permalink