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
1,412 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
c164f3d1f5
Go to file
bors[bot] c164f3d1f5
Merge #538 
538: Add ping protocol to ensure connection is alive r=da-kami a=da-kami

Fixes #532 

Adds the ping behaviour to both ASB and CLI behaviour that periodically pings a connected party to ensure that the underlying network connection is still alive.
This fixes problems with long-running connections that become dead without a connection closure being reported back to the swarm.

Co-authored-by: Daniel Karzel <daniel@comit.network>
2021-05-27 07:28:45 +00:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Add the arm CLI build to the release binaries 2021-05-24 17:54:27 +10:00
docs/asb Update ASB readme 2021-05-24 16:00:31 +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 Add ping protocol to ensure connection is alive 2021-05-27 11:19:27 +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 Add ping protocol to ensure connection is alive 2021-05-27 11:19:27 +10:00
Cargo.toml Use tokio-tar from crates.io 2021-05-18 12:52:17 +10:00
CHANGELOG.md Add ping protocol to ensure connection is alive 2021-05-27 11:19:27 +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 Update the README for mainnet 2021-05-24 10:31:51 +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

From version 0.6.0 onwards the software default to running on mainnet. It is recommended to try the software on testnet first, which can be achieved by providing the --testnet flag. This quickstart guide assumes that you are running the software on testnet (i.e. Bitcoin testnet3 and Monero stagenet):

  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 --testnet 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

For running the software on mainnet you just omit the --testnet flag. Running on mainnet will automatically apply sane defaults. Be aware that this software is still early-stage. Make sure to check --help and understand how the cancel and refund commands work before running on mainnet. You are running this software at your own risk. As always we recommend: Verify, don't trust. All code is available in this repository.

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.