Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-25 23:49:31 -05:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
941 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
1d1ed13b65
Go to file
bors[bot] 1d1ed13b65
Merge #302 
302: Fixup backticks in README r=da-kami a=thomaseizinger



Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
2021-03-11 06:12:20 +00:00
.github/workflows Rename binary to swap 2021-03-05 16:14:21 +11:00
monero-harness No prefix for wallets in monero harness 2021-03-03 17:03:34 +11:00
monero-rpc Remove Arcs in favour of references 2021-03-03 17:23:07 +11:00
swap Disable backoffs max_elapsed_time functionality 2021-03-11 13:33:46 +11:00
tokio-tar Download and run monero wallet rpc on swap cli startup 2021-02-25 11:21:41 +11:00
.gitignore Squashed 'tokio-tar/' content from commit 43dd166 2021-02-25 11:20:47 +11:00
bors.toml Add windows to release and build workflow 2021-03-02 15:09:12 +11:00
Cargo.lock Update Cargo.lock for new version 2021-03-05 13:38:20 +11:00
Cargo.toml Squashed 'tokio-tar/' content from commit 43dd166 2021-02-25 11:20:47 +11:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md Fixup backticks in README 2021-03-10 14:55:36 +11:00
rust-toolchain Update rust-toolchain to new toml syntax 2021-02-18 13:16:05 +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 this paper.

Quick start

  1. Download the latest release for your operation 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 to out us in the COMIT-Monero Matrix channel.