Skip to content

overlay-social/specs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

overlay.social specs

Open specifications for sovereign, BRC-100-native social applications on BSV.

This repository documents the conventions that the overlay.peck.to reference deployment actually runs, plus the roadmap toward a federated overlay layer. It is deliberately split so you can tell the two apart at a glance.

Honesty contract. Every spec file declares a Status: of IMPLEMENTED, PARTIAL, or ROADMAP in its header. If it says IMPLEMENTED, there is code running in production against it today. If it says ROADMAP, it is a design we intend to build - do not assume an endpoint exists because it is described here.

What runs today (IMPLEMENTED)

  • Bitcoin Schema admission. Content is written as B + MAP + AIP pushes inside OP_FALSE OP_RETURN, signed with canonical AIP (BSM-compact today). Any Bitcom-aware indexer can read it. See 00-content-bitcoin-schema.md.
  • Token-state decode (ProfileToken / HandleToken). Identity entities live as 1Sat UTXOs with a three-layer envelope (ord-inscription / MAP tags / sCrypt state). The overlay decodes @prop state out of the locking script and tracks the canonical, unspent token per subject. See 01-token-state.md.
  • Identity projection - the killer feature. A single batch call resolves a whole feed page of authors to their canonical ProfileToken state, and the renderer defensively overwrites display name / avatar / handle. SSO-feel across apps with no server session. See 02-identity-projection.md.
  • Topic-rooted overlay state. Topic managers admit outputs and serve REST hydration — content (tm_social-content), token-state identity (tm_social-profile/-handle), light identity attestations (tm_key-binding, tm_identity-profile/-handle/-cert) and relationships (tm_social-friend). See 03-overlay-topics.md.
  • Light identity attestations. BRC-3 self-signed profiles, first-come handle claims, key-binding (posting key ↔ identity root with mutual signatures) and cert publication — resolution collapses bound keys everywhere. See 06-identity-attestations.md.
  • Friend: mutual-consent relationships. Two one-way BRC-3 attestations form an active pair; unfriend revokes one side; friendship gates DMs (BRC-42-encrypted, message-box transport). Bitcoin-Schema-compatible vocabulary. See 07-social-friend.md.
  • On-chain state-root anchoring. Every topic's Merkle root anchors to chain as a prev-chained 1Sat ordinal; the scheduler anchors on change, autonomously, and GET /state exposes anchor.matchesLive so anyone can audit served state against Bitcoin. See 08-state-anchoring.md.

What is designed but not yet built (ROADMAP)

  • Federated overlay sync - GASP / subtree-rooted topic Merkle trees, N-of-M peer acceptance, idempotent submission. (On-chain state-root anchoring has graduated to IMPLEMENTED — see 08-state-anchoring.md.) See 04-federation-roadmap.md.
  • Additional write channels & token economics - input-script-data (payment-coupled actions), PostToken marketplace, paywall via BRC-104 channels, Teranode Kafka direct-consume, the Bitcoin-Schema hybrid bridge for token-state posts. See 05-write-channels-roadmap.md.

Reference deployment & data reality

The live reference is overlay.peck.to, consumed by peck-web (peck.to). As of this writing only a handful of ProfileToken owners exist on mainnet; most feed authors are bare P2PKH addresses with no ProfileToken. The identity projection is built to degrade gracefully for them - unresolved authors are simply omitted and the renderer falls back to a truncated address. Read 02-identity-projection.md data-reality section before assuming a full identity graph exists.

Layer map

Application        peck.to / peck.bio / peck.ink / Margin
Read/sync          overlay (BRC-22 topic managers, REST hydration)   <- single overlay today; federation = roadmap
Write channels     OP_RETURN Bitcoin Schema (live) / token-state (live) / input-script-data (roadmap)
Identity/content   BRC-100 / BRC-43 / BRC-52 / BRC-77 / BRC-104
Substrate          BSV mainnet

License

Open BSV License v5 — see LICENSE. The specs, and anything derived from them, are usable only on the Bitcoin SV blockchain, by design.

About

overlay.social protocol specs — content (Bitcoin Schema), token-state, identity projection, overlay topics, federation & write-channel roadmaps. MIT.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors