+ * After the maximum number of BSQ swap offers have been taken (good to start with 1), the bot will shut down. The API
+ * daemon will not be shut down because swaps do not require additional payment related steps taken outside Bisq, or
+ * in the GUI.
+ *
+ * Here is one possible use case: + *
+ * Take 1 BSQ swap offer to buy BSQ with BTC, priced no lower than 0.50% above the 30-day average BSQ price if: + * + * the offer's BTC amount is between 0.10 and 0.25 BTC + * the offer maker is one of two preferred trading peers + * the current transaction mining fee rate is below 20 sats / byte + * + * The bot configurations for these rules are set in TakeBestPricedOfferToBuyBsq.properties as follows: + * + * maxTakeOffers=1 + * minMarketPriceMargin=0.50 + * minAmount=0.10 + * maxAmount=0.25 + * preferredTradingPeers=preferred-address-1.onion:9999,preferred-address-2.onion:9999 + * maxTxFeeRate=20 + *+ * Usage + *
+ * You must encrypt your wallet password before running this bot. If it is not already encrypted, you can use the CLI:
+ *
+ * $ ./bisq-cli --password=xyz --port=9998 setwalletpassword --wallet-password="be careful" + *+ * There are some {@link bisq.bots.Config program options} common to all the Java bot examples, passed on the command + * line. The only one you must provide (no default value) is your API daemon's password option: + * `--password
+ * You can pass the '--dryrun=true' option to the program to see what offers your bot would take with a given
+ * configuration. This will help you avoid taking offers by mistake.
+ *
+ * TakeBestPricedOfferToBuyBsq --password=api-password --port=api-port [--dryrun=true|false] + *+ *
+ * The '--simulate-regtest-payment=true' option is ignored by this bot. Taking a swap triggers execution of the swap. */ @Slf4j @Getter @@ -99,7 +142,8 @@ public class TakeBestPricedOfferToBuyBsq extends AbstractBot { continue; } - // Get all available and takeable offers, sorted by price descending. + // Get all available sell BTC for BSQ offers, sorted by price descending. + // The list contains only fixed-priced offers. var offers = getOffers(SELL.name(), CURRENCY_CODE).stream() .filter(o -> !isAlreadyTaken.test(o)) .toList(); @@ -125,7 +169,6 @@ public class TakeBestPricedOfferToBuyBsq extends AbstractBot { takeCriteria.printOfferAgainstCriteria(highestPricedOffer); }); - printDryRunProgress(); runCountdown(log, pollingInterval); pingDaemon(startTime); } @@ -134,17 +177,21 @@ public class TakeBestPricedOfferToBuyBsq extends AbstractBot { private void takeOffer(TakeCriteria takeCriteria, OfferInfo offer) { log.info("Will attempt to take offer '{}'.", offer.getId()); takeCriteria.printOfferAgainstCriteria(offer); + + // An encrypted wallet must be unlocked before calling takeoffer and gettrade(s). + // Unlock the wallet for 5 minutes. If the wallet is already unlocked, this request + // will override the timeout of the previous unlock request. + try { + unlockWallet(walletPassword, 300); + } catch (NonFatalException nonFatalException) { + handleNonFatalException(nonFatalException, pollingInterval); + } + if (isDryRun) { addToOffersTaken(offer); numOffersTaken++; - maybeShutdownAfterSuccessfulSwap(numOffersTaken, maxTakeOffers); } else { - // An encrypted wallet must be unlocked before calling takeoffer and gettrade. - // Unlock the wallet for 10 minutes. If the wallet is already unlocked, - // this command will override the timeout of the previous unlock command. try { - unlockWallet(walletPassword, 600); - printBTCBalances("BTC Balances Before Swap Execution"); printBSQBalances("BSQ Balances Before Swap Execution"); @@ -155,13 +202,13 @@ public class TakeBestPricedOfferToBuyBsq extends AbstractBot { printBSQBalances("BSQ Balances After Swap Execution"); numOffersTaken++; - maybeShutdownAfterSuccessfulSwap(numOffersTaken, maxTakeOffers); } catch (NonFatalException nonFatalException) { handleNonFatalException(nonFatalException, pollingInterval); } catch (StatusRuntimeException fatalException) { handleFatalBsqSwapException(fatalException); } } + maybeShutdownAfterSuccessfulSwap(numOffersTaken, maxTakeOffers); } private void printBotConfiguration() { @@ -169,6 +216,7 @@ public class TakeBestPricedOfferToBuyBsq extends AbstractBot { configsByLabel.put("Bot OS:", getOSName() + " " + getOSVersion()); var network = getNetwork(); configsByLabel.put("BTC Network:", network); + configsByLabel.put("Dry Run?", isDryRun ? "YES" : "NO"); var isMainnet = network.equalsIgnoreCase("mainnet"); var mainnet30DayAvgBsqPrice = isMainnet ? get30DayAvgBsqPriceInBtc() : null; configsByLabel.put("My Payment Account:", ""); diff --git a/java-examples/src/main/resources/TakeBestPricedOfferToBuyBsq.properties b/java-examples/src/main/resources/TakeBestPricedOfferToBuyBsq.properties index 286bd30..89e3682 100644 --- a/java-examples/src/main/resources/TakeBestPricedOfferToBuyBsq.properties +++ b/java-examples/src/main/resources/TakeBestPricedOfferToBuyBsq.properties @@ -1,12 +1,12 @@ # Maximum # of offers to take during one bot session. When reached, bot will shut down (but not the API daemon). -maxTakeOffers=50 +maxTakeOffers=5 # # Minimum distance from 30-day average BSQ trade price. # Note: all BSQ Swap offers have a fixed-price, but the bot uses a margin (%) of the 30-day price for comparison. minMarketPriceMargin=0.00 # # Hard coded 30-day average BSQ trade price, used for development over regtest. -regtest30DayAvgBsqPrice=0.00005 +regtest30DayAvgBsqPrice=0.00004 # # Taker bot's min BTC amount to sell. The candidate SELL BTC offer's amount must be >= minAmount BTC. minAmount=0.01 @@ -24,4 +24,4 @@ maxTxFeeRate=25 preferredTradingPeers=localhost:8888 # # Offer polling frequency must be >= 1s (1000ms) between each getoffers request. -pollingInterval=30000 +pollingInterval=60000