xmr-btc-swap/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](https://arxiv.org/abs/2101.12332) paper.

More information about the protocol in this [presentation](https://youtu.be/Jj8rd4WOEy0) and this [blog post](https://comit.network/blog/2020/10/06/monero-bitcoin).

Currently, swaps are only offered in one direction with the `swap` CLI on the buying side (send BTC, receive XMR).
We are working on implementing a protocol where XMR moves first, but are currently blocked by advances on Monero itself.
You can read [this blogpost](https://comit.network/blog/2021/07/02/transaction-presigning) for more information.

## Quick Start

1. Download the [latest `swap` binary release](https://github.com/comit-network/xmr-btc-swap/releases/latest) for your operating system.
2. Find a seller to swap with:

```shell
./swap --testnet list-sellers
```

3. Swap with a seller:

```shell
./swap --testnet buy-xmr --receive-address <YOUR MONERO ADDRESS> --change-address <YOUR BITCOIN CHANGE ADDRESS> --seller <SELLER MULTIADDRESS>
```

For more detailed documentation on the CLI, see [this README](./docs/cli/README.md).

## Becoming a Market Maker

Swapping of course needs two parties - and the CLI is only one of them: The taker that occasionally starts a swap with a market maker.

If you are interested in becoming a market maker you will want to run the second binary provided in this repository: `asb` - the Automated Swap Backend.
Detailed documentation for the `asb` can be found [in this README](./docs/asb/README.md).

## Safety

This software is using cryptography that has not been formally audited.
While we do our best to make it safe, it is up to the user to evaluate whether or not it is safe to use for their purposes.
Please also see section 15 and 16 of the [license](./LICENSE).

Keep in mind that swaps are complex protocols, it is recommended to _not_ do anything fancy when moving coins in and out.
It is not recommended to bump fees when swapping because it can have unpredictable side effects.

## Contributing

We encourage community contributions whether it be a bug fix or an improvement to the documentation.
Please have a look at the [contribution guidelines](./CONTRIBUTING.md).

## Rust Version Support

Please note that only the latest stable Rust toolchain is supported.
All stable toolchains since 1.63 _should_ work.

## Contact

Feel free to reach out to us in the [COMIT-Monero Matrix channel](https://matrix.to/#/#comit-monero:matrix.org).
Enforce consistent formatting of Markdown files 2021-03-23 23:40:02 +00:00			`# XMR to BTC Atomic Swap`
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Replace protocol definition in README with setup instructions Fixes #262. 2021-03-05 04:47:16 +00:00			`This repository hosts an MVP for atomically swapping BTC to XMR.`
Minor fixes in README.md 2021-03-15 23:28:51 +00:00			`It implements the protocol described in section 3 of [this](https://arxiv.org/abs/2101.12332) paper.`
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Document the setup of the ASB - How to run the ASB - ASB component interaction - ASB wallet management 2021-03-23 08:42:25 +00:00			`More information about the protocol in this [presentation](https://youtu.be/Jj8rd4WOEy0) and this [blog post](https://comit.network/blog/2020/10/06/monero-bitcoin).`
Move alice/bob definition comment 2020-10-08 22:46:44 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			Currently, swaps are only offered in one direction with the `swap` CLI on the buying side (send BTC, receive XMR).
			`We are working on implementing a protocol where XMR moves first, but are currently blocked by advances on Monero itself.`
			`You can read [this blogpost](https://comit.network/blog/2021/07/02/transaction-presigning) for more information.`
Document the setup of the ASB - How to run the ASB - ASB component interaction - ASB wallet management 2021-03-23 08:42:25 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			`## Quick Start`
Update the README for mainnet 2021-05-21 10:09:10 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			1. Download the [latest `swap` binary release](https://github.com/comit-network/xmr-btc-swap/releases/latest) for your operating system.
			`2. Find a seller to swap with:`
Move alice/bob definition comment 2020-10-08 22:46:44 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			```shell
Fix quick start README.md list-sellers command Change list-sellers from flag to command 2021-07-08 00:10:13 +00:00			`./swap --testnet list-sellers`
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			```
Update README Update the readme inline with review suggestions by doing: - Copy 'long story short' text from blog post - Correct the erroneous description of watching blockchains - Fix gramar 2020-10-08 22:34:24 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			`3. Swap with a seller:`
Update README Update the readme inline with review suggestions by doing: - Copy 'long story short' text from blog post - Correct the erroneous description of watching blockchains - Fix gramar 2020-10-08 22:34:24 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			```shell
			`./swap --testnet buy-xmr --receive-address <YOUR MONERO ADDRESS> --change-address <YOUR BITCOIN CHANGE ADDRESS> --seller <SELLER MULTIADDRESS>`
			```
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			`For more detailed documentation on the CLI, see [this README](./docs/cli/README.md).`
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			`## Becoming a Market Maker`
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			`Swapping of course needs two parties - and the CLI is only one of them: The taker that occasionally starts a swap with a market maker.`
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Update docs with latest changes to CLI and ASB 2021-07-06 09:39:20 +00:00			If you are interested in becoming a market maker you will want to run the second binary provided in this repository: `asb` - the Automated Swap Backend.
			Detailed documentation for the `asb` can be found [in this README](./docs/asb/README.md).
Document the setup of the ASB - How to run the ASB - ASB component interaction - ASB wallet management 2021-03-23 08:42:25 +00:00
Add note about security of software 2021-07-16 01:54:33 +00:00			`## Safety`

			`This software is using cryptography that has not been formally audited.`
			`While we do our best to make it safe, it is up to the user to evaluate whether or not it is safe to use for their purposes.`
			`Please also see section 15 and 16 of the [license](./LICENSE).`

Add section that discourages bumping fees 2021-11-05 11:33:34 +00:00			`Keep in mind that swaps are complex protocols, it is recommended to _not_ do anything fancy when moving coins in and out.`
			`It is not recommended to bump fees when swapping because it can have unpredictable side effects.`

Improve discoverability of contribution guidelines 2021-08-31 06:43:50 +00:00			`## Contributing`

readme: fix minor grammar error 2023-02-27 20:13:17 +00:00			`We encourage community contributions whether it be a bug fix or an improvement to the documentation.`
Improve discoverability of contribution guidelines 2021-08-31 06:43:50 +00:00			`Please have a look at the [contribution guidelines](./CONTRIBUTING.md).`

Update dependencies and rust-toolchain to 1.59 This commit updates the rust-toolchain to the current stable version 1.59, and fixes a number of new clippy warnings from that change. Other changes: - updates backoff to 0.4 - updates swap to 2021 edition - updates comfy-table to 5.0 - updates monero-wallet to 2021 edition - updates moneor-harness to 2021 edition - updates bdk and rust_decimal - updates tokio-util to 0.7 - updates workflow to use actions/setup-python@3 - updates pem and serde_with - adds stable rust toolchain notice to readme 2022-03-12 11:05:36 +00:00			`## Rust Version Support`

			`Please note that only the latest stable Rust toolchain is supported.`
ci: update msrv and github actions toolchains 2023-01-10 12:43:07 +00:00			`All stable toolchains since 1.63 _should_ work.`
Update dependencies and rust-toolchain to 1.59 This commit updates the rust-toolchain to the current stable version 1.59, and fixes a number of new clippy warnings from that change. Other changes: - updates backoff to 0.4 - updates swap to 2021 edition - updates comfy-table to 5.0 - updates monero-wallet to 2021 edition - updates moneor-harness to 2021 edition - updates bdk and rust_decimal - updates tokio-util to 0.7 - updates workflow to use actions/setup-python@3 - updates pem and serde_with - adds stable rust toolchain notice to readme 2022-03-12 11:05:36 +00:00
Replace protocol definition in README with setup instructions Fixes #262. 2021-03-05 04:47:16 +00:00			`## Contact`
Add a README.md file Add a readme that describes the project. Specifically - module structure - what we prove and do not prove - how we test 2020-10-07 22:12:17 +00:00
Minor fixes in README.md 2021-03-15 23:28:51 +00:00			`Feel free to reach out to us in the [COMIT-Monero Matrix channel](https://matrix.to/#/#comit-monero:matrix.org).`