#137 : More Javadocs + config comments for new new sim adapter

gazbert · Mar 18, 2022 · f287c38 · f287c38
1 parent 00f9453
commit f287c38
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 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
@@ -53,7 +53,10 @@
  * <p>The Exchange Adapter to use is configured using the ./config/exchange.yaml otherConfig
  * section.
  *
- * <p>It only executes 'real' public API calls - the order operations are stubbed out.
+ * <p>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.
+ *
+ * <p>Only 1 open order is simulated at any time.
  *
  * @author MarcDahlem
  * @since 1.0

diff --git 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