helium

n8n community node for Helium Network - A complete DePIN wireless network toolkit for IoT (LoRaWAN) and Mobile (5G) operations

Package Information

Downloads: 3 weekly / 99 monthly
Latest Version: 1.0.0
Author: Velocity BPA, LLC

Documentation

n8n-nodes-helium

[Velocity BPA Licensing Notice]

This n8n node is licensed under the Business Source License 1.1 (BSL 1.1).

Use of this node by for-profit organizations in production environments requires a commercial license from Velocity BPA.

For licensing information, visit https://velobpa.com/licensing or contact licensing@velobpa.com.

A comprehensive n8n community node for the Helium Network - a decentralized wireless infrastructure (DePIN) supporting IoT (LoRaWAN) and Mobile (5G) networks. This package provides complete access to hotspot management, rewards tracking, staking, governance, oracle price feeds, and H3 hexagonal location operations.

npm version
License

Features

Action Node (Helium)

16 resources with 80+ operations:

Resource Operations
Wallet Get Balance, Get All Balances, Get Activity, Get Hotspots, Get Rewards, Transfer HNT/IOT/MOBILE, Validate Address
Hotspot Get Info, Search by Name, Get by Owner, Get Rewards, Get Activity, Get Witnesses, Get Status, Get Location
IoT Network Get Stats, Get Hotspots, Get Rewards Rate, Get Oracle Price, Get PoC Events, Get Data Transfer
Mobile Network Get Stats, Get Radios, Get Rewards Rate, Get Oracle Price, Get Coverage
Rewards Get Account/Hotspot Rewards, Get Rewards Sum, Get Pending, Calculate Estimated, Get Emissions
Proof of Coverage Get Events, Get Challenges, Get Statistics, Verify Event
Data Credits Get Balance, Get Price, Burn HNT for DC, Calculate DC Needed, Get Usage
Staking Get Position, Get veHNT/veIOT/veMOBILE Balance, Get Voting Power, Get Multiplier
Governance Get Proposals, Get Voting Power, Get Vote History, Get DAO Info
Oracle Get HNT/IOT/MOBILE/DC Prices, Get All Prices, Get Price History
H3 Hex Get Hex Info, Get Hotspots in Hex, Get Neighbors, Convert Lat/Lng, Calculate Distance
Block Get Block, Get Latest Block, Get Transaction, Get Chain Stats
Network Stats Get Overview, Get Hotspot Count, Get Cities, Get Token Stats, Get Coverage
NFT Get Hotspot NFT, Get NFTs by Owner, Get Metadata, Get Maker Info
Utility Convert Units, Validate Address, Get Animal Name, Calculate Distance

Trigger Node (Helium Trigger)

Real-time monitoring for 8 event types:

  • Wallet Balance Changed - Monitor HNT/IOT/MOBILE balance changes
  • Token Received - Trigger when tokens are received
  • Hotspot Rewards - Monitor hotspot earnings
  • Hotspot Status Change - Detect online/offline status
  • Hotspot Activity - Monitor all hotspot activity
  • New Block - Trigger on new blockchain blocks
  • Price Change - Alert on significant token price changes
  • Account Rewards - Monitor account reward distributions

Installation

Community Nodes (Recommended)

  1. Open n8n
  2. Go to Settings > Community Nodes
  3. Click Install a community node
  4. Enter n8n-nodes-helium
  5. Click Install

Manual Installation

# Build and pack the package
cd n8n-nodes-helium
npm run build
npm pack

# This creates n8n-nodes-helium-1.0.0.tgz

# Copy to n8n custom directory
cp n8n-nodes-helium-1.0.0.tgz ~/.n8n/custom/
cd ~/.n8n/custom
npm install n8n-nodes-helium-1.0.0.tgz

Development Installation

# 1. Extract the zip file
unzip n8n-nodes-helium.zip
cd n8n-nodes-helium

# 2. Install dependencies
npm install

# 3. Build the project
npm run build

# 4. Create symlink to n8n custom nodes directory
# For Linux/macOS:
mkdir -p ~/.n8n/custom
ln -s $(pwd) ~/.n8n/custom/n8n-nodes-helium

# For Windows (run as Administrator):
# mklink /D %USERPROFILE%\.n8n\custom\n8n-nodes-helium %CD%

# 5. Restart n8n
n8n start

Credentials Setup

Helium Network Credentials

Used for Solana blockchain interactions (token transfers, staking, etc.)

Field Description Required
Network Mainnet, Devnet, or Custom Yes
RPC URL Custom Solana RPC endpoint No
Private Key Solana wallet private key (Base58) For transfers

Helium API Credentials

Used for Helium Foundation API queries

Field Description Required
API Provider Foundation, Explorer, Oracle, Custom Yes
API URL Custom API endpoint No
API Key Authentication key No

Hotspot Owner Credentials

Used for hotspot management

Field Description Required
Owner Address Wallet address owning hotspots Yes
Hotspot Addresses List of hotspot addresses No

Usage Examples

Check Wallet Balance

// Get all Helium token balances for a wallet
{
  "resource": "wallet",
  "operation": "getBalance",
  "walletAddress": "YOUR_SOLANA_WALLET_ADDRESS"
}

Monitor Hotspot Rewards

// Get rewards for a specific hotspot
{
  "resource": "hotspot",
  "operation": "getRewards",
  "hotspotAddress": "HOTSPOT_ADDRESS",
  "timeRange": {
    "minTime": "2024-01-01T00:00:00Z",
    "maxTime": "2024-01-31T23:59:59Z"
  }
}

Convert Coordinates to H3 Hex

// Convert latitude/longitude to H3 hexagonal index
{
  "resource": "h3",
  "operation": "latLngToH3",
  "latitude": 37.7749,
  "longitude": -122.4194,
  "resolution": 12
}

Get Oracle Token Prices

// Get current prices for all Helium tokens
{
  "resource": "oracle",
  "operation": "getAllPrices"
}

Helium Network Concepts

Token Types

  • HNT - Main network token (8 decimals, "bones" = smallest unit)
  • IOT - IoT subnetwork token for LoRaWAN (6 decimals)
  • MOBILE - Mobile subnetwork token for 5G (6 decimals)
  • DC - Data Credits, burned for data transfer ($0.00001 each)

Proof of Coverage (PoC)

Helium's mechanism for verifying wireless coverage:

  • Beaconing - Hotspots transmit beacons
  • Witnessing - Nearby hotspots verify beacons
  • Valid witness distance: 300m - 100km

H3 Hexagonal System

Uber's H3 hexagonal hierarchical spatial index:

  • Resolution 4: Regional level
  • Resolution 8: District level
  • Resolution 10: Neighborhood level
  • Resolution 12: PoC precision (used for rewards)

veTokens (Vote-Escrowed)

Governance tokens obtained by locking base tokens:

  • veHNT - Locked HNT for governance voting
  • veIOT - Locked IOT for IoT governance
  • veMOBILE - Locked MOBILE for Mobile governance
  • Lock duration: Up to 4 years (longer = more voting power)

Networks

Network Endpoint
Solana Mainnet https://api.mainnet-beta.solana.com
Helium Foundation API https://api.helium.io/v1
Helium Explorer API https://api.helium.wtf/v1
Helium Oracle API https://oracle.helium.io

Error Handling

The node includes comprehensive error handling:

  • Automatic retry with exponential backoff for rate limits
  • Clear error messages for invalid addresses
  • Network timeout handling
  • Graceful degradation for unavailable services

Security Best Practices

  • Never share your private keys - Use environment variables
  • Use read-only operations when possible
  • Validate addresses before transactions
  • Test on Devnet before Mainnet
  • Keep credentials secure - Use n8n's credential storage

Development

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run linting
npm run lint

# Fix linting issues
npm run lint:fix

# Watch mode for development
npm run dev

Author

Velocity BPA, LLC

Licensing

This n8n community node is licensed under the Business Source License 1.1.

Free Use

Permitted for personal, educational, research, and internal business use.

Commercial Use

Use of this node within any SaaS, PaaS, hosted platform, managed service,
or paid automation offering requires a commercial license.

For licensing inquiries:
licensing@velobpa.com

See LICENSE, COMMERCIAL_LICENSE.md, and LICENSING_FAQ.md for details.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Support

Acknowledgments

Disclaimer

This is an unofficial community node and is not affiliated with, endorsed by, or sponsored by Helium Foundation or Nova Labs. Use at your own risk. Always verify transactions before signing and never share your private keys.

Discussion