API Reference macula v#4.1.1

Macula SDK — Public API for mesh applications.

macula-net address derivation: pubkey -> IPv6.

Periodic DHT advertisement of a macula-net station.

macula public API

Daemon-side attachment to a host station.

BLAKE3 hashing with NIF acceleration and Erlang fallback.

BOLT#4-style error taxonomy for CALL failures (Part 4 §6.1).

Generic LRU cache implementation. Provides least-recently-used eviction with configurable max size.

TTL-bounded route cache for macula-net.

CBOR (RFC 8949) pack/unpack for the Macula mesh wire protocol.

Macula Self-Sovereign Certificate System

Macula Certificate System Supervisor

macula_client — the canonical pool client.

Cluster management utilities for Macula platform.

Macula UDP Multicast Gossip Cluster Strategy.

Macula Static Cluster Strategy.

Macula Cluster Strategy for libcluster.

Macula Console Formatter - Beautiful colored terminal output.

Core type definitions and encoding/decoding for Macula. Provides fundamental types like node IDs, realm IDs, and addresses.

Cryptographic operations for Macula mesh.

Ingress delivery for macula-net packets.

Structured event emission + per-process metric accumulation.

Decentralized Identifier (DID) operations for Macula mesh.

QUIC Distribution Carrier for Erlang.

Supervised bridge process for relay distribution tunnels.

Supervisor for distribution relay bridge processes.

EPMD Replacement using Macula DHT Discovery.

Macula Distribution mDNS Advertiser.

Relay-routed Erlang distribution.

Client for the Macula dist relay (macula-io/macula-dist-relay).

Control protocol encoder/decoder for dist relay.

Macula Distribution System Supervisor.

Foundation trust anchor — firmware-embedded pubkeys for the Macula Foundation FROST-Ed25519 aggregated signer.

CBOR-encoded wire frames for Macula V2 (Part 6 §3 canonical wire).

Host-side controller for the macula-net attach plane.

Hosted-identity table for a macula-net station.

ID generation utilities for Macula. Provides functions for generating various types of IDs.

Ed25519 identities and the S/Kademlia crypto puzzle.

Node-wide Prometheus-style metric registry for macula-net.

Prometheus text-format pull endpoint for macula_metrics.

Macula Resource Identifier (MRI) - Core Module

MRI ETS Storage Adapter

MRI Graph Behaviour

MRI (Macula Resource Identifier) operations for Macula mesh.

MRI Type Registry

MRI Storage Behaviour

Shared naming utilities for hierarchical dot-separated names. Used by both pub/sub topics and RPC procedure names. Supports DNS-style reverse notation: org.domain.service.method

macula-net facade.

Transport plugin contract for macula-net.

QUIC transport plugin for macula-net.

Node identity and metadata management. Represents a single node in the Macula mesh.

Per-flow packet trace toggle for macula-net.

Macula peering — connection state machine API.

Per-peer connection state machine.

simple_one_for_one supervisor for macula_peering_conn workers.

Top supervisor for macula_peering.

Protocol message decoder for Macula mesh. Decodes binary wire format to message maps.

Protocol message encoder for Macula mesh. Encodes message maps to binary wire format.

Protocol message type definitions and constants for Macula mesh. Defines all message types that can be sent over QUIC streams.

Pubsub surface for the V2 SDK.

Macula QUIC transport — Quinn-based Rust NIF.

Realm management and validation. Realms provide logical isolation boundaries in the mesh. Realm names follow reverse DNS notation (e.g., "org.example.mesh").

PKARR-compatible signed records (envelope + node_record + tombstone).

Deterministic CBOR encoder/decoder.

UUIDv7 generator (RFC 9562 §5.7).

Relay Discovery — geographic-aware relay selection.

Resolve a macula-net IPv6 address to its hosting station's QUIC endpoint via the DHT.

Eclipse-mitigation wrapper for macula_resolve_address.

Macula SDK Root Supervisor.

Egress routing for macula-net packets.

Minimal IPv6 header parser for macula-net routing.

Source-route header codec (Part 6 §11).

Macula streaming RPC — single-stream state machine.

Local registry + dispatcher for streaming RPC.

Time utilities for Macula. Provides functions for timestamps, durations, and timeouts.

TLS Certificate Management and Verification Module (v0.11.0+)

Mesh topic construction and validation.

Macula Certificate Trust Store

TUN device lifecycle for macula-net.

Native function stubs for the TUN device NIF.

Owns the inbound TUN-reader mailbox.

UCAN (User Controlled Authorization Networks) token operations.

Macula URI parsing and construction. Format: macula://realm/node_id Example: macula://org.example.mesh/0123456789abcdef...

Yggdrasil-network helpers — pubkey-derived IPv6 addressing and self-signed Ed25519 cert generation.