overlay-bridge

module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2026 License: Apache-2.0

README

overlay-bridge

Run an unmodified overlay services engine with a multicast delivery fabric as its transport.

   delivery (down)
   fabric ══push══▶ overlay-bridge
       object lane ─▶ feed ─▶ POST /submit (x-topics: matched) ─▶ engine
       header lane ─▶ header store ◀── chain tracker reads ──── engine

   publication (up)
   client ─▶ facade (POST /submit) ─┬─▶ engine  (local admittance, real STEAK)
                                    └─▶ up-tunnel ══▶ fabric ══▶ every subscribed host

   engine: propagation switched off in configuration, so it admits and
           indexes but never re-submits to another host

Why a bridge

An overlay host does two jobs when an object arrives. It admits it: verify the BEEF, run the topic manager, index the outputs. Then it propagates it: one HTTPS submit to every other host of the topic. The second job is the expensive one, and only an operator sees it. A publisher already submits to every host it can find, and every host that admits re-submits to every other, so between N hosts one object crosses the network on the order of N squared times and is fully verified at every arrival before a duplicate check discards it. A host that was unreachable simply misses it, with no signal that it did.

This bridge replaces that second fan-out with one publication. Delivery arrives as an ordinary submit on the interface the engine already serves; publication goes out once and the network fans it out to every subscribed host.

Nothing is forked. The bridge imports no engine module and speaks only the engine's published HTTP interfaces. Stop it, give the engine back its propagation peers and its stock chain tracker, and you have a stock overlay host again. The bridge holds no state of record.

Planes

Plane Direction What the bridge does
Object lane (BRC-149) down splits delivery records, maps the matched topic identifier back to its name, submits to the engine
Header lane (BRC-135) down proof-of-work checks and chains bare headers, serves them to the engine as its chain tracker
Submit facade (BRC-22) up forwards to the local engine first, then publishes once onto the object plane

Sovereign verification follows from the header lane: every object the host admits is checked against headers the host itself received, from the same network that delivered the object, with no third-party header service in the loop and no rate limit to be subject to.

Status

Early. The packages land in the order the build plan sets out; see docs/.

Licence

Apache-2.0 (see LICENSE). Third-party dependencies and the attribution their licences require are in NOTICE. There is no licence check in this software, no call home, and no metering of any kind inside it.

Papers

Directories

Path Synopsis
cmd
overlay-bridge command
Command overlay-bridge runs an unmodified overlay services engine with a multicast delivery fabric as its transport.
Command overlay-bridge runs an unmodified overlay services engine with a multicast delivery fabric as its transport.
Package facade serves the engine's own submit interface, so a client publishes once through the bridge instead of to every host of a topic.
Package facade serves the engine's own submit interface, so a client publishes once through the bridge instead of to every host of a topic.
Package feed turns delivered BRC-149 records into ordinary engine submits.
Package feed turns delivered BRC-149 records into ordinary engine submits.
Package guard keeps one publication from going round twice.
Package guard keeps one publication from going round twice.
Package headers follows a BRC-135 header lane and serves it to an overlay engine as that engine's chain tracker.
Package headers follows a BRC-135 header lane and serves it to an overlay engine as that engine's chain tracker.
chainclient
Package chainclient is a chain tracker backed by an overlay-bridge header read API.
Package chainclient is a chain tracker backed by an overlay-bridge header read API.
Package topics reconciles the bridge's elected topic list against what its consumer is actually subscribed to.
Package topics reconciles the bridge's elected topic list against what its consumer is actually subscribed to.
Package uptunnel streams BRC-149 submission records to the fabric's BEEF ingress over a long-lived TCP connection through the consumer tunnel.
Package uptunnel streams BRC-149 submission records to the fabric's BEEF ingress over a long-lived TCP connection through the consumer tunnel.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL