Caution

This version of the specification is an active work in progress! The specification may change at any time without any notice. It is not correctly versioned and cannot accurately be trusted by servers and clients.

Nexirift Protocol Specification (NPS)

Specification Version: 0.1.0-draft

Nexirift Protocol Specification, also known as NPS, is a set of definitions for how servers should perform in order to interact with compliant apps.

The primary reasoning for this specification is to separate Nexirift (the primary platform) from other instances (which are called NPS-compliant).

While other specifications are created before development, the team is working on the servers before finalising the first specification version.

Not a developer?

Here are some already made NPS-compliant servers and clients:

• Aurora: Nexirift's high-performance reference API server implementing the NPS.
• Dawn: Nexirift's cross-platform client app powered by Expo, built on NPS.

Terminology

• Nexirift: The flagship platform and deployment maintained by Nexirift.
• NPS: The Nexirift Protocol Specification defining standards and endpoints.
• NPS-compliant: Any server or client adhering to the NPS standard.
• Instance: An independent, NPS-compliant server within the ecosystem.

Versioning

The specification follows Semantic Versioning 2.0.0 which uses a MAJOR.MINOR.PATCH format.

• MAJOR: Breaking changes to the schema, endpoints, or authentication.
• MINOR: Backward-compatible additions, new endpoints, or extended data.
• PATCH: Backward-compatible documentation updates, clarification, or fixes.

Clients should identify the servers specification version to ensure compatibility.

This will be updated when an identification method is available.

Federation

NPS does not define any methods for NPS-compliant servers to follow for federation. Instead, it is recommended that NPS-compliant servers implement the ActivityPub protocol via native integration or a plugin system to allow instances to toggle whether it is enabled or not.