feat(arby): add test-mode configuration option (#760)

* feat(arby): add test-mode configuration option

This commit deprecates the old `live-cex` configuration value in favour
of new `test-mode` option. If both values are set, the `test-mode`
option takes precedence over the legacy option.

`test-mode` defaults to `false` in mainnet, `true` in other networks.

* use branch of arby on mainnet

* use latest arby on mainnet, attempt 2

* fixup! feat(arby): add test-mode configuration option

* fixup! feat(arby): add test-mode configuration option

* fixup! feat(arby): add test-mode configuration option

* revert first mainnet change

* fix of the first revert

* revert of second mainnet change

Co-authored-by: raladev <[email protected]>

Author: Karl Ranna

images/utils/launcher/config/config.py

@@ -301,7 +301,12 @@ def parse_command_line_arguments(self):
         group.add_argument(
             "--arby.live-cex",
             metavar="<value>",
-            help="Live CEX"
+            help="Live CEX (deprecated)"
+        )
+        group.add_argument(
+            "--arby.test-mode",
+            metavar="<value>",
+            help="Whether to issue real orders on the centralized exchange"
         )
         group.add_argument(
             "--arby.base-asset",
@@ -779,6 +784,16 @@ def update_arby(self, parsed):
             if value:
                 node["live-cex"] = value
 
+        if "test-mode" in parsed:
+            if parsed["test-mode"]:
+                value = parsed["test-mode"]
+                node["test-mode"] = value
+        opt = "arby.test_mode"
+        if hasattr(self.args, opt):
+            value = getattr(self.args, opt)
+            if value:
+                node["test-mode"] = value
+
         if "cex" in parsed:
             if parsed["cex"]:
                 value = parsed["cex"]
@@ -1027,6 +1042,7 @@ def dump_node_attr(node: str, attr: str) -> None:
                     dump_node_attr(node, "cex_base_asset")
                     dump_node_attr(node, "cex_quote_asset")
                     dump_node_attr(node, "live_cex")
+                    dump_node_attr(node, "test_mode")
                     dump_node_attr(node, "cex")
                     #dump_node_attr(node, "cex_api_key")
                     #dump_node_attr(node, "cex_api_secret")

images/utils/launcher/config/mainnet.conf

@@ -121,7 +121,7 @@
 #expose-ports = ["8885", "8886", "8080"]
 
 [arby]
-#live-cex="false"
+#test-mode="true"
 #base-asset = "BTC"
 #quote-asset = "USDT"
 #cex-base-asset = "" # optional - only needs to be specified if centralized exchange base asset is different from base-asset

images/utils/launcher/config/simnet.conf

@@ -34,7 +34,7 @@
 #expose-ports = ["28885", "28886", "28080:8080"]
 
 [arby]
-#live-cex="false"
+#test-mode="true"
 #base-asset = "BTC"
 #quote-asset = "USDT"
 #cex-base-asset = "" # optional - only needs to be specified if centralized exchange base asset is different from base-asset

images/utils/launcher/config/testnet.conf

@@ -121,7 +121,7 @@
 #expose-ports = ["18885", "18886", "18080:8080"]
 
 [arby]
-#live-cex="false"
+#test-mode="true"
 #base-asset = "ETH"
 #quote-asset = "BTC"
 #cex-base-asset = "" # optional - only needs to be specified if centralized exchange base asset is different from base-asset

images/utils/launcher/node/arby.py

@@ -13,8 +13,22 @@ class Arby(Node):
     def __init__(self, name, ctx):
         super().__init__(name, ctx)
 
-        live_cex = self.node_config["live-cex"] \
-            if "live-cex" in self.node_config else "false"
+        if self.network == "mainnet":
+            default_test_mode = "false"
+        else:
+            default_test_mode = "true"
+        test_mode = default_test_mode
+        # legacy option (delete after 1st of January 2022)
+        if "live-cex" in self.node_config:
+            live_cex = self.node_config["live-cex"]
+            # we map the legacy live_cex value to the new (opposite) test_mode value
+            if live_cex is "false":
+                test_mode = "true"
+            else:
+                test_mode = "false"
+        # new option overwrites the legacy value
+        if "test-mode" in self.node_config:
+            test_mode = self.node_config["test-mode"]
         cex = self.node_config["cex"] \
             if "cex" in self.node_config else "binance"
         api_key = self.node_config["cex-api-key"] \
@@ -57,7 +71,7 @@ def __init__(self, name, ctx):
             f'CEX={cex}',
             f'CEX_API_SECRET={api_secret}',
             f'CEX_API_KEY={api_key}',
-            f'LIVE_CEX={live_cex}',
+            f'TEST_MODE={test_mode}',
             f'MARGIN={margin}',
             f'TEST_CENTRALIZED_EXCHANGE_BASEASSET_BALANCE={test_centralized_baseasset_balance}',
             f'TEST_CENTRALIZED_EXCHANGE_QUOTEASSET_BALANCE={test_centralized_quoteasset_balance}',

setup.sh

@@ -74,7 +74,7 @@ Xud options:
     --xud.preserve-config                       Preserve xud xud.conf file during updates
 
 Arby options:
-    --arby.live-cex [true|false]                Production/Demo mode (default: false)
+    --arby.test-mode [true|false]               Production/Demo mode (default: true for simnet and testnet; false for mainnet)
     --arby.base-asset <string>                  Base asset symbol
     --arby.quote-asset <string>                 Quote asset symbol
     --arby.cex-base-asset <string>              Centralized exchange base asset symbol