From 7a787fba6ae7366cf331e94eda7d96eb61238c00 Mon Sep 17 00:00:00 2001 From: Daniel Karzel Date: Fri, 21 May 2021 20:09:10 +1000 Subject: [PATCH] Update the README for mainnet --- README.md | 16 ++++++++++++---- docs/asb/README.md | 14 +++++++++++++- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1f1a8f25..7bb7c095 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,13 @@ More information about the protocol in this [presentation](https://youtu.be/Jj8r ## 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 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 --seller-peer-id --seller-addr ` + `./swap --testnet buy-xmr --receive-address --seller-peer-id --seller-addr ` 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. @@ -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` 3. Follow the instructions printed to the terminal -## Limitations - -For now, the MVP is limited to `testnet3` on Bitcoin and `stagenet` on Monero. +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 diff --git a/docs/asb/README.md b/docs/asb/README.md index 03958dc0..b0e314c1 100644 --- a/docs/asb/README.md +++ b/docs/asb/README.md @@ -2,10 +2,14 @@ ## 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 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` -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 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. +### 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 The ASB is a long running daemon that acts as the trading partner to the swap CLI.