feat: add xud-docker api (#726)

* feat: add xud-docker api

* keep proxy service align with other optional services

* fix proxy default ports

* fix status command "proxy"

Author: reliveyy

images/proxy/Dockerfile

@@ -0,0 +1,9 @@
+FROM golang:1.15.2-alpine3.12 as builder
+ADD .src github.com/ExchangeUnion/xud-docker-api-poc
+WORKDIR github.com/ExchangeUnion/xud-docker-api-poc
+RUN go build
+
+FROM alpine:3.12
+COPY --from=builder /go/github.com/ExchangeUnion/xud-docker-api-poc/xud-docker-api-poc /usr/local/bin/proxy
+ADD entrypoint.sh /
+ENTRYPOINT ["/entrypoint.sh"]

images/proxy/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+while [ ! -e /root/.xud/tls.cert ]; do
+    echo "[entrypoint] Waiting for xud tls.cert to be created..."
+    sleep 3
+done
+
+#shellcheck disable=2068
+exec proxy $@

images/proxy/src.py

@@ -0,0 +1 @@
+REPO_URL = "https://github.com/ExchangeUnion/xud-docker-api-poc"

images/utils/launcher/config/config.py

@@ -103,6 +103,11 @@ def parse_command_line_arguments(self):
             metavar="<images>",
             help="Use other local built images"
         )
+        parser.add_argument(
+            "--api",
+            action="store_true",
+            help="Expose xud-docker API (REST + WebSocket)"
+        )
 
         group = parser.add_argument_group("bitcoind")
         group.add_argument(
@@ -344,6 +349,19 @@ def parse_command_line_arguments(self):
             help="Expose webui service ports to your host machine"
         )
 
+        group = parser.add_argument_group("proxy")
+        group.add_argument(
+            "--proxy.disabled",
+            nargs='?',
+            metavar="true|false",
+            help="Enable/Disable proxy service"
+        )
+        group.add_argument(
+            "--proxy.expose-ports",
+            metavar="<ports>",
+            help="Expose proxy service ports to your host machine"
+        )
+
         self.args = parser.parse_args()
         self.logger.info("Parsed command-line arguments: %r", self.args)
 
@@ -762,6 +780,18 @@ def update_webui(self, parsed):
             "28888": "28888:8080",
         })
 
+    def update_proxy(self, parsed):
+        """Update proxy related configurations from parsed TOML webui section
+        :param parsed: Parsed proxy TOML section
+        """
+        node = self.nodes["proxy"]
+        self.update_disabled(node, parsed, "proxy.disabled")
+        self.update_ports(node, parsed, mapping={
+            "8889": "8889:8080",
+            "18889": "18889:8080",
+            "28889": "28889:8080",
+        })
+
     def parse_network_config(self):
         network = self.network
 

images/utils/launcher/config/mainnet.conf

@@ -134,3 +134,7 @@
 [webui]
 #disabled = false
 #expose-ports = ["8888:8080"]
+
+[proxy]
+#disabled = false
+#expose-ports = ["8889"]

images/utils/launcher/config/simnet.conf

@@ -47,3 +47,7 @@
 [webui]
 #disabled = false
 #expose-ports = ["28888:8080"]
+
+[proxy]
+#disabled = false
+#expose-ports = ["28889"]

images/utils/launcher/config/template.py

@@ -133,6 +133,21 @@ def __eq__(self, other):
             "use_local_image": False,
             "disabled": True,
         },
+        "proxy": {
+            "name": "proxy",
+            "image": "exchangeunion/proxy:latest",
+            "volumes": [
+                {
+                    "host": "$data_dir/xud",
+                    "container": "/root/.xud",
+                }
+            ],
+            "ports": [PortPublish("28889:8080")],
+            "mode": "native",
+            "preserve_config": False,
+            "use_local_image": False,
+            "disabled": True,
+        },
         "xud": {
             "name": "xud",
             "image": "exchangeunion/xud:latest",
@@ -320,6 +335,21 @@ def __eq__(self, other):
             "use_local_image": False,
             "disabled": True,
         },
+        "proxy": {
+            "name": "proxy",
+            "image": "exchangeunion/proxy:latest",
+            "volumes": [
+                {
+                    "host": "$data_dir/xud",
+                    "container": "/root/.xud",
+                }
+            ],
+            "ports": [PortPublish("18889:8080")],
+            "mode": "native",
+            "preserve_config": False,
+            "use_local_image": False,
+            "disabled": True,
+        },
         "xud": {
             "name": "xud",
             "image": "exchangeunion/xud:latest",
@@ -506,6 +536,21 @@ def __eq__(self, other):
             "use_local_image": False,
             "disabled": True,
         },
+        "proxy": {
+            "name": "proxy",
+            "image": "exchangeunion/proxy:latest",
+            "volumes": [
+                {
+                    "host": "$data_dir/xud",
+                    "container": "/root/.xud",
+                }
+            ],
+            "ports": [PortPublish("8889:8080")],
+            "mode": "native",
+            "preserve_config": False,
+            "use_local_image": False,
+            "disabled": True,
+        },
         "xud": {
             "name": "xud",
             "image": "exchangeunion/xud:1.0.1",

images/utils/launcher/config/testnet.conf

@@ -137,3 +137,7 @@
 [webui]
 #disabled = false
 #expose-ports = ["18888:8080"]
+
+[proxy]
+#disabled = false
+#expose-ports = ["18889"]

images/utils/launcher/node/__init__.py

@@ -21,6 +21,7 @@
 from .lnd import Lndbtc, Lndltc
 from .webui import Webui
 from .xud import Xud, XudApiError
+from .proxy import Proxy
 from .DockerTemplate import DockerTemplate
 from ..config import Config
 from ..errors import FatalError
@@ -328,7 +329,7 @@ def cli(self, name, *args):
         self.get_node(name).cli(" ".join(args), self.shell)
 
     def _get_status_nodes(self):
-        optional_nodes = ["arby", "boltz", "webui"]
+        optional_nodes = ["arby", "boltz", "webui", "proxy"]
         result = {}
         for node in self.nodes.values():
             if node.name in optional_nodes:

images/utils/launcher/node/proxy.py

@@ -0,0 +1,22 @@
+from .base import Node
+
+
+class Proxy(Node):
+    def __init__(self, name, ctx):
+        super().__init__(name, ctx)
+
+        command = [
+            "--xud.rpchost=xud",
+            "--xud.rpccert=/root/.xud/tls.cert",
+        ]
+        if self.network == "simnet":
+            command.append("--xud.rpcport=28886")
+        elif self.network == "testnet":
+            command.append("--xud.rpcport=18886")
+        elif self.network == "mainnet":
+            command.append("--xud.rpcport=8886")
+
+        self.container_spec.command.extend(command)
+
+    def status(self):
+        return "Ready"