Skip to content

HyperBEAM Reference

Complete API documentation for HyperBEAM's 139 modules, based on v0.9-milestone-3-beta-3. Each module page includes an overview, public function specifications with type signatures, internal function documentation, common usage patterns, and test code examples.

The reference is organized into three categories:

  • AR Utils — Low-level Arweave integration (cryptography, transactions, bundles)
  • HB Core — Core infrastructure (messaging, caching, HTTP, storage, runtime)
  • Devices — Pluggable device implementations (codecs, scheduling, execution, payment)

AR Utils (7)

ModulePurpose
rsa_pssRSA-PSS signatures (RFC 3447)
ar_walletKey generation, signing, serialization
ar_bundlesANS-104 bundle creation and verification
ar_txL1 transaction creation and signing
ar_deep_hashSHA384 recursive hashing for signatures
ar_timestampNetwork timestamp caching
ar_rate_limiterHTTP request throttling

HB Core (55)

Entry Points & Configuration

ModulePurpose
hbMain entry point and node startup
hb_appOTP application behavior
hb_supSupervisor tree management
hb_optsConfiguration management

Computation Engine

ModulePurpose
hb_aoCore AO resolution engine
hb_ao_deviceDevice loading and function routing
hb_ao_test_vectorsAO resolution test suite

HTTP Stack

ModulePurpose
hb_httpHigh-level HTTP request API
hb_http_serverCowboy server integration
hb_http_clientConnection pooling and retries
hb_http_client_supHTTP client supervisor
hb_http_multiMulti-node parallel requests
hb_http_benchmark_testsHTTP performance benchmarks

Caching & Storage

ModulePurpose
hb_cacheHigh-level caching with commitments
hb_cache_controlCache control heuristics
hb_cache_renderGraphViz cache visualization
hb_storeStorage abstraction layer
hb_store_fsFilesystem backend
hb_store_gatewayArweave gateway backend (read-only)
hb_store_lmdbLMDB embedded database
hb_store_lruLRU in-memory cache
hb_store_optsStore options processing
hb_store_remote_nodeRemote node proxy
hb_store_rocksdbRocksDB backend

Message Handling

ModulePurpose
hb_messageFormat conversion and commitments
hb_message_test_vectorsMessage format test suite
hb_mapsMap operations with link resolution
hb_pathPath routing and hashpath calculation
hb_linkLink resolution and normalization
hb_singletonSingleton message conversion
hb_privatePrivate message fields

WASM Runtime

ModulePurpose
hb_beamrWASM runtime wrapper
hb_beamr_ioWASM memory I/O operations

Utilities

ModulePurpose
hb_utilCore utilities and type conversion
hb_cryptoHashing and key derivation
hb_jsonJSON encoding/decoding
hb_keccakEthereum-compatible hashing
hb_escapeString escaping utilities
hb_formatPretty-printing and display
hb_structured_fieldsHTTP Structured Fields (RFC 9651)

Networking & Routing

ModulePurpose
hb_clientRemote node communication
hb_gateway_clientArweave GraphQL client
hb_routerNode routing configuration

Process Management

ModulePurpose
hb_persistentProcess grouping and workers
hb_nameNamed process registry
hb_process_monitorProcess lifecycle monitoring

Debugging & Monitoring

ModulePurpose
hb_debuggerInteractive debugging
hb_eventEvent logging and counters
hb_loggerStructured logging
hb_tracerExecution tracing
hb_metrics_collectorPrometheus metrics
hb_featuresFeature flags

Testing & Examples

ModulePurpose
hb_test_utilsTest store generation, benchmarking
hb_examplesIntegration examples
hb_volumeDisk and volume management

Devices (77)

Signature & Codec Foundation

ModulePurpose
dev_codec_httpsigHTTP Message Signatures (RFC-9421)
dev_codec_httpsig_convTABM ↔ HTTP conversion
dev_codec_httpsig_keyidKey material extraction
dev_codec_httpsig_siginfoSignature header encoding
dev_codec_httpsig_proxyHMAC commitment proxy
dev_codec_flatFlat path-based representation
dev_codec_structuredRich typed messages (int, float, atom, list)

Message Codecs

ModulePurpose
dev_codec_jsonJSON interchange format
dev_codec_ans104ANS-104 bundle format
dev_codec_ans104_fromANS-104 → TABM extraction
dev_codec_ans104_toTABM → ANS-104 conversion

Authentication Codecs

ModulePurpose
dev_codec_cookieCookie management and auth
dev_codec_cookie_authCookie commitment interface
dev_codec_cookie_test_vectorsCookie test suite
dev_codec_http_authHTTP Basic auth with PBKDF2

Core Message Operations

ModulePurpose
dev_messageDefault device, message manipulation
dev_stackDevice execution chaining
dev_multipassMulti-pass execution control
dev_applyDynamic path-based execution
dev_patchMessage reorganization
dev_dedupMessage deduplication
dev_hookLifecycle event hooks

Process Management

ModulePurpose
dev_processCore process execution engine
dev_process_cacheComputation result caching
dev_process_workerIn-memory state optimization
dev_node_processNode-specific singleton processes
dev_metaNode lifecycle and configuration
dev_monitorProcess execution monitoring

Scheduling

ModulePurpose
dev_schedulerCore scheduler device
dev_scheduler_cacheAssignment caching
dev_scheduler_formatsBundle ↔ AOS2 conversion
dev_scheduler_registryScheduler server registry
dev_scheduler_serverLong-lived scheduler servers
dev_cronScheduled message execution

Storage & Caching

ModulePurpose
dev_cacheCache read/write operations
dev_lookupResource lookup with format negotiation
dev_trieRadix trie for efficient key-value
dev_volumeVolume management for state

Name Resolution

ModulePurpose
dev_nameName resolution via resolver chain
dev_local_nameLocal name registration
dev_manifestArweave path manifest resolution

Arweave Integration

ModulePurpose
dev_arweaveArweave network access
dev_arweave_block_cacheBlock caching with indexing
dev_podaProof of Distributed Authority

Network & Routing

ModulePurpose
dev_routerHTTP message routing
dev_relayMessage relay between nodes
dev_pushOutbound message delivery
dev_whoisNetwork identity discovery

Query & Indexing

ModulePurpose
dev_queryData query interface
dev_query_arweaveArweave GraphQL queries
dev_query_graphqlFull GraphQL interface
dev_query_test_vectorsQuery test suite
dev_copycatData replication orchestration
dev_copycat_arweaveBlock-based indexing
dev_copycat_graphqlQuery-based indexing

Execution Runtimes

ModulePurpose
dev_wasmWebAssembly runtime (WAMR)
dev_wasiWASI interface implementation
dev_luaLua 5.3 execution with sandboxing
dev_lua_libAO-Core functions for Lua
dev_lua_testLua test framework
dev_lua_test_ledgersToken ledger test suite
dev_json_ifaceJSON interface for WASM
dev_delegated_computeRemote CU execution
dev_genesis_wasmLegacy AO compatibility
dev_cuCompute unit tracking

Payment & Economics

ModulePurpose
dev_p4P4 payment orchestration
dev_simple_payFlat-rate pricing and ledger
dev_faffFriends & Family whitelist

Security & Attestation

ModulePurpose
dev_secretSecret/wallet management
dev_auth_hookAuthentication hooks
dev_snpAMD SEV-SNP attestation
dev_snp_nifSNP NIF interface
dev_green_zoneTrusted execution zones

Debugging & Tools

ModulePurpose
dev_hyperbuddyWeb REPL interface
dev_cachevizCache visualization
dev_profilePerformance profiling
dev_testTesting utilities