Upgrade to ElectrumX 2.0.0 and port the Doichain coin classes (green CI, replaces #11)

.github/pull_request_template.md

@@ -0,0 +1,4 @@
+<!-- Note: Our primary focus is supporting Bitcoin, and contributions in that regard are appreciated the most!
+Due to historical reasons, ElectrumX also has support for many altcoins. These will be kept as long as
+maintenance burden can be kept *at a minimum*. When adding a new altcoin, (1) add a unit test (see tests/blocks),
+and (2) make sure the CI tests pass. -->

.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:  # https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  # if a PR gets force pushed, cancel the current run and run the new one
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  unittests:
+    name: unittests
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install system packages
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get install -yq libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev liblz4-dev librocksdb-dev libleveldb-dev libboost-all-dev libsodium-dev
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+          cache-dependency-path: 'pyproject.toml'
+
+      - name: Log Python version and Git tag
+        run: |
+          python3 --version
+          git tag
+
+      - name: Install Python deps
+        run: |
+          # test framework -related deps
+          pip install pycodestyle
+          pip install pytest-asyncio
+          pip install pytest-cov
+          pip install Sphinx
+          # e-x itself
+          # - install both leveldb and rocksdb bindings
+          pip install ".[leveldb,rocksdb]"
+          # hashes and other altcoin-specific stuff
+          pip install tribushashm
+          pip install blake256
+          pip install dash_hash
+          pip install git+https://github.com/bitcoinplusorg/x13-hash
+          pip install xevan_hash
+          pip install quark_hash
+          pip install groestlcoin_hash
+          pip install x16r_hash
+          pip install pycryptodomex
+          pip install git+https://github.com/Electra-project/nist5_hash
+          pip install x16rv2_hash
+
+      - name: Run pytest
+        run: pytest --cov=electrumx
+
+  pycodestyle:
+    name: pycodestyle
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+
+      - name: Install pycodestyle
+        run: pip install pycodestyle
+
+      - name: Run pycodestyle
+        run: |
+          pycodestyle \
+            --max-line-length=140 \
+            src
+
+  build_docs:
+    # note: this build task is not related to read-the-docs; it is only here to sanity-check the docs can be built.
+    #       For the read-the-docs build, see .readthedocs.yml
+    #       and the webhook set up in https://github.com/spesmilo/electrumx/settings/hooks
+    name: build_docs
+    runs-on: ubuntu-24.04
+    env:
+      LC_ALL: "C"
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+          cache-dependency-path: 'docs/requirements-docs.txt'
+
+      - name: Install docs deps
+        run: pip install -r docs/requirements-docs.txt
+
+      - name: Build docs
+        run: |
+          cd docs
+          make html

.gitignore

@@ -1,15 +1,20 @@
 **/__pycache__/
-.cache/
-.pytest_cache/
+/.cache/
+/.pytest_cache/
 */*~
 *.#*
 *#
 *~
-docs/_build
-/build
-/dist
-/electrumx.egg-info
-.vscode/
-.mypy_cache/
-.idea/
+/docs/_build/
+/build/
+/dist/
+/venv/
+/.vscode/
+/.mypy_cache/
+/.idea/
+
+/src/electrumx.egg-info/
+/src/e_x.egg-info/
+/electrumx.egg-info/
+/e_x.egg-info/
 /certs

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+   install:
+   - requirements: docs/requirements-docs.txt

LICENCE

@@ -1,4 +1,5 @@
-Copyright (c) 2016-2017, Neil Booth
+Copyright (c) 2016-2020, Neil Booth
+Copyright (c) 2020-2026, The Electrum developers
 
 All rights reserved.
 

MANIFEST.in

@@ -0,0 +1,5 @@
+# note: files listed in this file:
+#       - will be added to the sdist
+#       - but won't be added to the wheel (unless by other means)
+
+graft tests/

README.md

@@ -0,0 +1,31 @@
+# ElectrumX - python electrum server
+
+```
+Licence: MIT
+Original Author: Neil Booth
+Current Maintainers: The Electrum developers
+Language: Python (>= 3.10)
+```
+
+[![Latest PyPI package](https://badge.fury.io/py/e_x.svg)](https://pypi.org/project/e-x/)
+[![Build Status](https://github.com/spesmilo/electrumx/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/spesmilo/electrumx/actions/workflows/ci.yml)
+
+This project is a fork of [kyuupichan/electrumx](https://github.com/kyuupichan/electrumx).
+The original author dropped support for Bitcoin, which we intend to keep.
+
+ElectrumX allows users to run their own Electrum server. It connects to your
+full node and indexes the blockchain, allowing efficient querying of the history of
+arbitrary addresses. The server can be exposed publicly, and joined to the public network
+of servers via peer discovery. As of May 2020, a significant chunk of the public
+Electrum server network runs ElectrumX.
+
+### Documentation
+
+See [readthedocs](https://electrumx-spesmilo.readthedocs.io).
+
+### Releases
+
+Running from the latest git tag is always a safe bet, for which there are also releases on PyPI:
+```
+$ pip install e-x
+```

SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+See https://github.com/spesmilo/electrum/blob/master/SECURITY.md

contrib/Dockerfile

@@ -1,35 +1,52 @@
-# example of Dockerfile that builds release of electrumx-1.13.0
-# ENV variables can be overrided on the `docker run` command
-
-FROM ubuntu:18.04
-
-WORKDIR /
-ADD https://github.com/kyuupichan/electrumx/archive/1.13.0.tar.gz /
-RUN tar zxvf *.tar.gz
-
-RUN apt-get update && \
-        apt-get -y install python3.7 python3-pip librocksdb-dev libsnappy-dev libbz2-dev libz-dev liblz4-dev && \
-        pip3 install aiohttp pylru python-rocksdb
-
-RUN cd /electrumx* && python3 setup.py install
+# ElectrumX for Bitcoin, with RocksDB
+# This is a simple ~minimal example Dockerfile.
+#
+# Build: docker build --pull -t electrumx .
+#        podman build --pull  -t electrumx .
+# Run:   docker run -d --net=host -v ~/electrumx-db:/var/lib/electrumx -e DAEMON_URL="http://youruser:yourpass@localhost:8332" -e REPORT_SERVICES=tcp://example.com:50001 electrumx
+#        podman run -d --net=host -v ~/electrumx-db:/var/lib/electrumx -e DAEMON_URL="http://youruser:yourpass@localhost:8332" -e REPORT_SERVICES=tcp://example.com:50001 electrumx
+# Stop:  docker stop CONTAINER_ID
+#        podman stop CONTAINER_ID
+
+FROM python:3.14-trixie AS builder
+
+WORKDIR /usr/src/app
+
+# Install the libs needed by rocksdb (including development headers)
+RUN apt-get update \
+    && apt-get -y --no-install-recommends install \
+        build-essential \
+        git \
+        librocksdb-dev \
+        pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install ElectrumX
+ARG ELECTRUMX_VERSION=2.0.0
+#ARG ELECTRUMX_VERSION=b8f6e227f251fe5cba96b940ffaa094439636417
+RUN python -m venv venv \
+    && venv/bin/pip install --no-cache-dir \
+        "e_x[rocksdb] @ git+https://github.com/spesmilo/electrumx.git@${ELECTRUMX_VERSION}"
+
+
+FROM python:3.14-slim-trixie
+
+# Install the libs needed by rocksdb (no development headers or statics)
+RUN apt-get update && apt-get -y --no-install-recommends install librocksdb9.10 && rm -rf /var/lib/apt/lists/*
 
 ENV SERVICES="tcp://:50001"
-ENV COIN=BitcoinSV
-ENV DB_DIRECTORY=/db
+ENV COIN=Bitcoin
+ENV DB_DIRECTORY=/var/lib/electrumx
 ENV DAEMON_URL="http://username:password@hostname:port/"
 ENV ALLOW_ROOT=true
 ENV DB_ENGINE=rocksdb
-ENV MAX_SEND=10000000
-ENV BANDWIDTH_UNIT_COST=50000
-ENV CACHE_MB=2000
+#ENV CACHE_MB=2000
 
-VOLUME /db
+WORKDIR /usr/src/app
+COPY --from=builder /usr/src/app .
 
-RUN mkdir -p "$DB_DIRECTORY" && ulimit -n 1048576
+VOLUME /var/lib/electrumx
 
-CMD ["/usr/bin/python3", "/usr/local/bin/electrumx_server"]
+RUN mkdir -p "$DB_DIRECTORY"
 
-# build it with eg.: `docker build -t electrumx .`
-# run it with eg.:
-# `docker run -d --net=host -v /home/electrumx/db/:/db -e DAEMON_URL="http://youruser:yourpass@localhost:8332" -e REPORT_SERVICES=tcp://example.com:50001 electrumx`
-# for a proper clean shutdown, send TERM signal to the running container eg.: `docker kill --signal="TERM" CONTAINER_ID`
+CMD ["/usr/src/app/venv/bin/python", "/usr/src/app/venv/bin/electrumx_server"]