From 9ade321a9485c59072b82d53bbbcb3736fd9c4a1 Mon Sep 17 00:00:00 2001 From: Einliterflasche Date: Fri, 23 Aug 2024 13:14:32 +0200 Subject: [PATCH] docs: update READMEs --- README.md | 62 +++++++------------------------------------------- swap/README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 54 deletions(-) create mode 100644 swap/README.md diff --git a/README.md b/README.md index 35adc5f0..57200256 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,11 @@ -# XMR to BTC Atomic Swap +# `xmr-btc-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. +This is the monorepo containing the source code for all of our core projects: + - [`swap`](swap/README.md) contains the source code for the main swapping binaries, `asb` and `swap` + - [`gui`](src-gui/README.md) contains the new tauri based user interface + - [`tauri`](src-tauri/) contains the tauri bindings between binaries and user interface + - and other crates we use in our binaries -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). +If you're just here for the software, head over to the [releases](https://github.com/UnstoppableSwap/xmr-btc-swap/releases/latest) tab and grab the binary for your operating system! If you're just looking for documentation, check out our [docs page](https://docs.unstoppableswap.net/). -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 --change-address --seller -``` - -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.74 _should_ work. - -## Contact - -Feel free to reach out to us in the [COMIT-Monero Matrix channel](https://matrix.to/#/#comit-monero:matrix.org). +If you are looking for help or encountered an issue, feel free to open an issue. diff --git a/swap/README.md b/swap/README.md new file mode 100644 index 00000000..35adc5f0 --- /dev/null +++ b/swap/README.md @@ -0,0 +1,57 @@ +# 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 --change-address --seller +``` + +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.74 _should_ work. + +## Contact + +Feel free to reach out to us in the [COMIT-Monero Matrix channel](https://matrix.to/#/#comit-monero:matrix.org).