Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-25 15:39:25 -05:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
984 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
ccadc082eb
Go to file
bors[bot] ccadc082eb
Merge #316 
316: Minor fixes in README.md r=thomaseizinger a=luckysori

I was looking at this readme as inspiration for the one in `comit-network/waves` and I found a couple of little mistakes and a suggestion.

Hope it helps!

Co-authored-by: Lucas Soriano <lucas@coblox.tech>
2021-03-17 05:29:12 +00:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github/workflows Re-introduce punish test 2021-03-16 18:34:00 +11:00
monero-harness No prefix for wallets in monero harness 2021-03-03 17:03:34 +11:00
monero-rpc Remove unused field 2021-03-11 15:34:27 +11:00
swap Merge #307 2021-03-17 05:10:50 +00:00
tokio-tar Download and run monero wallet rpc on swap cli startup 2021-02-25 11:21:41 +11:00
.gitignore Push cargo lock to git as we are building a binary 2020-12-01 09:31:41 +11:00
bors.toml Re-introduce punish test 2021-03-16 18:34:00 +11:00
Cargo.lock Merge #313 2021-03-15 06:01:09 +00:00
Cargo.toml Split monero-harness into harness and rpc 2021-02-23 14:30:20 +11:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md Minor fixes in README.md 2021-03-16 13:05:43 +11:00
rust-toolchain Add asb to release including ARM build 2021-03-15 09:58:18 +11:00
rustfmt.toml Change imports_granularity to module 2021-03-04 14:48:13 +11: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.

Quick start

  1. Download the latest release for your operating system
  2. Run the binary: ./swap buy-xmr --receive-address <YOUR MONERO ADDRESS>
  3. Follow the instructions printed to the terminal

Limitations

For now, the MVP is limited to testnet3 on Bitcoin and stagenet on Monero.

How it works

This repository primarily hosts two components:

  • the swap CLI
  • the asb service

swap CLI

The swap CLI acts in the role of Bob and swaps BTC for XMR. See ./swap --help for a description of all commands. The main command is buy-xmr which automatically connects to an instance of asb.

asb service

asb is short for automated swap backend (we are open to suggestions for better names!). The service acts as the counter-party for the swap CLI in the role of Alice. It provides the CLI with a quote and the liquidity necessary for swapping BTC into XMR.

Contact

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