Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2025-11-29 12:06:35 -05:00
Code Issues Projects Releases Packages Wiki Activity
xmr-btc-swap/swap
History
binarybaron 8f33fe5b41
feat(tauri, gui): Send event on changes to details, timelocks and tx_lock confirmations (#100) 
- Send event when new swap state is inserated into database. The event only has the `swap_id` attached. The frontend then sends a request to the `get_swap_info` command to retrieve the updated version
- Send event when the Bitcoin lock transaction gets a new confirmation 
- A new `watcher` daemon runs contineously and sends an event when the timelock updated. The event has the the `swap_id` and the timelock attached
- Display logs on `ProcessExitedPage` (if swap was stopped prematurely)
- Rename `CliLogEmittedEvent` to `TauriLogEvent`
- Apply env_filter to tracing terminal writer to silence logging from other crates
- Add `.env.*` files in `src-gui` to `.gitingore`

Closes #93 and #12
2024-10-09 15:06:57 +02:00
..
migrations feat: cargo project at root 2024-08-08 00:49:04 +02:00
proptest-regressions/bitcoin feat: cargo project at root 2024-08-08 00:49:04 +02:00
src feat(tauri, gui): Send event on changes to details, timelocks and tx_lock confirmations (#100) 2024-10-09 15:06:57 +02:00
tests fix(asb): Allow history command to be run while asb is running (#82) 2024-09-17 17:32:21 +02:00
build.rs feat: cargo project at root 2024-08-08 00:49:04 +02:00
Cargo.toml chore(swap): Disable cargo tauri integration feature by default (#74) 2024-09-09 22:08:50 +02:00
README.md docs: update READMEs (#25) 2024-08-23 13:26:10 +02:00
sqlite_dev_setup.sh feat: cargo project at root 2024-08-08 00:49:04 +02:00
sqlx-data.json feat(gui, tauri): Save settings in Tauri storage (#102) 2024-10-08 12:57:01 +02:00
tempdb feat: cargo project at root 2024-08-08 00:49:04 +02:00

README.md

XMR to BTC Atomic Swap

This repository hosts an MVP for atomically swapping BTC to XMR. It implements the protocol described in section 3 of this paper.

More information about the protocol in this presentation and this blog post.

Currently, swaps are only offered in one direction with the swap CLI on the buying side (send BTC, receive XMR). We are working on implementing a protocol where XMR moves first, but are currently blocked by advances on Monero itself. You can read this blogpost for more information.

Quick Start

  1. Download the latest swap binary release for your operating system.
  2. Find a seller to swap with:
./swap --testnet list-sellers
  1. Swap with a seller:
./swap --testnet buy-xmr --receive-address <YOUR MONERO ADDRESS> --change-address <YOUR BITCOIN CHANGE ADDRESS> --seller <SELLER MULTIADDRESS>

For more detailed documentation on the CLI, see this README.

Becoming a Market Maker

Swapping of course needs two parties - and the CLI is only one of them: The taker that occasionally starts a swap with a market maker.

If you are interested in becoming a market maker you will want to run the second binary provided in this repository: asb - the Automated Swap Backend. Detailed documentation for the asb can be found in this README.

Safety

This software is using cryptography that has not been formally audited. While we do our best to make it safe, it is up to the user to evaluate whether or not it is safe to use for their purposes. Please also see section 15 and 16 of the license.

Keep in mind that swaps are complex protocols, it is recommended to not do anything fancy when moving coins in and out. It is not recommended to bump fees when swapping because it can have unpredictable side effects.

Contributing

We encourage community contributions whether it be a bug fix or an improvement to the documentation. Please have a look at the contribution guidelines.

Rust Version Support

Please note that only the latest stable Rust toolchain is supported. All stable toolchains since 1.74 should work.

Contact

Feel free to reach out to us in the COMIT-Monero Matrix channel.