WebSocket frontend for the Electrum JSONRPC server

Using websocat: https://github.com/vi/websocat

Author: shesek

Dockerfile.deps

@@ -73,10 +73,20 @@ RUN source /root/.cargo/env \
  && git checkout a808b51d0d9301fa82390b985c57551966001f9b \
  && cp contrib/popular-scripts.txt /srv/explorer \
  && cargo install --root /srv/explorer/electrs_bitcoin --locked --path . --features electrum-discovery \
- && cargo install --root /srv/explorer/electrs_liquid --locked --path . --features electrum-discovery,liquid) \
- && rm -fr /root/.cargo electrs \
+ && cargo install --root /srv/explorer/electrs_liquid --locked --path . --features electrum-discovery,liquid \
+    ) \
+ && rm -fr electrs \
  && strip /srv/explorer/electrs_*/bin/electrs
 
+# Install websocat v1.9.0 with none of the default features, which aren't needed (ssl, subprocess support and stdio support)
+RUN source /root/.cargo/env \
+ && git clone --no-checkout https://github.com/vi/websocat \
+ && (cd websocat \
+ && git checkout 9f301bd82bbb28e385a5020870738f98ab9010b1 \
+ && cargo install --root /srv/explorer/websocat --locked --path . --no-default-features \
+    ) \
+ && strip /srv/explorer/websocat/bin/websocat \
+ && rm -fr /root/.cargo websocat
 
 # cleanup
 RUN apt-get --auto-remove remove -yqq --purge ${ESPLORA_BUILD_DEPS} manpages ${CORE_BUILD_DEPS} \

contrib/nginx.conf.in

@@ -22,6 +22,11 @@ upstream prerenderer {
     keepalive 300;
 }
 
+upstream electrum_websocket {
+    server unix:/var/electrum-websocket.sock;
+    keepalive 300;
+}
+
 server {
     listen 80;
     keepalive_requests 100000;
@@ -59,6 +64,15 @@ server {
         proxy_http_version 1.1;
         proxy_set_header Connection "";
     }
+    location /{NGINX_PATH}electrum-websocket/ {
+        limit_req zone=lightlimitzone burst=10 nodelay;
+        proxy_pass http://electrum_websocket/;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+        proxy_read_timeout 1d;
+        proxy_send_timeout 1d;
+    }
 
     location = /{NGINX_PATH}nojs {
         return 301 " /{NGINX_PATH}nojs/";

contrib/runits/websocket-log-config.runit

@@ -0,0 +1,2 @@
+u127.0.0.1:23394
+p8-

contrib/runits/websocket-log.runit

@@ -0,0 +1,2 @@
+#!/bin/sh
+exec svlogd /data/logs/websocket

contrib/runits/websocket.runit

@@ -0,0 +1,3 @@
+#!/bin/sh -e
+exec 2>&1
+exec /srv/explorer/websocat/bin/websocat -E -b l-ws-unix:/var/electrum-websocket.sock tcp:127.0.0.1:50001

run.sh

@@ -153,18 +153,25 @@ function preprocess(){
 }
 
 if [ "$MODE" == "explorer" ]; then
-    mkdir -p /etc/service/prerenderer/log /etc/service/nginx/log /etc/service/electrs/log
-    mkdir -p /data/logs/prerenderer /data/logs/nginx /data/logs/electrs
+    mkdir -p /etc/service/{prerenderer,nginx,electrs,websocket}/log
+    mkdir -p /data/logs/{prerenderer,nginx,electrs,websocket}
+
     preprocess /srv/explorer/source/contrib/runits/electrs.runit /etc/service/electrs/run
     cp /srv/explorer/source/contrib/runits/electrs-log.runit /etc/service/electrs/log/run
     cp /srv/explorer/source/contrib/runits/electrs-log-config.runit /data/logs/electrs/config
+
     cp /srv/explorer/source/contrib/runits/nginx.runit /etc/service/nginx/run
     cp /srv/explorer/source/contrib/runits/nginx-log.runit /etc/service/nginx/log/run
     cp /srv/explorer/source/contrib/runits/nginx-log-config.runit /data/logs/nginx/config
+
     preprocess /srv/explorer/source/contrib/runits/prerenderer.runit /etc/service/prerenderer/run
     cp /srv/explorer/source/contrib/runits/prerenderer-log.runit /etc/service/prerenderer/log/run
     cp /srv/explorer/source/contrib/runits/prerenderer-log-config.runit /data/logs/prerenderer/config
     chmod +x /etc/service/prerenderer/run /etc/service/electrs/run
+
+    cp /srv/explorer/source/contrib/runits/websocket.runit /etc/service/websocket/run
+    cp /srv/explorer/source/contrib/runits/websocket-log.runit /etc/service/websocket/log/run
+    cp /srv/explorer/source/contrib/runits/websocket-log-config.runit /data/logs/websocket/config
 elif [ "$MODE" != "private-bridge" ] && [ "$MODE" != "public-bridge" ]; then
     echo "Mode can only be private-bridge, public-bridge or explorer"
     exit 1