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
Bitcoin–Monero Cross-chain Atomic Swap
1,079 Commits 72 Branches 27 Tags 73 MiB
Rust 99.8%
Shell 0.2%
7cf7e08132
Go to file
bors[bot] 7cf7e08132
Merge #366 
366: Asb docs r=da-kami a=da-kami

Note: 
There is currently quite a lot ongoing to make the ASB better, so the documentation will naturally get outdated. 
Knowing that, I opted for linking to ongoing issues that will improve ASB setup / execution so that users can refer to them to see the progress. 

We need documentation to make ASB setup / exec understandable. Let's see to get this in so we have something to iterate on :)

Co-authored-by: Daniel Karzel <daniel@comit.network>
2021-03-29 00:06:02 +00:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Merge #380 2021-03-25 08:10:58 +00:00
docs/asb Document the setup of the ASB 2021-03-29 11:04:56 +11:00
monero-harness Enforce consistent formatting of Markdown files 2021-03-25 11:11:57 +11:00
monero-rpc Use language agnostic heuristic to check if monero_wallet_rpc is ready 2021-03-25 18:13:06 +11:00
swap Specify LANG env variable for monero wallet rpc for unix systems 2021-03-25 19:52:43 +11:00
tokio-tar Enforce consistent formatting of Markdown files 2021-03-25 11:11:57 +11:00
.dprintrc.json Enforce consistent formatting of Markdown files 2021-03-25 11:11:57 +11:00
.gitignore Push cargo lock to git as we are building a binary 2020-12-01 09:31:41 +11:00
bors.toml Simplify matrix for test job 2021-03-25 15:19:08 +11:00
Cargo.lock Merge #359 2021-03-24 06:12:52 +00:00
Cargo.toml Split monero-harness into harness and rpc 2021-02-23 14:30:20 +11:00
CHANGELOG.md Use language agnostic heuristic to check if monero_wallet_rpc is ready 2021-03-25 18:13:06 +11:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md Document the setup of the ASB 2021-03-29 11:04:56 +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.

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: ./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:

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.