Skip to main content

Reference index

All Hathor reference documentation in one place. Jump directly to what you need.

APIs

ReferenceWhat it covers
Full node HTTP API100+ endpoints for reading ledger state, submitting transactions, querying nano contracts
Headless wallet HTTP APIWallet management, balance, history, token creation, transfers — all via REST
Wallet-to-DApp JSON-RPC APIJSON-RPC methods for DApp ↔ wallet communication over WalletConnect

SDKs

ReferenceWhat it covers
Blueprint SDK — APIPython SDK classes and methods for writing nano contract blueprints
Blueprint SDK — Development guidelinesStyle guide, invariants, security patterns for blueprint development
Blueprint SDK — TestsHow to write and run unit tests for blueprints
Blueprint SDK — Bet exampleAnnotated reference implementation of a betting blueprint
DApp wallet integration developmentStep-by-step: sign client, session management, RPC calls from a DApp front end

Libraries

LibraryPurpose
hathor-wallet-libCore JS/TS wallet library for building wallet applications
hathor-rpc-libJSON-RPC library for DApp ↔ wallet communication

Configurations & operations

ReferenceWhat it covers
Highlighted configurationsMost commonly used full node flags and environment variables
Full node CLIComplete CLI reference for hathor-core
Headless wallet — ConfigurationAll headless wallet config options
Headless wallet — TroubleshootingCommon errors and fixes for the headless wallet
Monitoring — MetricsPrometheus metrics exposed by the full node
Monitoring — PoC setupReference Grafana + Alertmanager + Node Exporter configuration
Custom notification pluginHow to write a headless wallet event plugin

Headless wallet operations

ReferenceWhat it covers
Starting a walletSeed phrase loading, wallet ID, startup sequence
Wallet IDHow wallet IDs are derived and used in API requests
Getting statusHealth and sync status endpoint
Getting addressesAddress generation and gap limit
Address informationPer-address balance and history
Getting balanceToken balance queries
Getting UTXOsUTXO selection and filtering
Transactions with data script outputsSending notarization transactions
Creating tokensToken creation, minting, and melting
Configuration stringToken configuration string format
Mint tokensMinting additional supply
Melt tokensDestroying token supply
Getting historyTransaction history queries
Transaction informationIndividual transaction detail
Stopping a walletGraceful shutdown

Protocol & networks

ReferenceWhat it covers
System specificationsHathor protocol: DAG structure, consensus, transaction model, limits
White paperOriginal Hathor protocol paper
Public networksMainnet and testnet endpoints, genesis hashes, bootstrap nodes

Knowledge

ReferenceWhat it covers
GlossaryDefinitions of Hathor-specific terms
EncyclopediaIn-depth articles on blockchain and Hathor concepts
FAQFrequently asked questions