Reference index
All Hathor reference documentation in one place. Jump directly to what you need.
APIs
| Reference | What it covers |
|---|---|
| Full node HTTP API | 100+ endpoints for reading ledger state, submitting transactions, querying nano contracts |
| Headless wallet HTTP API | Wallet management, balance, history, token creation, transfers — all via REST |
| Wallet-to-DApp JSON-RPC API | JSON-RPC methods for DApp ↔ wallet communication over WalletConnect |
SDKs
| Reference | What it covers |
|---|---|
| Blueprint SDK — API | Python SDK classes and methods for writing nano contract blueprints |
| Blueprint SDK — Development guidelines | Style guide, invariants, security patterns for blueprint development |
| Blueprint SDK — Tests | How to write and run unit tests for blueprints |
| Blueprint SDK — Bet example | Annotated reference implementation of a betting blueprint |
| DApp wallet integration development | Step-by-step: sign client, session management, RPC calls from a DApp front end |
Libraries
| Library | Purpose |
|---|---|
| hathor-wallet-lib | Core JS/TS wallet library for building wallet applications |
| hathor-rpc-lib | JSON-RPC library for DApp ↔ wallet communication |
Configurations & operations
| Reference | What it covers |
|---|---|
| Highlighted configurations | Most commonly used full node flags and environment variables |
| Full node CLI | Complete CLI reference for hathor-core |
| Headless wallet — Configuration | All headless wallet config options |
| Headless wallet — Troubleshooting | Common errors and fixes for the headless wallet |
| Monitoring — Metrics | Prometheus metrics exposed by the full node |
| Monitoring — PoC setup | Reference Grafana + Alertmanager + Node Exporter configuration |
| Custom notification plugin | How to write a headless wallet event plugin |
Headless wallet operations
| Reference | What it covers |
|---|---|
| Starting a wallet | Seed phrase loading, wallet ID, startup sequence |
| Wallet ID | How wallet IDs are derived and used in API requests |
| Getting status | Health and sync status endpoint |
| Getting addresses | Address generation and gap limit |
| Address information | Per-address balance and history |
| Getting balance | Token balance queries |
| Getting UTXOs | UTXO selection and filtering |
| Transactions with data script outputs | Sending notarization transactions |
| Creating tokens | Token creation, minting, and melting |
| Configuration string | Token configuration string format |
| Mint tokens | Minting additional supply |
| Melt tokens | Destroying token supply |
| Getting history | Transaction history queries |
| Transaction information | Individual transaction detail |
| Stopping a wallet | Graceful shutdown |
Protocol & networks
| Reference | What it covers |
|---|---|
| System specifications | Hathor protocol: DAG structure, consensus, transaction model, limits |
| White paper | Original Hathor protocol paper |
| Public networks | Mainnet and testnet endpoints, genesis hashes, bootstrap nodes |
Knowledge
| Reference | What it covers |
|---|---|
| Glossary | Definitions of Hathor-specific terms |
| Encyclopedia | In-depth articles on blockchain and Hathor concepts |
| FAQ | Frequently asked questions |