Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-24 23:19:34 -05:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
1,068 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
2c3c4936c6
Go to file
bors[bot] 2c3c4936c6
Merge #372 
372: Add a changelog and more automation for releases r=rishflab a=thomaseizinger

Tested workflow runs can be seen here:

- Drafting a new release via `workflow_dispatch`: https://github.com/thomaseizinger/xmr-btc-swap/actions/runs/681852142
- The created PR: https://github.com/thomaseizinger/xmr-btc-swap/pull/11
- The workflow running as a result of merging the PR: https://github.com/thomaseizinger/xmr-btc-swap/actions/runs/681855693
- The release created from that workflow: https://github.com/thomaseizinger/xmr-btc-swap/releases/tag/0.4.0

Fixes #364.

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
2021-03-25 00:50:07 +00:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Add workflow documentation 2021-03-25 11:12:02 +11:00
monero-harness Enforce consistent formatting of Markdown files 2021-03-25 11:11:57 +11:00
monero-rpc Enforce consistent formatting of Markdown files 2021-03-25 11:11:57 +11:00
swap Merge #359 2021-03-24 06:12:52 +00: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 Remove connection handling from swap execution 2021-03-24 15:17:54 +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 Add CHANGELOG file 2021-03-25 11:12:00 +11:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md Enforce consistent formatting of Markdown files 2021-03-25 11:11:57 +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.