E2E Test Suite: Configuration

Environment Variables

The test suite reads configuration from a .env file (loaded via dotenv) or falls back to xchain-hub discovery. All variables are optional if hub discovery is available.

Core Settings

Coin Node

UTXO Tracker

Encoder

Decoder

Indexer

Explorer

Regtest Miner

Hub Discovery

Hub Discovery Fallback

When direct environment variables are not set, the bootstrap sequence discovers configuration from xchain-hub:

flowchart TD
    CHECK{"checkAllEnvironmentalVariables()<br>All 21 vars set?"}
    DIRECT["Use direct config"]
    FALLBACK["Hub fallback"]
    PARSE["Parse endpoints:<br>HUB_VALIDATORS > HUB_URL+HUB_PORT > localhost:10000"]
    NEWCONN["new XChainHubConnector(endpoints)"]
    PING["hubConnector.ping()"]
    GETCONFIG["hubConnector.getAllConfig()<br>→ config[coin][network][service][param]"]
    EXTRACT["Extract host/port for:<br>node, database, utxo-tracker, encoder, decoder, indexer, regtest-miner"]
    NOTE["Note: explorer is NOT hub-discoverable;<br>EXPLORER_URL/EXPLORER_API_PORT must be set directly"]

    CHECK -->|Yes| DIRECT
    CHECK -->|"No (missing)"| FALLBACK
    FALLBACK --> PARSE --> NEWCONN --> PING --> GETCONFIG --> EXTRACT --> NOTE

Docker convention: When using hub discovery, all service hostnames are overridden to "localhost" (Docker Compose services are accessed via port mapping, not container hostnames). Database host defaults to "mariadb".

Internal Constants

Docker

Dockerfile

The suite provides a Dockerfile for containerized execution:

# Node 22 exactly (bookworm, not alpine): node:latest = Node 24+ can't build
# isolated-vm, and alpine's musl breaks native addon builds.
FROM node:22-bookworm

RUN mkdir /XChainE2ETest/
# xchain-hub and xchain-sdk are staged into the build context by xchain-node's
# install path (LIBRARY_BUNDLES); both must precede the package.json COPY so
# `npm ci` can resolve their file: deps inside the image.
COPY ./xchain-hub /XChainE2ETest/xchain-hub
COPY ./xchain-sdk /XChainE2ETest/xchain-sdk
COPY ./package.json /XChainE2ETest/package.json
COPY ./package-lock.json /XChainE2ETest/package-lock.json
WORKDIR /XChainE2ETest
RUN npm ci

COPY ./src /XChainE2ETest/src
COPY ./test /XChainE2ETest/test

# .env is NOT copied in. Pass credentials via `docker run --env-file` at runtime.
CMD ["npm", "test"]

Docker Compose

Run with an env file:

docker build -t xchain-e2e-test .
docker run --env-file .env --network host xchain-e2e-test

Or as part of a Docker Compose stack where all services are orchestrated together:

docker-compose up --exit-code-from xchain-e2e-test

Supported Coin/Network Combinations

Copyright © 2025–2026 Dankest, LLC

Based on XChain Platform by Dankest, LLC – https://dankest.llc

Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-or-later) with a commercial license available for proprietary use.

You may use, modify, and distribute this material under the terms of the License. See LICENSE and NOTICE for full terms. See the licensing overview.