Skip to content

overnet-project/spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overnet Specification

This repository contains the draft specifications for Overnet.

GitHub: https://github.com/overnet-project/spec

Overnet is a higher-level protocol and application platform built on top of Nostr. It is intended to support systems such as chat, email, code hosting, marketplaces, and websites, while emphasizing freedom, decentralization, self-hostability, and interoperability.

At present, this repository contains the Overnet Core Specification draft plus the first companion adapter specification for IRC, along with shared conformance fixtures used by the reference implementation work.

In this specification family:

  • adapter specifications define how external systems map into Overnet semantics
  • Overnet programs are runnable implementations that consume or produce Overnet data

Status

This repository is in active development.

The current specifications should be treated as working drafts. They are being revised alongside early implementation work in the sibling repositories:

The current document is useful as:

  • a statement of the intended architecture
  • a development target for early implementation work
  • a basis for review and discussion

It should not yet be treated as a stable interoperability standard.

See docs/status.md for more detail.

Repository Layout

Current Scope

The current focus of this repository is the Overnet core plus the first real adapter pressure test.

The current documents and fixtures cover:

  • the Overnet core event and provenance model
  • core validation rules and shared core fixtures
  • removal and delegation baseline semantics
  • generic adapter fidelity requirements
  • the first IRC adapter specification and IRC fixture corpus
  • the first draft Overnet Program Runtime specification
  • the first draft Overnet Program Protocol specification
  • the first draft Overnet Program Services specification
  • the first draft Overnet Authentication Agent specification
  • the first draft Overnet Profile Contract format
  • initial auth-agent protocol and bridge fixtures

Application-specific behavior and additional adapters are still expected to be defined in companion specifications rather than folded into the core.

This repository now contains initial working drafts for both the Overnet Program Runtime and Overnet Program Protocol.

Planned Companion Specifications

Over time, this repository is expected to grow to include documents such as:

  • email adapter specification
  • GitLab adapter specification
  • chat profile
  • email profile
  • code hosting profile
  • storage and replication profiles

These names are provisional and should not be treated as final.

Development Approach

This specification family is being developed through a combination of:

  • core design work
  • early implementation work
  • conformance-oriented thinking
  • iterative revision based on real adapter and application requirements

The intent is not to freeze the entire design prematurely. Instead, the goal is to develop a coherent core, pressure-test it through implementation and adapters, and refine it as needed.

Contributing

Discussion, review, criticism, issue reports, and pull requests are welcome.

If you think something in the spec is ambiguous, inconsistent, too broad, too narrow, or likely to break under implementation pressure, please open an issue.

Small clarifications and focused pull requests are especially helpful while the specification is still evolving.

Related Repositories

AI Usage

This code was developed in part with AI tooling such as Claude Code and Codex. We want to be upfront about that.

License

This repository is licensed under the GNU General Public License, version 3. See LICENSE.

About

The Overnet specification and conformance fixtures

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages