From f287c3867e4ef65e53ac212ada1ea92d60099819 Mon Sep 17 00:00:00 2001 From: gazbert Date: Fri, 18 Mar 2022 00:18:48 +0000 Subject: [PATCH] #137 : More Javadocs + config comments for new new sim adapter --- .../com/gazbert/bxbot/exchanges/TryModeExchangeAdapter.java | 5 ++++- config/exchange.yaml | 5 +++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/bxbot-exchanges/src/main/java/com/gazbert/bxbot/exchanges/TryModeExchangeAdapter.java b/bxbot-exchanges/src/main/java/com/gazbert/bxbot/exchanges/TryModeExchangeAdapter.java index a8c7ad9a..cd89358b 100644 --- a/bxbot-exchanges/src/main/java/com/gazbert/bxbot/exchanges/TryModeExchangeAdapter.java +++ b/bxbot-exchanges/src/main/java/com/gazbert/bxbot/exchanges/TryModeExchangeAdapter.java @@ -53,7 +53,10 @@ *

The Exchange Adapter to use is configured using the ./config/exchange.yaml otherConfig * section. * - *

It only executes 'real' public API calls - the order operations are stubbed out. + *

It only executes public API calls. Authenticated API calls to create orders, cancel orders, + * and fetch open orders are simulated based on actual ticker data from the exchange. + * + *

Only 1 open order is simulated at any time. * * @author MarcDahlem * @since 1.0 diff --git a/config/exchange.yaml b/config/exchange.yaml index 2f889135..57a7fcbf 100644 --- a/config/exchange.yaml +++ b/config/exchange.yaml @@ -49,7 +49,8 @@ exchange: - Unexpected end of file from server # Other config for adapter - it's not mandatory. - # It's included here to show example usage with the simulation TryModeExchangeAdapter (which has been configured to use Bitstamp). + # It's included here to show example usage with the dry-run/paper trading TryModeExchangeAdapter. + # The config values have been configured for Bitstamp. otherConfig: # The counter currency which is being simulated. This must match your chosen market counter currency. @@ -65,7 +66,7 @@ exchange: baseCurrencyStartingBalance: 2 # The adapter which should be used for public API calls. - # All special config values for this adapter must be given in this other config section as well. + # All special config values for this adapter must be given in this otherConfig section as well. # In this case, the otherConfig is for the Bitstamp exchange. delegateAdapter: com.gazbert.bxbot.exchanges.BitstampExchangeAdapter