From b5db6151d665a4718a5d78bcf8ab5d5c2e921f25 Mon Sep 17 00:00:00 2001 From: ghubstan <36207203+ghubstan@users.noreply.github.com> Date: Wed, 6 Jul 2022 11:52:12 -0300 Subject: [PATCH] Update 'Running Example Code' section --- .../src/main/resources/templates/examples-setup.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/reference-doc-builder/src/main/resources/templates/examples-setup.md b/reference-doc-builder/src/main/resources/templates/examples-setup.md index 50ad9fb..c74969f 100644 --- a/reference-doc-builder/src/main/resources/templates/examples-setup.md +++ b/reference-doc-builder/src/main/resources/templates/examples-setup.md @@ -1,10 +1,14 @@ # Running Example Code -Examples should not be used to make calls to an API daemon connected to the bitcoin mainnet. There is a convenient way -to run a regtest bitcoin-core daemon, a Bisq seed node, an arbitration node, and two regtest API daemons called Alice ( -listening on port 9998), and Bob (listening on port 9999). The Bob and Alice daemons will have regtest wallets -containing 10 BTC. Bob's BSQ wallet will also be set up with 1500000 BSQ, Alice's with 1000000 BSQ. These two API -daemons can simulate trading over the local regtest network. +Be careful about running any example that could affect your mainnet wallet. You might want to send `sendbsq`, +`sendbtc`, `createoffer`, and `takeoffer` requests to an API daemon connected to a local regtest network before trying +them on mainnet. + +There is a convenient way to run a regtest bitcoin-core daemon, a Bisq seed node, an arbitration node, and two regtest +API daemons called Alice (listening on port 9998), and Bob (listening on port 9999). The Bob and Alice daemons will +have regtest wallets containing 10 BTC. Bob's BSQ wallet will also be set up with 1500000 BSQ, Alice's with 1000000 BSQ. +These two API daemons can simulate trading over the local regtest network. Running a local, Bisq regtest network is +useful if you want to develop your own API bots. See the [Bisq API Beta Testing Guide](https://github.com/bisq-network/bisq/blob/master/apitest/docs/api-beta-test-guide.md)