Skip to main content

Configure and Launch Node

This chapter will guide you through deploying and launching a HyMatrix node. You will learn how to:

  • Obtain the node client
  • Prepare the configuration file
  • Launch and connect to the network

Prerequisite Checklist​

Before proceeding, make sure you have completed the following:

  • A server that meets the requirements (Linux recommended, public access enabled, ≥100Mbps bandwidth)
  • All necessary dependencies installed (Docker, Redis, etc. — see: Software Dependencies)
  • A generated Ethereum or Arweave wallet (used as node identity)

🔍 If you haven’t completed wallet setup or environment preparation, refer to the previous section: Preparation.

Get the Node Client​

You can obtain the hymx node client in one of the following ways:

⬇️ Hymx releases ⬇️

Option 2: Build from Source (Optional)​

If you prefer to build from source:

git clone https://github.com/hymatrix/hymx
cd hymx
go mod tidy
make build

📌 Make sure Go ≥ 1.24.0 and Git are installed if using source build.

Prepare Configuration File​

Create a file named config.yaml with the following minimal configuration, suitable for local testing and quick validation of the node startup process:

# Node Service
port: :8080
ginMode: release  # Options: "debug", "release"

# Redis Configuration
redisURL: redis://@localhost:6379/0

# Storage & Network
arweaveURL: https://arweave.net
hymxURL: http://127.0.0.1:8080

# Node Identity (Wallet)
prvKey: 0x64dd2342616f385f3e8157cf7246cf394217e13e8f91b7d208e9f8b60e25ed1b
keyfilePath:

# Node Info
nodeName: test1
nodeDesc: first test node
nodeURL: http://127.0.0.1:8080

# Registration & Network Join
joinNetwork: false

Field Explanation (Minimal Setup)​

  • hymxURL: Set to local node address — useful for SDK-based local calls.
  • prvKey: Ethereum-format private key used for signing node identity and logs.
  • nodeName / nodeURL: Basic node metadata — local settings for development/debugging.
  • joinNetwork: false: Node will not register to the network or stake tokens. Ideal for local testing and development.

Prepare Core Modules​

To enable the node to properly join the network, you need to provide core Module files in the hymx runtime directory.

Create a mod/ folder in the runtime directory and download the following Module files into it:

👉 https://github.com/hymatrix/hymx/tree/develop/cmd/mod

  • mod-1i03Vpe8DljkUMBEEEvR0VmbJjvgZtP_ytZdThkVSMw.json: HyMatrix core token Module
  • mod-MVTil0kn5SRiJELW7W2jLZ6cBr3QUGj1nJ67I2Wi4Ps.json: Registry Module

These two Modules define the network’s core token and the global registry, which are essential for node registration and subsequent network interactions.

Start Redis​

Before starting the node, ensure the Redis service is running, and the redisURL in your config.yaml is correct.

Start the Node​

Place the downloaded or built hymx binary and your config.yaml in the same directory, then start the node service:

./hymx --config ./config.yaml

If successful, the terminal output should resemble:

INFO[07-25|00:00:01] server is running   module=node-v0.0.1 wallet=0x... port=:8080

Your node is now initialized locally.

✅ Next step: To join the testnet or mainnet and provide live services, continue with: Join the Network