Search documentation of macula

# API Reference macula v#4.4.9

View Source

## Modules

macula

Macula SDK — Public API for mesh applications.

macula_address

macula-net address derivation: pubkey -> IPv6.

macula_advertise_station

Periodic DHT advertisement of a macula-net station.

macula_app

macula public API

macula_attach_identity

Daemon-side attachment to a host station.

macula_blake3_nif

BLAKE3 hashing with NIF acceleration and Erlang fallback.

macula_bolt4

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

macula_cache

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

macula_cache_route

TTL-bounded route cache for macula-net.

macula_cbor_nif

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

macula_cert

Macula Self-Sovereign Certificate System

macula_cert_system

Macula Certificate System Supervisor

macula_client

`macula_client` — the canonical pool client.

macula_cluster

Cluster management utilities for Macula platform.

macula_cluster_gossip

Macula UDP Multicast Gossip Cluster Strategy.

macula_cluster_static

Macula Static Cluster Strategy.

macula_cluster_strategy

Macula Cluster Strategy for libcluster.

macula_console

Macula Console Formatter - Beautiful colored terminal output.

macula_core_types

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

macula_crypto_nif

Cryptographic operations for Macula mesh.

macula_deliver_packet

Ingress delivery for macula-net packets.

macula_diagnostics

Structured event emission + per-process metric accumulation.

macula_did_nif

Decentralized Identifier (DID) operations for Macula mesh.

macula_dist

QUIC Distribution Carrier for Erlang.

macula_dist_bridge

Supervised bridge process for relay distribution tunnels.

macula_dist_bridge_sup

Supervisor for distribution relay bridge processes.

macula_dist_discovery

EPMD Replacement using Macula DHT Discovery.

macula_dist_mdns_advertiser

Macula Distribution mDNS Advertiser.

macula_dist_relay

Relay-routed Erlang distribution.

macula_dist_relay_client

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

macula_dist_relay_protocol

Control protocol encoder/decoder for dist relay.

macula_dist_system

Macula Distribution System Supervisor.

macula_foundation

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

macula_frame

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

macula_host_attach_controller

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

macula_host_identity

Hosted-identity table for a macula-net station.

macula_id

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

macula_identity

Ed25519 identities and the S/Kademlia crypto puzzle.

macula_metrics

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

macula_metrics_http

Prometheus text-format pull endpoint for `macula_metrics`.

macula_mri

Macula Resource Identifier (MRI) - Core Module

macula_mri_ets

MRI ETS Storage Adapter

macula_mri_graph

MRI Graph Behaviour

macula_mri_nif

MRI (Macula Resource Identifier) operations for Macula mesh.

macula_mri_registry

MRI Type Registry

macula_mri_store

MRI Storage Behaviour

macula_names

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

macula-net facade.

macula_net_transport

Transport plugin contract for macula-net.

macula_net_transport_quic

QUIC transport plugin for macula-net.

macula_node

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

macula_packet_trace

Per-flow packet trace toggle for macula-net.

macula_peering

Macula peering — connection state machine API.

macula_peering_conn

Per-peer connection state machine.

macula_peering_conn_sup

simple_one_for_one supervisor for `macula_peering_conn` workers.

macula_peering_sup

Top supervisor for macula_peering.

macula_protocol_decoder

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

macula_protocol_encoder

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

macula_protocol_types

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

macula_pubsub

Pubsub surface for the V2 SDK.

macula_quic

Macula QUIC transport — Quinn-based Rust NIF.

macula_realm

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

macula_record

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

macula_record_cbor

Deterministic CBOR encoder/decoder.

macula_record_uuid

UUIDv7 generator (RFC 9562 §5.7).

macula_relay_discovery

Relay Discovery — geographic-aware relay selection.

macula_resolve_address

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

macula_resolve_quorum

Eclipse-mitigation wrapper for `macula_resolve_address`.

macula_root

Macula SDK Root Supervisor.

macula_route_packet

Egress routing for macula-net packets.

macula_route_packet_ipv6

Minimal IPv6 header parser for macula-net routing.

macula_source_route

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

macula_stream

Macula streaming RPC — single-stream state machine.

macula_stream_local

Local registry + dispatcher for streaming RPC.

macula_time

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

macula_tls

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

macula_topic

Mesh topic construction and validation.

macula_trust_store

Macula Certificate Trust Store

macula_tun

TUN device lifecycle for macula-net.

macula_tun_nif

Native function stubs for the TUN device NIF.

macula_tun_reader_proxy

Owns the inbound TUN-reader mailbox.

macula_ucan_nif

UCAN (User Controlled Authorization Networks) token operations.

macula_uri

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

macula_z32

z-base-32 codec (Phil Zimmermann's "Human-Oriented Base-32 Encoding"). Alphabet: `ybndrfg8ejkmcpqxot1uwisza345h769`.