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,184 Commits 72 Branches 27 Tags 73 MiB
Rust 99.8%
Shell 0.2%
b417950f99
Go to file
Thomas Eizinger b417950f99
Improve error reporting of failed protocols 
Instead of forwarding every error, we deliberately ignore certain
variants that are not worth being printed to the log. In particular,
this concerns "UnsupportedProtocols" and "ResponseOmission".

To make this less verbose we introduce a macro for mapping a
`RequestResponseEvent` to `{alice,bob}::OutEvent`. We use a macro
because those `OutEvent`s are different types and the only other
way of abstracting over them would be to introduce traits that we
implement on both of them.

To make the macro easier to use, we move all the `From` implementations
that convert between the protocol and the more high-level behaviour
into the actual protocol module.
2021-04-14 10:34:06 +10:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Multiple swaps with the same peer 2021-04-13 18:16:19 +10:00
docs/asb Update ASB docs 2021-04-07 11:58:28 +10:00
monero-harness Multiple swaps with the same peer 2021-04-13 18:16:19 +10:00
monero-rpc Merge #405 2021-04-13 08:50:44 +00:00
swap Improve error reporting of failed protocols 2021-04-14 10:34:06 +10: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 Multiple swaps with the same peer 2021-04-13 18:16:19 +10:00
Cargo.lock Log at debug level to file 2021-04-08 16:10:35 +10:00
Cargo.toml Split monero-harness into harness and rpc 2021-02-23 14:30:20 +11:00
CHANGELOG.md Multiple swaps with the same peer 2021-04-13 18:16:19 +10:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md Remove default connection details from CLI 2021-04-06 16:59:11 +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-multiaddr <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 /dns4/xmr-btc-asb.coblox.tech/tcp/9876
  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.