Files
bare-operating-system/packages/bare-os-protocol
Raven Scott ae6f1cf8ac Implement the 20-task Bare OS POSIX + P2P roadmap: holepunch lockfile drift
reporting and audit:holepunch-clones docs; placeholder baseline automation;
maintainer kernel-image sync script; protomux schema coupling in protocol
tests; disk.os RPC hints (replication_operator_sketch, hyperblobs/blind v3);
union/mirror VFS + warm-cache selective eviction tests; extension resolver
coverage; curl/wget fall through PATH when BARE_OS_DELEGATE_ALLOW excludes
delegates (kernel-runner) with handbook/ctx docs; socket contract / Wasm /
boot budget strict path / hrpc allowlist tests; subprocess bridge meta;
shell until gate + tar stat metadata; POSIX profile triplet pretest verifier;
regenerate kernel bundle, seeder parity, and audit artifacts as needed.

Covers KERNEL_CONTRACT, POSIX_DECLARED_PROFILE, handbook, developer-guide,
scripts/README, and related reference docs.
2026-04-05 02:21:07 -04:00
..
2026-04-05 00:45:17 -04:00
2026-04-04 08:31:39 -04:00

bare-os-protocol

Shared wire format and constants for the Bare operating system monorepo: Hyperswarm topic, 512-byte MBR layout, and Protomux bare-os-v1 seed-channel message shapes.

Documentation: Protocol reference · Kernel extensions · Handbook ch.3.

What it provides

  • PROTOCOL_NAME, TOPIC_STRING — Protomux channel name and swarm topic input string (bare-os-v1)
  • topicKey() — 32-byte topic for swarm.join()
  • BLOCK_SIZE, MBR_MAGIC — 512-byte MBR, magic BIOS at offset 0
  • buildMbr / parseMbr — Pack/unpack primary + optional failover Hyperdrive keys
  • setupSeedChannel — Wire Protomux messages 06 for RAM block reads, gossip bitfield, manifest path search, RPC (incl. bare_os.capabilities with bitsbits11 when non-zero, typed errors for unknown RPC methods, bare_os.replication_status, bare_os.replication_queue, extended RPC short names in seed-rpc-methods.js, bare_os.gossip), and drive.replicate

Subpath exports: bare-os-protocol/constants.js, bare-os-protocol/messages (compact-encoding schemas), bare-os-protocol/kernel-feature-bits.js (documented booter capability words BARE_OS_KERNEL_FEATURES_STOCK_WORD_*; BARE_OS_KERNEL_FEATURE_BITS_DOC=14; surfaced in /proc/bare_os_features and /proc/bare_os/), bare-os-protocol/lib/seed-rpc-methods.js (authoritative bare_os.* RPC name list for kernel_info), bare-os-protocol/protocol-meta.js (BARE_OS_PROTOCOL_PACKAGE_VERSION for the seed handshake).

Consumers

  • bare-os-seeder — builds MBR, serves block 0 over the channel, replicates the system Hyperdrive.
  • bare-os-booter — parses MBR from SwarmDisk, opens system drives, uses the same channel on the client side.

Tests

npm test -w bare-os-protocol

Runs brittle-bare against test.js (topic stability, MBR roundtrip, encodings).

Dependencies

b4a, compact-encoding, hypercore-crypto (via constants/topic). No Hyperdrive or Hyperswarm here — this package stays small and testable.

See also