Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-06-30 16:41:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
1,363 Commits 58 Branches 24 Tags 43 MiB
Rust 99.8%
Shell 0.2%
5373f697ed
Go to file
bors[bot] 5373f697ed
Merge #486 #508 
486: Update metadata and remove outdated config files / READMEs r=thomaseizinger a=thomaseizinger



508: Remove tokio-tar from workspace in favor of git dependency r=thomaseizinger a=thomaseizinger

Fixes #315.
Fixes #227.

The upstream PR that upgrades to tokio v1 got merged, hence we can at least point to the git dependency for now and remove that later once it has been released to crates.io

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
2021-05-17 09:31:41 +00:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Merge #495 2021-05-16 16:43:28 +00:00
docs/asb Apply suggestions from code review 2021-05-04 08:47:33 +10:00
monero-harness Update metadata and remove outdated config files / READMEs 2021-05-17 11:03:43 +10:00
monero-rpc Update metadata and remove outdated config files / READMEs 2021-05-17 11:03:43 +10:00
monero-wallet Introduce monero-wallet crate 2021-04-30 10:28:46 +10:00
swap Remove tokio-tar from workspace in favor of git dependency 2021-05-17 11:04:20 +10:00
.gitignore Push cargo lock to git as we are building a binary 2020-12-01 09:31:41 +11:00
bors.toml Move recovery commands in dedicated module 2021-05-07 16:21:02 +10:00
Cargo.lock Merge #486 #508 2021-05-17 09:31:41 +00:00
Cargo.toml Remove tokio-tar from workspace in favor of git dependency 2021-05-17 11:04:20 +10:00
CHANGELOG.md Toggle json logs using commandline flag. 2021-05-11 15:28:25 +10:00
dprint.json Remove tokio-tar from workspace in favor of git dependency 2021-05-17 11:04:20 +10:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md dnsaddr instead of dns4 2021-04-19 22:48:08 +10: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.

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

Quick start - CLI

  1. Download the latest swap binary release for your operating system
  2. Run the binary specifying the monero address where you wish to receive monero and the connection details of the seller: ./swap buy-xmr --receive-address <YOUR MONERO ADDRESS> --seller-peer-id <SELLERS PEER ID> --seller-addr <SELLERS MULTIADDRESS> You can generate a receive address using your monero wallet. The seller will provide you their peer id and multiaddress. We are running an asb instance on testnet. You can swap with to get familiar with the swap CLI. Our peer id is 12D3KooWCdMKjesXMJz1SiZ7HgotrxuqhQJbP5sgBm2BwP1cqThi and our multiaddress is /dnsaddr/xmr-btc-asb.coblox.tech
  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:

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.

For details on how to run the ASB please refer to the ASB docs.

Contact

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