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

Merge #524

Browse Source 
524: Update the README for mainnet r=da-kami a=da-kami



Co-authored-by: Daniel Karzel <daniel@comit.network>
This commit is contained in:
bors[bot] 2021-05-24 00:32:52 +00:00 committed by GitHub
commit bc27b9a47d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,9 +7,13 @@ More information about the protocol in this [presentation](https://youtu.be/Jj8r
## Quick start - CLI ## 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](https://github.com/comit-network/xmr-btc-swap/releases/latest) for your operating system 1. Download the [latest `swap` binary release](https://github.com/comit-network/xmr-btc-swap/releases/latest) 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: 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-addr <SELLERS MULTIADDRESS>` `./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. You can generate a receive address using your monero wallet.
The seller will provide you their peer id and multiaddress. The seller will provide you their peer id and multiaddress.
We are running an `asb` instance on testnet. We are running an `asb` instance on testnet.
@ -17,9 +21,13 @@ More information about the protocol in this [presentation](https://youtu.be/Jj8r
Our peer id is `12D3KooWCdMKjesXMJz1SiZ7HgotrxuqhQJbP5sgBm2BwP1cqThi` and our multiaddress is `/dnsaddr/xmr-btc-asb.coblox.tech` Our peer id is `12D3KooWCdMKjesXMJz1SiZ7HgotrxuqhQJbP5sgBm2BwP1cqThi` and our multiaddress is `/dnsaddr/xmr-btc-asb.coblox.tech`
3. Follow the instructions printed to the terminal 3. Follow the instructions printed to the terminal
## Limitations For running the software on mainnet you just omit the `--testnet` flag.
Running on mainnet will automatically apply sane defaults.
For now, the MVP is limited to `testnet3` on Bitcoin and `stagenet` on Monero. 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 ## How it works

14
docs/asb/README.md
View File

@ -2,10 +2,14 @@
## Quick Start ASB ## Quick Start ASB
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 [latest release](https://github.com/comit-network/xmr-btc-swap/releases/latest) of the `asb` binary 1. Download [latest release](https://github.com/comit-network/xmr-btc-swap/releases/latest) of the `asb` binary
2. Ensure that you have the Monero Wallet RPC running with `--wallet-dir` and `--disable-rpc-login`: 2. Ensure that you have the Monero Wallet RPC running with `--wallet-dir` and `--disable-rpc-login`:
1. `monero-wallet-rpc --stagenet --daemon-host STAGENET-NODE-URL --rpc-bind-port STAGENET-NODE-PORT --disable-rpc-login --wallet-dir PATH/TO/WALLET/DIR` 1. `monero-wallet-rpc --stagenet --daemon-host STAGENET-NODE-URL --rpc-bind-port STAGENET-NODE-PORT --disable-rpc-login --wallet-dir PATH/TO/WALLET/DIR`
3. Run the ASB in terminal: `./asb start` 3. Run the ASB in terminal: `./asb --testnet start`
4. Follow the setup wizard in the terminal 4. Follow the setup wizard in the terminal
Public Monero stagenet nodes for running the Monero Wallet RPC: Public Monero stagenet nodes for running the Monero Wallet RPC:
@ -15,6 +19,14 @@ Public Monero stagenet nodes for running the Monero Wallet RPC:
Run `./asb --help` for more information. Run `./asb --help` for more information.
### Running on mainnet
Public Monero mainnet nodes can be found [here](https://moneroworld.com/#nodes).
The default mainnet node is set to `node.moneroworld.com:18089`.
For running the ASB on mainnet you will have to change you `monero-wallet-rpc` setup to mainnet.
The default port for expecting the `monero-wallet-rpc` when running the ASB on mainnet is `18083`.
## ASB Details ## ASB Details
The ASB is a long running daemon that acts as the trading partner to the swap CLI. The ASB is a long running daemon that acts as the trading partner to the swap CLI.