Harmony Guides
Validator Toolbox

๐Ÿ› ๏ธ Harmony Validator Toolbox


Professional Automation Suite: The Harmony Validator Toolbox (opens in a new tab) provides automated installation, configuration, and management tools for experienced Harmony validators.

Harmony Loading

๐Ÿ“ฆ Open Source Project

Community Driven: Our Harmony Validator Toolbox is open source and actively maintained on GitHub (opens in a new tab). Contributions and feedback from the validator community help drive continuous improvements.

๐Ÿ“Š Project Status

Codacy Security Scan (opens in a new tab) Discord Badge (opens in a new tab) Stake Now Badge (opens in a new tab)


๐Ÿš€ Prerequisites

โš ๏ธ

Experience Required: This toolbox is designed for experienced validators. For beginners, please review our complete setup guide first.

๐Ÿ–ฅ๏ธ Server Requirements

System Specifications: Detailed server requirements covered in our admin tools section.

  • Operating System: Linux server running Ubuntu 20.04/22.04 LTS
  • User Account: Regular user account with sudo/root access
  • Network: Stable internet connection with required ports open

๐Ÿ’ฐ Wallet Setup

โš ๏ธ

Wallet Required: Ensure you have a properly configured validator wallet before proceeding. See our wallet setup guide for detailed instructions.


๐Ÿ“ฅ Installation Guide

Flexible Deployment: The harmony-toolbox can be installed on existing validator nodes for management capabilities or on new servers for complete Harmony validator setup.

๐Ÿ“น Video Tutorial

Visual Guide: Watch our comprehensive installation walkthrough for step-by-step guidance.

๐Ÿ”ง System Dependencies

Install Ubuntu dependencies and download the toolbox with the following command:

cd ~/ && sudo apt-get install dnsutils git python3-pip python3-dotenv unzip tmux -y && wget -O harmony.sh https://raw.githubusercontent.com/easy-node-pro/harmony-toolbox/main/src/bin/harmony.sh && chmod +x harmony.sh

๐Ÿš€ Launch Installation

โš ๏ธ

First-Time Setup: Initial launch will prompt configuration questions before installing Harmony validator software.

cd ~/ && ./harmony.sh

โš™๏ธ Configuration Process

Interactive Setup: The installation process includes several configuration screens to customize your validator deployment.

๐ŸŽฏ Shard Selection

Pick a shard, any shard!

โš ๏ธ

Strategic Choice: Select the shard for your validator node. We recommend checking the Smart Stake election dashboard (opens in a new tab) to identify shards 1-3 with the lowest key count for optimal election chances.

๐Ÿ“ Installation Directory

Flexible Paths: Choose between default installation (~/harmony) or custom location for better organization.

Recommended paths:

  • Default: /home/serviceharmony/harmony
  • Shard-specific: /home/serviceharmony/harmony1 (for shard 1)

Install in default location

Example of using a custom location:

Install custom #1

Install custom #2

File Setup

Files will now configure since we know the shard and location.

Files Installed


๐Ÿ” Wallet Configuration

โš ๏ธ

Advanced Features: Wallet recovery enables claim/send functionality and auto-bidding features in future toolbox versions.

Wallet Config

Two Options: Choose wallet recovery for full functionality or provide validator address for basic operation.

Wallet Recovery

If you answered No above, instead you'll get this prompt to input your address with verification.

Save wallet address for toolbox

If you answered Yes above, you'll get this menu to load your wallet.

Recover mnemonic phrase into wallet directly

You'll be asked directly by the hmy app for your phrase or mnemonic. We do not store or save this information. When selecting an option you'll first be prompted to set a wallet password for this server. This will be saved in your harmony directory as passphrase.txt.

Password

After setting up your password for the server, you'll be prompted to provide your private key or mnemonic depending on your choice.

Private Wallet Info

Confirm your password again, and verify your proper address is displayed.

Wallet Info

Clone Shards

You will now start cloning your shards. If you choose shard 1-3 that shard will download before shard 0. You can press ctrl+c to cancel downloading of any shard to move past that download.

Shard 1 Incoming

Shard 0 on the way!

Install completed!

Install complete!

As mentioned earlier, if you do not have sudoless root access, you will be prompted for a passwords. Keep an eye out for any prompts.


๐Ÿ”‘ Post-Installation Requirements

๐Ÿšซ

New Validators Only: Complete these steps after toolbox installation but before first management menu launch. Experienced validators should have already completed these requirements.

๐Ÿ” BLS Key Management

โš ๏ธ

Critical Security: BLS keys are shard-specific and cannot be transferred between shards. Proper backup is essential.

  • Backup Protocol: Transfer .key & .pass files to secure local storage
  • Key Addition: New keys can be created and added after next election cycle
  • Shard Limitation: Keys are permanently bound to their creation shard

Reference: Complete BLS Key Guide

๐ŸŽฏ Validator Creation

Foundation Command: Create your validator on the Harmony network with proper configuration.

๐Ÿšซ

Formatting Critical: Copy the entire command without modifications. Extra whitespace can cause transaction failures. Multi-word parameters require double quotes (e.g., --name "John the Validator").


๐ŸŽจ Professional Setup Recommendations

Validator Branding: Establish professional validator identity with logo and comprehensive information.

๐Ÿ–ผ๏ธ Validator Logo Setup

Configure your validator logo using the official Harmony guide (opens in a new tab) to obtain an identity string for professional presentation.

๐Ÿ“‹ Enhanced Creation Example

๐Ÿ“‹ Parameter Configuration

๐Ÿšซ

Permanent Settings: max-change-rate and max-rate cannot be modified after validator creation. Plan carefully before execution.

Parameter Reference:

  • validator-addr - Validator wallet with 10,001+ ONE (10k stake + fees)
  • amount - Minimum 10,000 ONE self-delegation
  • bls-pubkeys - Your BLS public key(s) for signing
  • name - Validator display name on staking interface
  • identity - Logo identity string from keybase verification
  • details - Validator description for delegators
  • security-contact - Professional contact email
  • website - Official validator website or social media
  • max-change-rate - Maximum daily rate adjustment (permanent)
  • max-rate - Maximum possible commission rate (permanent)
  • rate - Current commission rate (adjustable within limits)
  • max-total-delegation - Per-delegator maximum stake limit
  • min-self-delegation - Minimum self-stake (10,000 ONE minimum)

๐ŸŽฎ Management Commands

Operational Control: Use these commands for ongoing validator management and monitoring.

๐Ÿš€ Launch Management Interface

Best Practice: Always check for updates when launching the management menu.

bash -x ~/harmony.sh

๐Ÿ“Š Quick Statistics

Status Check: Retrieve validator statistics without entering the full management interface.

bash -x ~/harmony.sh -s

๐ŸŽ‰ Setup Complete: Your Harmony Validator Toolbox is now configured and ready for professional validator operations. Visit our live validator dashboard (opens in a new tab) to see professional validation in action.